20.2 Enable-DRARemoteMailbox

Synopsis

Creates a mailbox for an existing on-premises user account specified by the Identifier parameter in the cloud-based service.

Syntax

Enable-DRARemoteMailbox -Domain <String> [-RemoteRoutingAddress <String>] [-LicensingGroup <String>] [-Archive <SwitchParameter>] [-ArchiveName <String>] -Identifier <String> [-DRAHostServer<String>] [-DRAHostPort <Int32>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

Use the Enable-DRARemoteMailbox cmdlet to:

  • Create a mailbox in the cloud-based service for an on-premises user account. The parameters LicensingGroup and RemoteRoutingAddress are mandatory. The requesting user must have the Create Exchange Mailbox power.

  • Create an archive mailbox for an on-premises user account with an associated mailbox in the cloud-based service. The Archive parameter is mandatory and the requesting user must have the Create Exchange Archive Mailbox Only power.

  • Create an archive mailbox for an on-premises object with an associated shared mailbox in the cloud-based service. The Archive parameter is mandatory and the requesting user must have the Create Exchange Archive Mailbox Only power.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

RemoteRoutingAddress [<String>]

The SMTP address of the mailbox in the cloud-based service that the on-premises user is associated with.

  • If this parameter is not specified, and the remote routing address policy is configured, DRA generates the value for the parameter based on the policy.

  • If this parameter is specified and the remote routing address policy is also configured, DRA overrides the policy configuration and uses the specified value.

  • If this parameter is not specified and the remote routing address policy is also not configured, DRA generates an error.

false

named

 

true (ByPropertyName)

false

LicensingGroup [<String>]

The licensing group that is configured in DRA to enforce office 365 licenses. Valid input is a distinguished name or a canonical name.

false

named

 

true (ByPropertyName)

false

Archive [<SwitchParameter>]

The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. The on-premises user account and its associated cloud-based mailbox are not removed if you use this switch.

false

named

true (ByPropertyName)

false

ArchiveName [<String>]

The archive mailbox name in the cloud-based service.

true

named

true (ByPropertyName)

false

Identifier <String>

The name or distinguished name of an existing Active Directory 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 Enable-DRARemoteMailbox -detailed". For technical information, type "Get-Help Enable-DRARemoteMailbox -full".

Example 20-3 1

PS C:\\>Enable-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp" -LicensingGroup "CN=MyLicensingGroup,DC=MyDomain,DC=corp"

This example creates the cloud-based mailbox for an existing on-premises user account MyUser. The identifier contains the distinguished name for the user. The parameters LicensingGroup and RemoteRoutingAddress are mandatory. The example assumes that the remote routing address policy is configured. If the RemoteRoutingAddress parameter is not specified, DRA generates the remote routing address based on the policy.

Example 20-4 2

PS C:\\>Enable-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp" -Archive -ArchiveName MyUserArch

This example creates the cloud-based archive mailbox MyUserArch for the existing on-premises user account MyUser. The identifier contains the distinguished name for the user. The Archive parameter is mandatory. However, the ArchiveName parameter is optional. The creation of the archive mailbox in the cloud-based service is not immediate and depends on the directory synchronization schedule.

Example 20-5 3

PS C:\\>Enable-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=SHMB,OU=MyOU,DC=MyDomain,DC=corp" -Archive -ArchiveName MySHMBArch

This example creates a cloud-based archive mailbox MySHMBArch for the existing remote shared mailbox SHMB. The identifier contains the distinguished name for the remote shared mailbox. The Archive parameter is mandatory. However, the ArchiveName parameter is optional. The creation of the archive mailbox in the cloud-based service is not immediate and depends on the directory synchronization schedule.