Updates the properties of an existing group account in Active Directory.
Set-DRAGroup -Domain <String> [-RemoveDynamicFilter <SwitchParameter>] [-DynamicFilterIncludeChildren <SwitchParameter>] [-DynamicFilterLDAPQuery <String>] [-DynamicFilterVAQuery <String>] [-DynamicFilterRootContainer <String>] [-Properties <Hashtable>] [-Replace <Hashtable>] [-Add <Hashtable>] [-Remove <Hashtable>] [-Clear <String[]>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Set-DRAGroup cmdlet updates the specified group account. The requesting user must have one of the Modify Group powers.
NOTE:Set-DRAGroup cmdlet supports multi-values only for the ProxyAddresses attribute.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
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 |
Replace [<Hashtable>] A Hashtable of property values to replace the current set of values for the specified property. The key is the name of a defined property in the REST interface. For example: -Replace @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list and will replace currently set values.For example: -Replace @{Attribute1DRADisplayName=value1, value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Replace @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Replace @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Add [<Hashtable>] A Hashtable of property values to add to the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Add @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list.For example: -Add @{Attribute1DRADisplayName=value1, value2}} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Add @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Add @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Remove [<Hashtable>] A Hashtable of property values to remove from the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Remove @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list and will be removed from currently set values.For example: -Remove @{Attribute1DRADisplayName=value1,value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Remove @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Remove @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Clear [<String>] An array of property names whose values will be cleared. Each name is the name of a defined property in the REST interface. For example: -Clear "Attribute1-DRA-DisplayName" Multiple values need to be separated by a comma. For example: -Clear Attribute1DRADisplayName, Attribute2DRADisplayName |
false |
named |
|
true (ByPropertyName) |
false |
RemoveDynamicFilter [<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 |
|
DynamicFilterIncludeChildren [<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 |
|
DynamicFilterLDAPQuery [<String>] 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 |
|
DynamicFilterVAQuery [<String>] Specifies the virtual attribute query for dynamic group member filter. For example: (&(objectClass=User)(MyVA=*)) |
false |
named |
false |
false |
|
DynamicFilterRootContainer [<String>] 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 |
|
Identifier <String> The name or distinguished name of an existing Active Directory object. When the name is specified, an additional call to the DRA Server is needed to obtain the distinguished name for the object. |
true |
named |
true (ByPropertyName) |
false |
|
Domain <String> The domain of the object in fqdn format. For example: mydomain.corp |
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-DRAGroup -detailed". For technical information, type "Get-Help Set-DRAGroup -full".
Example 16-32 1
PS C:\>Set-DRAGroup -Domain MyDomain.corp -Identifier "GROUP123" -Properties @{ManagedBy="CN=George,CN=Users, DC=MYDOMAIN,DC=corp";Description="updated description";HideFromAddressLists=$true}
This command example updates some of the properties for the group GROUP123 in MyDomain.corp. The Identifier specifies the name of the group. When the identifier format is the name, DRA resolves the name to the full distinguished name.
Example 16-33 2
PS C:\>Set-DRAGroup -Domain MyDomain.corp -Identifier "CN=GROUP123,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{ManagedBy="CN=George,CN=Users,DC=MYDOMAIN,DC=corp";ReportToOriginator=$true}
This example updates some of the properties for the group GROUP123 in MyDomain.corp. The identifier contains the distinguished name for the group. Two properties are updated: ManagedBy and ReportToOriginator. To see the complete list of available properties, perform a Get-Member command on the object returned from any DRAGroup command.