Data Structure of the Machines Events

Machine Dimensions data source

Machine Meta Data Type Nullable Description Value
machineId GUID Yes Machine identifier.  
machineSid GUID No Machine AD identifier.  
machineName String No User defined machine name.  
machineIP String Yes IP Address of the machine.  
operatingSystem String No Operating system of the machine.  
deliveryGroupId GUID No Delivery group identifier.  
deliveryGroupName String No Delivery group name.  
siteId GUID No Citrix Virtual Apps and Desktops Site Identifier.  
siteName String No Citrix Virtual Apps and Desktops Site Name  
machineProvisioningType Integer No Describes how the machine was provisioned 0: Unknown, 1: MCS - Machine provisioned by Machine Creation Services (machine must be a VM), 2: PVS - Machine provisioned by Provisioning Services (might be physical, blade, VM), 3: Manual - No automated provisioning
hypervisorName String No Name of hypervisor  
hypervisorId GUID No Unique identifier of Hypervisor  
catalogName String No Name of Catalog Broker name  
catalogId GUID No Unique identifier for the Catalog  
agentVersion String No VDA version installed on the machine  
hostedMachineName String Yes    
hostingServerName String Yes    
sessionSupport String No Specifies the session support of the machines in the catalog 1: Single-session, 2: Multi-session
status Integer No Last known status of the machine in the last 15 minutes 1: Unregistered, 2: Registered, 3: Under Maintenance, 4: Failed, 5: Powered off
statusChangeTime Timestamp No Time when machine status has changed in the last 15 minutes The value format is “yyyy-MM-ddTHH: mm:ss.SSSZ”
machineActualStatus Integer No Calculated machine status using multiple state transitions that happened in the last 15 minutes. If the machine went from registered to unregistered state, machineActualStatus is unregistered 1: Unregistered, 2: Registered, 3: Failed
machineFailureReason




String




Yes




Failure reason why machine went into failed state




Fault unknown
No fault (healthy machine)
The last power-on operation for the machine failed
The machine does not seem to have booted following power on (VM tools did not transition to running)
The machine has failed to register within the expected period, or its registration has been rejected
The machine is reporting itself at maximum capacity
machineFailureType String Yes   Values can be any of: “Unknown”, “None”, “FailedToStart”, “StuckOnBoot”, “Unregistered”, “MaxCapacity
machinePowerState









Integer









No









Represents machine power state









0: Unknown
1: Unavailable
2: Off
3: On
4: Suspended
5: TurningOn
6: TurningOff
7: Suspending
8: Resuming
9: Unmanaged
10: NotSupported
unregisteredStartTime Timestamp Yes Time when the machine went into the unregistered state The value format is “yyyy-MM-ddTHH:mm:ss”
unregisteredEndTime Timestamp Yes Time when the machine came out from the unregistered state The value format is “yyyy-MM-ddTHH:mm:ss”
isMaintenanceMode Boolean Yes A boolean flag specifies if the machine is in Maintenance mode or not 0: true, 1: false
isUnregistered Boolean Yes A boolean flag specifies if the machine is in an unregistered state or not 0: true, 1: false
machineFailureTime Timestamp Yes Time when a machine went into a failed state Any date-time value
cpuSpikesCount Integer Yes Represents the number of times CPU utilization crossed the CPU threshold of 80% and sustained for 5 minutes or more in an interval of the last 15 minutes.  
usedMemory Decimal No Used memory (bytes)  
totalMemory Integer No Total available memory (bytes)  
percentCpu Integer No Average percentage CPU used on a machine  
ramSpikeCount 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.  
sessionCount Integer Yes Total number of sessions (successful + failed) launched on the machine in the last 15 minutes.  
downTime Integer Yes The total downtime of the machine calculated in seconds.  
consecutiveMachineFailure Integer Yes Consecutive failures on a machine known in an interval of the last 15 minutes.  
activeSessionCount Integer Yes The number of active sessions in an interval of the last 15 minutes.  
successfulSessionCount Integer No The number of successful sessions launched in an interval of the last 15 minutes.  
machineFailureOccurred Integer Yes Session Failures that occurred on the machine in an interval of the last 15 minutes.  
unRegistrationCount Integer No The number of times the machine went into the registered State in an interval of the last 15 minutes.  
Data Structure of the Machines Events