Get-Vusmachine¶
Retrieves VUS related information for machine
Syntax¶
Get-VusMachine [-CatalogName <String>] [-DNSName <String>] [-MachineName <String>] [-MachineUid <Int32>] [-MachineUuid <Guid>] [-ProvisioningType <ProvisioningType>] [-SessionSupport <SessionSupport>] [-StateId <MachineScheduleState>] [-UpgradeState <UpgradeState>] [-UpgradeType <UpgradeType>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-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-VusMachine cmdlet returns the VUS-related machine information such as UUID, Name, UpgradeType, UpgradeState and information about recent upgrade of a specific machine or all machines.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| CatalogName | Name of the catalog provided by broker service to filter machines | false | false | |
| DNSName | DNSName of entity | false | false | |
| MachineName | Name of the machine or list of machine names provided by broker service | false | false | |
| MachineUid | UID of the machine or list of UIDs for machines provided by broker service | false | false | |
| MachineUuid | UUID of the machine or list of UUIDs for machines provided by broker service | false | false | |
| ProvisioningType | The ProvisioningType of entity | false | false | |
| SessionSupport | The SessionSupport type of entity | false | false | |
| StateId | Filter machines by its MachineScheduleState | false | false | |
| UpgradeState | Filter machines by its UpgradeState | false | false | |
| UpgradeType | Filter machines by its UpgradeType i.e CR/LTSR | false | 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. | false | 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. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| 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. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell-style filter expression. See about_Vus_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | 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¶
Citrix.Vdaupdateservice.Sdk.Upgradetype¶
Citrix.Vdaupdateservice.Sdk.Machineschedulestate¶
Citrix.Vdaupdateservice.Sdk.Sessionsupport¶
Citrix.Vdaupdateservice.Sdk.Provisioningtype¶
Return Values¶
Citrix.Vdaupdateservice.Sdk.Machine¶
Examples¶
Example 1¶
C:\PS> Get-VusMachine -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
Description¶
Retrieve the machine info of the machine corresponding to the UUID.
Example 2¶
C:\PS> Get-VusMachine
Description¶
Retrieve the machine info of all machines.
Example 3¶
C:\PS> Get-VusMachine -CatalogName "WS2019Catalog" -UpgradeState UpgradeAvailable
Description¶
Retrieve the machine info for machines in WS2019Catalog that could be upgraded.
Example 4¶
C:\PS> Get-VusMachine -UpgradeState UpgradeAvailable
Description¶
Retrieve the machine info of all machines which are in UpgradeAvailable state.
Example 5¶
C:\PS> Get-VusMachine -Filter { CatalogName -eq 'STCatalog10222021' -and MachineName -notcontains '\*S\*' -and UpgradeState -eq "UpToDate" } -MaxRecordCount 1000
Description¶
Retrieve the machine info of all machines which satisfy the filters