-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Get-VusMachine
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-VusMachine
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>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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"
<!--NeedCopy-->
EXAMPLE 2
Retrieve the machine info of all machines.
Get-VusMachine
<!--NeedCopy-->
EXAMPLE 3
Retrieve the machine info for machines in WS2019Catalog that could be upgraded.
Get-VusMachine -CatalogName "WS2019Catalog" -UpgradeState UpgradeAvailable
<!--NeedCopy-->
EXAMPLE 4
Retrieve the machine info of all machines which are in UpgradeAvailable state.
Get-VusMachine -UpgradeState UpgradeAvailable
<!--NeedCopy-->
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
<!--NeedCopy-->
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 |
| 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 |
| 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.MachineScheduleState
Citrix.VdaUpdateService.Sdk.SessionSupport
Citrix.VdaUpdateService.Sdk.ProvisioningType
Outputs
Citrix.VdaUpdateService.Sdk.Machine
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.