Citrix Virtual Apps and Desktops SDK

New-BrokerConfigurationSlot

August 9, 2024

Contributed by:

Creates a new configuration slot.

Syntax

New-BrokerConfigurationSlot
   [-Description <String>]
   [-Name] <String>
   -SettingsGroup <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a new configuration slot. The SettingsGroup of the slot determines the particular collection of related settings that may be specified in a machine configuration associated with this slot.

For example, the configuration slot may be restricted to configuring Citrix User Profile Manager settings by specifying the SettingsGroup parameter as “G=UPM”.

Examples

EXAMPLE 1

Create a new slot named “UPM” to configure settings specific to “User Profile Management”

New-BrokerConfigurationSlot -Name "UPM" -SettingsGroup "G=UPM"
<!--NeedCopy-->

Parameters

-Name

Name of the new configuration slot. This must be alphanumeric and not contain white space.

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

-SettingsGroup

The settings group determines the particular collection of related settings that may be controlled by this slot.

This must match the format of a Citrix Group Policy configuration group (e.g. “G=UPM”).

Only settings that have this exact group may be specified in a machine configuration associated with this configuration slot.

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

-Description

Description of configuration slot.

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

-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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.ConfigurationSlot

New-BrokerConfigurationSlot returns an object representing the newly created configuration slot

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerConfigurationSlot

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

New-BrokerConfigurationSlot

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Name

-SettingsGroup

-Description

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.ConfigurationSlot

Related Links

In this article