Citrix Virtual Apps and Desktops

Manage a Nutanix catalog

Manage machine catalogs describes the wizards that manage a machine catalog. The following information covers details specific to Nutanix AHV Prism Central environments.

Note:

Before managing a machine catalog on Nutanix AHV Prism Central, you need to finish creating a machine catalog on Nutanix AHV Prism Central. See Create a Nutanix catalog.

You can manage a machine catalog on Nutanix AHV Prism Central using:

Use Web Studio

Following are the options to manage a machine catalog on Nutanix AHV Prism Central using Web Studio:

Option Description
Add Machines Create and add VMs to the machine catalog.
Delete Machine Catalog Delete a machine catalog. You can choose to delete VMs at the same time or leave persistent VMs intact.
Change Master Image Change the master image used as a template for all VMs in the catalog.
Add or change Machine Profile Change the template version of the machine profile or add a machine profile to an existing catalog.
Manage Configuration Set Bind a catalog to a Workspace Environment Management™ configuration set or switch to a different configuration.
Edit Machine Catalog Modify configurations for the catalog, such as NICs and Virtual Machines.
View Machines Jump to the Search node to see all VMs that belong to the catalog.
Rename Machine Catalog Change the catalog name.
Upgrade VDAs Upgrade VDAs on a per-catalog basis. This feature only applies to static persistent machines.
Change Functional Level Select the minimum functional level for the catalog. Setting a functional level makes all features available.
Test Machine Catalog Test whether the catalog has errors or warnings.
Manage Tags Create, edit, and delete tags. Select tags to apply to the catalog.
Move Machine Catalog Move the catalog to another folder.

Note:

Currently, the Clone option is not available.

Change master image

To change the master image for a catalog, follow these steps:

  1. On the Machine Catalogs page, right-click the machine catalog you want to update, and select Change Master Image.
  2. On the Change Master Image page, click Select an image.

    ahv-prism-central-host-connection

  3. On the Select an image page, expand a template and select a template version to use as the master image. You can filter machine templates by name.
  4. On the Rollout Strategy page, choose when you want the update to be applied.

Note:

For an MCS provisioned non-persistent catalog with the Nutanix AHV Prism Central host connection plug-in, updating the master image to switch the boot configuration between Legacy and UEFI, prevents existing VMs from starting at their next boot.

Add or change the machine profile

To add or change a machine profile for a catalog, follow these steps:

  1. On the Machine Catalogs page, right-click the machine catalog you want to modify, and select Edit Machine Catalog.
  2. On the Machine Profile page,

    • If the machine catalog already has a machine profile, then click the pencil icon to select a different machine profile template version. You can filter by the template name. Confirm the machine profile settings.
    • If the machine catalog doesn’t have a machine profile, then select Use a machine profile and select a machine profile. Confirm the machine profile settings.
  3. The Virtual Machines page must reflect the updated configuration as per the selected machine profile template version.

Change NICs

To change NICs for a catalog, follow these steps:

  1. On the Machine Catalogs page, right-click the machine catalog you want to modify, and select Edit Machine Catalog.
  2. On the NICs page:

    1. Select an NIC type
    2. Select or clear the boxes to select NICs, and choose an associated virtual network for each NIC.

    ahv-prism-central-host-connection

Change VMs configuration

To change the configuration of VMs, including Memory, CPU count, and Cores per vCPU, follow these steps:

  1. On the Machine Catalogs page, right-click the machine catalog you want to modify, and select Edit Machine Catalog.
  2. On the Virtual Machines page, use the up or down arrow, or enter values directly to adjust the Memory, CPU count, and Cores per vCPU for the VMs.

    ahv-prism-central-host-connection

Use PowerShell

Change master image

The required parameters are:

  • ProvisioningSchemeName: Name of the provisioning scheme to edit.
  • MasterImage: Literal path to the new master image.

Run the following command. For example:

Set-ProvSchemeMetadata  -Name "ImageManagementPrep_DoImagePreparation" -ProvisioningSchemeName "<ProvisioningSchemeName>" -Value "True"

Publish-ProvMasterVMImage  -MasterImageVM "<Literal path to the new master image- template version> -ProvisioningSchemeName "<ProvisioningSchemeName>" -RunAsynchronously
<!--NeedCopy-->

Add or change machine profile

You can change the machine profile of a catalog or convert a non-machine profile based catalog to a machine profile based catalog using the Set-ProvScheme command.

Note:

This change doesn’t affect the new VMs added to the machine catalog.

The required parameters are:

  • ProvisioningSchemeName: Name of the provisioning scheme to edit.
  • MachineProfile: Literal path to the new machine profile.

Run the following command. For example:

Set-ProvScheme -ProvisioningSchemeName "<ProvisioningSchemeName>" -Value -MachineProfile "<Literal path to the new machine profile- template version>
<!--NeedCopy-->

Change NIC and VM’s configuration

The required parameters are:

  • ProvisioningSchemeName: Name of the provisioning scheme to edit.
  • NetworkMapping: Updated network mapping.

Run the following command. For example:

