arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed formatting of several pod files

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1516 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers 2008-05-28 21:07:33 +00:00
parent 3a5ea92bde
commit 3ac2fc7322
14 changed files with 463 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
xCAT-client-2.0/pods/man1/chdef.1.pod
View File

@ -1,15 +1,14 @@
=head1 NAME
B<chdef> - Change xCAT data object definitions.
=head1 SYNOPSIS
I<chdef [-h | --help ] [-t object-types]>
I<chdef [-V | --verbose] [-t object-types] [-o object-names]>
I<[-p |--plus] [-m |--minus] [-z | --stanza ] [-x | --xml ]>
I<[-w attr=val,[attr=val...]] [noderange]>
I<[attr=val [attr=val...]]>
B<chdef> - Change xCAT data object definitions.
=head1 SYNOPSIS
B<chdef> [B<-h>|B<--help>] [B<-t> I<object-types>]
B<chdef> [B<-V>|B<--verbose>] [B<-t> I<object-types>] [B<-o> I<object-names>]
[B<-p>|B<--plus>] [B<-m>|B<--minus>] [B<-z>|B<--stanza>] [B<-x>|B<--xml>]
[B<-w> I<attr>=I<val>,[I<attr>=I<val...>]] [I<noderange>] [I<attr>=I<val> [I<attr>=I<val...>]]
=head1 DESCRIPTION
@ -17,27 +16,53 @@ This command is used to change xCAT object definitions which are stored in the x
=head1 OPTIONS
B<attr=val [attr=val ...]> Specifies one or more "attribute equals value" 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.
=over 10
B<-h |--help> Display usage message.
=item I<attr=val [attr=val ...]>
B<-m |--minus> If the value of the attribute is a list then this option may be used to remove one or more items from the list.
Specifies one or more "attribute equals value" 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.
B<noderange> A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats.
=item B<-h|--help>
B<-o object-names> A set of comma delimited object names.
Display usage message.
B<-p |--plus> This option will add the specified values to the existing value of the attribute. It will create a comma-separated list of values.
=item B<-m|--minus>
B<-t object-types> A set of comma delimited object types. Use the help option to get a list of valid object types.
If the value of the attribute is a list then this option may be used to remove one or more items from the list.
B<-V |--verbose> Verbose mode.
=item I<noderange>
B<-w attr=val,[attr=val...]> 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.
A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats.
B<-x | --xml> Indicates that the file being piped to the command is in XML format.
=item B<-o> I<object-names>
B<-z | --stanza> Indicates that the file being piped to the command is in stanza format.
A set of comma delimited object names.
=item B<-p|--plus>
This option will add the specified values to the existing value of the attribute. It will create a comma-separated list of values.
=item B<-t> I<object-types>
A set of comma delimited object types. Use the help option to get a list of valid object types.
=item B<-V|--verbose>
Verbose mode.
=item B<-w> I<attr=val,[attr=val...]>
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.
=item B<-x|--xml>
Indicates that the file being piped to the command is in XML format.
=item B<-z|--stanza>
Indicates that the file being piped to the command is in stanza format.
=back
=head1 RETURN VALUE
@ -47,35 +72,51 @@ B<-z | --stanza> Indicates that the file being piped to the command is i
=head1 EXAMPLES
1. To change a site definition.
=over 3
I<chdef -t site -o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall>
=item 1.
2. To change a basic node definition.
To change a site definition.
I<chdef -t node -o node01 groups="all,aix">
chdef -t site -o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall
(The group definitions are also created if they don't already exist.)
=item 2.
3. To add another group to the "groups" attribute in the previous example.
To change a basic node definition.
I<chdef -p -t node -o node01 groups="compute">
chdef -t node -o node01 groups="all,aix"
4. To remove the "all" group from the "groups" attribute in the previous example.
(The group definitions are also created if they don't already exist.)
I<chdef -m -t node -o node01 groups="all">
=item 3.
5. To replace the current "groups" attribute value of "node01".
To add another group to the "groups" attribute in the previous example.
I<chdef -t node -o node01 groups="linux">
chdef -p -t node -o node01 groups="compute"
6. To add "node01" to the "memberslist" attribute of a group definition called "LinuxNodes".
=item 4.
I<chdef -p -t group -o LinuxNodes memberlist="node01">
To remove the "all" group from the "groups" attribute in the previous example.
chdef -m -t node -o node01 groups="all"
=item 5.
To replace the current "groups" attribute value of "node01".
chdef -t node -o node01 groups="linux"
=item 6.
To add "node01" to the "memberslist" attribute of a group definition called "LinuxNodes".
chdef -p -t group -o LinuxNodes memberlist="node01"
=back
=head1 FILES
$XCATROOT/bin/chdef
(The XCATROOT environment variable is set when xCAT is installed. The
@ -89,5 +130,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef, lsdef and rmdef commands.
See the mkdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands.

2
xCAT-client-2.0/pods/man1/gettab.1.pod
View File

@ -52,6 +52,7 @@ To display node names that have B<mgt> set to B<blade> in the nodehm table:
B<gettab> I<mgt=blade nodehm.node>
The output would be similar to:
nodehm.node: blades
=item *
@ -61,6 +62,7 @@ To display setting for B<master> (management node) in the site table:
B<gettab> I<key=master site.value>
The output would be similar to:
site.value: mgmtnode.cluster.com
=back

136
xCAT-client-2.0/pods/man1/lsdef.1.pod
View File

@ -1,96 +1,150 @@
=head1 NAME
B<lsdef> - Use this command to list xCAT data object definitions.
=head1 SYNOPSIS
I<lsdef [-h | --help ] [-t object-types]>
B<lsdef> [B<-h>|B<--help>] [B<-t> I<object-types>]
B<lsdef> [B<-V>|B<--verbose>] [B<-l>|B<--long>] [B<-a>|B<--all>] [B<-t> I<object-types>]
[B<-o> I<object-names>] [B<-z>|B<--stanza>] [B<-x>|B<--xml>] [B<-i> I<attr-list>]
[B<-w> I<attr>=I<val>,[I<attr>=I<val...>] [I<noderange>]
I<lsdef [-V | --verbose] [ -l | --long] [-a | --all] [-t object-types] >
I<[-o object-names] [-z | --stanza] [-x | --xml] [-i attr-list]>
I<[-w attr=val,[attr=val...] [noderange]>
=head1 DESCRIPTION
This command is used to display xCAT object definitions which are stored
This command is used to display xCAT object definitions which are stored
in the xCAT database.
=head1 OPTIONS
B<-a | --all> Display all definitions.
=over 10
B<-h|--help> Display usage message.
=item B<-a|--all>
B<-i attr-list> Comma separated list of attribute names to display.
Display all definitions.
B<-l | --long> List the complete object definition. (The default for some options is to give only a list of object names.)
=item B<-h|--help>
B<noderange> A set of comma delimited node names and/or group names.
Display usage message.
=item B<-i> I<attr-list>
Comma separated list of attribute names to display.
=item B<-l|--long>
List the complete object definition. (The default for some options is to give only a list of object names.)
=item I<noderange>
A set of comma delimited node names and/or group names.
See the "noderange" man page for details on supported formats.
B<-o object-names> A set of comma delimited object names.
=item B<-o> I<object-names>
B<-t object-types> A set of comma delimited object types. Use the help option to get a list of valid objects.
A set of comma delimited object names.
B<-V|--verbose> Verbose mode.
=item B<-t> I<object-types>
B<-w attr=val,[attr=val...]> 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.
A set of comma delimited object types. Use the help option to get a list of valid objects.
=item B<-V|--verbose>
Verbose mode.
=item B<-w> I<attr=val,[attr=val...]>
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.
=item B<-x|--xml>
Display output in XML format.
=item B<-z|--stanza>
Display output in stanza format.
=back
B<-x | --xml> Display output in XML format.
B<-z | --stanza> Display output in stanza format.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To get a list of all object names.
=over 4
I<lsdef -a>
=item 1.
2. To get a list of all the network definitions.
To get a list of all object names.
I<lsdef -t network>
lsdef -a
3. To get a complete listing of all network definitions.
=item 2.
I<lsdef -l -t network >
To get a list of all the network definitions.
4. To list the whole xCAT database and write it to a stanza file. (backup database)
lsdef -t network
I<< lsdef -a -l -z > mydbstanzafile >>
=item 3.
5. To list the MAC and install adapter name for each node.
To get a complete listing of all network definitions.
I<lsdef -t node -i mac,installnic>
lsdef -l -t network
6. To list an osimage definition named "aix53J".
=item 4.
I<lsdef -t osimage -l -o aix53J>
To list the whole xCAT database and write it to a stanza file. (backup database)
7. To list all adapter definitions for node "clstrn03".
lsdef -a -l -z > mydbstanzafile
I<lsdef -t adapter -w nodename=clstrn03>
=item 5.
8. To list all the attributes of the group "service".
To list the MAC and install adapter name for each node.
I<lsdef -l -t group -o service>
lsdef -t node -i mac,installnic
9. To list all the attributes of the nodes that are members of the group "service".
=item 6.
I<lsdef -t node -l service>
To list an osimage definition named "aix53J".
10. To list all nodes that have a service node called "FMS01".
lsdef -t osimage -l -o aix53J
=item 7.
To list all adapter definitions for node "clstrn03".
lsdef -t adapter -w nodename=clstrn03
=item 8.
To list all the attributes of the group "service".
lsdef -l -t group -o service
=item 9.
To list all the attributes of the nodes that are members of the group "service".
lsdef -t node -l service
=item 10.
To list all nodes that have a service node called "FMS01".
lsdef -t node -w nfsserver=FMS01
=back
I<lsdef -t node -w nfsserver=FMS01>
=head1 FILES
$XCATROOT/bin/lsdef
(The XCATROOT environment variable is set when xCAT is installed. The
@ -103,4 +157,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef, chdef and rmdef commands.
See the mkdef(1), chdef(1), rmdef(1), and xcatstanzafile(5) commands.

50
xCAT-client-2.0/pods/man1/lsslp.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<lsslp> - Queries selected networked services information within the same subnet.
=head1 SYNOPSIS
I<lsslp [-h| --help]>
I<lsslp [-v| --version]>
@ -25,19 +25,19 @@ B<-b> IP(s) the command will broadcast out.
B<-h> Display usage message.
B<-r> Raw slp response.
B<-r> Raw slp response.
B<-s> Service type interested in discovering.
B<-s> Service type interested in discovering.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
B<-w> Writes output to xCAT database.
B<-w> Writes output to xCAT database.
B<-x> XML format.
B<-x> XML format.
B<-z> Stanza formated output.
B<-z> Stanza formated output.
=head1 RETURN VALUE
@ -48,36 +48,32 @@ B<-z> Stanza formated output.
=head1 EXAMPLES
1. To list all discovered HMC service types in tabular format, enter:
1. To list all discovered HMC service types in tabular format, enter:
I<lsslp -s HMC>
lsslp -s HMC
Output is similar to:
device type-model serial-number ip-addresses hostname
HMC 7310CR2 103F55A 1.1.1.115 2.2.2.164 3.3.3.102 hmc01
HMC 7310CR2 105369A 3.3.3.103 2.2.2.103 1.1.1.163 hmc02
HMC 7310CR3 KPHHK24 3.3.3.154 2.2.2.110 1.1.1.154 hmc03
device type-model serial-number ip-addresses hostname
HMC 7310CR2 103F55A 1.1.1.115 2.2.2.164 3.3.3.102 hmc01
HMC 7310CR2 105369A 3.3.3.103 2.2.2.103 1.1.1.163 hmc02
HMC 7310CR3 KPHHK24 3.3.3.154 2.2.2.110 1.1.1.154 hmc03
2. list all discovered FSP service types in raw response format on subnet 30.0.0.255, enter:
I<lsslp -b 3.0.0.255 -s FSP -r>
lsslp -b 3.0.0.255 -s FSP -r
Output is similar to:
(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)
(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)
(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)
(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)
3. To list all discovered MM service types in XML format and write the output to the xCAT database, enter:
I<lsslp -s MM -x -w>
lsslp -s MM -x -w
Output is similar to:
@ -95,7 +91,7 @@ Output is similar to:
4. To list all discovered service types in stanza format and write the output to the xCAT database, enter:
I<lsslp -z -w>
lsslp -z -w
Output is similar to:
@ -131,7 +127,7 @@ Output is similar to:
=head1 FILES
/opt/xcat/bin/lsslp
@ -140,6 +136,6 @@ Output is similar to:
This command is part of the xCAT software product.

38
xCAT-client-2.0/pods/man1/lsvm.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<lsvm> - Lists partition profile information for HMC- and IVM-managed nodes.
=head1 SYNOPSIS
I<lsvm [-h| --help]>
I<lsvm [-v| --version]>
@ -21,9 +21,9 @@ I<lsvm [-V| --verbose] noderange>
B<-h> Display usage message.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
=head1 RETURN VALUE
@ -34,37 +34,27 @@ B<-V> Verbose output.
=head1 EXAMPLES
1. To list all partition profiles defined for HMC-managed partition lpar3, enter:
1. To list all partition profiles defined for HMC-managed partition lpar3, enter:
I<lsvm lpar3>
lsvm lpar3
Output is similar to:
lpar3: name=lpar3,lpar_name=lpar3,lpar_id=4,lpar_env=aixlinux,all_resources=0,min_mem=512, desired_mem=2048, max_mem=3072,min_num_huge_pages=0,desired_num_huge_pages=0,max_num_huge_pages=0,proc_mode=shared, min_proc_units=0.5,desired_proc_units=0.5,max_proc_units=0.5,min_procs=1,desired_procs=1,max_procs=1, sharing_mode=uncap,uncap_weight=128,shared_proc_pool_id=0,shared_proc_pool_name=DefaultPool,io_slots=none, lpar_io_pool_ids=none,max_virtual_slots=10,
"virtual_serial_adapters=1/server/1/any//any/1,0/server/1/any//any/1", virtual_scsi_adapters=2/client/1/p6vios/4/1,virtual_eth_adapters=3/0/1//0/1,hca_adapters=none,boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none,work_group_id=none,redundant_err_path_reporting=0, bsr_arrays=0,lhea_logical_ports=none,lhea_capabilities=none,lpar_proc_compat_mode=default,electronic_err_reporting=null
lpar3: name=lpar3,lpar_name=lpar3,lpar_id=4,lpar_env=aixlinux,all_resources=0,min_mem=512, desired_mem=2048, max_mem=3072,min_num_huge_pages=0,desired_num_huge_pages=0,max_num_huge_pages=0,proc_mode=shared, min_proc_units=0.5,desired_proc_units=0.5,max_proc_units=0.5,min_procs=1,desired_procs=1,max_procs=1, sharing_mode=uncap,uncap_weight=128,shared_proc_pool_id=0,shared_proc_pool_name=DefaultPool,io_slots=none, lpar_io_pool_ids=none,max_virtual_slots=10, "virtual_serial_adapters=1/server/1/any//any/1,0/server/1/any//any/1", virtual_scsi_adapters=2/client/1/p6vios/4/1,virtual_eth_adapters=3/0/1//0/1,hca_adapters=none,boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none,work_group_id=none,redundant_err_path_reporting=0, bsr_arrays=0,lhea_logical_ports=none,lhea_capabilities=none,lpar_proc_compat_mode=default,electronic_err_reporting=null
2.To list all IVM-managed partitions associated with CEC cec01, enter:
I<lsvm cec01>
lsvm cec01
Output is similar to:
cec01: name=10-B7D1G,lpar_name=10-B7D1G,lpar_id=1,os_type=vioserver,all_resources=0,min_mem=512, desired_mem=2048,max_mem=2048,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.40, max_proc_units=4.00,min_procs=1,desired_procs=4,max_procs=4,sharing_mode=uncap,uncap_weight=128, "io_slots=21010002/none/0,21010003/none/0,21010004/none/0,21020003/none/0,21020004/none/0,21030003/none/0,21030004/none/0,21040003/none/0,21040004/none/0",lpar_io_pool_ids=none,max_virtual_slots=48,
"virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1,10/client/0/2/lp2/0/0,12/client/0/3/lp3/0/0,14/client/0/4/lp4/0/0","virtual_scsi_adapters=11/server/2/lp2/2/0,13/server/3/lp3/2/0,15/server/4/lp4/2/0","virtual_eth_adapters=3/0/1//1/0,4/0/2//1/0,5/0/3//1/0,6/0/4//1/0",boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none
name=lp2,lpar_name=lp2,lpar_id=2,os_type=aixlinux,all_resources=0,min_mem=128,desired_mem=1024,max_mem=1024,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.10,max_proc_units=4.00,min_procs=1,desired_procs=1,max_procs=4,sharing_mode=uncap,uncap_weight=128,io_slots=none,lpar_io_pool_ids=none,max_virtual_slots=6,
"virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1",virtual_scsi_adapters=2/client/1/10-7D1G/11/1,virtual_eth_adapters=4/0/1//0/0,boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none
name=lp3,lpar_name=lp3,lpar_id=3,os_type=aixlinux,all_resources=0,min_mem=128,desired_mem=128,max_mem=128,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.10,max_proc_units=4.00,min_procs=1,desired_procs=1,max_procs=4,sharing_mode=uncap,uncap_weight=128,io_slots=none,lpar_io_pool_ids=none,max_virtual_slots=6,
"virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1",virtual_scsi_adapters=2/client/1/10-B7D1G/13/1,virtual_eth_adapters=4/0/1//0/0,boot_mode=of,conn_monitoring=0,auto_start=1, power_ctrl_lpar_ids=none
cec01: name=10-B7D1G,lpar_name=10-B7D1G,lpar_id=1,os_type=vioserver,all_resources=0,min_mem=512, desired_mem=2048,max_mem=2048,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.40, max_proc_units=4.00,min_procs=1,desired_procs=4,max_procs=4,sharing_mode=uncap,uncap_weight=128, "io_slots=21010002/none/0,21010003/none/0,21010004/none/0,21020003/none/0,21020004/none/0,21030003/none/0,21030004/none/0,21040003/none/0,21040004/none/0",lpar_io_pool_ids=none,max_virtual_slots=48, "virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1,10/client/0/2/lp2/0/0,12/client/0/3/lp3/0/0,14/client/0/4/lp4/0/0","virtual_scsi_adapters=11/server/2/lp2/2/0,13/server/3/lp3/2/0,15/server/4/lp4/2/0","virtual_eth_adapters=3/0/1//1/0,4/0/2//1/0,5/0/3//1/0,6/0/4//1/0",boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none
name=lp2,lpar_name=lp2,lpar_id=2,os_type=aixlinux,all_resources=0,min_mem=128,desired_mem=1024,max_mem=1024,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.10,max_proc_units=4.00,min_procs=1,desired_procs=1,max_procs=4,sharing_mode=uncap,uncap_weight=128,io_slots=none,lpar_io_pool_ids=none,max_virtual_slots=6, "virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1",virtual_scsi_adapters=2/client/1/10-7D1G/11/1,virtual_eth_adapters=4/0/1//0/0,boot_mode=norm,conn_monitoring=0,auto_start=0,power_ctrl_lpar_ids=none
name=lp3,lpar_name=lp3,lpar_id=3,os_type=aixlinux,all_resources=0,min_mem=128,desired_mem=128,max_mem=128,proc_mode=shared,min_proc_units=0.10,desired_proc_units=0.10,max_proc_units=4.00,min_procs=1,desired_procs=1,max_procs=4,sharing_mode=uncap,uncap_weight=128,io_slots=none,lpar_io_pool_ids=none,max_virtual_slots=6, "virtual_serial_adapters=0/server/1/any//any/1,1/server/1/any//any/1",virtual_scsi_adapters=2/client/1/10-B7D1G/13/1,virtual_eth_adapters=4/0/1//0/0,boot_mode=of,conn_monitoring=0,auto_start=1, power_ctrl_lpar_ids=none
=head1 FILES
/opt/xcat/bin/lsvm
@ -73,5 +63,5 @@ name=lp3,lpar_name=lp3,lpar_id=3,os_type=aixlinux,all_resources=0,min_mem=128,de
This command is part of the xCAT software product.

120
xCAT-client-2.0/pods/man1/mkdef.1.pod
View File

@ -1,40 +1,67 @@
=head1 NAME
B<mkdef> - Use this command to create xCAT data object definitions.
=head1 SYNOPSIS
I<mkdef [-h | --help ] [-t object-types]>
I<mkdef [-V | --verbose] [-t object-types] [-o object-names]>
I<[-z | --stanza ] [-x | --xml] [-f | --force] [-w attr=val,[attr=val...]]>
I<[noderange] [attr=val [attr=val...]] >
B<mkdef> - Use this command to create xCAT data object definitions.
=head1 SYNOPSIS
B<mkdef> [B<-h>|B<--help>] [B<-t> I<object-types>]
B<mkdef> [B<-V>|B<--verbose>] [B<-t> I<object-types>] [B<-o> I<object-names>]
[B<-z>|B<--stanza>] [B<-x>|B<--xml>] [B<-f>|B<--force>] [B<-w> I<attr>=I<val>,[I<attr>=I<val...>]]
[I<noderange>] [I<attr>=I<val> [I<attr>=I<val...>]]
=head1 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.
=head1 OPTIONS
B<attr=val [attr=val ...]> Specifies one or more "attribute equals value" 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.
=over 10
B<-f |--force> Use the force option to re-create object definitions. This option removes the old definition before creating the new one.
=item I<attr=val [attr=val ...]>
B<-h |--help> Display usage message.
Specifies one or more "attribute equals value" 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.
B<noderange> A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats.
=item B<-f|--force>
B<-o object-names> A set of comma delimited object names.
Use the force option to re-create object definitions. This option removes the old definition before creating the new one.
B<-t object-types> A set of comma delimited object types. Use the help option to get a list of valid object types.
=item B<-h|--help>
B<-V |--verbose> Verbose mode.
Display usage message.
B<-w attr=val,[attr=val...]> 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.
=item I<noderange>
B<-x | --xml> Indicates that the file being piped to the command is in XML format.
A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats.
=item B<-o> I<object-names>
A set of comma delimited object names.
=item B<-t> I<object-types>
A set of comma delimited object types. Use the help option to get a list of valid object types.
=item B<-V|--verbose>
Verbose mode.
=item B<-w> I<attr=val,[attr=val...]>
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.
=item B<-x|--xml>
Indicates that the file being piped to the command is in XML format.
=item B<-z|--stanza>
Indicates that the file being piped to the command is in stanza format.
=back
B<-z | --stanza> Indicates that the file being piped to the command is in stanza format.
=head1 RETURN VALUE
@ -42,40 +69,60 @@ B<-z | --stanza> Indicates that the file being piped to the command is i
1 An error has occurred.
=head1 EXAMPLES
1. To create a site definition.
=over 3
I<mkdef -t site -o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall>
=item 1.
2. To create a basic node definition.
To create a site definition.
I<mkdef -t node -o node01 groups="all,aix">
mkdef -t site -o clustersite rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall
3. To re-create the current definition of "node01".
=item 2.
I<mkdef -f -t node -o node01 nodetype=osi groups="linux">
To create a basic node definition.
(The group definitions are also created if they don't already exist.)
mkdef -t node -o node01 groups="all,aix"
4. To create a set of different types of definitions based on information contained in a stanza file.
=item 3.
I<cat defstanzafile | mkdef -z>
To re-create the current definition of "node01".
5. To create a group definition called LinuxNodes containing the nodes clstrn01 and clstrn02.
mkdef -f -t node -o node01 nodetype=osi groups="linux"
I<mkdef -t group -o LinuxNodes members="clstrn01,clstrn02">
(The group definitions are also created if they don't already exist.)
6. To create a node definition for an FSP node using the attributes provided by the group fspnodes.
=item 4.
I<mkdef -t node fspn1 groups=fspnodes nodetype=fsp>
To create a set of different types of definitions based on information contained in a stanza file.
7. To create node definitions for a set of node host names contained in the node range "node1,node2,node3"
cat defstanzafile | mkdef -z
=item 5.
To create a group definition called LinuxNodes containing the nodes clstrn01 and clstrn02.
mkdef -t group -o LinuxNodes members="clstrn01,clstrn02"
=item 6.
To create a node definition for an FSP node using the attributes provided by the group fspnodes.
mkdef -t node fspn1 groups=fspnodes nodetype=fsp
=item 7.
To create node definitions for a set of node host names contained in the node range "node1,node2,node3"
mkdef -t node node1,node2,node3 power=hmc groups="all,aix"
=back
I<mkdef -t node node1,node2,node3 power=hmc groups="all,aix" >
=head1 FILES
$XCATROOT/bin/mkdef
(The XCATROOT environment variable is set when xCAT is installed. The
@ -89,5 +136,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the chdef, lsdef and rmdef commands.
See the chdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands.

38
xCAT-client-2.0/pods/man1/monls.1.pod
View File

@ -1,30 +1,30 @@
=head1 NAME
B<monls> - Lists monitoring plug-in modules that can be used to monitor the xCAT cluster.
=head1 SYNOPSIS
I<monls [-h| --help]>
I<monls [-v| --version]>
I<monls I<name> [-d|--description]>
I<monls I<name> [-d|--description]>
I<monls [-a|--all] [-d|--description]>
I<monls [-a|--all] [-d|--description]>
=head1 DESCRIPTION
This command is used to list the status, desctiption and the settings of one or all of the monitoring plug-in modules.
This command is used to list the status, desctiption and the settings of one or all of the monitoring plug-in modules.
=head1 Parameters
I<name> is the name of the monitoring plug-in module.
I<name> is the name of the monitoring plug-in module.
=head1 OPTIONS
@ -34,9 +34,9 @@ B<-d | --description> Display the description of the plug-in modules. The descr
B<-h | --help> Display usage message.
B<-v | -version > Command Version.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-V | -verbose> Verbose output.
=head1 RETURN VALUE
@ -49,9 +49,10 @@ B<-V | -verbose> Verbose output.
1. To list the status of all the monitoring plug-in modules from the I<monitoring> table, enter:
monls
monls
The output looks like this:
xcatmon monitored node-status-monitored
snmpmon not-monitored
@ -60,20 +61,21 @@ The output looks like this:
monls -a
The output looks like this:
xcatmon monitored node-status-monitored
snmpmon not-monitored
gangliamon not-monitored
rmcmon monitored
nagiosmon not-monitored
3. To list the status and the desciption for I<snmpmon> module, enter:
monls snmpmon -d
=head1 FILES
=head1 FILES
/opt/xcat/bin/monls
@ -84,4 +86,4 @@ See monstart monstop
This command is part of the xCAT software product.

33
xCAT-client-2.0/pods/man1/monstart.1.pod
View File

@ -1,30 +1,30 @@
=head1 NAME
B<monstart> - Starts a plug-in module to monitor the xCAT cluster.
=head1 SYNOPSIS
I<monstart [-h| --help]>
I<monstart [-v| --version]>
I<monstart I<name> [-n|--nodestatmon] [-s|--settings settings]>
I<monstart I<name> [-n|--nodestatmon] [-s|--settings settings]>
=head1 DESCRIPTION
This command is used to register a monitoring plug-in module and invoke it to monitor the xCAT cluster. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. The plug-in module will be registered in the xCAT I<monitoring> database table. A registered plug-in module is automatically started by the I<xcatd>.
This command is used to register a monitoring plug-in module and invoke it to monitor the xCAT cluster. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. The plug-in module will be registered in the xCAT I<monitoring> database table. A registered plug-in module is automatically started by the I<xcatd>.
=head1 Parameters
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<monls -a> command to list all the monitoring plug-in modules that can be used.
I<name> is the name of the monitoring plug-in module. For example, if the the I<name> is called I<xxx>, then the actual file name that the xcatd looks for is I</opt/xcat/lib/perl/xCAT_monitoring/xxx.pm>. Use I<monls -a> command to list all the monitoring plug-in modules that can be used.
I<settings> is the monitoring plug-in specific settings. It is used to customize the behavior of the plug-in or configure the 3rd party software. Format: I<[key-value],[key=value]...> Please note that the square brackets are needed here. Use I<monls name -d> command to look for the possbile setting keys for a plug-in module.
=head1 OPTIONS
@ -34,9 +34,9 @@ B<-n | -nodestatmon> Indicate that this monitoring plug-in will be used for fe
B<-s | -settings> Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. [mon_interval=10],[toggle=1].
B<-v | -version > Command Version.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-V | -verbose> Verbose output.
=head1 RETURN VALUE
@ -53,17 +53,18 @@ B<-V | -verbose> Verbose output.
2. To start rmcmon plug-in module (which interacts with IBM's RSCT monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's I<nodelist> table, enter:
monstart rmcmon -n
monstart rmcmon -n
3. To start xcatmon plug-in module to feed the node liveness status to xCAT's I<nodelist> table, enter:
monstart rmcmon -n -s [ping-interval=2]
where 2 is the number of minutes between the pings.
=head1 FILES
=head1 FILES
/opt/xcat/bin/monstart
@ -74,4 +75,4 @@ See monstop monls
This command is part of the xCAT software product.

18
xCAT-client-2.0/pods/man1/nodels.1.pod
View File

@ -90,9 +90,10 @@ An error has occurred.
To list all defined nodes, enter:
B<nodels>
nodels
Output is similar to:
node1
node2
node3
@ -101,9 +102,10 @@ Output is similar to:
To list all defined attributes in a table for a node or noderange, enter:
B<nodels> I<rra001a> I<noderes>
nodels rra001a noderes
Output is similar to:
rra001a: noderes.primarynic: eth0
rra001a: noderes.xcatmaster: rra000
rra001a: noderes.installnic: eth0
@ -116,9 +118,10 @@ Output is similar to:
To list nodes in node group ppc, enter:
B<nodels> I<ppc>
nodels ppc
Output is similar to:
ppcnode1
ppcnode2
ppcnode3
@ -127,9 +130,10 @@ Output is similar to:
To list the groups each node is part of:
B<nodels> I<all> I<groups>
nodels all groups
Output is similar to:
node1: groups: all
node2: groups: all,storage
node3: groups: all,blade
@ -138,9 +142,10 @@ Output is similar to:
To list the groups each node is part of:
B<nodels> I<all> I<nodehm.power>
nodels all nodehm.power
Output is similar to:
node1: nodehm.power: blade
node2: nodehm.power: ipmi
node3: nodehm.power: ipmi
@ -149,9 +154,10 @@ Output is similar to:
To list the out-of-band mgt method for blade1:
B<nodels> I<blade1> I<nodehm.mgt>
nodels blade1 nodehm.mgt
Output is similar to:
blade1: nodehm.mgt: blade
=back

10
xCAT-client-2.0/pods/man1/nodestat.1.pod
View File

@ -34,12 +34,12 @@ Print help.
=head1 B<Examples>
I<nodestat> I<gpfs>
nodestat gpfs
node4 snmp
node5 pbs
node6 snmp
node7 noping
node4 snmp
node5 pbs
node6 snmp
node7 noping
=head1 B<Author>

73
xCAT-client-2.0/pods/man1/rmdef.1.pod
View File

@ -1,33 +1,54 @@
=head1 NAME
B<rmdef> - Use this command to remove xCAT data object definitions.
=head1 SYNOPSIS
I<rmdef [-h | --help ] [-t object-types]>
B<rmdef> [B<-h>|B<--help>] [B<-t> I<object-types>]
B<rmdef> [B<-V>|B<--verbose>] [B<-a>|B<--all>] [B<-t> I<object-types>] [B<-o> I<object-names>]
[B<-f>|B<--force>] [I<noderange>]
I<rmdef [-V | --verbose] [-a | --all] [-t object-types] [-o object-names]>
I<[-f | --force] [noderange]>
=head1 DESCRIPTION
This command is used to remove xCAT object definitions that are stored in the xCAT database.
=head1 OPTIONS
B<-a | --all> Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option.
=over 10
B<-f|--force> Use this with the all option as an extra indicator that ALL definitions are to be removed.
=item B<-a|--all>
B<-h|--help> Display a usage message.
Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option.
B<noderange> A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats.
=item B<-f|--force>
B<-o object-names> A set of comma delimited object names.
Use this with the all option as an extra indicator that ALL definitions are to be removed.
B<-t object-types> A set of comma delimited object types.
=item B<-h|--help>
B<-V|--verbose> Verbose mode.
Display a usage message.
=item I<noderange>
A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats.
=item B<-o> I<object-names>
A set of comma delimited object names.
=item B<-t> I<object-types>
A set of comma delimited object types.
=item B<-V|--verbose>
Verbose mode.
=back
=head1 RETURN VALUE
@ -38,35 +59,39 @@ B<-V|--verbose> Verbose mode.
=head1 EXAMPLES
1. To completely clear the xCAT database.
=over 3
I<rmdef -f -a>
=item 1. To completely clear the xCAT database.
2. To remove a range of node definitions.
rmdef -f -a
I<rmdef -t node node1-node4>
=item 2. To remove a range of node definitions.
5. To remove all node and group definitions.
rmdef -t node node1-node4
I<rmdef -t node,group>
=item 3. To remove all node and group definitions.
6. To remove all node definitions for the nodes contained in the group bpcnodes.
rmdef -t node,group
I<rmdef -t node -o bpcnodes>
=item 4. To remove all node definitions for the nodes contained in the group bpcnodes.
7. To remove the group called bpcnodes.
rmdef -t node -o bpcnodes
I<rmdef -t group -o bpcnodes>
=item 5. To remove the group called bpcnodes.
rmdef -t group -o bpcnodes
(This will also update the values of the "groups" attribute of the member nodes.)
=back
=head1 FILES
$XCATROOT/bin/rmdef
(The XCATROOT environment variable is set when xCAT is installed. The
default value is "/opt/xcat".)
=head1 NOTES
@ -74,4 +99,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef, chdef and lsdef commands.
See the mkdef(1), chdef(1), lsdef(1), and xcatstanzafile(5) commands.

1
xCAT-client-2.0/pods/man1/tabgrep.1.pod
View File

@ -49,6 +49,7 @@ To display the tables that contain blade1:
B<tabgrep> I<blade1>
The output would be similar to:
nodelist
nodehm
mp

9
xCAT-client-2.0/pods/man1/xdcp.1.pod
View File

@ -7,7 +7,7 @@ B<xdcp> - Concurrently copies files to or from multiple nodes.
B<xdcp> I<noderange> [B<-C> I<context>] [B<-f> I<fanout>]
[B<-L>] [B<-l> I<userID>] [B<-o> I<node_options>]
[B<-r> I<node_remote_shell>] [B<-R>] [B<-t> I<timeout>]
[B<-T>] [B<-v>] [B<-X> I<env_list>] sourcefile.... targetpath
[B<-T>] [B<-v>] [B<-X> I<env_list>] sourcefile.... targetpath
B<xdcp> [B<-h> | B<-V> | B<-q>]
@ -311,10 +311,9 @@ B<xdcp> I<all -P /etc/hosts /tmp/hosts.dir>
A suffix specifying the name of the target is appended to each
file name. The contents of the /tmp/hosts.dir directory are similar to:
hosts._node1 hosts._node4 hosts._node7
hosts._node2 hosts._node5 hosts._node8
hosts._node3 hosts._node6
hosts._node1 hosts._node4 hosts._node7
hosts._node2 hosts._node5 hosts._node8
hosts._node3 hosts._node6
=item *

97
xCAT-client-2.0/pods/man5/xcatstanzafile.5.pod
View File

@ -1,105 +1,130 @@
=head1 NAME
B<xcatstanzafile> - Describes the format of a stanza file that can be used with xCAT commands.
=head1 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:
* An object stanza header consists of the object name followed by a colon, (":").
=over 2
* Attribute lines must take the form of Attribute=Value.
=item *
* Only one stanza can exist for each object name.
An object stanza header consists of the object name followed by a colon, (":").
* All stanzas except for default stanzas must have a value set for "objtype".
=item *
* Comments beginning with the "#" pound sign may be added to the file. A comment must be on a separate line.
Attribute lines must take the form of Attribute=Value.
* When parsing the file, tab characters and spaces are ignored.
=item *
* Each line of the file can have no more than one header or attribute definition.
Only one stanza can exist for each object name.
* If the header name is "default-<object type>:" the attribute values in the stanza are considered default values for subsequent definitions in the file that are the same object type.
=item *
* 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.
All stanzas except for default stanzas must have a value set for "objtype".
* To turn off a default value, use another default stanza to set the attribute to have no value using a blank space.
=item *
* When a specific value for an attribute is provided in the stanza, it takes priority over any default value that had been set.
Comments beginning with the "#" pound sign may be added to the file. A comment must be on a separate line.
=item *
When parsing the file, tab characters and spaces are ignored.
=item *
Each line of the file can have no more than one header or attribute definition.
=item *
If the header name is "default-<object type>:" the attribute values in the stanza are considered default values for subsequent definitions in the file that are the same object type.
=item *
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.
=item *
To turn off a default value, use another default stanza to set the attribute to have no value using a blank space.
=item *
When a specific value for an attribute is provided in the stanza, it takes priority over any default value that had been set.
=back
The format of a stanza file should look similar to the following.
-----------------------------------------------------------
default-<object type>:
default-<object type>:
attr=val
attr=val
. . .
<object name>:
objtype=<object type>
attr=val
attr=val
. . .
<object name>:
<object name>:
objtype=<object type>
attr=val
attr=val
. . .
------------------------------------------------------------
<object name>:
objtype=<object type>
attr=val
attr=val
. . .
=head1 EXAMPLES
1) Sample stanza file:
=over 3
--------------------------------------------------
=item 1)
mysite:
Sample stanza file:
mysite:
objtype=site
rsh=/bin/rsh
rcp=/bin/rcp
installdir=/xcatinstall
domain=ppd.pok.ibm.com
MSnet01:
MSnet01:
objtype=network
gateway=1.2.3.4
netmask=255.255.255.0
nameserver=5.6.7.8
default-node:
default-node:
next_osimage=aix61
network=MSnet01
groups=all,compute
node01:
node01:
objtype=node
MAC=A2E26002C003
xcatmaster=MS02.ppd.pok.com
nfsserver=IS227.ppd.pok.com
node02:
objtype=node
node02:
objtype=node
MAC=A2E26002B004
xcatmaster=MS01.ppd.pok.com
nfsserver=IS127.ppd.pok.com
grp01:
grp01:
objtype=group
memberlist=node1,node2,node3
--------------------------------------------------------
=back
=head1 NOTES
This file is part of xCAT software product.
This file is part of xCAT software product.
=head1 SEE ALSO
See the mkdef, chdef, lsdef, and rmdef commands.
See the mkdef(1), chdef(1), lsdef(1), and rmdef(1) commands.