Get-Vusmachineinfo¶
Returns machine-specific details such as UpgradeType and UpgradeState
Syntax¶
Get-VusMachineInfo -MachineUuid <String[]> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo -MachineName <String[]> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo -MachineUid <Int32[]> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo -CatalogUuid <String> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo -CatalogName <String> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo -CatalogUid <Int32> [-UpgradeState <UpgradeState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusMachineInfo [-UpgradeState <UpgradeState>] [-All] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Retrieves machines matching specified criteria. If no parameters are specified, this cmdlet returns all machines.
The Get-VusMachineInfo cmdlet returns the machine-related persistent information such as UUID, Name, UpgradeType, and UpgradeState of a specific machine or all machines.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| MachineUuid | UUID of the machine or list of UUIDs for machines provided by broker service | true | false | |
| MachineName | Name of the machine or list of machine names provided by broker service | true | false | |
| MachineUid | UID of the machine or list of UIDs for machines provided by broker service | true | false | |
| CatalogUuid | UUID of the catalog provided by broker service to filter machines | true | false | |
| CatalogName | Name of the catalog provided by broker service to filter machines | true | false | |
| CatalogUid | UID of the catalog provided by broker service to filter machines | true | false | |
| UpgradeState | Filter machines by its UpgradeState | false | false | |
| All | Retrieves all machine 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¶
Citrix.Vdaupdateservice.Sdk.Upgradestate¶
Return Values¶
Citrix.Vdaupdateservice.Sdk.Machineobject¶
Examples¶
Example 1¶
C:\PS> Get-VusMachineInfo -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
Description¶
Retrieve the machine info of the machine corresponding to the UUID.
Example 2¶
C:\PS> Get-VusMachineInfo
Description¶
Retrieve the machine info of all machines.
Example 3¶
C:\PS> Get-VusMachineInfo -CatalogName "WS2019Catalog" -UpgradeState UpgradeAvailable
Description¶
Retrieve the machine info for machines in WS2019Catalog that could be upgraded.
Example 4¶
C:\PS> Get-VusMachineInfo -UpgradeState UpgradeAvailable
Description¶
Retrieve the machine info of all machines which are in UpgradeAvailable state.