xcat-core/xCAT-client-2.0/share/man/man1/getmacs.1
sakolish 12757922a3 Initial draft
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@460 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2008-02-13 13:55:29 +00:00

208 lines
5.9 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 "GETMACS.1 1"
.TH GETMACS.1 1 "2008-02-13" "perl v5.8.3" "User Contributed Perl Documentation"
.SH "NAME"
\&\fBgetmacs\fR \- Collects node MAC address.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIgetmacs [\-h| \-\-help]\fR
.PP
\&\fIgetmacs [\-v| \-\-version]\fR
.PP
\&\fIgetmacs [\-V| \-\-verbose] noderange\fR [\-c][\-S server \-G gateway \-C client]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The getmacs command collects \s-1MAC\s0 address from a single or range of nodes.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-c\fR Colon seperated output.
.PP
\&\fB\-C\fR \s-1IP\s0 address of the partition.
.PP
\&\fB\-G\fR Gateway \s-1IP\s0 address of the partition specified with the \-C option.
.PP
\&\fB\-h\fR Display usage message.
.PP
\&\fB\-S\fR The \s-1IP\s0 address of the machine to ping.
.PP
\&\fB\-v\fR Command Version.
.PP
\&\fB\-V\fR Verbose 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 retrieve the \s-1MAC\s0 address for the HMC-managed partition lpar4, enter:
.PP
\&\fIgetmacs lpar4\fR
.PP
Output is similar to:
.PP
lpar4:
.PP
#Type Location Code \s-1MAC\s0 Address Full Path Name Ping Result
.PP
ent U9133.55A.10B7D1G\-V12\-C4\-T1 8ee2245cf004 /vdevice/l\-lan@30000004 virtual
.PP
2. To retrieve the \s-1MAC\s0 address for the HMC-managed partition lpar4 and display trhe result in colon-seperated format, enter:
.PP
\&\fIgetmacs lpar4 \-c\fR
.PP
Output is similar to:
.PP
lpar4:
.PP
#Type:Location_Code:MAC_Address:Full_Path_Name:Ping_Result:Device_Type:Size_MB:OS:OS_Version:
.PP
ent:U9133.55A.10B7D1G\-V12\-C4\-T1:8ee2245cf004:/vdevice/l\-lan@30000004::virtual::::
.PP
3. To retrieve the \s-1MAC\s0 address while performing a ping test for the HMC-managed partition lpar4 and display the result in colon-seperated format, enter:
.PP
\&\fIgetmacs lpar4 \-c \-S 9.3.6.49 \-G 9.3.6.1 \-C 9.3.6.234\fR
.PP
#Type:Location_Code:MAC_Address:Full_Path_Name:Ping_Result:Device_Type:Size_MB:OS:OS_Version:
.PP
ent:U9133.55A.10B7D1G\-V12\-C4\-T1:8ee2245cf004:/vdevice/l\-lan@30000004:successful:virtual::::
.SH "FILES"
.IX Header "FILES"
/opt/xcat/bin/getmac
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.