From a1a44a916a4476e9051589e8d2506397f352448c Mon Sep 17 00:00:00 2001 From: lissav Date: Mon, 7 Jan 2008 17:38:01 +0000 Subject: [PATCH] Add man pages for new commands git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@215 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd --- xCAT-client-2.0/share/man/man1/lslpp.1 | 239 ++++++++++++++++++ xCAT-client-2.0/share/man/man1/makedhcp.1 | 177 ++++++++++++++ xCAT-client-2.0/share/man/man1/rscan.1 | 281 ++++++++++++++++++++++ 3 files changed, 697 insertions(+) create mode 100644 xCAT-client-2.0/share/man/man1/lslpp.1 create mode 100644 xCAT-client-2.0/share/man/man1/makedhcp.1 create mode 100644 xCAT-client-2.0/share/man/man1/rscan.1 diff --git a/xCAT-client-2.0/share/man/man1/lslpp.1 b/xCAT-client-2.0/share/man/man1/lslpp.1 new file mode 100644 index 000000000..0b0438359 --- /dev/null +++ b/xCAT-client-2.0/share/man/man1/lslpp.1 @@ -0,0 +1,239 @@ +.\" Automatically generated by Pod::Man version 1.02 +.\" Mon Jan 7 07:24:43 2008 +.\" +.\" Standard preamble: +.\" ====================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R + +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used +.\" to do unbreakable dashes and therefore won't be available. \*(C` and +.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` ` +. ds C' ' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr +.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and +.\" index entries marked with X<> in POD. Of course, you'll have to process +.\" the output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +. . +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it +.\" makes way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ====================================================================== +.\" +.IX Title "LSLPP.1 1" +.TH LSLPP.1 1 "perl v5.6.0" "2008-01-07" "User Contributed Perl Documentation" +.UC +.SH "NAME" +\&\fBlslpp\fR \- Queries selected networked services configuration information. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fIlsslp [\-h|\-\-help]\fR +.PP +\&\fIlsslp [\-v|\-\-version]\fR +.PP +\&\fIlsslp [\-V|\-\-verbose] [\-b ip[,ip..]][\-w][\-r|\-x|\-z][\-s BPA|MM|IVM|RSA|FSP|HMC]\fR +.SH "DESCRIPTION" +.IX Header "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. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fB\-b\fR \fIIP\fR\|(s) the command will broadcast out. +.PP +\&\fB\-h\fR Display usage message. +.PP +\&\fB\-r\fR Raw slp response. +.PP +\&\fB\-s\fR Service type interested in discovering. +.PP +\&\fB\-v\fR Command Version. +.PP +\&\fB\-V\fR Verbose output. +.PP +\&\fB\-w\fR Writes output to xCAT database. +.PP +\&\fB\-x\fR \s-1XML\s0 format. +.PP +\&\fB\-z\fR Stanza formated output. +.SH "RETURN VALUE" +.IX Header "RETURN VALUE" +0 The command completed successfully. +.PP +1 An error has occurred. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +1. To list all discovered \s-1HMC\s0 service types in tabular format, enter: +.PP +\&\fIlsslp \-s \s-1HMC\s0\fR +.PP +Output is similar to: +.PP +device type-model serial-number ip-addresses +.PP +\&\s-1HMC\s0 7310CR2 103F55A 1.1.1.115 2.2.2.164 3.3.3.102 +.PP +\&\s-1HMC\s0 7310CR2 105369A 3.3.3.103 2.2.2.103 1.1.1.163 +.PP +\&\s-1HMC\s0 7310CR3 \s-1KPHHK24\s0 3.3.3.154 2.2.2.110 1.1.1.154 +.PP +2. list all discovered \s-1FSP\s0 service types in raw response format on subnet 30.0.0.255, enter: +.PP +\&\fI lsslp \-b 3.0.0.255 \-s \s-1FSP\s0 \-r\fR +.PP +Output is similar to: +.PP +(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) +.PP +(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) +.PP +3. To list all discovered \s-1MM\s0 service types in \s-1XML\s0 format and write the output to the xCAT database, enter: +.PP +I +.PP +.Vb 8 +\& +\& MM +\& mm01 +\& 1.1.1.19 +\& 78AG034 +\& 86772XX +\& +.Ve +4. To list all discovered \s-1MM\s0 service types in stanza format and write the output to the xCAT database, enter: +.PP +\&\fIlsslp \-s \s-1MM\s0 \-z \-w\fR +.PP +.Vb 1 +\& Output is similar to: +.Ve +.Vb 6 +\& mm01: +\& objtype=node +\& device=MM +\& type-model=86772XX +\& serial-number=78AG034 +\& ip-addresses=1.1.1.19 +.Ve +.SH "FILES" +.IX Header "FILES" +/opt/xcat/bin/lslpp +.SH "NOTES" +.IX Header "NOTES" +This command is part of the xCAT software product. diff --git a/xCAT-client-2.0/share/man/man1/makedhcp.1 b/xCAT-client-2.0/share/man/man1/makedhcp.1 new file mode 100644 index 000000000..3feea0a33 --- /dev/null +++ b/xCAT-client-2.0/share/man/man1/makedhcp.1 @@ -0,0 +1,177 @@ +.\" Automatically generated by Pod::Man version 1.02 +.\" Mon Jan 7 12:30:59 2008 +.\" +.\" Standard preamble: +.\" ====================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R + +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used +.\" to do unbreakable dashes and therefore won't be available. \*(C` and +.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` ` +. ds C' ' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr +.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and +.\" index entries marked with X<> in POD. Of course, you'll have to process +.\" the output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +. . +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it +.\" makes way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ====================================================================== +.\" +.IX Title "MAKEDHCP.1 1" +.TH MAKEDHCP.1 1 "perl v5.6.0" "2008-01-07" "User Contributed Perl Documentation" +.UC +.SH "NAME" +\&\fBmakedhcp\fR \-Creates new dhcp configuration files and updates live dhcp configuration using omapi. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fImakedhcp [h|\-\-help]\fR +.PP +\&\fImakedhcp [\-n]\fR +.PP +\&\fImakedhcp noderange [\-s statements]\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The makedhcp command with the \-n option will create a dhcpd.conf file to allow xCAT to manage the \s-1DHCP\s0 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. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fB\-h\fR Display usage message. +.PP +\&\fB\-n\fR Create a new dhcpd.conf file. +.PP +\&\fB\-s\fR For the input noderange, the argument will be interpreted like dhcpd.conf text. +.SH "RETURN VALUE" +.IX Header "RETURN VALUE" +0 The command completed successfully. +.PP +1 An error has occurred. +.SH "EXAMPLES" +.IX Header "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 \s-1OMAPI\s0 layer). +.PP +\&\fImakedhcp node5 \-s 'option root-path \e\*(L"172.16.0.1:/install/freebsd6.2/x86_64\e\*(R";'\fR +.SH "FILES" +.IX Header "FILES" +/opt/xcat/bin/mkdhcp +.SH "NOTES" +.IX Header "NOTES" +This command is part of the xCAT software product. diff --git a/xCAT-client-2.0/share/man/man1/rscan.1 b/xCAT-client-2.0/share/man/man1/rscan.1 new file mode 100644 index 000000000..4373a9677 --- /dev/null +++ b/xCAT-client-2.0/share/man/man1/rscan.1 @@ -0,0 +1,281 @@ +.\" Automatically generated by Pod::Man version 1.02 +.\" Mon Jan 7 07:52:47 2008 +.\" +.\" Standard preamble: +.\" ====================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R + +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used +.\" to do unbreakable dashes and therefore won't be available. \*(C` and +.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` ` +. ds C' ' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr +.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and +.\" index entries marked with X<> in POD. Of course, you'll have to process +.\" the output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +. . +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it +.\" makes way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +.bd B 3 +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ====================================================================== +.\" +.IX Title "RSCAN.1 1" +.TH RSCAN.1 1 "perl v5.6.0" "2008-01-07" "User Contributed Perl Documentation" +.UC +.SH "NAME" +\&\fBrscan\fR \- Collects node information from one or more hardware control points. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fIrscan [\-h|\-\-help]\fR +.PP +\&\fIrscan [\-v|\-\-version]\fR +.PP +\&\fIrscan [\-V|\-\-verbose] noderange [\-w][\-x|\-z]\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The rscan command lists hardware information for each node managed by the hardware control points specified in noderange. +.PP +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 \s-1HMC\s0 or \s-1IVM\s0 hardware control points, note that FSPs and BPAs are included in the output. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fB\-h\fR Display usage message. +.PP +\&\fB\-v\fR Command Version. +.PP +\&\fB\-V\fR Verbose output. +.PP +\&\fB\-w\fR Writes output to xCAT database. +.PP +\&\fB\-x\fR \s-1XML\s0 format. +.PP +\&\fB\-z\fR Stanza formated output. +.SH "RETURN VALUE" +.IX Header "RETURN VALUE" +.Vb 1 +\& 0 The command completed successfully. +.Ve +.Vb 1 +\& 1 An error has occurred. +.Ve +.SH "EXAMPLES" +.IX Header "EXAMPLES" +1. To list all nodes managed by \s-1HMC\s0 hmc01 in tabular format, enter: +.PP +\&\fIrscan hmc01\fR +.PP +Output is similar to: +.PP +.Vb 1 +\& type name id type-model serial-number address +.Ve +.Vb 6 +\& 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 +.Ve +2.To list all nodes managed by \s-1IVM\s0 ivm02 in \s-1XML\s0 format and write the output to the xCAT database, enter: +.PP +\&\fIrscan ivm02 \-x \-w\fR +.PP +.Vb 1 +\& Output is similar to: +.Ve +.Vb 8 +\& +\&
ivm02
+\& +\& ivm02 +\& 10B7D1G +\& ivm +\& 9133-55A +\& +.Ve +.Vb 8 +\& +\&
3.3.3.91
+\& +\& Server-9133-55A-SN10B7D1G +\& 10B7D1G +\& fsp +\& 9133-55A +\& +.Ve +.Vb 8 +\& +\&
+\& 1 +\& 10-B7D1G +\& 10B7D1G +\& lpar +\& 9133-55A +\& +.Ve +.Vb 8 +\& +\&
+\& 2 +\& lp2 +\& 10B7D1G +\& lpar +\& 9133-55A +\& +.Ve +3. To list all nodes managed by Management Module mm03 in stanza format and write the output to the xCAT database, enter: +.PP +I +.PP +.Vb 1 +\&