From fc81e91d3fb3bc15fc8d1b6e93be7639219bd89b Mon Sep 17 00:00:00 2001 From: lissav Date: Mon, 7 Jan 2008 17:37:19 +0000 Subject: [PATCH] Add pods for new commands git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@214 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client-2.0/pods/man1/lslpp.1.pod | 117 +++++++++++++++++ xCAT-client-2.0/pods/man1/makedhcp.1.pod | 52 ++++++++ xCAT-client-2.0/pods/man1/rscan.1.pod | 152 +++++++++++++++++++++++ 3 files changed, 321 insertions(+) create mode 100644 xCAT-client-2.0/pods/man1/lslpp.1.pod create mode 100644 xCAT-client-2.0/pods/man1/makedhcp.1.pod create mode 100644 xCAT-client-2.0/pods/man1/rscan.1.pod diff --git a/xCAT-client-2.0/pods/man1/lslpp.1.pod b/xCAT-client-2.0/pods/man1/lslpp.1.pod new file mode 100644 index 000000000..2458b5d9e --- /dev/null +++ b/xCAT-client-2.0/pods/man1/lslpp.1.pod @@ -0,0 +1,117 @@ +=head1 NAME + +B - Queries selected networked services configuration information. + +=head1 SYNOPSIS + +I + +I + + +I + + +=head1 DESCRIPTION + +The lsslp command queries selected service types using the -s flag. All service types are returned if the -s flag is not specified. If a specific broadcast address is not specified using the -b flag, the broadcast is performed out all broadcast enabled network adapters. The optional -r, -x, and -z flags format the output. + + +=head1 OPTIONS + + +B<-b> IP(s) the command will broadcast out. + +B<-h> Display usage message. + +B<-r> Raw slp response. + +B<-s> Service type interested in discovering. + +B<-v> Command Version. + +B<-V> Verbose output. + +B<-w> Writes output to xCAT database. + +B<-x> XML format. + +B<-z> Stanza formated output. + + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +1. To list all discovered HMC service types in tabular format, enter: + +I + +Output is similar to: + +device type-model serial-number ip-addresses + +HMC 7310CR2 103F55A 1.1.1.115 2.2.2.164 3.3.3.102 + +HMC 7310CR2 105369A 3.3.3.103 2.2.2.103 1.1.1.163 + +HMC 7310CR3 KPHHK24 3.3.3.154 2.2.2.110 1.1.1.154 + + +2. list all discovered FSP service types in raw response format on subnet 30.0.0.255, enter: + +I< lsslp -b 3.0.0.255 -s FSP -r> + +Output is similar to: + +(type=cec-service-processor),(serial-number=10A3AEB),(machinetype-model=9117-570),(fru-serial-number=YL11C5338102),(hostname=),(frame-number=0),(cage-number=0),(ip-address=3.0.0.94,1.1.1.147),(web-url=https://3.0.0.94:473 ), (slot=1),(bpc-machinetype-model=0),(bpc-serial-number=0),(Image=fips240/b0630a_0623.240) + +(type=cec-service-processor),(serial-number=10A3E2B),(machinetype-model=9117-570),(fru-serial- number=YL11C5338250),(hostname=),(frame-number=0),(cage-number=0),(ip-address=3.0.0.95,1.1.1.147), (web-url=https://3.0.0.95:473 ),(slot=1),(bpc-machinetype-model=0),(bpc-serial-number=0),(Image=fips240/b0630a_0623.240) + + + +3. To list all discovered MM service types in XML format and write the output to the xCAT database, enter: + +I + + + MM + mm01 + 1.1.1.19 + 78AG034 + 86772XX + + + +4. To list all discovered MM service types in stanza format and write the output to the xCAT database, enter: + +I + + Output is similar to: + + mm01: + objtype=node + device=MM + type-model=86772XX + serial-number=78AG034 + ip-addresses=1.1.1.19 + + + + +=head1 FILES + +/opt/xcat/bin/lslpp + + +=head1 NOTES + +This command is part of the xCAT software product. + + + diff --git a/xCAT-client-2.0/pods/man1/makedhcp.1.pod b/xCAT-client-2.0/pods/man1/makedhcp.1.pod new file mode 100644 index 000000000..e3be85bbf --- /dev/null +++ b/xCAT-client-2.0/pods/man1/makedhcp.1.pod @@ -0,0 +1,52 @@ +=head1 NAME + +B -Creates new dhcp configuration files and updates live dhcp configuration using omapi. + +=head1 SYNOPSIS + +I + +I + +I + + +=head1 DESCRIPTION + +The makedhcp command with the -n option will create a dhcpd.conf file to allow xCAT to manage the DHCP configuration, including certain general parameters such as a dynamic range and omapi configuration. With a noderange, makedhcp will inject configuration data pertinent to the specified nodes that immediately takes effect without a reset. + +=head1 OPTIONS + + + +B<-h> Display usage message. + +B<-n> Create a new dhcpd.conf file. + +B<-s> For the input noderange, the argument will be interpreted like dhcpd.conf text. + + + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +1. The following example, will cause dhcp on the next request to set root-path appropriately for only node5. Note some characters (e.g. ") must be doubly escaped (once for the shell, and once for the OMAPI layer). + +I + + + +=head1 FILES + +/opt/xcat/bin/mkdhcp + + +=head1 NOTES + +This command is part of the xCAT software product. + diff --git a/xCAT-client-2.0/pods/man1/rscan.1.pod b/xCAT-client-2.0/pods/man1/rscan.1.pod new file mode 100644 index 000000000..9fb1713c6 --- /dev/null +++ b/xCAT-client-2.0/pods/man1/rscan.1.pod @@ -0,0 +1,152 @@ +=head1 NAME + +B - Collects node information from one or more hardware control points. + +=head1 SYNOPSIS + +I + +I + +I + + +=head1 DESCRIPTION + +The rscan command lists hardware information for each node managed by the hardware control points specified in noderange. + +Note that the first line of the output always contains information about the hardware control point itself. When using the rscan command to generate output for HMC or IVM hardware control points, note that FSPs and BPAs are included in the output. + + + +=head1 OPTIONS + + + +B<-h> Display usage message. + +B<-v> Command Version. + +B<-V> Verbose output. + +B<-w> Writes output to xCAT database. + +B<-x> XML format. + +B<-z> Stanza formated output. + + +=head1 RETURN VALUE + + 0 The command completed successfully. + + 1 An error has occurred. + +=head1 EXAMPLES + +1. To list all nodes managed by HMC hmc01 in tabular format, enter: + +I + + +Output is similar to: + + type name id type-model serial-number address + + hmc hmc01 7310-C05 10F426A hmc01 + fsp Server-9117-MMA-SN10F6F3D 9117-MMA 10F6F3D 3.3.3.197 + lpar lpar3 4 9117-MMA 10F6F3D + lpar lpar2 3 9117-MMA 10F6F3D + lpar lpar1 2 9117-MMA 10F6F3D + lpar p6vios 1 9117-MMA 10F6F3D + + +2.To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter: + +I + + + Output is similar to: + + +
ivm02
+ + ivm02 + 10B7D1G + ivm + 9133-55A + + + +
3.3.3.91
+ + Server-9133-55A-SN10B7D1G + 10B7D1G + fsp + 9133-55A + + + +
+ 1 + 10-B7D1G + 10B7D1G + lpar + 9133-55A + + + +
+ 2 + lp2 + 10B7D1G + lpar + 9133-55A + + + + +3. To list all nodes managed by Management Module mm03 in stanza format and write the output to the xCAT database, enter: + + +I + +