Citrix Daas SDK

Get-VusCatalog

Retrieves VUS related information for catalog

Syntax

Get-VusCatalog
   [-Name <String>]
   [-ProvisioningType <ProvisioningType>]
   [-SessionSupport <SessionSupport>]
   [-StateId <ScheduleState>]
   [-Uid <Int32>]
   [-UpgradeState <UpgradeState>]
   [-UpgradeType <UpgradeType>]
   [-UpgradeVersion <String>]
   [-Uuid <Guid>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves catalog matching specified criteria. If no parameters are specified, this cmdlet returns all catalogs.

The Get-VusCatalog cmdlet returns the VUS-related machine information such as UUID, Name, UpgradeType, UpgradeState and information about recent upgrade of a specific catalog or all catalogs.

Examples

EXAMPLE 1

Retrieve the Catalog info of the catalog corresponding to the UUID.

Get-VusCatalog -Uuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
<!--NeedCopy-->

EXAMPLE 2

Retrieve the catalog info of all catalogs.

Get-VusCatalog
<!--NeedCopy-->

EXAMPLE 3

Retrieve the catalog info of all catalogs which are in UpgradeAvailable state.

Get-VusCatalog -UpgradeState UpgradeAvailable
<!--NeedCopy-->

EXAMPLE 4

Retrieve the catalog info of all catalogs which satisfy the filters

Get-VusCatalog -Filter { ProvisioningType -eq 'Manual' -and UpgradeState -eq "UpToDate" } -MaxRecordCount 1000
<!--NeedCopy-->

Parameters

-Name

Name of the Catalog or list of catalog names provided by broker service

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

-ProvisioningType

The ProvisioningType of entity

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

-SessionSupport

The SessionSupport type of entity

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

-StateId

Filter Catalogs by its ScheduleState

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

-Uid

UID of the Catalog or list of UIDs for catalog provided by broker service

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

-UpgradeState

Filter Catalogs by its UpgradeState

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

-UpgradeType

Filter Catalogs by its UpgradeType i.e CR/LTSR

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

-UpgradeVersion

The Version the catalog is/was being upgraded to

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

-Uuid

UUID of the Catalog or list of UUIDs for catalogs provided by broker service

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

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Vus_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Vus_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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

Guid

Citrix.VdaUpdateService.Sdk.UpgradeState

Citrix.VdaUpdateService.Sdk.UpgradeType

Citrix.VdaUpdateService.Sdk.ScheduleState

Citrix.VdaUpdateService.Sdk.SessionSupport

Citrix.VdaUpdateService.Sdk.ProvisioningType

Outputs

Citrix.VdaUpdateService.Sdk.Catalog

Get-VusCatalog