233 lines
7.0 KiB
Groff
233 lines
7.0 KiB
Groff
|
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
|
||
|
|
.\"
|
||
|
|
.\" 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 "XCATSTANZAFILE.5 1"
|
||
|
|
.TH XCATSTANZAFILE.5 1 "2007-11-15" "perl v5.8.2" "User Contributed Perl Documentation"
|
||
|
|
.SH "NAME"
|
||
|
|
\&\fBxcatstanzafile\fR \- Describes the format of a stanza file that can be used with xCAT commands.
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
A stanza file contains information that can be used to create xCAT data object definitions. A stanza file can be used as input to several xCAT commands. The stanza file contains one or more individual stanzas that provide information for individual object definitions. The following rules must be followed when creating a stanza file:
|
||
|
|
.PP
|
||
|
|
* An object stanza header consists of the object name followed by a colon, (\*(L":\*(R").
|
||
|
|
.PP
|
||
|
|
* Attribute lines must take the form of Attribute=Value.
|
||
|
|
.PP
|
||
|
|
* Only one stanza can exist for each object name.
|
||
|
|
.PP
|
||
|
|
* All stanzas except for default stanzas must have a value set for \*(L"objtype\*(R".
|
||
|
|
.PP
|
||
|
|
* Comments beginning with the \*(L"#\*(R" pound sign may be added to the file. A comment must be on a separate line.
|
||
|
|
.PP
|
||
|
|
* When parsing the file, tab characters and spaces are ignored.
|
||
|
|
.PP
|
||
|
|
* Each line of the file can have no more than one header or attribute definition.
|
||
|
|
.PP
|
||
|
|
* If the header name is \*(L"default\-<object type>:\*(R" the attribute values in the stanza are considered default values for subsequent definitions in the file that are the same object type.
|
||
|
|
.PP
|
||
|
|
* Default stanzas can be specified multiple times and at any point in a stanza file. The values apply to all definitions following the default stanzas in a file. The default values are cumulative; a default attribute value will remain set until it is explicitly unset or changed.
|
||
|
|
.PP
|
||
|
|
* To turn off a default value, use another default stanza to set the attribute to have no value using a blank space.
|
||
|
|
.PP
|
||
|
|
* When a specific value for an attribute is provided in the stanza, it takes priority over any default value that had been set.
|
||
|
|
.PP
|
||
|
|
The format of a stanza file should look similar to the following.
|
||
|
|
.PP
|
||
|
|
\&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
||
|
|
.PP
|
||
|
|
default\-<object type>:
|
||
|
|
attr=val
|
||
|
|
attr=val
|
||
|
|
. . .
|
||
|
|
.PP
|
||
|
|
<object name>:
|
||
|
|
objtype=<object type>
|
||
|
|
attr=val
|
||
|
|
attr=val
|
||
|
|
. . .
|
||
|
|
.PP
|
||
|
|
<object name>:
|
||
|
|
objtype=<object type>
|
||
|
|
attr=val
|
||
|
|
attr=val
|
||
|
|
. . .
|
||
|
|
.PP
|
||
|
|
\&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
1) Sample stanza file:
|
||
|
|
.PP
|
||
|
|
\&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
||
|
|
.PP
|
||
|
|
mysite:
|
||
|
|
objtype=site
|
||
|
|
rsh=/bin/rsh
|
||
|
|
rcp=/bin/rcp
|
||
|
|
installdir=/xcatinstall
|
||
|
|
domain=ppd.pok.ibm.com
|
||
|
|
.PP
|
||
|
|
MSnet01:
|
||
|
|
objtype=network
|
||
|
|
gateway=1.2.3.4
|
||
|
|
netmask=255.255.255.0
|
||
|
|
nameserver=5.6.7.8
|
||
|
|
.PP
|
||
|
|
default\-node:
|
||
|
|
next_osimage=aix61
|
||
|
|
network=MSnet01
|
||
|
|
groups=all,compute
|
||
|
|
.PP
|
||
|
|
node01:
|
||
|
|
objtype=node
|
||
|
|
MAC=A2E26002C003
|
||
|
|
xcatmaster=MS02.ppd.pok.com
|
||
|
|
nfsserver=IS227.ppd.pok.com
|
||
|
|
.PP
|
||
|
|
node02:
|
||
|
|
objtype=node
|
||
|
|
MAC=A2E26002B004
|
||
|
|
xcatmaster=MS01.ppd.pok.com
|
||
|
|
nfsserver=IS127.ppd.pok.com
|
||
|
|
.PP
|
||
|
|
grp01:
|
||
|
|
objtype=group
|
||
|
|
memberlist=node1,node2,node3
|
||
|
|
\&\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
||
|
|
.SH "NOTES"
|
||
|
|
.IX Header "NOTES"
|
||
|
|
.Vb 1
|
||
|
|
\& This file is part of xCAT software product.
|
||
|
|
.Ve
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
.Vb 1
|
||
|
|
\& See the mkdef, chdef, lsdef, and rmdef commands.
|
||
|
|
.Ve
|