Citrix Virtual Apps and Desktops 2411 SDK

Get-ProvVMConfigurationResultantSet

Introduced in: Citrix Virtual Apps and Desktop 7 2308

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

Syntax

Get-ProvVMConfigurationResultantSet [-ProvisioningSchemeUid <Guid>] [[-ProvisioningSchemeName] <String>] [-VMName <String>] [-VMId <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [<CitrixCommonParameters>] [<CommonParameters>]

Description

Provides the ability to list the resultant configuration properties for virtual machines created using Machine Creation Services. This merges properties at the provisioning scheme level with those set on a machine with Set-ProvVM specifically.

To configure a machine with custom configuration data, see Set-ProvVM To list just the properties specific to a machine, use Get-ProvVMConfiguration

Examples

EXAMPLE 1

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

Get-ProvScheme -ProvisioningSchemeName example-catalog | select ProvisioningSchemeName, ServiceOffering, CustomProperties ProvisioningSchemeName : example-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> ... Get-ProvVMConfigurationResultantSet -ProvisioningSchemeName example-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="UseManagedDisks" Value="true" /> <Property xsi:type="StringProperty" Name="OsType" Value="Windows" /> <Property xsi:type="StringProperty" Name="LicenseType" Value="Windows_Client" /> </CustomProperties> MachineProfile : MemoryInMB : ProvisioningSchemeName : example-catalog ProvisioningSchemeUid : 378cece5-a824-41f7-9e92-74be76672be6 ServiceOffering : serviceoffering.folder\Standard_D2_v3.serviceoffering VMId : 0707da6d-2f0f-a8c7-ce92-3d64f824ac60 VMMetadata : VMName : machine1 Version : 2 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="UseManagedDisks" Value="true" /> <Property xsi:type="StringProperty" Name="OsType" Value="Windows" /> </CustomProperties> MachineProfile : MemoryInMB : ProvisioningSchemeName : example-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

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.

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

-VMName

The name of the VM in the hypervisor.

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

-VMId

The ID of the VM in the hypervisor.

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

-ReturnTotalRecordCount

See about_Prov_Filtering for details.

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

-MaxRecordCount

See about_Prov_Filtering for details.

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

-Skip

See about_Prov_Filtering for details.

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

-SortBy

See about_Prov_Filtering for details.

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

-Filter

See about_Prov_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

-ProvisioningSchemeName

The name of the provisioning scheme.

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

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

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.MachineCreation.Sdk.ProvisionedMachineConfigurationResultantSet

The object has the following properties:

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_Prov_CustomProperties)

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.

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.

Get-ProvVMConfigurationResultantSet