Remove-Brokeradminfolder¶

Removes an admin folder.

Syntax¶

Remove-BrokerAdminFolder [-InputObject] <AdminFolder[]> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Remove-BrokerAdminFolder [-Name] <String> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Detailed Description¶

The Remove-BrokerAdminFolder cmdlet removes an existing admin folder.

Remove-BrokerAdminFolder will not remove a folder if it contains any other objects (e.g. sub-folders or applications).

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Identifies the folder to remove	true	true (ByValue)
Name	The name pattern of folder(s) to remove	true	true (ByPropertyName)
LoggingId	Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false

Input Type¶

Citrix.Broker.Admin.Sdk.Adminfolder¶

The admin folder objects can be specified as input.

Return Values¶

None¶

This cmdlet does not return any output.

Examples¶

Example 1¶

Remove-BrokerAdminFolder F1\F2\

Description¶

Removes the folder called F2 within the folder F1\