21.5 Remove-DRAResourceMailbox

Synopsis

Removes the resource mailbox account specified by the Identifier parameter.

Syntax

Remove-DRAResourceMailbox -Domain <String> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Remove-DRAResourceMailbox cmdlet deletes the specified account. The requesting user must have the Delete Resource Mailbox power. If the Recycle Bin is enabled, the specified account is moved to the Recycle Bin.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

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

Example 21-10 1

PS C:\>Remove-DRAResourceMailbox  -Domain MyDom.corp -Identifier "CN=RMB_123,OU=Accounting,DC=MyDomain,DC=corp"

This example deletes the resource mailbox named RMB_123 from MyDomain.corp. The identifier contains the distinguished name for the resource mailbox. If the Recycle Bin is enabled, the resource mailbox is moved to the Recycle Bin. Otherwise, it is removed permanently.

Example 21-11 3

PS C:\>Remove-DRAResourceMailbox -Domain MyDom.corp -Identifier "CN=RMB_X,OU=NetIQRecycleBin,DC=MyDomain,DC=corp"

This example deletes the resource mailbox named RMB_X from the DRA Recycle Bin, removing it permanently from Active Directory.