xcat-core/xCAT-client-2.0/share/man/man1/rscan.1
sakolish 315406815b Reformatted example output
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@410 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2008-02-06 20:21:27 +00:00

281 lines
7.2 KiB
Groff

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" 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 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.
. \" 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 "2008-02-06" "perl v5.8.3" "User Contributed Perl Documentation"
.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
.PP
.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
.PP
.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
.PP
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
Output is similar to:
.PP
.Vb 8
\& <Node>
\& <address>ivm02</address>
\& <id></id>
\& <name>ivm02</name>
\& <serial-number>10B7D1G</serial-number>
\& <type>ivm</type>
\& <type-model>9133-55A</type-model>
\& </Node>
.Ve
.PP
.Vb 8
\& <Node>
\& <address>3.3.3.91</address>
\& <id></id>
\& <name>Server-9133-55A-SN10B7D1G</name>
\& <serial-number>10B7D1G</serial-number>
\& <type>fsp</type>
\& <type-model>9133-55A</type-model>
\& </Node>
.Ve
.PP
.Vb 8
\& <Node>
\& <address></address>
\& <id>1</id>
\& <name>10-B7D1G</name>
\& <serial-number>10B7D1G</serial-number>
\& <type>lpar</type>
\& <type-model>9133-55A</type-model>
\& </Node>
.Ve
.PP
.Vb 8
\& <Node>
\& <address></address>
\& <id>2</id>
\& <name>lp2</name>
\& <serial-number>10B7D1G</serial-number>
\& <type>lpar</type>
\& <type-model>9133-55A</type-model>
\& </Node>
.Ve
.PP
3. To list all nodes managed by Management Module mm03 in stanza format and write the output to the xCAT database, enter:
.PP
\&\fIrscan mm03 \-z \-w\fR
.PP
Output is similar to:
.PP
.Vb 7
\& SN#IBM:
\& objtype=node
\& type=mm
\& id=0
\& type-model=8852-22Z
\& serial-number=23A4328
\& address=mm01
.Ve
.PP
.Vb 7
\& blade1:
\& objtype=node
\& type=blade
\& id=1
\& type-model=8853-SWZ
\& serial-number=23AD188
\& address=
.Ve
.PP
.Vb 7
\& blade2:
\& objtype=node
\& type=blade
\& id=3
\& type-model=7971-6AZ
\& serial-number=23A0052
\& address=
.Ve
.SH "FILES"
.IX Header "FILES"
/opt/xcat/bin/rscan
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.