diff --git a/confluent_client/doc/man/confluent2ansible.ronn b/confluent_client/doc/man/confluent2ansible.ronn new file mode 100644 index 00000000..e9d9a5f1 --- /dev/null +++ b/confluent_client/doc/man/confluent2ansible.ronn @@ -0,0 +1,35 @@ +confluent2ansible(8) -- Export confluent node inventory to an Ansible hosts file +================================================================================ + +## SYNOPSIS + +`confluent2ansible -o ` [`-a`] + +## DESCRIPTION + +`confluent2ansible` reads the nodes matched by `` from confluent and +writes a corresponding Ansible inventory (hosts) file, allowing an existing +confluent inventory to be used directly by Ansible. + +## OPTIONS + +* `-o FILE`, `--output=FILE`: + Write the Ansible hosts file to FILE. + +* `-a`, `--append`: + Append to an existing hosts file rather than overwriting it. + +* `-h`, `--help`: + Show help message and exit + +## EXAMPLES + +* Write an Ansible hosts file for the compute group: + `# confluent2ansible compute -o /etc/ansible/hosts` + +* Append a rack to an existing hosts file: + `# confluent2ansible rack3 -o /etc/ansible/hosts -a` + +## SEE ALSO + +confluent2xcat(8), confluent2lxca(8), nodelist(8) diff --git a/confluent_client/doc/man/confluent2lxca.ronn b/confluent_client/doc/man/confluent2lxca.ronn new file mode 100644 index 00000000..05f09c5e --- /dev/null +++ b/confluent_client/doc/man/confluent2lxca.ronn @@ -0,0 +1,30 @@ +confluent2lxca(8) -- Export confluent nodes to a Lenovo XClarity Administrator bulk import file +============================================================================================== + +## SYNOPSIS + +`confluent2lxca -o ` + +## DESCRIPTION + +`confluent2lxca` reads the nodes matched by `` from confluent and +writes a CSV file suitable for bulk import into Lenovo XClarity Administrator +(LXCA), so that hardware already known to confluent can be brought under LXCA +management. + +## OPTIONS + +* `-o FILE`, `--output=FILE`: + Write the XClarity Administrator bulk import CSV to FILE. + +* `-h`, `--help`: + Show help message and exit + +## EXAMPLES + +* Generate a bulk import file for all nodes: + `# confluent2lxca everything -o bulkimport.csv` + +## SEE ALSO + +confluent2xcat(8), confluent2ansible(8), nodelist(8) diff --git a/confluent_client/doc/man/confluent2xcat.ronn b/confluent_client/doc/man/confluent2xcat.ronn new file mode 100644 index 00000000..e6eea202 --- /dev/null +++ b/confluent_client/doc/man/confluent2xcat.ronn @@ -0,0 +1,36 @@ +confluent2xcat(8) -- Export confluent nodes to an xCAT stanza definition +======================================================================== + +## SYNOPSIS + +`confluent2xcat -o ` [`-m `] + +## DESCRIPTION + +`confluent2xcat` reads the nodes matched by `` from confluent and +writes an xCAT object definition stanza file, easing interoperation with or +migration to/from an xCAT environment. Optionally it can also write an xCAT +`macs.csv` file capturing the MAC addresses of the nodes. + +## OPTIONS + +* `-o FILE`, `--output=FILE`: + Write the xCAT stanza definition to FILE. + +* `-m FILE`, `--macs=FILE`: + Write an xCAT macs.csv file to FILE. + +* `-h`, `--help`: + Show help message and exit + +## EXAMPLES + +* Export all nodes to an xCAT stanza file: + `# confluent2xcat everything -o xcatnodes.def` + +* Also capture MAC addresses: + `# confluent2xcat everything -o xcatnodes.def -m macs.csv` + +## SEE ALSO + +confluent2ansible(8), confluent2lxca(8), nodelist(8) diff --git a/confluent_client/doc/man/dir2img.ronn b/confluent_client/doc/man/dir2img.ronn new file mode 100644 index 00000000..6e3dabac --- /dev/null +++ b/confluent_client/doc/man/dir2img.ronn @@ -0,0 +1,41 @@ +dir2img(8) -- Create a disk image from a directory for nodemedia upload +======================================================================= + +## SYNOPSIS + +`dir2img` [`-e `] [`-s `] ` ` [`