Copies an existing group to a new group.
Copy-DRAGroup -Domain <String> [-NoCopyMembers <SwitchParameter>] [-RemoveDynamicFilter <SwitchParameter>] [-DynamicFilterIncludeChildren <SwitchParameter>] [-DynamicFilterLDAPQuery <String>] [-DynamicFilterRootContainer <String>] -Properties <Hashtable> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Copy-DRAGroup cmdlet copies an existing group to a new group.The values provided in the -Properties parameter will overwrite the values provided by the existing group. You must supply properties to give the new group a name and a location. See the help for the Add-DRAGroup cmdlet for examples of how to define the new group. The response contains the string generated by the server.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
NoCopyMembers [<SwitchParameter>] Specifies NOT to copy all members information from source group. If the parameter is not specified, the value false and the members will be copied. |
false |
named |
false |
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 |
|
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 |
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 Copy-DRAGroup -detailed". For technical information, type "Get-Help Copy-DRAGroup -full".
Example 16-8 1
PS C:\>Copy-DRAGroup -Identifier "Groupsource" -Domain MyDomain.corp -DynamicFilterRootContainer "OU=OU01,DC=MyDom,DC=corp" -DynamicFilterLDAPQuery "(&(objectClass=user)(objectCategory=person))" -DynamicFilterIncludeChildren -Properties @{distinguishedName="CN=GROUP123,OU=Accounting,DC=MyDomain,DC=corp"; WhiteList="CN=Add Me,OU=XXX,DC=MyDom,DC=corp","CN=Add Me2,OU=YYY,DC=MyDom,DC=corp"; BlackList="CN=Skip Me,OU=OU01,DC=MyDom,DC=corp","CN=Skip Me2,OU=OU01,DC=MyDom,DC=corp"}
This command example copies a dynamic group by specifying the source Identifier and the DynamicFilterLDAPQuery and DynamicFilterRootContainer parameters. The distinguishedName will become the destination dynamic group name. DynamicFilterIncludeChildren indicates that the group includes objects from the DynamicFilterRootContainer and all of its children. Group members may also include the two accounts listed in the WhiteList property, even though the accounts do not match the filter criteria. The two BlackList accounts will be excuded from the group, even though they are users in the DynamicFilterRootContainer.
Example 16-9 2
PS C:\>Copy-DRAGroup -Identifier "Groupsource" -NoCopyMembers -Properties @{distinguishedName="CN=Group123,OU=Tax,DC=MyDomain,DC=corp"} -domain MyDomain.corp
This command example will copy the group named Groupsource to a new group named Group123 in the Tax OU in MyDomain.corp. The members of Groupsource will not be copied to Group123. Otherwise, the properties of Group123 will be the same as the properties of Groupsource.
Example 16-10 3
PS C:\>Copy-DRAGroup -Identifier "CN=Groupsource,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{distinguishedName="CN=Group123,OU=Tax,DC=MyDomain,DC=corp"} -domain MyDomain.corp
This command example will copy the group named Groupsource from the Accounting OU in MyDomain.corp to a new group named Group123 in the Tax OU in MyDomain.corp. The properties of Group123 will be the same as the properties of Groupsource.
Example 16-11 4
PS C:\>Copy-DRAGroup -Identifier "CN=Groupsource,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{distinguishedName="CN=Group123,OU=Tax,DC=MyDomain,DC=corp";Description="Tax group"} -domain MyDomain.corp
This command example will copy the group named Groupsource from the Accounting OU in MyDomain.corp to a new group named Group123 in the Tax OU in MyDomain.corp. The Description property for Group123 will be set to 'Tax group'.