21.1 Add-DRAResourceMailbox

Synopsis

Adds a user having a resource mailbox to an Active Directory domain.

Syntax

Add-DRAResourceMailbox -MailboxType <String> -Properties <Hashtable> -Domain <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Add-DRAResourceMailbox cmdlet adds a resource mailbox to a domain managed by DRA. The requesting user must have the Create Resource Mailbox power. Use the Properties parameter to specify the values to use when creating the resource mailbox. To see the complete list of available properties, perform a Get-Member command on the object returned from any DRAResourceMailbox command.

Creating a resource mailbox requires a full path for the object and the LDAP path to the target MailboxStore. You can get the LDAP path to the mailbox store by using the Get-DRAExchangeServers and Get-DRAExchangeStores cmdlets.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

MailboxType [<String>]

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

true

named

true (ByPropertyName)

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

Example 21-1 1

PS C:\>Add-DRAResourceMailbox  -Domain MyDomain.corp -MailboxType room -Properties @{FriendlyName="MyDomain.corp/Accounting/RMB_123";MailboxStore="LDAP://MDOMAIN.CORP/CN=etc."; Description="ResourceMailbox for powershell";AllowConflicts=$true}

This example creates a room resource mailbox named RMB_123 in Active Directory using the DRA FriendlyName property. The resource mailbox will be created in the domain MyDomain.corp in the Accounting OU. There are two properties set on this resource mailbox: Description and AllowConflicts. The samAccountName defaults to the name. The principal name defaults to RMB_123@MyDomain.corp. The alias will be set by the server, according to configured policy.

Example 21-2 2

PS C:\>Add-DRAResourceMailbox  -Domain MyDomain.corp  -MailboxType equipment  -Properties  @{DistinguishedName="CN= RMB_123,OU=Accounting,DC=MyDomain,DC=corp";MailboxStore="LDAP://MDOMAIN.CORP/CN=etc.";Description="some description"}

This example creates an equipment resource mailbox named RMB_123 in Active Directory using the DistinguishedName property. The resource mailbox will be created in the domain MyDomain.corp in the Accounting OU. There is one property set: Description. The samAccountName defaults to the name. The resource mailbox principal name defaults to RMB_123@MyDomain.corp. The alias will be set by the server, according to configured policy.