Citrix Virtual Apps and Desktops SDK

Remove-BrokerCatalog

Removes catalogs from the site.

Syntax

Remove-BrokerCatalog
      [-InputObject] <Catalog[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerCatalog
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Remove catalogs from the site.

In order to remove a catalog from a site, the catalog must not contain machines. To remove a machine from a catalog use the Remove-BrokerMachine cmdlet. Note: in order to remove a machine from a catalog, it must not belong to a desktop group.

Examples

EXAMPLE 1

These commands delete the catalog with the name “MyCatalog”.

Remove-BrokerCatalog -Name "MyCatalog"
Remove-BrokerCatalog -InputObject (Get-BrokerCatalog -Name "MyCatalog")
<!--NeedCopy-->

EXAMPLE 2

This command deletes all catalogs with names beginning with “test”.

Remove-BrokerCatalog -Name 'test*'
<!--NeedCopy-->

EXAMPLE 3

Remove all the Remote PC catalogs that are associated with desktop group 42. Note that this only breaks the Remote PC relationships and does not delete the desktop groups.

Get-BrokerCatalog -RemotePCDesktopGroupUid 42 | Remove-BrokerCatalog -RemotePCDesktopGroup 42
<!--NeedCopy-->

Parameters

-InputObject

Specifies the catalog objects to delete.

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

-Name

Specifies the name of the catalog to delete.

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

Citrix.Broker.Admin.SDK.Catalog

You can pipe the catalogs to be deleted to Remove-BrokerCatalog.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerCatalog