Citrix Virtual Apps and Desktops

Manage an AWS catalog

August 22, 2024

Contributed by:

C 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:

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

Unlock the VM before removing the VMs. For example:

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

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
 
```
- Run Remove-ProvScheme to remove machine catalog from Citrix database and resources from a machine catalog. For example:
```
 Run Remove-ProvScheme -ProvisioningSchemeName "<name>" -ForgetVM
 
```
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
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

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

Manage an AWS catalog

August 22, 2024

Contributed by:

C C

August 22, 2024

Contributed by:

C C

Manage an AWS catalog

Remove tags

Identify resources created by MCS

More information

In this article