Citrix Daas SDK

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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The VDA Update Service maintains a list of Entities and corresponding information such as UpgradeType, Name, UUID etc.

Examples

EXAMPLE 1

Retrieves the upgrade type,Display name etc. for the Entity

Get-VusEntityUnit -EntityUUID "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
<!--NeedCopy-->

EXAMPLE 2

Retrieve the list of entities

Get-VusEntityUnit
<!--NeedCopy-->

Parameters

-Uid

A unique identifier for the data record

Type: Guid
Position: 2
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-DNSName

DNSName of entity

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-EntityName

The name of entity as set through broker

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-EntityType

The type of entity Catalog/Machine

Type: EntityType
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EntityUid

The Uid of entity as provided by broker

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EntityUUID

The UUID of entity as provided by broker

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-InstalledComponentsTypes

CSV list of installed components types

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-ParentUUID

If the entity is machine Uid of the Catalog entity

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

-RecentSchedule

The UUID of most recent schedule

Type: Guid
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

-UpgradeState

Current state of VDA in Entity UpToDate/Scheduled/UpgradeAvailable

Type: UpgradeState
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UpgradeType

The type of upgrade that happens for this Catalog i.e LTSR/CR

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

Outputs

Citrix.VdaUpdateService.Sdk.EntityUnit

Get-VusEntityUnit