xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-21 10:40:24 +00:00
Code Issues Releases Wiki Activity

Adding man pages for mkdef, chdef, lsdef, rmdef

Browse Source 
and also for the xCAT stanza file format.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@101 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
nott
2007-11-29 20:45:11 +00:00
parent 7c2453afb6
commit 3984f3f0a9
5 changed files with 1069 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

208
xCAT-client-2.0/share/man/man1/chdef.1 Normal file
View File

@@ -0,0 +1,208 @@
.\" 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 "CHDEF.1 1"
.TH CHDEF.1 1 "2007-11-30" "perl v5.8.2" "User Contributed Perl Documentation"
.SH "NAME"
\&\fBchdef\fR \- Change xCAT data object definitions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIchdef [\-h | \-\-help ] [\-t object\-types]\fR
.PP
\&\fIchdef [\-V | \-\-verbose] [\-t object\-types] [\-o object\-names]\fR
\&\fI[\-z | \-\-stanza ] [\-x | \-\-xml ] [\-w attr=val,[attr=val...]]\fR
\&\fI[noderange] [attr=val [attr=val...]] \fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to change xCAT object definitions which are stored in the xCAT database. The default is to replace any existing attribute value with the one specified on the command line. The command will also create a new definition if one doesn't exist.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fBattr=val [attr=val ...]\fR Specifies one or more \*(L"attribute equals value\*(R" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. Use the help option to get a list of valid attributes for each object type.
.PP
\&\fB\-h |\-\-help\fR Display usage message.
.PP
\&\fB\-m |\-\-minus\fR If the value of the attribute is a list then this option may be used to remove one or more items from the list.
.PP
\&\fBnoderange\fR A set of comma delimited node names and/or group names. (must be the first parameter) See the \*(L"noderange\*(R" man page for details on supported formats.
.PP
\&\fB\-o object-names\fR A set of comma delimited object names.
.PP
\&\fB\-p |\-\-plus\fR This option will add the specified values to the existing value of the attribute. It will create a comma-separated list of values.
.PP
\&\fB\-t object-types\fR A set of comma delimited object types. Use the help option to get a list of valid object types.
.PP
\&\fB\-V |\-\-verbose\fR Verbose mode.
.PP
\&\fB\-w attr=val,[attr=val...]\fR A comma-separated list of attributes and values that can be used to select objects. Use the help option to get a list of validattributes for each object type.
.PP
\&\fB\-x | \-\-xml\fR Indicates that the file being piped to the command is in \s-1XML\s0 format.
.PP
\&\fB\-z | \-\-stanza\fR Indicates that the file being piped to the command is in stanza format.
.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 change a site definition.
.PP
\&\fIchdef \-t site \-o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall\fR
.PP
2. To change a basic node definition.
.PP
\&\fIchdef \-t node \-o node01 groups=\*(L"all,aix\*(R"\fR
.PP
(The group definitions are also created if they don't already exist.)
.PP
3. To add another group to the \*(L"groups\*(R" attribute in the previous example.
.PP
\&\fIchdef \-p \-t node \-o node01 groups=\*(L"compute\*(R"\fR
.PP
4. To remove the \*(L"all\*(R" group from the \*(L"groups\*(R" attribute in the previous example.
.PP
\&\fIchdef \-m \-t node \-o node01 groups=\*(L"all\*(R"\fR
.PP
5. To replace the current \*(L"groups\*(R" attribute value of \*(L"node01\*(R".
.PP
\&\fIchdef \-t node \-o node01 groups=\*(L"linux\*(R"\fR
.PP
6. To add \*(L"node01\*(R" to the \*(L"memberslist\*(R" attribute of a group definition called \*(L"LinuxNodes\*(R".
.PP
\&\fIchdef \-p \-t group \-o LinuxNodes memberlist=\*(L"node01\*(R"\fR
.SH "FILES"
.IX Header "FILES"
/usr/sbin/chdef
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the mkdef, lsdef and rmdef commands.

224
xCAT-client-2.0/share/man/man1/lsdef.1 Normal file
View File

@@ -0,0 +1,224 @@
.\" 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 "LSDEF.1 1"
.TH LSDEF.1 1 "2007-11-30" "perl v5.8.2" "User Contributed Perl Documentation"
.SH "NAME"
\&\fBlsdef\fR \- Use this command to list xCAT data object definitions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIlsdef [\-h | \-\-help ] [\-t object\-types]\fR
.PP
\&\fIlsdef [\-V | \-\-verbose] [ \-l | \-\-long] [\-a | \-\-all] [\-t object\-types] \fR
\&\fI[\-o object\-names] [\-z | \-\-stanza] [\-x | \-\-xml] [\-i attr\-list]\fR
\&\fI[\-w attr=val,[attr=val...] [noderange]\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to display xCAT object definitions which are stored
in the xCAT database.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-a | \-\-all\fR Display all definitions.
.PP
\&\fB\-h|\-\-help\fR Display usage message.
.PP
\&\fB\-i attr-list\fR Comma separated list of attribute names to display.
.PP
\&\fB\-l | \-\-long\fR List the complete object definition. (The default for some options is to give only a list of object names.)
.PP
\&\fBnoderange\fR A set of comma delimited node names and/or group names.
See the \*(L"noderange\*(R" man page for details on supported formats.
.PP
\&\fB\-o object-names\fR A set of comma delimited object names.
.PP
\&\fB\-t object-types\fR A set of comma delimited object types. Use the help option to get a list of valid objects.
.PP
\&\fB\-V|\-\-verbose\fR Verbose mode.
.PP
\&\fB\-w attr=val,[attr=val...]\fR A comma-separated list of attributes and values that can be used to select items to display. Use the help option to get a list of valid attributes.
.PP
\&\fB\-x | \-\-xml\fR Display output in \s-1XML\s0 format.
.PP
\&\fB\-z | \-\-stanza\fR Display output in stanza format.
.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 get a list of all object names.
.PP
\&\fIlsdef \-a\fR
.PP
2. To get a list of all the network definitions.
.PP
\&\fIlsdef \-t network\fR
.PP
3. To get a complete listing of all network definitions.
.PP
\&\fIlsdef \-l \-t network \fR
.PP
4. To list the whole xCAT database and write it to a stanza file. (backup database)
.PP
\&\fIlsdef \-a \-l \-z > mydbstanzafile\fR
.PP
5. To list the \s-1MAC\s0 and install adapter name for each node.
.PP
\&\fIlsdef \-t node \-i mac,installnic\fR
.PP
6. To list an osimage definition named \*(L"aix53J\*(R".
.PP
\&\fIlsdef \-t osimage \-l \-o aix53J\fR
.PP
7. To list all adapter definitions for node \*(L"clstrn03\*(R".
.PP
\&\fIlsdef \-t adapter \-w nodename=clstrn03\fR
.PP
8. To list all the attributes of the group \*(L"servicenodes\*(R".
.PP
\&\fIlsdef \-l \-t group \-o servicenodes\fR
.PP
9. To list all the attributes of the nodes that are members of the group \*(L"servicenodes\*(R".
.PP
\&\fIlsdef \-t node \-l servicenodes\fR
.PP
10. To list all nodes that have a service node called \*(L"\s-1FMS01\s0\*(R".
.PP
\&\fIlsdef \-t node \-w nfsserver=FMS01\fR
.SH "FILES"
.IX Header "FILES"
/usr/sbin/lsdef
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the mkdef, chdef and rmdef commands.

210
xCAT-client-2.0/share/man/man1/mkdef.1 Normal file
View File

@@ -0,0 +1,210 @@
.\" 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 "MKDEF.1 1"
.TH MKDEF.1 1 "2007-11-30" "perl v5.8.2" "User Contributed Perl Documentation"
.SH "NAME"
\&\fBmkdef\fR \- Use this command to create xCAT data object definitions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fImkdef [\-h | \-\-help ] [\-t object\-types]\fR
.PP
\&\fImkdef [\-V | \-\-verbose] [\-t object\-types] [\-o object\-names]\fR
\&\fI[\-z | \-\-stanza ] [\-x | \-\-xml] [\-f | \-\-force] [\-w attr=val,[attr=val...]]\fR
\&\fI[noderange] [attr=val [attr=val...]] \fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to create xCAT object definitions which are stored in the xCAT database. If the definition already exists it will return an error message. The force option may be used to re-create a definition. In this case the old definition will be remove and the new definition will be created.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fBattr=val [attr=val ...]\fR Specifies one or more \*(L"attribute equals value\*(R" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. Use the help option to get a list of valid attributes for each object type.
.PP
\&\fB\-f |\-\-force\fR Use the force option to re-create object definitions. This option removes the old definition before creating the new one.
.PP
\&\fB\-h |\-\-help\fR Display usage message.
.PP
\&\fBnoderange\fR A set of comma delimited node names and/or group names. (must be the first parameter) See the \*(L"noderange\*(R" man page for details on supported formats.
.PP
\&\fB\-o object-names\fR A set of comma delimited object names.
.PP
\&\fB\-t object-types\fR A set of comma delimited object types. Use the help option to get a list of valid object types.
.PP
\&\fB\-V |\-\-verbose\fR Verbose mode.
.PP
\&\fB\-w attr=val,[attr=val...]\fR A comma-separated list of attributes and values that can be used to select objects. Use the help option to get a list of validattributes for each object type.
.PP
\&\fB\-x | \-\-xml\fR Indicates that the file being piped to the command is in \s-1XML\s0 format.
.PP
\&\fB\-z | \-\-stanza\fR Indicates that the file being piped to the command is in stanza format.
.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 create a site definition.
.PP
\&\fImkdef \-t site \-o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall\fR
.PP
2. To create a basic node definition.
.PP
\&\fImkdef \-t node \-o node01 groups=\*(L"all,aix\*(R"\fR
.PP
3. To re-create the current definition of \*(L"node01\*(R".
.PP
\&\fImkdef \-f \-t node \-o node01 nodetype=osi groups=\*(L"linux\*(R"\fR
.PP
(The group definitions are also created if they don't already exist.)
.PP
4. To create a set of different types of definitions based on information contained in a stanza file.
.PP
\&\fIcat defstanzafile | mkdef \-z\fR
.PP
5. To create a group definition called LinuxNodes containing the nodes clstrn01 and clstrn02.
.PP
\&\fImkdef \-t group \-o LinuxNodes memberlist=\*(L"clstrn01,clstrn02\*(R"\fR
.PP
6. To create a node definition for an \s-1FSP\s0 node using the attributes provided by the group fspnodes.
.PP
\&\fImkdef \-t node fspn1 groups=fspnodes nodetype=fsp\fR
.PP
7. To create node definitions for a set of node host names contained in the node range \*(L"node1,node2,node3\*(R"
.PP
\&\fImkdef \-t node node1,node2,node3 power=hmc groups=\*(L"all,aix\*(R" \fR
.SH "FILES"
.IX Header "FILES"
/usr/sbin/mkdef
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the chdef, lsdef and rmdef commands.

195
xCAT-client-2.0/share/man/man1/rmdef.1 Normal file
View File

@@ -0,0 +1,195 @@
.\" 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 "RMDEF.1 1"
.TH RMDEF.1 1 "2007-11-30" "perl v5.8.2" "User Contributed Perl Documentation"
.SH "NAME"
\&\fBrmdef\fR \- Use this command to remove xCAT data object definitions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIrmdef [\-h | \-\-help ] [\-t object\-types]\fR
.PP
\&\fIrmdef [\-V | \-\-verbose] [\-a | \-\-all] [\-t object\-types] [\-o object\-names]\fR
\&\fI[\-f | \-\-force] [noderange]\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This command is used to remove xCAT object definitions that are stored in the xCAT database.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-a | \-\-all\fR Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option.
.PP
\&\fB\-f|\-\-force\fR Use this with the all option as an extra indicator that \s-1ALL\s0 definitions are to be removed.
.PP
\&\fB\-h|\-\-help\fR Display a usage message.
.PP
\&\fBnoderange\fR A set of comma delimited node names and/or group names. See the \*(L"noderange\*(R" man page for details on supported formats.
.PP
\&\fB\-o object-names\fR A set of comma delimited object names.
.PP
\&\fB\-t object-types\fR A set of comma delimited object types.
.PP
\&\fB\-V|\-\-verbose\fR Verbose mode.
.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 completely clear the xCAT database.
.PP
\&\fIrmdef \-f \-a\fR
.PP
2. To remove a range of node definitions.
.PP
\&\fIrmdef \-t node node1\-node4\fR
.PP
5. To remove all node and group definitions.
.PP
\&\fIrmdef \-t node,group\fR
.PP
6. To remove all node definitions for the nodes contained in the group bpcnodes.
.PP
\&\fIrmdef \-t node \-o bpcnodes\fR
.PP
7. To remove the group called bpcnodes.
.PP
\&\fIrmdef \-t group \-o bpcnodes\fR
.PP
(This will also update the values of the \*(L"groups\*(R" attribute of the member nodes.)
.SH "FILES"
.IX Header "FILES"
/usr/sbin/rmdef
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the mkdef, chdef and lsdef commands.

232
xCAT-client-2.0/share/man/man5/xcatstanzafile.5 Normal file
View File

@@ -0,0 +1,232 @@
.\" 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