choria-mcorpc-support 2.24.1 → 2.25.0

data/lib/mcollective/agent/rpcutil.ddl

@@ -1,224 +1,283 @@
-metadata    :name        => "rpcutil",
-            :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
-            :author      => "R.I.Pienaar <rip@devco.net>",
-            :license     => "Apache License, Version 2.0",
-            :version     => "0.19.0",
-            :url         => "https://choria.io/",
-            :timeout     => 2
-
-action "collective_info", :description => "Info about the main and sub collectives" do
-    display :always
-
-    output :main_collective,
-           :description => "The main Collective",
-           :display_as => "Main Collective"
-
-    output :collectives,
-           :description => "All Collectives",
-           :display_as => "All Collectives"
-
-    summarize do
-        aggregate summary(:collectives)
-    end
-end
+metadata :name        => "rpcutil",
+         :description => "Utility actions that expose information about the state of the running Server",
+         :author      => "R.I.Pienaar <rip@devco.net>",
+         :license     => "Apache-2.0",
+         :version     => "0.22.0",
+         :url         => "https://choria.io/",
+         :timeout     => 2
 
-action "inventory", :description => "System Inventory" do
-    display :always
 
-    output :agents,
-           :description => "List of agent names",
-           :display_as => "Agents"
+action "agent_inventory", :description => "Inventory of all agents on the server including versions, licenses and more" do
+  display :always
 
-    output :facts,
-           :description => "List of facts and values",
-           :display_as => "Facts"
 
-    output :classes,
-           :description => "List of classes on the system",
-           :display_as => "Classes"
 
-    output :version,
-           :description => "MCollective Version",
-           :display_as => "Version"
+  output :agents,
+         :description => "List of agents on the server",
+         :type        => "array",
+         :display_as  => "Agents"
 
-    output :main_collective,
-           :description => "The main Collective",
-           :display_as => "Main Collective"
+end
 
-    output :collectives,
-           :description => "All Collectives",
-           :display_as => "All Collectives"
+action "collective_info", :description => "Info about the main and sub collectives that the server belongs to" do
+  display :always
 
-    output :data_plugins,
-           :description => "List of data plugin names",
-           :display_as => "Data Plugins"
 
-    output :machines,
-           :description => "Autonomous Agents",
-           :display_as => "Machines"
-end
 
-action "get_fact", :description => "Retrieve a single fact from the fact store" do
-     display :always
-
-     input :fact,
-           :prompt      => "The name of the fact",
-           :description => "The fact to retrieve",
-           :type        => :string,
-           :validation  => '.+',
-           :optional    => false,
-           :maxlength   => 512
-
-     output :fact,
-            :description => "The name of the fact being returned",
-            :display_as => "Fact"
-
-     output :value,
-            :description => "The value of the fact",
-            :display_as => "Value"
-
-    summarize do
-        aggregate summary(:value)
-    end
-end
+  output :collectives,
+         :description => "All Collectives",
+         :type        => "array",
+         :display_as  => "All Collectives"
 
-action "get_facts", :description => "Retrieve multiple facts from the fact store" do
-     display :always
-
-     input :facts,
-           :prompt      => "Comma-separated list of facts",
-           :description => "Facts to retrieve",
-           :type        => :string,
-           :validation  => '^\s*[\w\.\-]+(\s*,\s*[\w\.\-]+)*$',
-           :optional    => false,
-           :maxlength   => 200
-
-     output :values,
-            :description => "List of values of the facts",
-            :display_as => "Values"
+  output :main_collective,
+         :description => "The main Collective",
+         :type        => "string",
+         :display_as  => "Main Collective"
+
+  summarize do
+    aggregate summary(:collectives)
+  end
 end
 
 action "daemon_stats", :description => "Get statistics from the running daemon" do
