1 metadata :name => "rpcutil",
2 :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
3 :author => "R.I.Pienaar <rip@devco.net>",
4 :license => "Apache License, Version 2.0",
6 :url => "http://marionette-collective.org/",
9 action "collective_info", :description => "Info about the main and sub collectives" do
12 output :main_collective,
13 :description => "The main Collective",
14 :display_as => "Main Collective"
17 :description => "All Collectives",
18 :display_as => "All Collectives"
21 aggregate summary(:collectives)
25 action "inventory", :description => "System Inventory" do
29 :description => "List of agent names",
30 :display_as => "Agents"
33 :description => "List of facts and values",
34 :display_as => "Facts"
37 :description => "List of classes on the system",
38 :display_as => "Classes"
41 :description => "MCollective Version",
42 :display_as => "Version"
44 output :main_collective,
45 :description => "The main Collective",
46 :display_as => "Main Collective"
49 :description => "All Collectives",
50 :display_as => "All Collectives"
53 :description => "List of data plugin names",
54 :display_as => "Data Plugins"
57 action "get_fact", :description => "Retrieve a single fact from the fact store" do
61 :prompt => "The name of the fact",
62 :description => "The fact to retrieve",
64 :validation => '^[\w\-\.]+$',
69 :description => "The name of the fact being returned",
73 :description => "The value of the fact",
74 :display_as => "Value"
77 aggregate summary(:value)
81 action "daemon_stats", :description => "Get statistics from the running daemon" do
85 :description => "List of threads active in the daemon",
86 :display_as => "Threads"
89 :description => "List of agents loaded",
90 :display_as => "Agents"
93 :description => "Process ID of the daemon",
97 :description => "Processor time consumed by the daemon",
98 :display_as => "Times"
101 :description => "Messages that passed security validation",
102 :display_as => "Security Validated"
105 :description => "Messages that failed security validation",
106 :display_as => "Failed Security"
109 :description => "Passed filter checks",
110 :display_as => "Passed Filter"
113 :description => "Didn't pass filter checks",
114 :display_as => "Failed Filter"
117 :description => "Time the server started",
118 :display_as => "Start Time"
121 :description => "Total messages received",
122 :display_as => "Total Messages"
125 :description => "Replies sent back to clients",
126 :display_as => "Replies"
129 :description => "Config file used to start the daemon",
130 :display_as => "Config File"
133 :description => "MCollective Version",
134 :display_as => "Version"
137 :description => "Messages that did pass TTL checks",
138 :display_as => "TTL Expired"
141 aggregate summary(:version)
142 aggregate summary(:agents)
146 action "agent_inventory", :description => "Inventory of all agents on the server" do
150 :description => "List of agents on the server",
151 :display_as => "Agents"
154 action "get_config_item", :description => "Get the active value of a specific config property" do
158 :prompt => "Configuration Item",
159 :description => "The item to retrieve from the server",
161 :validation => '^.+$',
166 :description => "The config property being retrieved",
167 :display_as => "Property"
170 :description => "The value that is in use",
171 :display_as => "Value"
174 aggregate summary(:value)
178 action "get_data", :description => "Get data from a data plugin" do
182 :prompt => "Data Source",
183 :description => "The data plugin to retrieve information from",
185 :validation => '^\w+$',
191 :description => "The query argument to supply to the data plugin",
193 :validation => '^.+$',
198 action "ping", :description => "Responds to requests for PING with PONG" do
202 :description => "The local timestamp",
203 :display_as => "Timestamp"