From 6d88dbb374e65de9484bad428d1923d3cadfd1a3 Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Tue, 14 Nov 2017 15:55:03 -0500 Subject: [PATCH] Add missing man pages Several commands did not yet have man pages, address this documentation issue. --- confluent_client/doc/man/nodeconfig.ronn | 33 ++++++++++++++++++++++++ confluent_client/doc/man/nodedefine.ronn | 28 ++++++++++++++++++++ confluent_client/doc/man/noderemove.ronn | 25 ++++++++++++++++++ confluent_client/doc/man/nodereseat.ronn | 19 ++++++++++++++ 4 files changed, 105 insertions(+) create mode 100644 confluent_client/doc/man/nodeconfig.ronn create mode 100644 confluent_client/doc/man/nodedefine.ronn create mode 100644 confluent_client/doc/man/noderemove.ronn create mode 100644 confluent_client/doc/man/nodereseat.ronn diff --git a/confluent_client/doc/man/nodeconfig.ronn b/confluent_client/doc/man/nodeconfig.ronn new file mode 100644 index 00000000..8f7919f2 --- /dev/null +++ b/confluent_client/doc/man/nodeconfig.ronn @@ -0,0 +1,33 @@ +nodeconfig(8) -- Show or change node configuration +================================================== + +## SYNOPSIS + +`nodecanfig [..]` +`nodecanfig [..]` + +## DESCRIPTION + +**nodeconfig** manages the configuration of nodes managed by confluent. +Rather than manipulating the confluent database, this actually modifies the +running configuration on the node firmware. Calling without '=' will show the +current value, and '=' will change the value. Network information can be +given as a node expression, as documented in the man page for nodeattribexpressions(5). + +## EXAMPLES +* Showing the current IP configuration of noderange BMC/IMM/XCC: + `# nodeconfig s3,s4 bmc` + `s3: bmc.ipv4_address: 172.30.254.193/16` + `s3: bmc.ipv4_method: DHCP` + `s3: bmc.ipv4_gateway: 172.30.0.6` + `s4: bmc.ipv4_address: 172.30.254.192/16` + `s4: bmc.ipv4_method: DHCP` + `s4: bmc.ipv4_gateway: 172.30.0.6` + +* Changing nodes `s3` and `s4` to have the ip addressess 10.1.2.3 and 10.1.2.4 with a 16 bit subnet mask: + `# nodeconfig s3,s4 bmc.ipv4_address=10.1.2.{n1}/16` + +## SEE ALSO + +nodeattribexpressions(5) + diff --git a/confluent_client/doc/man/nodedefine.ronn b/confluent_client/doc/man/nodedefine.ronn new file mode 100644 index 00000000..6bd4e70c --- /dev/null +++ b/confluent_client/doc/man/nodedefine.ronn @@ -0,0 +1,28 @@ +nodedefine(8) -- Define new confluent nodes + +## SYNOPSIS + +`nodedefine [nodeattribute1=value1> ...]` + +## DESCRIPTION + +`nodedefine` allows the definition of new nodes for the confluent management +system. It has the same syntax as `nodeattrib(8)`, and the commands differ in +that `nodeattrib(8)` will error if a node does not exist. + +## EXAMPLES + +* Define two racks of nodes, named r{rack}u{u}: + `# nodedefine r1u1-r2u4` + `r1u4: created` + `r1u1: created` + `r1u2: created` + `r1u3: created` + `r2u4: created` + `r2u3: created` + `r2u2: created` + `r2u1: created` + +## SEE ALSO + +noderange(5), nodeattribexpressions(8) diff --git a/confluent_client/doc/man/noderemove.ronn b/confluent_client/doc/man/noderemove.ronn new file mode 100644 index 00000000..0fd1b48e --- /dev/null +++ b/confluent_client/doc/man/noderemove.ronn @@ -0,0 +1,25 @@ +noderemove(8) -- Remove nodes from the confluent management service +=================================================================== + +## SYNOPSIS + +`noderemove ` + +## DESCRIPTION + +`noderemove` simply removes the given noderange from the confluent database. + + +## EXAMPLES + +* Remove two racks each with 4 nodes: + `# noderemove r1u1-r2u4` + `r1u4: deleted` + `r1u1: deleted` + `r1u2: deleted` + `r1u3: deleted` + `r2u4: deleted` + `r2u3: deleted` + `r2u2: deleted` + `r2u1: deleted` + diff --git a/confluent_client/doc/man/nodereseat.ronn b/confluent_client/doc/man/nodereseat.ronn new file mode 100644 index 00000000..09b45286 --- /dev/null +++ b/confluent_client/doc/man/nodereseat.ronn @@ -0,0 +1,19 @@ +nodereseat(8) -- Request a reseat of a node +============================================ + +## SYNOPSIS + +`nodereseat ` + +## DESCRIPTION + +`nodereseat` requests the enclosure manager of the current node to reseat that +node's slot. This should be equivalent to removing the system entirely from +the chassis and putting it back in, but without actually having to do so. + +## EXAMPLES + +* Reseating the node `s1`: + `# nodereseat s1` + `s1: Reseat successful` +