Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Manage an AWS catalog

December 18, 2023
Contributed by: 
C

Manage machine catalogs describes the wizards that manage a machine catalog. The following information covers details specific to AWS cloud environments.

Note:

Before managing an AWS catalog, you need to finish creating an AWS catalog. See Create an AWS catalog.

Remove tags

When you create a catalog or a VM, MCS- created tags are created on the following resources:

  • Virtual machine
  • Root disk volume
  • Identity disk volume
  • NIC
  • Root disk image (AMI)
  • Launch template
  • Snapshot of AMI or root disk

You can remove VMs and machine catalogs from Citrix database and remove MCS- created tags. You can use:

  • Remove-ProvVM with ForgetVM parameter to remove VMs and MCS- created tags from a single VM or a list of VMs from a machine catalog.
  • Remove-ProvScheme with ForgetVM parameter to remove a machine catalog from the Citrix database and resources from a machine catalog.

This feature is only applicable to persistent VMs.

To do this:

  1. Open a PowerShell window.
  2. Run asnp citrix* to load the Citrix-specific PowerShell modules.

  3. Unlock the VM before removing the VMs. For example:

    Unlock-ProvVM -ProvisioningSchemeName "<name>" -VMID "<id"
<!--NeedCopy-->

  4. Run one of the following commands to remove VMs, machine catalog, and MCS- created tags from resources.

    • Run Remove-ProvVM with ForgetVM to remove VMs from Citrix database and tags from VMs. For example:

       Remove-ProvVM -ProvisioningSchemeName "<name>" -VMName "<name>" -ForgetVM
 <!--NeedCopy-->

    • Run Remove-ProvScheme to remove machine catalog from Citrix database and resources from a machine catalog. For example:

       Run Remove-ProvScheme -ProvisioningSchemeName "<name>" -ForgetVM
 <!--NeedCopy-->

  5. Verify that the VM is removed from the Delivery Controller, however, not from the hypervisor.

    1. Run Get-ProvVM -ProvisioningSchemeName "<name>" -VMName "<name>". This must return nothing.

    2. Go to AWS EC2 console. You must see the VMs, however, the tags are now removed. Tags from the following resources are removed:

      • Virtual machine
      • Root disk volume
      • Identity disk volume
      • NIC

  6. If you remove the machine catalog, verify that the catalog is removed from the Delivery Controller.

    1. Run Get-ProvScheme -ProvisioningSchemeName "forgetvmdemo". This must return an error.

    2. Verify in AWS EC2 console that the following resources are removed.

      • Root disk image (AMI)
      • Launch template
      • Snapshot of AMI or root disk

Identify resources created by MCS

Following are the tags that MCS adds to the resources. The tags in the table are represented as “key”:”value”.

Resource name Tag
ID disk “Name”: “VMName_IdentityDisk”
  “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
Image “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
NIC “Description”: “XD NIC”
  “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
OS disk “Name”: “VMName_rootDisk”
  “XdConfig”: “XdProvisioned=True”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
  [when AwsCaptureInstanceProperties = true] “Citrix Resource”: “”
  [when AwsCaptureInstanceProperties = true and AwsOperationalResourcesTagging = true] “CitrixOperationalResource”: “”
PrepVM “Name”: “Preparation - CatalogName - xxxxxxxxxx”
  “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
  [when AwsCaptureInstanceProperties = true] “Citrix Resource”: “”
  [when AwsCaptureInstanceProperties = true and AwsOperationalResourcesTagging = true] “CitrixOperationalResource”: “”
Published snapshot “XdConfig”: “XdProvisioned=true”
  If not a snapshot for Volume Worker AMI, then “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
Template [when AwsCaptureInstanceProperties = true] “XdConfig”: “XdProvisioned=true”
  [when AwsCaptureInstanceProperties = true] “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
  [when AwsCaptureInstanceProperties = true] “CitrixResource”: “”
  [when AwsCaptureInstanceProperties = true and AwsOperationalResourcesTagging = true] “CitrixOperationalResource”: “”
VM in catalog “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
  [when AwsCaptureInstanceProperties = true] “CitrixResource”: “”
  [when AwsCaptureInstanceProperties = true] “aws:ec2launchtemplate:id”:”lt-xxxx”
  [when AwsCaptureInstanceProperties = true] “aws:ec2launchtemplate:version”: “n”
  [when AwsCaptureInstanceProperties = true and AwsOperationalResourcesTagging = true] “CitrixOperationalResource”: “”
Volume worker AMI “XdConfig”: “XdProvisioned=true”
Volume worker bootstraper “Name”: “XenDesktop Temp”
  “XdConfig”: “XdProvisioned=true”
  “CitrixProvisioningSchemeId”: “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx”
  [when AwsCaptureInstanceProperties = true and AwsOperationalResourcesTagging = true] “CitrixVolumeWorkerBootstrapper”: “”
Volume worker instance “Name”: “Citrix.XD.Volumeworker-xxxx-xx-xx-xx-xxxx”
  “XdConfig”: “XdProvisioned=true”

More information

Manage an AWS catalog
December 18, 2023
Contributed by: 
C
December 18, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.