choria-mcorpc-support 2.24.1 → 2.25.0

data/lib/mcollective/agent/choria_util.ddl

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

data/lib/mcollective/agent/choria_util.json

@@ -5,7 +5,7 @@
     "description": "Choria Utilities",
     "author": "R.I.Pienaar <rip@devco.net>",
     "license": "Apache-2.0",
-    "version": "0.19.0",
+    "version": "0.22.0",
     "url": "https://choria.io",
     "timeout": 2
   },
@@ -18,82 +18,82 @@
         "security": {
           "description": "Security Provider plugin",
           "display_as": "Security Provider",
-          "default": null
+          "type": "string"
         },
         "secure_protocol": {
           "description": "If the protocol is running with PKI security enabled",
           "display_as": "Protocol Secure",
-          "default": null
+          "type": "boolean"
         },
         "connector": {
           "description": "Connector plugin",
           "display_as": "Connector",
-          "default": null
+          "type": "string"
         },
         "connector_tls": {
           "description": "If the connector is running with TLS security enabled",
           "display_as": "Connector TLS",
-          "default": null
+          "type": "boolean"
         },
         "path": {
           "description": "Active OS PATH",
           "display_as": "Path",
-          "default": null
+          "type": "string"
         },
         "choria_version": {
           "description": "Choria version",
           "display_as": "Choria Version",
-          "default": null
+          "type": "string"
         },
         "client_version": {
           "description": "Middleware client library version",
           "display_as": "Middleware Client Library Version",
-          "default": null
+          "type": "string"
         },
         "client_flavour": {
-          "description": "Middleware client gem flavour",
+          "description": "Middleware client library flavour",
           "display_as": "Middleware Client Flavour",
-          "default": null
+          "type": "string"
         },
         "client_options": {
-          "description": "Active Middleware client gem options",
+          "description": "Active Middleware client options",
           "display_as": "Middleware Client Options",
-          "default": null
+          "type": "hash"
         },
         "connected_server": {
           "description": "Connected middleware server",
           "display_as": "Connected Broker",
-          "default": null
+          "type": "string"
         },
         "client_stats": {
-          "description": "Middleware client gem statistics",
+          "description": "Middleware client statistics",
           "display_as": "Middleware Client Stats",
-          "default": null
+          "type": "hash"
         },
         "facter_domain": {
           "description": "Facter domain",
           "display_as": "Facter Domain",
-          "default": null
+          "type": "string"
         },
         "facter_command": {
           "description": "Command used for Facter",
           "display_as": "Facter",
-          "default": null
+          "type": "string"
         },
         "srv_domain": {
           "description": "Configured SRV domain",
           "display_as": "SRV Domain",
-          "default": null
+          "type": "string"
         },
         "using_srv": {
           "description": "Indicates if SRV records are considered",
           "display_as": "SRV Used",
-          "default": null
+          "type": "boolean"
         },
         "middleware_servers": {
           "description": "Middleware Servers configured or discovered",
           "display_as": "Middleware",
-          "default": null
+          "type": "array"
         }
       },
       "display": "failed",
@@ -149,6 +149,106 @@
         }
       ]
     },
+    {
+      "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": {
@@ -157,17 +257,17 @@
         "machine_names": {
           "description": "List of running machine names",
           "display_as": "Machine Names",
-          "default": null
+          "type": "array"
         },
         "machine_ids": {
           "description": "List of running machine IDs",
           "display_as": "Machine IDs",
-          "default": null
+          "type": "array"
         },
         "states": {
           "description": "Hash map of machine statusses indexed by machine ID",
           "display_as": "Machine States",
-          "default": null
+          "type": "hash"
         }
       },
       "display": "always",
@@ -234,11 +334,11 @@
         "success": {
           "description": "Indicates if the transition was successfully accepted",
           "display_as": "Accepted",
-          "default": null
+          "type": "boolean"
         }
       },
       "display": "failed",
       "description": "Attempts to force a transition in a hosted Choria Autonomous Agent"
     }
   ]
-}
+}