Citrix Virtual applicationss and Desktops provides virtualization solutions that give IT control of virtual machines, applications, and security while providing anywhere access for any device.The service allows you to manage on-premises data center and public cloud workloads together in a hybrid deployment.

Available resources under Citrix Virtual applications and Desktops are as follows:

  • Citrix Site: A site is the name you give to citrix Cloud deployment. It comprises the Delivery Controllers and other core components, Virtual Delivery Agents (VDAs), connections to hosts, machine catalogs, and delivery groups.
  • Delivery Group: A delivery group specifies one or more machines from a catalog.
  • Machine Catalog: A Machine catalog is a collection of virtual or physical machines that have the same operating system type (for example, Windows multi-session, Ubuntu single-session).
  • Citrix Desktop: A virtual desktop is a software computing platform with applicationss and data that is accessible from multiple devices and locations over a network.
  • Citrix Application: Citrix Workspace application provides users with quick, secure, self-service access to documents, applications, and desktops. Citrix Workspace application provides on-demand access to Windows, Web, and Software as a Service (SaaS) applications.
  • Citrix Machine:Citrix Machine Creation Services is a component of the XenDesktop virtual desktop infrastructure platform that IT administrators use to design and deliver virtual desktop images.

Citrix Architecture diagram:

Citrix site overview

Citrix site overview

Get Customer ID and Region

  1. Login to Citrix Cloud portal.

  2. Once you log in, you can find the Customer ID on the right pane as shown below:

  3. On the left pane, click Menu.

  4. From the list click Home. You can find the region in URL as shown below:

For example, Region Name:

Get Client ID and Secret Key

  1. Login to Citrix Cloud portal.

  2. Once you log in, on the left pane, click Menu.

  3. Click Identity and Access Management. In the Identity and Access Management page, select the API Access tab.

  4. In Secure Clients screen, enter the client name and click Create Client as shown below:

  5. From the create client details page, copy or download the client ID and secret key.

Supported Metrics

