Creates an archive mailbox for the user account specified by the Identifier, Alias, and MailboxStore parameters.
Add-DRAUserArchiveMailbox -Domain <String> -ArchiveMailboxName <String> -MailboxStore <String> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Add-DRAUserArchiveMailbox cmdlet creates an archive mailbox for the user specified by the Identifier. The user must already have an Exchange mailbox. The requesting user must have the Create Exchange Archive Mailbox Only power.
NOTE:You can use the Add-DRAUserArchiveMailbox cmdlet to create an archive of resource mailbox objects by specifying the identifier of the room or equipment mailbox in the identifier parameter.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
ArchiveMailboxName <String> The name of the archive mailbox. |
true |
named |
|
false |
false |
MailboxStore <String> Full path to the Exchange mailbox store. Use the Get-DRAExchangeStores command to list available mailbox stores managed by DRA. |
true |
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 Add-DRAUserArchiveMailbox -detailed". For technical information, type "Get-Help Add-DRAUserArchiveMailbox -full".
Example 31-6 1
PS C:\>Add-DRAUserArchiveMailbox -Domain MyDomain.corp -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp" -ArchiveMailboxName "User123Archive" -MailboxStore "LDAP://CN=Mailbox Database 0565232367,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First,CN=Microsoft Exchange,CN=Services,CN=Configuration, DC=MyDomain,DC=corp
This example creates an archive mailbox named User123Archive for the user named USER123 in MyDomain.corp in the mailbox store specified in MailboxStore parameter.