Copies an existing user to a new user.
Copy-DRAUser -Domain <String> -Properties <Hashtable> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Copy-DRAUser cmdlet copies an existing user property to a new user. The values provided in the -Properties parameter will overwrite the values provided by the existing user. You must supply the properties to give the new user a name and a location. See the Add-DRAUser for examples of how to define the new user. The response contains the string generated by the server.
|
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 |
|
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. This parameter is only used when the DRARestServer parameter is also specified. 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-DRAUser -detailed". For technical information, type "Get-Help Copy-DRAUser -full".
Example 31-9 1
PS C:\>Copy-DRAUser -Identifier "CN=Usersource,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{distinguishedName="CN=USER123,OU=Tax,DC=MyDomain,DC=corp"} -domain MyDomain.corp
This example will copy the user named Usersource from the Accounting OU in MyDomain.corp to a new user named USER123 in the Tax OU in MyDomain.corp. The properties of USER123 will be the same as the properties of Usersource.
Example 31-10 2
PS C:\>Copy-DRAUser -Identifier "CN=Usersource,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{distinguishedName="CN=USER123,OU=Tax,DC=MyDomain,DC=corp";Description="Tax group member"} -domain MyDomain.corp
This example will copy the user named Usersource from the Accounting OU in MyDomain.corp to a new user named USER123 in the Tax OU in MyDomain.corp. The Description property for USER123 will be set to 'Tax group member'.
Example 31-11 3
PS C:\>Copy-DRAUser -Identifier "CN=Usersource,OU=Accounting,DC=MyDomain,DC=corp" -Properties @{distinguishedName="CN=USER123,OU=Tax,DC=MyDomain,DC=corp";Description="Tax group member";MailboxStore="LDAP://Myserver.Mydomain.Corp/CN=Mailbox Database 0962326578,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=MessageStore1,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=Mydomain,DC=corp";UseDefaultMailboxStore=$true} -domain MyDomain.corp
This example will copy the user named Usersource from the Accounting OU in MyDomain.corp to a new user named USER123 in the Tax OU in MyDomain.corp. The Description property for USER123 will be set to 'Tax group member'. A mailbox will be created using the specified mailbox store to connect to the Exchange server. An optional UseDefaultMailboxStore flag requestes the Exchange server to use the default mailbox store.