Get-Vusentityunit¶
Gets Entity related persistent data.
Syntax¶
Get-VusEntityUnit [[-Uid] <Guid>] [-DNSName <String>] [-EntityName <String>] [-EntityType <EntityType>] [-EntityUid <Int32>] [-EntityUUID <Guid>] [-InstalledComponentsTypes <String>] [-ParentUUID <Guid>] [-ProvisioningType <ProvisioningType>] [-RecentSchedule <Guid>] [-SessionSupport <SessionSupport>] [-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¶
The VDA Update Service maintains a list of Entities and corresponding information such as UpgradeType, Name, UUID etc.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Uid | A unique identifier for the data record | false | true (ByValue, ByPropertyName) | |
| DNSName | DNSName of entity | false | false | |
| EntityName | The name of entity as set through broker | false | false | |
| EntityType | The type of entity Catalog/Machine | false | false | |
| EntityUid | The Uid of entity as provided by broker | false | false | |
| EntityUUID | The UUID of entity as provided by broker | false | false | |
| InstalledComponentsTypes | CSV list of installed components types | false | false | |
| ParentUUID | If the entity is machine Uid of the Catalog entity | false | false | |
| ProvisioningType | The ProvisioningType of entity | false | false | |
| RecentSchedule | The UUID of most recent schedule | false | false | |
| SessionSupport | The SessionSupport type of entity | false | false | |
| UpgradeState | Current state of VDA in Entity UpToDate/Scheduled/UpgradeAvailable | false | false | |
| UpgradeType | The type of upgrade that happens for this Catalog i.e LTSR/CR | 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¶
Return Values¶
Citrix.Vdaupdateservice.Sdk.Entityunit¶
Examples¶
Example 1¶
C:\PS> Get-VusEntityUnit -EntityUUID "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
Description¶
Retrieves the upgrade type,Display name etc. for the Entity
Example 2¶
C:\PS> Get-VusEntityUnit
Description¶
Retrieve the list of entities