Set-ProvScheme  -CustomProperties "<CustomProperties xmlns=`"http://schemas.citrix.com/2014/xd/machinecreation`" xmlns:xsi=`"http://www.w3.org/2001/XMLSchema-instance`"><Property xsi:type=`"StringProperty`" Name=`"ClusterId`" Value=`"000xxxx-1fb0-xxxxx-4fc8-5c257335xxxx`" /><Property xsi:type=`"StringProperty`" Name=`"CPUCores`" Value=`"1`" /></CustomProperties>"  -NetworkMapping @{"6"="XDHyp:\HostingUnits\<Hosting Unit Name>\Clusters.folder\<Cluster Name>\<Network name>.network"} -ProvisioningSchemeName "<ProvisioningSchemeName>" -VMCpuCount 4
<!--NeedCopy-->

Update hardware configuration

You can update and schedule hardware configurations for an individual MCS provisioned VM or all existing VMs in an MCS provisioned machine catalog under Nutanix AHV Prism Central host connection.

This provides enhanced flexibility, allowing you to fine-tune resource allocation and OS disk management by modifying:

  • Memory, CPU, CPU per Core, Network Mapping, vGCP profile, and machine profile

The feature is applicable to machine catalogs with and without a machine profile.

This feature supports configuration changes under the following conditions:

  • For persistent VMs: You can apply configuration changes and hardware updates at both machine catalog level and the individual VM level. Per-VM configurations have higher priority and always overrides ProvScheme configurations.

  • For non-persistent VMs: You can apply configuration changes and hardware updates only at the machine catalog level.

There are two ways of updating hardware configurations:

  • Using Provisioning Scheme versions (link will be added)
  • Using Provisioned VM configurations (link will be added)

Use provisioning scheme versions

Use this to configure new hardware configurations for multiple provisioned VMs in a machine catalog. This is supported for persistent and non-persistent machine catalogs.

Key steps:

  1. Run New-ProvSchemeVersion powershell command to create a ProvSchemeVersion.
  2. Run New-ProvSchemeHardwareUpdate with the newly created ProvSchemeVersion to apply this ProvSchemeVersion to the provisioned VMs.

Parameters that are supported for New-ProvSchemeVersion in Nutanix AHV Prism Central:

Parameter Name Support
CpuCount Yes
MemoryInMB Yes
CustomProperties Yes
ServiceOffering No
MachineProfile Yes
NetworkMapping Yes
SecurityGroup No
WriteBackCacheDiskSize No
WriteBackCacheMemorySize No
ProvisioningSchemeUid Yes
ConfigurationInfo Yes
LoggingId Yes

Example for updating the network mapping in a provision scheme

$HostingUnitsName = "nuthu"
$ProvScheme = Get-ProvScheme -ProvisioningSchemeName "myprovscheme"

$VMNetwork1="XDHyp:\HostingUnits\${HostingUnitName}\Clusters.folder\my-cluster01.cluster\mynetwork1.network"
 
$NetworkMapping=@{"0"=$VMNetwork1}
 
New-ProvSchemeVersion -ProvisioningSchemeUid $ProvScheme.ProvisioningSchemeUid -NetworkMapping $NetworkMapping
 
New-ProvSchemeHardwareUpdate `
   -AllVMs `
   -ProvisioningSchemeUid $ProvScheme.ProvisioningSchemeUid `
   -StartsNow `
   -ProvisioningSchemeVersion $ProvSchemeVersion.ProvisioningSchemeVersionCreated
<!--NeedCopy-->

Use provisioned VM configurations

Use this to configure new hardware configurations for individual provisioned VM. This is supported only for persistent machine catalog.

Key steps:

  1. Run New-ProvVMConfiguration PowerShell command to create a ProvVMConfiguration.
  2. Run the powershell command New-ProvVMHardwareUpdate with the newly created ProvVMConfiguration to apply this ProvVMConfiguration to the provisioned VM.

Parameters that are supported for New-ProvSchemeVersion in Nutanix AHV Prism Central:

Parameter Name Support
ADAccountSid Yes
CpuCount Yes
MemoryInMB Yes
CustomProperties Yes
ServiceOffering No
MachineProfile Yes
NetworkMapping Yes
SecurityGroup No
WriteBackCacheDiskSize No
WriteBackCacheMemorySize No
ProvisioningSchemeUid Yes
ConfigurationInfo Yes
RemoveCustomizations Yes
LoggingId Yes

Example for updating the number of Cpu core per socket

$ProvVM = Get-ProvVM -VMName "myvmname"
$ProvScheme = Get-ProvScheme -ProvisioningSchemeName "myprovscheme"
$CustomProperties='<CustomProperties xmlns="http://schemas.citrix.com/2014/xd/machinecreation">`
<StringProperty Name="CPUCores" Value="2"/>`
</CustomProperties>'
   
$ProvVMConfiguration=New-ProvVMConfiguration `
   -CustomProperties $CustomProperties `
   -ADAccountSid $ProvVM.ADAccountSid `
   -ProvisioningSchemeUid $ProvScheme.ProvisioningSchemeUid   
    
New-ProvVMHardwareUpdate `
   -ProvisioningSchemeUid $ProvScheme.ProvisioningSchemeUid `
   -StartsNow `
   -ADAccountSid $ProvVM.ADAccountSid `
   -ProvisionedVmConfiguration $ProvVMConfiguration.ProvisionedVmConfigurationCreated
<!--NeedCopy-->

More information

Manage a Nutanix catalog