-    display :always
+  display :always
+
+
+
+  output :agents,
+         :description => "List of agents loaded",
+         :type        => "array",
+         :display_as  => "Agents"
+
+  output :configfile,
+         :description => "Config file used to start the daemon",
+         :type        => "string",
+         :display_as  => "Config File"
+
+  output :filtered,
+         :description => "Count of message that didn't pass filter checks",
+         :type        => "integer",
+         :display_as  => "Failed Filter"
+
+  output :passed,
+         :description => "Count of messages that passed filter checks",
+         :type        => "integer",
+         :display_as  => "Passed Filter"
+
+  output :pid,
+         :description => "Process ID of the Choria Server",
+         :type        => "integer",
+         :display_as  => "PID"
+
+  output :replies,
+         :description => "Count of replies sent back to clients",
+         :type        => "integer",
+         :display_as  => "Replies"
+
+  output :starttime,
+         :description => "Time the Choria Server started in unix seconds",
+         :type        => "integer",
+         :display_as  => "Start Time"
+
+  output :threads,
+         :description => "List of threads active in the Choria Server",
+         :type        => "array",
+         :display_as  => "Threads"
+
+  output :times,
+         :description => "Processor time consumed by the Choria Server",
+         :type        => "hash",
+         :display_as  => "Times"
+
+  output :total,
+         :description => "Count of messages received by the Choria Server",
+         :type        => "integer",
+         :display_as  => "Total Messages"
+
+  output :ttlexpired,
+         :description => "Count of messages that did pass TTL checks",
+         :type        => "integer",
+         :display_as  => "TTL Expired"
+
+  output :unvalidated,
+         :description => "Count of messages that failed security validation",
+         :type        => "integer",
+         :display_as  => "Failed Security"
+
+  output :validated,
+         :description => "Count of messages that passed security validation",
+         :type        => "integer",
+         :display_as  => "Security Validated"
+
+  output :version,
+         :description => "Choria Server Version",
+         :type        => "string",
+         :display_as  => "Version"
+
+  summarize do
+    aggregate summary(:version)
+    aggregate summary(:agents)
+  end
+end
 
-    output :threads,
-           :description => "List of threads active in the daemon",
-           :display_as => "Threads"
+action "get_config_item", :description => "Get the active value of a specific config property" do
+  display :always
 
-    output :agents,
-           :description => "List of agents loaded",
-           :display_as => "Agents"
+  input :item,
+        :prompt      => "Configuration Item",
+        :description => "The item to retrieve from the server",
+        :type        => :string,
+        :validation  => '^.+$',
+        :maxlength   => 120,
+        :optional    => false
 
-    output :pid,
-           :description => "Process ID of the daemon",
-           :display_as => "PID"
 
-    output :times,
-           :description => "Processor time consumed by the daemon",
-           :display_as => "Times"
 
-    output :validated,
-           :description => "Messages that passed security validation",
-           :display_as => "Security Validated"
 
-    output :unvalidated,
-           :description => "Messages that failed security validation",
-           :display_as => "Failed Security"
+  output :item,
+         :description => "The config property being retrieved",
+         :type        => "string",
+         :display_as  => "Property"
 
-    output :passed,
-           :description => "Passed filter checks",
-           :display_as => "Passed Filter"
+  output :value,
+         :description => "The value that is in use",
+         :display_as  => "Value"
 
-    output :filtered,
-           :description => "Didn't pass filter checks",
-           :display_as => "Failed Filter"
+  summarize do
+    aggregate summary(:value)
+  end
+end
 
-    output :starttime,
-           :description => "Time the server started",
-           :display_as => "Start Time"
+action "get_data", :description => "Get data from a data plugin" do
+  display :always
 
-    output :total,
-           :description => "Total messages received",
-           :display_as => "Total Messages"
+  input :query,
+        :prompt      => "Query",
+        :description => "The query argument to supply to the data plugin",
+        :type        => :string,
+        :validation  => '^.+$',
+        :maxlength   => 200,
+        :optional    => true
 
-    output :replies,
-           :description => "Replies sent back to clients",
-           :display_as => "Replies"
 
-    output :configfile,
-           :description => "Config file used to start the daemon",
-           :display_as => "Config File"
+  input :source,
+        :prompt      => "Data Source",
+        :description => "The data plugin to retrieve information from",
+        :type        => :string,
+        :validation  => '^\w+$',
+        :maxlength   => 50,
+        :optional    => false
+
 
-    output :version,
-           :description => "MCollective Version",
-           :display_as => "Version"
 
