Get-VusMachine
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Retrieves VUS related information for machine
Syntax
Get-VusMachine
[-CatalogName <String>]
[-DNSName <String>]
[-EntitySID <String>]
[-LastUpgradeCheck <DateTime>]
[-MachineName <String>]
[-MachineScheduleID <Guid>]
[-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>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
Retrieve the machine info of the machine corresponding to the UUID.
Get-VusMachine -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
EXAMPLE 2
Retrieve the machine info of all machines.
Get-VusMachine
EXAMPLE 3
Retrieve the machine info for machines in WS2019Catalog that could be upgraded.
Get-VusMachine -CatalogName "WS2019Catalog" -UpgradeState UpgradeAvailable
EXAMPLE 4
Retrieve the machine info of all machines which are in UpgradeAvailable state.
Get-VusMachine -UpgradeState UpgradeAvailable
EXAMPLE 5
Retrieve the machine info of all machines which satisfy the filters
Get-VusMachine -Filter { CatalogName -eq 'STCatalog10222021' -and MachineName -notcontains '*S*' -and UpgradeState -eq "UpToDate" } -MaxRecordCount 1000
Parameters
-CatalogName
Name of the catalog provided by broker service to filter machines
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DNSName
DNSName of entity
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-EntitySID
The SID of entity as provided by broker
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-LastUpgradeCheck
The Last Upgrade Check of entity
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineName
Name of the machine or list of machine names provided by broker service
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MachineScheduleID
The Last schedule of entity
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineUid
UID of the machine or list of UIDs for machines provided by broker service
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineUuid
UUID of the machine or list of UUIDs for machines provided by broker service
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 machines by its MachineScheduleState
| Type: | MachineScheduleState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpgradeState
Filter machines by its UpgradeState
| Type: | UpgradeState |
| Accepted values: | MissingUpgradeType, UpgradeScheduled, UpgradeAvailable, UpToDate, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpgradeType
Filter machines by its UpgradeType i.e CR/LTSR/EAR_CR/EAR_LTSR
| Type: | UpgradeType |
| Accepted values: | NotSet, LTSR, CR, EAR_LTSR, EAR_CR |
| 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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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.