From 2efadf21b58de6d63306347c9b00197f1a5a9c63 Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Tue, 4 Oct 2016 15:10:53 -0400 Subject: [PATCH] Begin writing man pages Provide a couple of man pages to get started on the effort to provide man pages for the commands. --- confluent_client/doc/man/nodelist.ronn | 48 ++++++++++++++++++++ confluent_client/doc/man/nodesensors.ronn | 55 +++++++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 confluent_client/doc/man/nodelist.ronn create mode 100644 confluent_client/doc/man/nodesensors.ronn diff --git a/confluent_client/doc/man/nodelist.ronn b/confluent_client/doc/man/nodelist.ronn new file mode 100644 index 00000000..b231cc54 --- /dev/null +++ b/confluent_client/doc/man/nodelist.ronn @@ -0,0 +1,48 @@ +nodelist(1) -- List confluent nodes and their attributes +========================================================= + +## SYNOPSIS + +`nodelist` `noderange` +`nodelist` `noderange` [-b] [...] + +## DESCRIPTION + +**nodelist** queries the confluent server to get information about nodes. In +the simplest form, it simply takes the given noderange(5) and lists the +matching nodes, one line at a time. + +If a list of node attribute names are given, the value of those are also +displayed. If `-b` is specified, it will also display information on +how inherited and expression based attributes are defined. There is more +information on node attributes in nodeattributes(5) man page. + +## OPTIONS + +* `-b`, `--blame`: + Annotate inherited and expression based attributes to show their base value. + +## EXAMPLES +* Listing matching nodes of a simple noderange: + `# nodelist n1-n4` + `n1` + `n2` + `n3` + `n4` + +* Getting an attribute of nodes matching a noderange: + `# nodelist n1,n2 hardwaremanagement.manager` + `n1: hardwaremanagement.manager: 172.30.3.1` + `n2: hardwaremanagement.manager: 172.30.3.2` + +* Getting a group of attributes while determining what group defines them: + `# nodelist n1,n2 hardwaremanegement --blame` + `n1: hardwaremanagement.manager: 172.30.3.1` + `n1: hardwaremanagement.method: ipmi (inherited from group everything)` + `n1: hardwaremanagement.switch: r8e1` + `n1: hardwaremanagement.switchport: 14` + `n2: hardwaremanagement.manager: 172.30.3.2` + `n2: hardwaremanagement.method: ipmi (inherited from group everything)` + `n2: hardwaremanagement.switch: r8e1` + `n2: hardwaremanagement.switchport: 2` + diff --git a/confluent_client/doc/man/nodesensors.ronn b/confluent_client/doc/man/nodesensors.ronn new file mode 100644 index 00000000..16b5b47a --- /dev/null +++ b/confluent_client/doc/man/nodesensors.ronn @@ -0,0 +1,55 @@ +nodesensors(1) --- Retrieve telemetry for sensors of confluent nodes +==================================================================== + +## SYNOPSIS + +`nodesensors` `noderange` [-c] [-i ] [-n ] [...] + + +## DESCRIPTION + +**nodesensors** queries the confluent server to get telemetry from nodes. Telemetry can include +data such as temperature, power, and so forth. Without arguments, it lists all available sensors +and their current values. If `-c` is specified, CSV format is used for output. Normally +nodesensors outputs once and exits. Repeated periodic gathering can be done with `-i` to specify +interval and `-n` to specify number of requests. If `-i` is specified without `-n`, then it will +retrieve data at the requested interval indefinitely. If '-n' is specified without `-i`, an +interval of 1 second is used. + +## OPTIONS + +* `-c`, `--csv`: + Organize output into CSV format, one sensor per column. + +* `-i`, `--interval`=**SECONDS**: + Repeat data gathering waiting, waiting the specified time between samples. Unless `-n` is + specified, indefinite retrieval is assumed. + +* `-n`, `--numreadings`=**SAMPLES**: + Perform the specified number of readings, waiting `-i` indicated interval or 1 second if not + otherwise indicated. + +## EXAMPLES +* Retrieving all temperature related sensors from one system + `# nodesensors n1 temperature` + `n1: CPU 1 Overtemp: Ok` + `n1: CPU 2 Overtemp: Ok` + `n1: Inlet Temp: 16.0 °C` + `n1: PCH Overtemp: Ok` + `n1: LOM Temp: Ok` + +* Retrieving a sensor named "Inlet Temp" for 4 systems over a 3 second period of time: + 'nodesensors n1-n4 'Inlet Temp' -c -n 3 + 'time,node,Inlet Temp (°C)` + '2016-10-04T15:09:20,n1,19.0` + '2016-10-04T15:09:20,n2,18.0` + '2016-10-04T15:09:20,n3,18.0` + '2016-10-04T15:09:20,n4,17.0` + '2016-10-04T15:09:21,n1,19.0` + '2016-10-04T15:09:21,n2,18.0` + '2016-10-04T15:09:21,n3,18.0` + '2016-10-04T15:09:21,n4,17.0` + '2016-10-04T15:09:22,n1,19.0` + '2016-10-04T15:09:22,n2,18.0` + '2016-10-04T15:09:22,n3,18.0` + '2016-10-04T15:09:22,n4,17.0`