-    output :ttlexpired,
-           :description => "Messages that did pass TTL checks",
-           :display_as => "TTL Expired"
 
-    summarize do
-        aggregate summary(:version)
-        aggregate summary(:agents)
-    end
 end
 
-action "agent_inventory", :description => "Inventory of all agents on the server" do
-    display :always
+action "get_fact", :description => "Retrieve a single fact from the fact store" do
+  display :always
+
+  input :fact,
+        :prompt      => "The name of the fact",
+        :description => "The fact to retrieve",
+        :type        => :string,
+        :validation  => '.+',
+        :maxlength   => 512,
+        :optional    => false
+
+
+
 
-    output :agents,
-           :description => "List of agents on the server",
-           :display_as => "Agents"
+  output :fact,
+         :description => "The name of the fact being returned",
+         :type        => "string",
+         :display_as  => "Fact"
+
+  output :value,
+         :description => "The value of the fact",
+         :display_as  => "Value"
+
+  summarize do
+    aggregate summary(:value)
+  end
 end
 
-action "get_config_item", :description => "Get the active value of a specific config property" do
-    display :always
-
-    input :item,
-          :prompt      => "Configuration Item",
-          :description => "The item to retrieve from the server",
-          :type        => :string,
-          :validation  => '^.+$',
-          :optional    => false,
-          :maxlength    => 50
-
-    output :item,
-           :description => "The config property being retrieved",
-           :display_as => "Property"
-
-    output :value,
-           :description => "The value that is in use",
-           :display_as => "Value"
-
-    summarize do
-        aggregate summary(:value)
-    end
+action "get_facts", :description => "Retrieve multiple facts from the fact store" do
+  display :always
+
+  input :facts,
+        :prompt      => "Comma-separated list of facts to retrieve",
+        :description => "Facts to retrieve",
+        :type        => :string,
+        :validation  => '^\s*[\w\.\-]+(\s*,\s*[\w\.\-]+)*$',
+        :maxlength   => 200,
+        :optional    => false
+
+
+
+
+  output :values,
+         :description => "List of values of the facts",
+         :type        => "hash",
+         :display_as  => "Values"
+
 end
 
-action "get_data", :description => "Get data from a data plugin" do
-    display :always
-
-    input :source,
-          :prompt      => "Data Source",
-          :description => "The data plugin to retrieve information from",
-          :type        => :string,
-          :validation  => '^\w+$',
-          :optional    => false,
-          :maxlength   => 50
-
-    input :query,
-          :prompt      => "Query",
-          :description => "The query argument to supply to the data plugin",
-          :type        => :string,
-          :validation  => '^.+$',
-          :optional    => true,
-          :maxlength   => 200
+action "inventory", :description => "System Inventory" do
+  display :always
+
+
+
+  output :agents,
+         :description => "List of agent names",
+         :type        => "array",
+         :display_as  => "Agents"
+
+  output :classes,
+         :description => "List of classes on the system",
+         :type        => "array",
+         :display_as  => "Classes"
+
+  output :collectives,
+         :description => "All Collectives",
+         :type        => "array",
+         :display_as  => "All Collectives"
+
+  output :data_plugins,
+         :description => "List of data plugin names",
+         :type        => "array",
+         :display_as  => "Data Plugins"
+
+  output :facts,
+         :description => "List of facts and values",
+         :type        => "hash",
+         :display_as  => "Facts"
+
+  output :machines,
+         :description => "Autonomous Agents",
+         :type        => "hash",
+         :display_as  => "Machines"
+
+  output :main_collective,
+         :description => "The main Collective",
+         :type        => "string",
+         :display_as  => "Main Collective"
+
+  output :version,
+         :description => "Choria Server Version",
+         :type        => "string",
+         :display_as  => "Version"
+
 end
 
 action "ping", :description => "Responds to requests for PING with PONG" do
-    display :always
+  display :always
+
+
+
+  output :pong,
+         :description => "The local Unix timestamp",
+         :type        => "string",
+         :display_as  => "Timestamp"
 
-    output :pong,
-           :description => "The local timestamp",
-           :display_as => "Timestamp"
 end
+