Product Documentation

XenDesktop properties for Microsoft System Center Configuration Manager

Mar 29, 2013

XenDesktop makes properties available to Microsoft System Center 2012 Configuration Manager (Configuration Manager) so that you can manage virtual desktops using this tool. The properties are available for the Citrix_virtualDesktopInfo class in the Root\Citrix\DesktopInformation namespace.

The following properties are available. Property names come from the Windows Management Instrumentation (WMI) provider:

  • AssignmentType – Sets the value of IsAssigned. The valid AssignmentType values are:
    • ClientIP
    • ClientName
    • None
    • User – This value sets IsAssigned to True
  • BrokerSiteName – Site; returns the same value as HostIdentifier

  • DesktopCatalogName – Machine Catalog associated with the desktop

  • DesktopGroupName – Delivery group associated with the desktop

  • HostIdentifier – Site; returns the same value as BrokerSiteName

  • IsAssigned – True to assign the desktop to a user, set to False for a random desktop

  • IsMasterImage – Allows decisions about the environment. For example, you may want to install applications on the Master Image and not on the provisioned machines, especially if those machines are in a clean state on boot machines. The values are:
    • True on a Virtual Machine (VM) that is used as a Master Image (This value is set during installation based on a selection during in the installation process).
    • Cleared on a VM that is provisioned from that image.
  • IsVirtualMachine – True for a virtual machine, false for a physical machine.

  • OSChangesPersist – False if the desktop operating system image is reset to a clean state every time it is restarted, otherwise true.

  • PersistentDataLocation – The location where Configuration Manager stores persistent data. This is not accessible to users.

  • PersonalvDiskDriveLetter – For a desktop with a Personal vDisk, the drive letter you assign to the Personal vDisk.

The properties BrokerSiteName, DesktopCatalogName, DesktopGroupName, and HostIdentifier are determined when the desktop registers with the controller they are null for a desktop that has not fully registered.

You can display the properties by using the hardware inventory in Configuration Manager, or by using attributes of Configuration Manager objects. In these instances, the names may include spaces or vary slightly from the property names. For example, BrokerSiteName may appear as Broker Site Name.

You can also use Microsoft properties in the Microsoft class CCM_DesktopMachine in the Root\ccm_vdi namespace. For more information on these properties, see the Microsoft documentation.

Note: Boolean properties displayed in Microsoft System Center Configuration Manager 2012 may appear as 1 or 0, not true or false.