Elep

{
  "$schema": "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
  "metadata": {
    "name": "choria_util",
    "description": "Choria Utilities",
    "author": "R.I.Pienaar <rip@devco.net>",
    "license": "Apache-2.0",
    "version": "0.26.2",
    "url": "https://choria.io",
    "timeout": 2
  },
  "actions": [
    {
      "action": "info",
      "input": {
      },
      "output": {
        "security": {
          "description": "Security Provider plugin",
          "display_as": "Security Provider",
          "type": "string"
        },
        "secure_protocol": {
          "description": "If the protocol is running with PKI security enabled",
          "display_as": "Protocol Secure",
          "type": "boolean"
        },
        "connector": {
          "description": "Connector plugin",
          "display_as": "Connector",
          "type": "string"
        },
        "connector_tls": {
          "description": "If the connector is running with TLS security enabled",
          "display_as": "Connector TLS",
          "type": "boolean"
        },
        "path": {
          "description": "Active OS PATH",
          "display_as": "Path",
          "type": "string"
        },
        "choria_version": {
          "description": "Choria version",
          "display_as": "Choria Version",
          "type": "string"
        },
        "client_version": {
          "description": "Middleware client library version",
          "display_as": "Middleware Client Library Version",
          "type": "string"
        },
        "client_flavour": {
          "description": "Middleware client library flavour",
          "display_as": "Middleware Client Flavour",
          "type": "string"
        },
        "client_options": {
          "description": "Active Middleware client options",
          "display_as": "Middleware Client Options",
          "type": "hash"
        },
        "connected_server": {
          "description": "Connected middleware server",
          "display_as": "Connected Broker",
          "type": "string"
        },
        "client_stats": {
          "description": "Middleware client statistics",
          "display_as": "Middleware Client Stats",
          "type": "hash"
        },
        "facter_domain": {
          "description": "Facter domain",
          "display_as": "Facter Domain",
          "type": "string"
        },
        "facter_command": {
          "description": "Command used for Facter",
          "display_as": "Facter",
          "type": "string"
        },
        "srv_domain": {
          "description": "Configured SRV domain",
          "display_as": "SRV Domain",
          "type": "string"
        },
        "using_srv": {
          "description": "Indicates if SRV records are considered",
          "display_as": "SRV Used",
          "type": "boolean"
        },
        "middleware_servers": {
          "description": "Middleware Servers configured or discovered",
          "display_as": "Middleware",
          "type": "array"
        }
      },
      "display": "failed",
      "description": "Choria related information from the running Daemon and Middleware",
      "aggregate": [
        {
          "function": "summary",
          "args": [
            "choria_version"
          ]
        },
        {
          "function": "summary",
          "args": [
            "client_version"
          ]
        },
        {
          "function": "summary",
          "args": [
            "client_flavour"
          ]
        },
        {
          "function": "summary",
          "args": [
            "connected_server"
          ]
        },
        {
          "function": "summary",
          "args": [
            "srv_domain"
          ]
        },
        {
          "function": "summary",
          "args": [
            "using_srv"
          ]
        },
        {
          "function": "summary",
          "args": [
            "secure_protocol"
          ]
        },
        {
          "function": "summary",
          "args": [
            "connector_tls"
          ]
        }
      ]
    },
    {
      "action": "machine_state",
      "description": "Retrieves the current state of a specific Choria Autonomous Agent",
      "display": "ok",
      "input": {
        "instance": {
          "prompt": "Instance ID",
          "description": "Machine Instance ID",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": "^.+-.+-.+-.+-.+$",
          "maxlength": 36
        },
        "name": {
          "prompt": "Name",
          "description": "Machine Name",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": "^[a-zA-Z][a-zA-Z0-9_-]+",
          "maxlength": 128
        },
        "path": {
          "prompt": "Path",
          "description": "Machine Path",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": ".+",
          "maxlength": 512
        }
      },
      "aggregate": [
        {
          "function": "summary",
          "args": [
            "state"
          ]
        },
        {
          "function": "summary",
          "args": [
            "name"
          ]
        },
        {
          "function": "summary",
          "args": [
            "version"
          ]
        }
      ],
      "output": {
        "name": {
          "type": "string",
          "description": "The name of the autonomous agent",
          "display_as": "Name"
        },
        "version": {
          "type": "string",
          "description": "The version of the autonomous agent",
          "display_as": "Version"
        },
        "state": {
          "type": "string",
          "description": "The current state the agent is in",
          "display_as": "State"
        },
        "path": {
          "type": "string",
          "description": "The location on disk where the autonomous agent is stored",
          "display_as": "Path"
        },
        "id": {
          "type": "string",
          "description": "The unique running ID of the autonomous agent",
          "display_as": "ID"
        },
        "start_time": {
          "type": "string",
          "description": "The time the autonomous agent was started in unix seconds",
          "display_as": "Started"
        },
        "available_transitions": {
          "type": "array",
          "description": "The list of available transitions this autonomous agent can make",
          "display_as": "Available Transitions"
        },
        "scout": {
          "type": "boolean",
          "description": "True when this autonomous agent represents a Choria Scout Check",
          "display_as": "Scout Check"
        },
        "current_state": {
          "description": "The Choria Scout specific state for Scout checks",
          "display_as": "Scout State"
        }
      }
    },
    {
      "action": "machine_states",
      "input": {
      },
      "output": {
        "machine_names": {
          "description": "List of running machine names",
          "display_as": "Machine Names",
          "type": "array"
        },
        "machine_ids": {
          "description": "List of running machine IDs",
          "display_as": "Machine IDs",
          "type": "array"
        },
        "states": {
          "description": "Hash map of machine statusses indexed by machine ID",
          "display_as": "Machine States",
          "type": "hash"
        }
      },
      "display": "always",
      "description": "States of the hosted Choria Autonomous Agents",
      "aggregate": [
        {
          "function": "summary",
          "args": [
            "machine_names"
          ]
        }
      ]
    },
    {
      "action": "machine_transition",
      "input": {
        "instance": {
          "prompt": "Instance ID",
          "description": "Machine Instance ID",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": "^.+-.+-.+-.+-.+$",
          "maxlength": 36
        },
        "version": {
          "prompt": "Version",
          "description": "Machine Version",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": "^\\d+\\.\\d+\\.\\d+$",
          "maxlength": 20
        },
        "name": {
          "prompt": "Name",
          "description": "Machine Name",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": "^[a-zA-Z][a-zA-Z0-9_-]+",
          "maxlength": 128
        },
        "path": {
          "prompt": "Path",
          "description": "Machine Path",
          "type": "string",
          "default": null,
          "optional": true,
          "validation": ".+",
          "maxlength": 512
        },
        "transition": {
          "prompt": "Transition Name",
          "description": "The transition event to send to the machine",
          "type": "string",
          "default": null,
          "optional": false,
          "validation": "^[a-zA-Z][a-zA-Z0-9_-]+$",
          "maxlength": 128
        }
      },
      "output": {
        "success": {
          "description": "Indicates if the transition was successfully accepted",
          "display_as": "Accepted",
          "type": "boolean"
        }
      },
      "display": "failed",
      "description": "Attempts to force a transition in a hosted Choria Autonomous Agent"
    }
  ]
}