Removes a public folder permanently.
Remove-DRAPublicFolder -Domain <String> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>][<CommonParameters>]
The Remove-DRAPublicFolder cmdlet removes a public folder permanently. The requesting user must have the Delete Public Folder power.
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 |
ContainerDN [<String>] The full path to the container to search in distinguished name format. For example: -ContainerDN "OU=Accounting,DC=MyDomain,DC=corp" |
false |
named |
|
false |
false |
EnforceServerLimit [<SwitchParameter>] A switch parameter to indicate that the search results should be limited by the search result limit on the DRA Server. The typical server limit is 1000 items. The default is true. |
false |
named |
|
false |
false |
IncludeChildContainers [<SwitchParameter>] A switch parameter to request that the search include child containers. The default is false: only the container named in the ContainerDN parameter is searched. |
false |
named |
|
false |
false |
ObjectsPerResponse [<Nullable`1>] The number of objects to return in a response. The default is 250. |
false |
named |
|
false |
false |
ResumeString [<String>] When multiple responses are needed to return all of the search results to the client, this parameter indicates the last item returned from the server. The value of this parameter would be set using the ResumeString property from the previous set of results. The ResumeString may look like this: "CN=MYUser160,CN=Users,DC=MyDomain,DC=corp". The EnforceServerLimit, ObjectsPerResponse, and ResumeString parameters are applicable only when the Identifier parameter is not specified. |
false |
named |
|
false |
false |
Attributes [<String[]>] An array of attributes to retrieve values for. If this parameter is missing, a default list of properties is returned. |
false |
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 |
false |
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-DRAPublicFolder -detailed". For technical information, type "Get-Help Remove-DRAPublicFolder -full".
Example 19-11 1
PS C:\>Remove-DRAPublicFolder -Identifier "PF=MyPublicFolder,DC=MyDomain,DC=corp" -Domain MyDomain.corp
This example will remove a public folder named MyPublicFolder.