12.2 Set-DRADomain

Synopsis

Updates the properties of a managed domain.

Syntax

Set-DraDomain -Domain <String> -Properties <Hashtable> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Set-DRADomain cmdlet updates the properties of a managed domain. You must have the power to modify DRA configuration data

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

Domain [<String>]

The domain of the object in fqdn format. For example: mydomain.corp

true

named

 

true (ByPropertyName)

false

Properties <Hashtable>

A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value}

Multiple values are specified as a comma-separated list.For example: -Properties @{Attribute1DRADisplayName=value1, value2}

If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value}

If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"}

true

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA Rest Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'.

false

named

 

true (ByPropertyName

false

DRARestPort [<Int32>]

The port where the DRA REST Service listens for requests. If the parameter is not specified, the value defaults to 8755.

false

named

8755

true (ByPropertyName

false

IgnoreCertificateErrors [<SwitchParameter>]

Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate.

false

named

false

false

Force [<SwitchParameter>]

Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user.

false

named

 

false

false

Timeout [<Int32>]

The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1.

false

named

100 seconds

true (ByPropertyName)

false

<CommonParameters>

Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

 

 

 

 

 

NOTE:For more information, type "Get-Help Set-DRADomain -detailed". For technical information, type "Get-Help Set-DRADomain -full".

Example 12-3 1

PS C:\>Set-DRADomain -Domain MyDomain.corp -Properties
@{IsRecycleBinEnabled=$true;PeriodicallyCleanRecycleBin=$true;
PeriodicallyCleanRecycleBinDailyInterval=100;
PeriodicallyCleanRecycleBinStartDate=(Get-Date).AddDays(7);
RecycleBinManagesComputers=$true;
PeriodicallyDeleteComputersFromRecycleBin=$true;
DeleteComputersOlderThanDays=100}

This example enables the Recycle Bin for the domain MyDomain.corp with the following settings:1. The Recycle Bin cleanup job tor run every 100 days starting 7 days from when the cmdlet is run.2. Computer objects should be moved to the Recycle Bin when deleted from Active Directory.3. The Recycle Bin cleanup job should permanently delete any computer in the Recycle Bin older than 100 days.

Example 12-4 2

PS C:\>Set-DRADomain -Domain MyDomain.corp -Properties @{preferredDc="CorpDC01.MyDomain.corp"}

This command example sets the preferred domain controller for MyDomain.corp to CorpDC01.MyDomain.corp