Citrix Daas SDK

Get-ProvImageRuntimeEnvironment

November 14, 2023

Contributed by:

Get image runtime Environment.

Syntax

Get-ProvImageRuntimeEnvironment -ImageVersionUid <Guid> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-ProvImageRuntimeEnvironment -ProvisioningSchemeUid <Guid> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Allow you to extract information from ‘ImageRutimeInfo’ field in provisioning scheme or image version.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ImageVersionUid	The unique identifier of image version.	true	true (ByPropertyName)
ProvisioningSchemeUid	The unique identifier of provisioning scheme.	true	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of 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 user	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	The address of a Citrix Virtual Apps and Desktops 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

Return Values

Citrix.Machinecreation.SdkImageruntimeenvironment

This object provides details of the image runtime environment and contains the following infrmation: Capabilities <System.Collections.Generic.IDictionary<string, string>> The capabilities of the image such as ‘AzureAdSupported’. DeviceEnrollmentStatus <string> The device enrollment status of the image. IdentityJoinStatus <string> The identity join status of the image. OperatingSystem <Citrix.MachineCreation.Sdk.OperatingSystemInfo> The operating system information of the image. PagingFileSettings <Citrix.MachineCreation.Sdk.PagingFileSetting[]> The page file settings of the image. VDASessionSupport <string> Specifies the session support of the VDA on the image. Valid values are: ‘SingleSession’, ‘MultiSession’, ‘Unknown’.

Notes

The Get-ProvImageRuntimeEnvironment cmdlet returns an object containing the following six sub-objects: o The image capabilities o The device enrollment status o The identity join status o The operating system information of the image o The page file settings of the image o The type of VDA installed on the image

Examples

Example 1

$res = Get-ProvImageRuntimeEnvironment -ImageVersionUid a80c8338-e7af-48d6-8f08-21d2590b21b6

PS C:\Users\hanw> $res

Capabilities           : {[AzureAdSupported, True], [HybridAzureAdSupported, True], [IntuneSupported, False]}

DeviceEnrollmentStatus : Unknown

IdentityJoinStatus     : NotDomainJoined

OperatingSystem        : Citrix.MachineCreation.Sdk.OperatingSystemInfo

PagingFileSettings     : {Citrix.MachineCreation.Sdk.PagingFileSetting}

VDASessionSupport      : MultiSession

PS C:\Users\hanw> $res.OperatingSystem

FullName                          Type

--------                      ------------------

Windows Server 2019 Datacenter    Windows
<!--NeedCopy-->

Description

Get the image runtime environment associated with the given image version.

Example 2

$res = Get-ProvImageRuntimeEnvironment -ProvisioningSchemeUid c0c55fa2-3d9f-44ee-8aba-3baec6547525

PS C:\Users\hanw> $res

Capabilities           : {[AzureAdSupported, False], [HybridAzureAdSupported, False], [IntuneSupported, True]}

DeviceEnrollmentStatus : Unknown

IdentityJoinStatus     : NotDomainJoined

OperatingSystem        : Citrix.MachineCreation.Sdk.OperatingSystemInfo

PagingFileSettings     :

VDASessionSupport      : SingleSession

PS C:\Users\hanw> $res.OperatingSystem

FullName       Type

--------   ------------------

Ubuntu 22.04   Linux
<!--NeedCopy-->

Description

Get the image runtime environment associated with the given provisioning scheme.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvImageRuntimeEnvironment

November 14, 2023

Contributed by:

November 14, 2023

Contributed by:

Get-ProvImageRuntimeEnvironment

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.SdkImageruntimeenvironment

Notes

Examples

Example 1

Description

Example 2

Description

In this article