Data Structure of the Machines Events
| Machine Meta Data | Type | Nullable | Description | Value |
|---|---|---|---|---|
| Timestamp | String | No | Time when an API is called. | |
| SiteId | String | No | Citrix Virtual Apps and Desktops Site identifier. | |
| SiteName | String | No | Citrix Virtual Apps and Desktops Site name. | |
| MachineName | String | No | User defined machine name | |
| DeliveryGroupName | String | No | Delivery group name | |
| MachineOS | String | No | Operating system | |
| LatestConsecutiveFailures | Integer | Yes | Consecutive failures on a machine known in the interval of the last 15 minutes. | |
| Status | String | No | Last known status of the machine in the interval of the last 15 minutes. | 1: Unregistered, 2: Registered, 3: Under Maintenance, 4: Failed, 5: Powered off |
| UnRegistrationCount | Integer | No | The number of times the machine went into registered State in the interval of the last 15 minutes. | >=0 |
| SustainedCpuSpikes | Integer | Yes | Represents the number of times CPU utilization crossed the CPU threshold of 80%. Also, sustained for 5 minutes or more in the interval of the last 15 minutes. | >=0 |
| SustainedMemorySpikes | Integer | Yes | Represents the number of times memory consumption crossed the memory threshold of 80%. Also, sustained for 5 minutes or more in the interval of the last 15 minutes. | >=0 |
| PeakConcurrentSessions | Integer | Yes | The total number of sessions (successful and failed) launched on the machine in the interval of the last 15 minutes. | >=0 |
| SessionFailureRate | Double | Yes | Session failure rate on machine. | 0–100 |
| LoadIndicator | Double | No | Number of machines with machine score > 0. |
>=0 |
DownTime |
Double | Yes | Total downtime of the machine calculated in seconds. | |
| AvgMemoryConsumption | Double | No | Average used memory percentage on a machine. | 0–100 |
| PeakMemoryConsumption | Double | No | Total available memory percentage on a machine. | 0–100 |
| AvgCPU | Double | No | Average percentage of CPU used on a machine. | 0–100 |
| PeakCPU | Double | No | Maximum percentage of CPU used on a machine. | 0–100 |
| MachineOSType | String | No | Specifies the session support of the machines in the catalog. | 1: Single-session, 2: Multi-session |
| LowLoadInstances | Integer | No | Number of machines with machine score < 41. | >=0 |
| MediumLoadInstances | Integer | No | Number of machines with machine score >= 40 and machine score < 70 | >=0 |
| HighLoadInstances | Integer | No | Number of machines with machine score >=70. | >=0 |
| AggregatedStatus | String | No | Status description Failed, Unregistered, Maintenance, Active, Ready for use. | |
| ReadyForUseInstance | Integer | No | Number of machines with ‘Ready for use’ status. | >=0 |
| ActiveInstance | Integer | No | Number of machines with ‘Active’ status. | >=0 |
| UnregisteredInstance | Integer | No | Number of machines with ‘Unregistered’ status. | >=0 |
| FailedInstance | Integer | No | Number of machines with ‘Failed’ status. | >=0 |
| MaintenanceInstance | Integer | No | Number of machines with ‘Maintenance’ status. | >=0 |
Data Structure of the Machines Events
In this article
Copied!
Failed!