Introduction

Citrix Virtual Apps 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 Apps 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 apps and data that is accessible from multiple devices and locations over a network.
  • Citrix Application: Citrix Workspace app provides users with quick, secure, self-service access to documents, applications, and desktops. Citrix Workspace app 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: ap-s.cloud.com.

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.

Configure the integration

  1. From All Clients, select a client.
  2. Go to Setup > Integrations > Integrations.
  3. In the Saas Application section, select Citrix Cloud VDA Service.
  1. Enter your account information:
Image
PropertyDescription
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.

  2. Choose the discovery schedule period:

    Image
  3. Click Finish.

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

    Image

Supported metrics

Metric NameMetric Display NameUnits
citrixcvda_site_LicenseGraceSessionsRemaining
The number of concurrent grace sessions remaining.
License Grace Sessions RemainingCount
citrixcvda_site_LicensedSessionsActive
The number of active licensed sessions.
Licensed Sessions ActiveCount
citrixcvda_site_PeakConcurrentLicenseUsers
The peak number of concurrent license users.
Peak Concurrent License UsersCount
citrixcvda_deliverygroup_SessionCount
The number of sessions of the delivery group.
Session CountCount
citrixcvda_deliverygroup_TotalMachines
Shows the total number of machines.
Total MachinesCount
citrixcvda_deliverygroup_MachineUnregisteredCount
Shows the unregistered machine count.
Unregistered Machine CountCount
citrixcvda_deliverygroup_SessionLingering
Shows the lingering session enabling state. Possible values: 0- false, 1- true
Session Lingering EnabledBoolean
citrixcvda_deliverygroup_SessionPrelaunch
Shows the pre-launch session enabling state. Possible values: 0- false, 1- true
Prelaunch Session EnabledBoolean
citrixcvda_deliverygroup_StateEnabled
Shows the delivery group enabling state. Possible values: 0 -false, 1 - true
Delivery Group State EnabledBoolean
citrixcvda_deliverygroup_RegisteredMachines
Shows the number of registered machines.
Registered MachinesCount
citrixcvda_deliverygroup_DesktopsAvailable
Shows the number of desktops available.
Desktops CountCount
citrixcvda_deliverygroup_DesktopsDisconnected
Shows the count of disconnected desktops.
Disconnected Desktops CountCount
citrixcvda_deliverygroup_DesktopsFaulted
Shows the number of faulted desktops.
Faulted Desktops CountCount
citrixcvda_deliverygroup_DesktopsUnregistered
Shows the number of unregistered desktops.
Unregistered Desktops CountCount
citrixcvda_deliverygroup_IsBroken
Shows the broken state of delivery group. Possible values: 0 - false, 1 - true
Is Delivery Group BrokenBoolean
citrixcvda_deliverygroup_MachinesInMaintenanceMode
Shows the number of machines in maintenance mode.
Machines In Maintenance ModeCount
citrixcvda_deliverygroup_DesktopsInUse
Shows the number of desktops in used state.
Desktops In UseCount
citrixcvda_deliverygroup_DesktopsNeverRegistered
Shows the number of desktops that are not registered.
Desktops Never RegisteredCount
citrixcvda_deliverygroup_DesktopsPreparing
Shows the number of desktops preparing.
Preparing Desktops CountCount
citrixcvda_deliverygroup_MaxAverageLoadThreshold
Shows the maximum average load threshold value of a delivery group.
Max Average Load ThresholdCount
citrixcvda_deliverygroup_OffPeakBufferSizePercent
Shows the percentage of off peak buffer size.
Off Peak Buffer Size PercentPercentage
citrixcvda_deliverygroup_PeakBufferSizePercent
Shows the percentage of peak buffer size.
Peak Buffer Size PercentPercentage
citrixcvda_deliverygroup_SecureIcaRequired
Shows whether the securelca is required or not. Possible values: 0 -false, 1- true
SecureIca RequiredBoolean
citrixcvda_deliverygroup_UnassignedMachines
Shows the number of unassigned machines.
Unassigned Machines CountCount
citrixcvda_machinecatalog_DiskSizeGB
Shows the machine catalog disk size in GB.
Machine Catalog Disk SizeGB
citrixcvda_machinecatalog_CpuCount
Shows the count of CPU.
CPU CountCount
citrixcvda_machinecatalog_CoresPerCpuCount
Shows the available cores per CPU count.
Cores Per CPU CountCount
citrixcvda_machinecatalog_MemoryMB
Shows the memory in MB.
Memory In MBMB
citrixcvda_machinecatalog_MachineCount
Shows the machine count.
Machine CountCount
citrixcvda_machinecatalog_AssignedCount
Shows the machine catalog assigned count.
Assigned CountCount
citrixcvda_machinecatalog_IsBroken
Shows the machine catalog broken state. Possible values: 0- false, 1 - true.
Machine Catalog Broken StateBoolean
citrixcvda_machinecatalog_DiskImageStatus
Shows the disk image status. Possible values: 0 - Unknown, 1- Other.
Disk Image StatusNone (Enum)
citrixcvda_machinecatalog_NumAvailableMachineAccounts
Shows the numer of avalailable machine accounts.
Available Machine Accounts CountCount
citrixcvda_machinecatalog_JobsInProgress
Shows the number of jobs that are in progress state.
Jobs In ProgressCount
citrixcvda_machinecatalog_AvailableAssignedCount
Shows the available assigned count.
Available Assigned CountCount
citrixcvda_machinecatalog_AvailableCount
Shows the number of machine catalogs available.
Machine Catalog Available CountCount
citrixcvda_machinecatalog_AvailableUnassignedCount
Shows the machine catalog available unassigned count.
Machine Catalog Available Unassigned CountCount
citrixcvda_machinecatalog_TotalCount
Shows the total machine catalogs count.
Machine Catalog Total CountCount
citrixcvda_machinecatalog_UnassignedCount
Shows the machine catalog unassigned count.
Machine Catalog Unassigned CountCount
citrixcvda_machinecatalog_UsedCount
Shows the machine catalog Used Count.
Machine Catalog Used CountCount
citrixcvda_machinecatalog_ProvisioningProgress
Shows the machine catalog provisioning progress.
Machine Catalog Provisioning ProgressCount
citrixcvda_desktop_MachinesForAssignment
Shows the number of desktop machines for assignment.
Desktop Machines For AssignmentCount
citrixcvda_desktop_Enabled
Shows the desktop enabling state. Possible values: 0 -false, 1- true.
Desktop Enabling StateBoolean
citrixcvda_desktop_ExcludedUserFilterEnabled
Shows the excluded user filter enabling state. Possible values: 0- false, 1- true.
Excluded User Filter Enabling StateBoolean
citrixcvda_desktop_IncludedUserFilterEnabled
Shows the included user filter enabling state. Possible values: 0- false, 1- true.
Included User Filter Enabling StateBoolean
citrixcvda_desktop_LeasingBehavior
Shows the desktop leasing behavior. Possible values: 1- Allowed , 0- Notallowed.
Desktop Leasing BehaviorNone (Enum)
citrixcvda_desktop_MaxDesktops
Shows the maximum desktops count.
Maximum DesktopsCount
citrixcvda_desktop_SessionReconnection
Shows the desktop session reconnection. Possible values: 0 - Unknown, 1- Alaways.
Desktop Session ReconnectionNone (Enum)
citrixcvda_desktop_SecureIcaRequired
Shows if the desktop secureIca required. Possible values: 0- false, 1- true.
Desktop SecureIca RequiredBoolean
citrixcvda_application_Enabled
Shows the application enabling state. Possible values: 0-false, 1-true.
Application Enabling StateBoolean
citrixcvda_application_MaxPerUserInstances
Shows the values of max per user instances.
Max Per User InstancesCount
citrixcvda_machine_PowerState
Shows the machine power state. Possible values: 0- Off, 1- On.
Power StateNone (Enum)
citrixcvda_machine_MaintanenceMode
Shows the maintenance mode status. Possible values: 0 - false, 1 - true.
Maintanence ModeBoolean
citrixcvda_machine_RegistrationState
Shows the registration state. Possible values: 0- Unregistered, 1- Registered.
Registration StateNone (Enum)
citrixcvda_machine_ImageOutOfDate
Shows the image out of date value. Possible values: 0- false, 1- true.
Is Image Out Of DateBoolean
citrixcvda_machine_IsAssigned
Shows Is Assigned machine value. Possible values: 0-false, 1 - true.
Assigned StateBoolean
citrixcvda_machine_LoadIndex
Shows machine load index value.
Machine Load IndexCount
citrixcvda_machine_SessionCount
Shows machine session count.
Machine Session CountCount
citrixcvda_machine_SummaryState
Shows summary state. Possible values: 0 - Unavailable, 1- Available.
Summary StateNone (Enum)
citrixcvda_machine_FaultState
Shows fault state of machone. Possible values: 0 - "None", 1-"Unknown".
Fault StateNone (Enum)




References

https://developer.cloud.com/citrix-cloud/citrix-cloud-api-overview/docs/get-started-with-citrix-cloud-apis