Citrix Virtual Apps and Desktops SDK

Remove-BrokerConfigurationSlot

Removes a configuration slot.

Syntax

Remove-BrokerConfigurationSlot
      [-InputObject] <ConfigurationSlot[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerConfigurationSlot
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Removes a configuration slot from the site.

All machine configurations associated with this slot are also removed.

Examples

EXAMPLE 1

Remove the configuration slot named “User Profile Manager”.

Remove-BrokerConfigurationSlot -Name "User Profile Manager"
<!--NeedCopy-->

Parameters

-InputObject

Configuration slot to remove.

Type: ConfigurationSlot[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Name of configuration slot to remove.

Type: String
Position: 2
Default value: None
Required: True
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

Configuration slot to remove

Configuration slots may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerConfigurationSlot