31.3 Add-DRAUserMailbox

Synopsis

Adds an Exchange mailbox to an existing user.

Syntax

Add-DRAUserMailbox -Domain <String> -MailboxStore <String> [-MailboxType <String>] [-UseDefaultMailboxStore <SwitchParameter>] [-MailNickname <String>] [-LinkedMasterAccount <String>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Add-DRAUserMailbox cmdlet adds a mailbox to an existing user that is managed by DRA. The requesting user must have one of the Create Exchange Mailbox power. To convert an existing user to a resource mailbox, specify the MailboxType parameter.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

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

MailboxType[<String>]

The type of resource mailbox you want to create. Valid values are 'room' or 'equipment'.

false

named

true (ByPropertyName)

false

UseDefaultMailboxStore [<SwitchParameter>]

Flag denoting if the default Exchange mailbox store should be used when creating the mailbox.

false

named

false

false

MailNickname [<String>]

Specifies the Exchange alias for the mailbox. If not specified the sAMAccount name will be used.

false

named

false

false

LinkedMasterAccount [<String>]

Specifies the master account to link the mailbox account to. The master account has access to the mailbox.

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 Add-DRAUserMailbox -detailed". For technical information, type "Get-Help Add-DRAUserMailbox -full"

Example 31-7 1

PS C:\>Add-DRAUserMailbox  -Domain "MyDomain.corp" -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp -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" -UseDefaultMailboxStore -MailNickname "User123NN"

This example creates an Exchange mailbox for an existing user managed by DRA. You can use the command Get-DRAExchangeStores to get the value needed for the MailboxStore parameter. The MailNickname is set to User123NN. If this property is not present, the MailNickname defaults to the samAccountName. The UseDefaultMailboxStore option tells the Exchange server to use the default mailbox store.

Example 31-8 2

PS C:\>Add-DRAUserMailbox  -Domain "MyDomain.corp" -Identifier "CN=USER123,OU=Accounting,DC=MyDomain,DC=corp -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" -MailNickname "User123NN"

This example creates an Exchange mailbox for an existing user managed by DRA. You can use the command Get-DRAExchangeStores to get the value needed for the MailboxStore parameter. The MailNickname is set to User123NN. If this property is not present, the MailNickname defaults to the samAccountName.