Citrix Daas SDK

Get-ProvVMConfiguration

Gets the custom configuration properties for virtual machines created using Machine Creation Services.

Syntax

Get-ProvVMConfiguration [[-ProvisioningSchemeName] <String>] [-ProvisioningSchemeUid <Guid>] [-VMName <String>] [-VMId <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Provides the ability to list current configuration properties for virtual machines created using Machine Creation Services.

The returned list of properties details what has been applied to VMs specifically with Set-ProvVM. It does not consistute the full set of properties VMs will have when the configuration is applied, to view that information use Get-ProvVMConfigurationResultantSet

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme. false false  
ProvisioningSchemeUid The unique identifier of the provisioning scheme. false false  
VMName The name of the VM in the hypervisor. false false  
VMId The ID of the VM in the hypervisor. false false  
ReturnTotalRecordCount See about_Prov_Filtering for details. false false false
MaxRecordCount See about_Prov_Filtering for details. false false false
Skip See about_Prov_Filtering for details. false false 0
SortBy See about_Prov_Filtering for details. false false  
Filter See about_Prov_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  
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 that the PowerShell snap-in connects 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.SdkProvisionedmachineconfiguration

The object has the following properties: Version <int> The current version of the configuration CpuCount <int> The number of processors allocated to the VM. MemoryInMB <int> The maximum amount of memory allocated to the VM. CustomProperties <string> Properties of the provisioning scheme which that are specific to the target hosting infrastructure. (See about_ProvCustomProperties) ServiceOffering <string> The service offering that the scheme uses when creating VMs in cloud hypervisors. MachineProfile <string> The inventory path to the source VM used by the provisioning scheme as a template. VMMetadata <char[]> The metadata that will be used to created VMs in a plain text format. ProvisioningSchemeName <string> The name of the provisioning scheme associated with the VM. ProvisioningSchemeUid <Guid> The unique identifier of the provisioning scheme associated with the VM. VMId <string> The identifier for the VM in the hypervisor. VMName <string> The name of the VM in the hypervisor.

Examples

Example 1

C:\PS> Get-ProvScheme -ProvisioningSchemeName test-catalog | select ProvisioningSchemeName, ServiceOffering, CustomProperties

ProvisioningSchemeName : test-catalog

ServiceOffering        : serviceoffering.folder\Standard_D2_v3.serviceoffering

CustomProperties       : <CustomProperties xmlns="http://schemas.citrix.com/2014/xd/machinecreation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                         <Property xsi:type="StringProperty" Name="SchemaVersion" Value="2" />

                         <Property xsi:type="StringProperty" Name="UseManagedDisks" Value="true" />

                         <Property xsi:type="StringProperty" Name="OsType" Value="Windows" />

                         </CustomProperties>

...

C:\PS>Get-ProvVMConfiguration -ProvisioningSchemeName test-catalog

CpuCount               :

CustomProperties       : <CustomProperties xmlns="http://schemas.citrix.com/2014/xd/machinecreation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                         <Property xsi:type="StringProperty" Name="SchemaVersion" Value="2" />

                         <Property xsi:type="StringProperty" Name="LicenseType" Value="Windows_Client" />

                         </CustomProperties>

MachineProfile         :

MemoryInMB             :

ProvisioningSchemeName : test-catalog

ProvisioningSchemeUid  : 378cece5-a824-41f7-9e92-74be76672be6

ServiceOffering        :

VMId                   : 0707da6d-2f0f-a8c7-ce92-3d64f824ac60

VMMetadata             :

VMName                 : machine1

Version                : 2

CpuCount               :

CustomProperties       :

MachineProfile         :

MemoryInMB             :

ProvisioningSchemeName : test-catalog

ProvisioningSchemeUid  : 378cece5-a824-41f7-9e92-74be76672be6

ServiceOffering        : serviceoffering.folder\Standard_D2s_v5.serviceoffering

VMId                   : d04f4677-f4e7-4c92-ae44-178c22545395

VMMetadata             :

VMName                 : machine2

Version                : 1
<!--NeedCopy-->

Description

Configuration is listed on the ProvScheme. Get-ProvVMConfiguration is used to obtain configuration data for all machines in test-catalog. Compare with Example 1 under Get-ProvVMConfigurationResultantSet

Get-ProvVMConfiguration