Citrix · Schema

Machine

Application DeliveryDesktop-As-A-ServiceNetworkingVirtualizationWorkspaceFortune 1000

Properties

Name Type Description
id string Unique identifier for the machine
name string Machine name
dnsName string DNS name of the machine
registrationState string Registration state with the delivery controller
powerState string Current power state
inMaintenanceMode boolean Whether the machine is in maintenance mode
currentSessionCount integer Number of active sessions on the machine
View JSON Schema on GitHub

JSON Schema

citrix-machine-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Machine",
  "title": "Machine",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the machine"
    },
    "name": {
      "type": "string",
      "description": "Machine name"
    },
    "dnsName": {
      "type": "string",
      "description": "DNS name of the machine"
    },
    "registrationState": {
      "type": "string",
      "enum": [
        "Registered",
        "Unregistered"
      ],
      "description": "Registration state with the delivery controller"
    },
    "powerState": {
      "type": "string",
      "enum": [
        true,
        false,
        "Suspended",
        "Unknown"
      ],
      "description": "Current power state"
    },
    "inMaintenanceMode": {
      "type": "boolean",
      "description": "Whether the machine is in maintenance mode"
    },
    "currentSessionCount": {
      "type": "integer",
      "description": "Number of active sessions on the machine"
    }
  }
}