Get-Vuscatalogupgradestatus¶
Gets upgrade information for most recent upgrade for a catalog
Syntax¶
Get-VusCatalogUpgradeStatus -CatalogUid <Int32> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusCatalogUpgradeStatus -CatalogUuid <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusCatalogUpgradeStatus -CatalogName <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusCatalogUpgradeStatus [-All] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Retrieves catalogs matching specified criteria. If no parameters are specified, this cmdlet returns all machines.
The Get-VusCatalogUpgradeStatus cmdlet returns the catalog related to the most recent upgrade information.
For any catalog that has even 1 scheduled upgrade, the cmdlet returns the data related to the most recently scheduled upgrade.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| CatalogUid | UID of the catalog provided by broker service | true | false | |
| CatalogUuid | UUID of the catalog provided by broker service | true | false | |
| CatalogName | Name of the catalog provided by broker service | true | false | |
| All | Retrieves all catalog records | false | false | |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type¶
System.Guid¶
Return Values¶
Citrix.Vdaupdateservice.Sdk.Catalogscheduleinfo¶
Upgrade information for the most recent catalog schedule
Examples¶
Example 1¶
C:\PS> Get-VusCatalogUpgradeStatus
Description¶
Returns the most recent upgrade status for each catalog
Example 2¶
C:\PS> Get-VusCatalogUpgradeStatus -CatalogUid 1
Description¶
Return the most recent upgrade status for the catalog with UID 1.