Citrix Virtual Apps and Desktops SDK

New-BrokerAdminFolder

Creates a new admin folder.

Syntax

New-BrokerAdminFolder
   [-FolderName] <String>
   [-ParentFolder <AdminFolder>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The New-BrokerAdminFolder cmdlet creates a new folder for organising objects for administration purposes (for example, Applications).

New-BrokerAdminFolder creates the folder object and optionally places it within an existing admin folder if required.

The following special characters are not allowed in the FolderName: \ / ; : # . * ? = < > | [ ] ( ) “ ‘ `

Examples

EXAMPLE 1

Creates an admin folder called F1 under the root folder (i.e. F1\)

New-BrokerAdminFolder F1
<!--NeedCopy-->

EXAMPLE 2

Creates an admin folder called F2 under the folder F1\ (i.e. F1\F2\)

New-BrokerAdminFolder F2 -AdminFolder F1\
<!--NeedCopy-->

Parameters

-FolderName

The simple name of the new folder within its parent (if any)

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-ParentFolder

The name or UID of the parent folder (if any)

Type: AdminFolder
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Depends on parameter

Parameters can be piped by property name.

Outputs

Citrix.Broker.Admin.SDK.AdminFolder

The new admin folder.

New-BrokerAdminFolder