Click here to view the supported metrics
Metric NameMetric Display NameUnits
The number of concurrent grace sessions remaining.
License Grace Sessions RemainingCount
The number of active licensed sessions.
Licensed Sessions ActiveCount
The peak number of concurrent license users.
Peak Concurrent License UsersCount
The number of sessions of the delivery group.
Session CountCount
Shows the total number of machines.
Total MachinesCount
Shows the unregistered machine count.
Unregistered Machine CountCount
Shows the lingering session enabling state. Possible values: 0- false, 1- true
Session Lingering EnabledBoolean
Shows the pre-launch session enabling state. Possible values: 0- false, 1- true
Prelaunch Session EnabledBoolean
Shows the delivery group enabling state. Possible values: 0 -false, 1 - true
Delivery Group State EnabledBoolean
Shows the number of registered machines.
Registered MachinesCount
Shows the number of desktops available.
Desktops CountCount
Shows the count of disconnected desktops.
Disconnected Desktops CountCount
Shows the number of faulted desktops.
Faulted Desktops CountCount
Shows the number of unregistered desktops.
Unregistered Desktops CountCount
Shows the broken state of delivery group. Possible values: 0 - false, 1 - true
Is Delivery Group BrokenBoolean
Shows the number of machines in maintenance mode.
Machines In Maintenance ModeCount
Shows the number of desktops in used state.
Desktops In UseCount
Shows the number of desktops that are not registered.
Desktops Never RegisteredCount
Shows the number of desktops preparing.
Preparing Desktops CountCount
Shows the maximum average load threshold value of a delivery group.
Max Average Load ThresholdCount
Shows the percentage of off peak buffer size.
Off Peak Buffer Size PercentPercentage
Shows the percentage of peak buffer size.
Peak Buffer Size PercentPercentage
Shows whether the securelca is required or not. Possible values: 0 -false, 1- true
SecureIca RequiredBoolean
Shows the number of unassigned machines.
Unassigned Machines CountCount
Shows the machine catalog disk size in GB.
Machine Catalog Disk SizeGB
Shows the count of CPU.
CPU CountCount
Shows the available cores per CPU count.
Cores Per CPU CountCount
Shows the memory in MB.
Memory In MBMB
Shows the machine count.
Machine CountCount
Shows the machine catalog assigned count.
Assigned CountCount
Shows the machine catalog broken state. Possible values: 0- false, 1 - true.
Machine Catalog Broken StateBoolean
Shows the disk image status. Possible values: 0 - Unknown, 1- Other.
Disk Image StatusNone (Enum)
Shows the numer of avalailable machine accounts.
Available Machine Accounts CountCount
Shows the number of jobs that are in progress state.
Jobs In ProgressCount
Shows the available assigned count.
Available Assigned CountCount
Shows the number of machine catalogs available.
Machine Catalog Available CountCount
Shows the machine catalog available unassigned count.
Machine Catalog Available Unassigned CountCount
Shows the total machine catalogs count.
Machine Catalog Total CountCount
Shows the machine catalog unassigned count.
Machine Catalog Unassigned CountCount
Shows the machine catalog Used Count.
Machine Catalog Used CountCount
Shows the machine catalog provisioning progress.
Machine Catalog Provisioning ProgressCount
Shows the number of desktop machines for assignment.
Desktop Machines For AssignmentCount
Shows the desktop enabling state. Possible values: 0 -false, 1- true.
Desktop Enabling StateBoolean
Shows the excluded user filter enabling state. Possible values: 0- false, 1- true.
Excluded User Filter Enabling StateBoolean
Shows the included user filter enabling state. Possible values: 0- false, 1- true.
Included User Filter Enabling StateBoolean
Shows the desktop leasing behavior. Possible values: 1- Allowed , 0- Notallowed.
Desktop Leasing BehaviorNone (Enum)
Shows the maximum desktops count.
Maximum DesktopsCount
Shows the desktop session reconnection. Possible values: 0 - Unknown, 1- Alaways.
Desktop Session ReconnectionNone (Enum)
Shows if the desktop secureIca required. Possible values: 0- false, 1- true.
Desktop SecureIca RequiredBoolean
Shows the application enabling state. Possible values: 0-false, 1-true.
Application Enabling StateBoolean
Shows the values of max per user instances.
Max Per User InstancesCount
Shows the machine power state. Possible values: 0- Off, 1- On.
Power StateNone (Enum)
Shows the maintenance mode status. Possible values: 0 - false, 1 - true.
Maintanence ModeBoolean
Shows the registration state. Possible values: 0- Unregistered, 1- Registered.
Registration StateNone (Enum)
Shows the image out of date value. Possible values: 0- false, 1- true.
Is Image Out Of DateBoolean
Shows Is Assigned machine value. Possible values: 0-false, 1 - true.
Assigned StateBoolean
Shows machine load index value.
Machine Load IndexCount
Shows machine session count.
Machine Session CountCount
Shows summary state. Possible values: 0 - Unavailable, 1- Available.
Summary StateNone (Enum)
Shows fault state of machone. Possible values: 0 - "None", 1-"Unknown".
Fault StateNone (Enum)

Configure the integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the ADD APP page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
  6. Select Citrix Cloud VDA Service.
  1. Enter your account information:
Name(required) Enter integration name.
Customer Id(required) Enter the Customer ID saved from Get Customer ID and Region.
Client Id(required) Enter the Client ID saved from Get Client ID and Secret Key.
Security Key(required) Enter the Security Key saved from Get Client ID and Secret Key.
Confirm Security Key(required) Re-enter the Security Key saved from Get Client ID and Secret Key.
Region(required) Enter the region name saved from Get Customer ID and Region.
  1. Click Next.In the RESOURCE TYPE section, select:

    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click Finish.
    The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

  4. After configuring the integration, Citrix Cloud metrics can be viewed from the Infrastructure > Resources page.