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

Added a bunch more man pages and converted all the roff man pages to pod.

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@786 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers 2008-03-14 20:54:31 +00:00
parent 41e5425d8c
commit 3c0dfdbfbf
34 changed files with 2476 additions and 1786 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
perl-xCAT-2.0/db2man
View File

@ -51,6 +51,23 @@ It consists of a series of tables, which are described below. To get more infor
particular table, run man for that table name. The tables can be manipulated directly using the
B<tabedit> or B<chtab> commands. They can be viewed using B<nodels> or B<tabdump>.
xCAT allows the use of different database applications, depending on the needs of your cluster.
The default database is SQLite, which is a daemonless, zero-config database. But you could instead
choose to use something like postgresql for greater scalability and remote access in the
hierarchical/service node case. To use a different database or a different location, create
the file /etc/xcat/cfgloc. The first line of the file should contain something like one of the examples
below:
=over 4
=item SQLite:/var/xcat/cfg
=item Pg:dbname=xcat;host=<mgmtnode>|<pguserid>|<pgpasswd>
where mgmtnode is the hostname of the management node adapter on the cluster side
=back
xCAT also supports regular expressions in the tables. This enables one row to represent many
rows. For example, if you have many blades in your cluster and their hostnames have a regular
pattern of blade1, blade2, etc., and your BladeCenter management modules also have a hostname

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

@ -1,30 +1,35 @@
=head1 NAME
B<makedhcp> -Creates new dhcp configuration files and updates live dhcp configuration using omapi.
B<makedhcp> - Creates new dhcp configuration files and updates live dhcp configuration using omapi.
=head1 SYNOPSIS
I<makedhcp [h|--help]>
I<makedhcp [-n]>
B<makedhcp [-n]>
I<makedhcp noderange [-s statements]>
B<makedhcp> I<noderange> [B<-s> I<statements>]
B<makedhcp> I<[h|--help]>
=head1 DESCRIPTION
The makedhcp command with the -n option will create a dhcpd.conf file to allow xCAT to manage the DHCP configuration, including certain general parameters such as a dynamic range and omapi configuration. With a noderange, makedhcp will inject configuration data pertinent to the specified nodes that immediately takes effect without a reset.
The B<makedhcp> command with the B<-n> option will create a dhcpd.conf file to allow xCAT to manage
the DHCP configuration, including certain general parameters such as a dynamic range and omapi configuration.
With a noderange, makedhcp will inject configuration data pertinent to the specified nodes that immediately
takes effect without a reset.
The B<makedhcp> command also uses the following attributes from the xCAT database: B<site.xcatservers>,
B<site.dhcpinterfaces>, B<site.domain>,
B<networks.dynamicrange>, B<networks.dhcpserver>
=head1 OPTIONS
B<-h> Display usage message.
B<-n> Create a new dhcpd.conf file.
B<-s> For the input noderange, the argument will be interpreted like dhcpd.conf text.
B<-n> Create a new dhcpd.conf file.
B<-s> For the input noderange, the argument will be interpreted like dhcpd.conf text.
=head1 RETURN VALUE
@ -35,15 +40,9 @@ B<-s> For the input noderange, the argument will be interpreted like dh
=head1 EXAMPLES
1. The following example, will cause dhcp on the next request to set root-path appropriately for only node5. Note some characters (e.g. ") must be doubly escaped (once for the shell, and once for the OMAPI layer).
1. The following example, will cause dhcp on the next request to set root-path appropriately for only node5. Note some characters (e.g. ") must be doubly escaped (once for the shell, and once for the OMAPI layer).
I<makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";'>
=head1 FILES
/opt/xcat/bin/mkdhcp
I<makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";'>
=head1 NOTES

182
xCAT-client-2.0/pods/man1/nodeset.1.pod Normal file
View File

@ -0,0 +1,182 @@
=head1 Name
B<nodeset> - set the boot state for a noderange
=head1 B<Synopsis>
B<nodeset> [I<noderange>] [I<boot>|I<install>|I<state>|I<stat>]
B<nodeset> [I<noderange>] [I<stage2>|I<stage3>|I<shell>]
B<nodeset> [I<noderange>] [I<clone>|I<cloneserver>|I<image>]
B<nodeset> [I<noderange>] [I<flash>={I<image>}]
B<nodeset> [I<-h>|I<--help>|I<-v>|I<--version>]
=head1 B<Description>
B<nodeset> sets the next cold or warm boot state for a single or range of
nodes or groups. This tells xCAT what you want to happen the next time the
nodes are booted up. See L<noderange(3)>. B<nodeset> accomplishes this by
changing the network boot files. Each xCAT node always boots from the
network and downloads a boot file with instructions on what action to
take next.
B<nodeset> only supports PXELINUX, Etherboot, Etherboot/NBGRUB, and ELILO
as network boot loaders. B<nodeset> calls B<nodeset.pxe>, B<nodeset.eb>, B<node->
B<set.nbgrub>, and B<nodeset.elilo> to perform the updates.
Assume that /tftpboot is the root for tftpd (set in L<site.tab(5)>).
B<nodeset.pxe> makes changes to /tftpboot/pxelinux.0/{node hex ip}
B<nodeset.eb> makes changes to /etc/dhcpd.conf
B<nodeset.nbgrub> makes changes to /tftpboot/grub/{node hostname}.grub
B<nodeset.elilo> makes changes to /tftpboot/elilo/{node ip}.conf and
/tftpboot/elilo/{node hex ip}.conf
B<nodeset.elilo> support both formats for xCAT patch elilo 2.5 and xCAT
patched elilo 3.x.
B<nodeset> only sets the next boot state, but does not reboot.
B<nodeset> is called by rinstall and winstall and is also called by the
installation process remotely to set the boot state back to "boot".
When B<nodeset> is called to set a node for an installation state, a NODE-
TYPE-RESOURCE.BOOTTYPE template must exist in /tftpboot/xcat (or the
appropriate directory as defined in L<site.tab(5)>), where NODETYPE is
defined per node in L<nodetype.tab(5)>, RESOURCE is defined per node or
group in L<noderes.tab(5)>, and BOOTTYPE is defined per node in
L<nodehm.tab(5)>.
=head1 B<Options>
=over 7
=item B<boot>
Instruct node to boot local harddisk 0 on next boot.
=item B<install>
Instruct node to boot from network. This usually involves TFTP
downloading a kernel, initrd, and kernel options, then booting
the downloaded images to facilitate automated unattended
installation.
=item B<state>|B<stat>
Display the next boot state.
=item B<stage2>
Instruct node to boot from network image stage2. This involves
TFTP downloading a special prebuilt kernel, initrd, and kernel
options used for MAC address collection. For a new node this is
the default action and cannot be changed until a node entry
exists in L<dhcpd.conf(5)>. It is not necessary to explicitly set
stage2, unless it is used for testing and development purposes.
=item B<stage3>
Instruct node to boot from network image stage3. This involves
TFTP downloading a special prebuilt kernel, initrd, and kernel
options used for the automated programming of IBM service pro-
cessors.
=item B<shell>
Instruct node to boot from a network maintainance shell image.
This involves TFTP downloading a special prebuilt kernel, ini-
trd, and kernel options used for a limited RAMdisk-based main-
tainance shell. Only available for IA64 systems.
=item B<clone>
Instruct node to boot from network into clone mode. In clone
mode the node will poll the management node for nodes in clone-
server mode, once a clone lock is established the clone node
clones the cloneserver node. Usually called from L<rclone(1)>.
=item B<cloneserver>
Instruct node to boot from network into cloneserver mode. In
cloneserver mode the node will wait for a node to attempt a
clone lock. Once a clone lock is established the clone node
clones the cloneserver node. All other requested will be
refused until node cloning is completed.
=item B<image>
Instruct node to boot from network and run Partition Imager to
create partition images.
=item B<flash>=I<image>
Instruct node to boot from network load DOS and flash I<image>.
Usually called from L<rflash(1)>.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Files>
B<nodehm> table -
xCAT node hardware management file. See L<nodehm(5)> for fur-
ther details. This is used to determine the network boot type:
PXE, Etherboot, ELILO, or NA.
B<noderes> table -
xCAT node resources file. See L<noderes(5)> for further
details. This is used to determine the node's resource group.
B<nodetype> table -
xCAT node installation type file. See L<nodetype(5)> for fur-
ther details. This is used to determine the node installation
image type.
B<site> table -
xCAT main configuration file. See L<site(5)> for further
details. This is used to determine the location of the TFTP
root directory and the TFTP xCAT subdirectory. /tftpboot and
/tftpboot/xcat is the default.
B</etc/dhcpd.conf> file -
xCAT dhcpd configuration file. See L<dhcpd.conf(5)> for further
details. This is used by B<nodeset> to determine if a node will
only boot stage2 because no statically assigned IP exists for
that node. Also used by nodeset.eb to set the boot state for
Etherboot enabled nodes.
=head1 B<Examples>
B<nodeset> I<node5> I<install>
node5: install compute62-compute
Install node5 with the compute62 image using resources from the compute
resource group.
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<nodels(1)>, L<nodestat(1)>, L<rinstall(1)>,
L<rflash(1)>, L<makedhcp(8)>

50
xCAT-client-2.0/pods/man1/nodestat.1.pod Normal file
View File

@ -0,0 +1,50 @@
=head1 Name
B<nodestat> - display the running status of a noderange
=head1 B<Synopsis>
B<nodestat> [I<noderange>]
B<nodestat> [I<-h>|I<--help>|I<-v>|I<--version>]
=head1 B<Description>
B<nodestat> is a small utility used to display the running status of a
single or range of nodes or groups. See L<noderange(3)>.
B<nodestat> will first check for pbs_mom, if that fails then B<nodestat> will
check for snmpd, then ping. If ping fails, then B<nodestat> returns "nop-
ing".
=head1 B<Options>
=over 5
=item B<-v>|B<--version>
Print version.
=item B<-h>|B<--help>
Print help.
=back
=head1 B<Examples>
I<nodestat> I<gpfs>
node4 snmp
node5 pbs
node6 snmp
node7 noping
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<nodels(1)>, L<nodeloc(1)>, L<nodeset(1)>

33
xCAT-client-2.0/pods/man1/pcons.1.pod Normal file
View File

@ -0,0 +1,33 @@
=head1 NAME
B<pcons> - Runs a command on the noderange using the out-of-band console.
=head1 SYNOPSIS
B<pcons> I<noderange> I<command>
B<pcons>
[B<-h>|B<--help>]
B<pcons>
[B<-v>|B<--version>]
=head1 DESCRIPTION
Runs the a command to the noderange using the console.
=head1 EXAMPLES
pcons 1,3 stat
pcons all,-129-256 stat
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

56
xCAT-client-2.0/pods/man1/pping.1.pod Normal file
View File

@ -0,0 +1,56 @@
=head1 NAME
B<pping> - parallel ping.
=head1 SYNOPSIS
B<pping> [B<-q>] [B<-s>] [B<-i> I<interface>] I<noderange>
B<pping> [B<-h>|B<--help>]
B<pping> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<pping> is a utility used to ping list of nodes in parallel.See noderange(3).
B<pping> will return an unsorted list of nodes with a ping or noping status. The list is actually sorted by first ping, unless -s is specified.
B<pping> front-ends ping and fping if available.
This command does not support the xcatd client/server communication. It must be run on the management node.
=head1 OPTIONS
B<-q> quiet, only show noping nodes
B<-s> Ping serially
B<-i interface> interface
B<-h | help> help
B<-v | version> version
=head1 EXAMPLES
pping all
blade7: ping
blade8: ping
blade9: ping
devmaster: ping
node4: ping
node2: noping
pping -q all
node2: noping
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

52
xCAT-client-2.0/pods/man1/ppping.1.pod Normal file
View File

@ -0,0 +1,52 @@
=head1 NAME
B<ppping> - parallel ping between nodes in cluster.
=head1 SYNOPSIS
B<ppping> [B<-s>] [B<-i> I<interface>] I<noderange>
B<ppping> [B<-h>|B<--help>]
B<pping> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<ppping> is a utility used to test ping between nodes in the noderange.
B<ppping> will return an unsorted list of nodes with a ping or noping status. The list is actually sorted by first ping, unless -s is specified.
B<ppping> front-ends ping and fping if available.
This command does not support the xcatd client/server communication. It must be run on the management node.
=head1 OPTIONS
B<-s> Ping serially
B<-i interface> interface
B<-h | help> help
B<-v | version> version
=head1 EXAMPLES
ppping all
blade7: node2: noping
blade8: node2: noping
blade9: node2: noping
devmaster: node2: noping
node2: noping
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

74
xCAT-client-2.0/pods/man1/prsync.1.pod Normal file
View File

@ -0,0 +1,74 @@
=head1 Name
prsync - parallel rsync
=head1 B<Synopsis>
B<prsync> I<filename> [I<filename> I<...>] I<noderange:destinationdirectory>
B<prsync> [I<rsync-opts>] [I<filename> I<filename> I<...>] [I<directory> I<directory> I<...>]
I<noderange:destinationdirectory>
B<prsync> {B<-h>|B<--help>|B<-v>|B<--version>}
=head1 B<Description>
B<prsync> is a front-end to rsync for a single or range of nodes and/or
groups in parallel.
Note: this command does not support the xcatd client/server communication and therefore must be run on the management node.
B<prsync> is NOT multicast, but is parallel unicasts.
=head1 B<Options>
=over 7
=item B<rsyncopts>
rsync options. See L<rsync(1)>.
=item B<filename>
A space delimited list of files to rsync.
=item B<directory>
A space delimited list of directories to rsync.
=item B<noderange:destination>
A L<noderange(3)> and destination directory. The : is required.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
=over 3
=item *
B<cd> I</install;> B<prsync> B<-cravz> I<post> I<stage:/install>
=item *
B<prsync> I<passwd> I<group> I<rack01:/etc>
=back
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<pscp(1)>, L<pping(1)>, L<psh(1)>

67
xCAT-client-2.0/pods/man1/pscp.1.pod Normal file
View File

@ -0,0 +1,67 @@
=head1 Name
B<pscp> - parallel remote copy
=head1 B<Synopsis>
B<pscp> I<filename> [I<filename> I<...>] I<noderange:destinationdirectory>
B<pscp> [B<-r>] [I<filename> I<filename> I<...>] [I<directory> I<directory> I<...>]
I<noderange:destinationdirectory>
B<pscp> {B<-h>|B<--help>|B<-v>|B<--version>}
=head1 B<Description>
B<pscp> is a utility used to copy a single or multiple set of files and/or
directories to a single or range of nodes and/or groups in parallel.
B<pscp> is a front-end to the remote copy B<scp>.
Note: this command does not support the xcatd client/server communication and therefore must be run on the management node.
B<pscp> is NOT multicast, but is parallel unicasts.
=head1 B<Options>
=over 7
=item B<-r>
Recursive copy through directories.
=item B<filename>
A space delimited list of files to copy.
=item B<directory>
A space delimited list of directories to copy.
=item B<noderange:destination>
A L<noderange(3)> and destination directory. The : is required.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<pscp> B<-r> I</usr/local> I<node1,node3:/usr/local>
B<pscp> I<passwd> I<group> I<rack01:/etc>
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<pping(1)>, L<prsync(1)>, L<psh(1)>

80
xCAT-client-2.0/pods/man1/psh.1.pod Normal file
View File

@ -0,0 +1,80 @@
=head1 Name
psh - parallel remote shell
=head1 B<Synopsis>
B<psh> [I<-s>] {I<noderange>|B<me>|I<pbs-job-id>} I<command>
B<psh> {B<-h>|B<--help>|B<-v>|B<--version>}
=head1 B<Description>
B<psh> is a utility used to run a command across a list of nodes in parallel.
B<ssh> must be set up to allow no prompting for B<psh> to work.
Note: this command does not support the xcatd client/server communication and therefore must be run on the management node.
=head1 B<Options>
=over 7
=item B<-s>
Issues the commands serially.
=item B<noderange>
See L<noderange(3)>.
=item B<me>
Run against nodes owned by "me" as listed by PBS's L<qstat(1B)>
command.
=item B<pbs>
Run against nodes assigned to a PBS job as listed by PBS's
L<qstat(1B)> command.
=item B<command>
Command to be run in parallel. If no command is give then B<psh>
enters interactive mode. In interactive mode a ">" prompt is
displayed. Any command entered is executed in parallel to the
nodes in the noderange. Use "exit" or "Ctrl-D" to end the interactive session.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<psh> I<node4-node6> I<uptime>
node4: Sun Aug 5 17:42:06 MDT 2001
node5: Sun Aug 5 17:42:06 MDT 2001
node6: Sun Aug 5 17:42:06 MDT 2001
B<psh> I<node1-node10> I<rm> I<-f> I</tmp/blah>
B<psh> I<rack01> I<'rm> I<-f> I</tmp/*'>
Notice the use of '' to forward shell expansion. This is not necessary
in interactive mode.
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<pscp(1)>, L<pping(1)>, L<prsync(1)>

35
xCAT-client-2.0/pods/man1/rbeacon.1.pod Normal file
View File

@ -0,0 +1,35 @@
=head1 NAME
B<rbeacon> - Turns beacon on/off/blink or gives status of a node or noderange.
=head1 SYNOPSIS
B<rbeacon> I<noderange> {B<on>|B<blink>|B<off>|B<stat>}
B<rbeacon> [B<-h>|B<--help>]
B<rbeacon> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<rbeacon> Turns beacon (a light on the front of the physical server) on/off/blink or gives status of a node or noderange.
=head1 EXAMPLES
rbeacon 1,3 off
rbeacon 14-56,70-203 on
rbeacon 1,3,14-56,70-203 blink
rbeacon all,-129-256 stat
=head1 SEE ALSO
noderange(3), rpower(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

88
xCAT-client-2.0/pods/man1/rbootseq.1.pod Normal file
View File

@ -0,0 +1,88 @@
=head1 NAME
B<rbootseq> - Sets the boot order for BladeCenter blades.
=head1 SYNOPSIS
B<rbootseq> I<noderange> {B<hd0>|B<hd1>|B<hd2>|B<hd3>|B<net>|B<iscsi>|B<iscsicrit>|B<cdrom>|B<usbflash>|B<floppy>|B<none>|B<list>|B<stat>}B<,>I<...>
B<rbootseq> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
B<rbootseq> sets the boot sequence of the specified blades. Up to four different medium can be listed, separated by commas.
=head1 OPTIONS
=over 7
=item B<hd0>|B<harddisk0>|B<hd>|B<harddisk>
The first hard disk.
=item B<hd1>|B<harddisk1>
The second hard disk.
=item B<hd2>|B<harddisk2>
The third hard disk.
=item B<hd3>|B<harddisk3>
The fourth hard disk.
=item B<n>|B<net>|B<network>
Boot over the network, using a PXE or BOOTP broadcast.
=item B<iscsi>
Boot to an iSCSI disk over the network.
=item B<iscsicrit>
??
=item B<cd>|B<cdrom>
The CD or DVD drive.
=item B<usbflas>|B<usb>|B<flash>
A USB flash drive.
=item B<floppy>
The floppy drive.
=item B<none>
If it gets to this part of the sequence, do not boot. Can not be specified 1st, or before any real boot devices.
=item B<list>|B<stat>
Display the current boot sequence.
=back
=head1 EXAMPLES
rbootseq 1,3 c,f,n,hd0
rbootseq 14-56,70-203 c,f,n,hd0
rbootseq 1,3,14-56,70-203 c,f,n,hd0
rbootseq all,-129-256 c,f,n,hd0
=head1 SEE ALSO
rsetboot(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

48
xCAT-client-2.0/pods/man1/rcons.1.pod Normal file
View File

@ -0,0 +1,48 @@
=head1 Name
B<rcons> - remote console
=head1 B<Synopsis>
B<rcons> I<singlenode>
B<rcons> [I<-h>|I<--help>|I<-v>|I<--version>]
=head1 B<Description>
B<rcons> provides access to a single remote node serial console.
=head1 B<Options>
=over 5
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Files>
B<nodehm> table -
xCAT node hardware management table. See L<nodehm(5)> for
further details. This is used to determine the console access
method.
=head1 B<Examples>
B<rcons> I<node5>
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<rvid(1)>, L<wcons(1)>, L<wvid(1)>

66
xCAT-client-2.0/pods/man1/reventlog.1.pod Normal file
View File

@ -0,0 +1,66 @@
=head1 Name
B<reventlog> - retrieve or clear remote hardware event logs
=head1 B<Synopsis>
B<reventlog> I<noderange> {I<number-of-entries>|B<all>|B<clear>}
B<reventlog> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<reventlog> can display any number of remote hardware event log entries
or clear them for a range of nodes. Hardware event
logs are stored on each servers service processor.
=head1 B<Options>
=over 7
=item I<number-of-entries>
Retrieve the specified number of entries from the nodes' service processors.
=item B<all>
Retrieve all entries.
=item B<clear>
Clear event logs.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<reventlog> I<node4,node5> I<5>
node4: SERVPROC I 09/06/00 15:23:33 Remote Login Successful User ID = USERID[00]
node4: SERVPROC I 09/06/00 15:23:32 System spn1 started a RS485 connection with us[00]
node4: SERVPROC I 09/06/00 15:22:35 RS485 connection to system spn1 has ended[00]
node4: SERVPROC I 09/06/00 15:22:32 Remote Login Successful User ID = USERID[00]
node4: SERVPROC I 09/06/00 15:22:31 System spn1 started a RS485 connection with us[00]
node5: SERVPROC I 09/06/00 15:22:32 Remote Login Successful User ID = USERID[00]
node5: SERVPROC I 09/06/00 15:22:31 System spn1 started a RS485 connection with us[00]
node5: SERVPROC I 09/06/00 15:21:34 RS485 connection to system spn1 has ended[00]
node5: SERVPROC I 09/06/00 15:21:30 Remote Login Successful User ID = USERID[00]
node5: SERVPROC I 09/06/00 15:21:29 System spn1 started a RS485 connection with us[00]
B<reventlog> I<node4,node5> I<clear>
node4: clear
node5: clear
=head1 B<SEE ALSO>
rpower(1), startmon(1)

100
xCAT-client-2.0/pods/man1/rinv.1.pod Normal file
View File

@ -0,0 +1,100 @@
=head1 Name
B<rinv> - remote hardware inventory
=head1 B<Synopsis>
B<rinv> I<noderange> {B<pci>|B<config>|B<model>|B<serial>|B<asset>|B<vpd>|B<mprom>|B<deviceid>|B<guid>|B<firm>|B<diag>|B<bios>|B<mparom>|B<mac>|B<all>}
B<rinv> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<rinv> retrieves hardware configuration information from the on-board
Service Processor for a single or range of nodes and groups.
=head1 B<Options>
=over 7
=item B<pci>
Retrieves PCI bus information.
=item B<config>
Retrieves number of processors, speed, total memory, and DIMM
locations.
=item B<model>
Retrieves model number.
=item B<serial>
Retrieves serial number.
=item B<asset>
Retrieves asset tag. Usually it's the MAC address of eth0.
=item B<vpd>
Same as specifying model, serial, deviceid, and mprom.
=item B<mprom>
?
=item B<deviceid>
?
=item B<guid>
?
=item B<all>
All of the above.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<rinv> I<node5> I<all>
node5: Machine Type/Model 865431Z
node5: Serial Number 23C5030
node5: Asset Tag 00:06:29:1F:01:1A
node5: PCI Information
node5: Bus VendID DevID RevID Description Slot Pass/Fail
node5: 0 1166 0009 06 Host Bridge 0 PASS
node5: 0 1166 0009 06 Host Bridge 0 PASS
node5: 0 5333 8A22 04 VGA Compatible Controller0 PASS
node5: 0 8086 1229 08 Ethernet Controller 0 PASS
node5: 0 8086 1229 08 Ethernet Controller 0 PASS
node5: 0 1166 0200 50 ISA Bridge 0 PASS
node5: 0 1166 0211 00 IDE Controller 0 PASS
node5: 0 1166 0220 04 Universal Serial Bus 0 PASS
node5: 1 9005 008F 02 SCSI Bus Controller 0 PASS
node5: 1 14C1 8043 03 Unknown Device Type 2 PASS
node5: Machine Configuration Info
node5: Number of Processors:
node5: Processor Speed: 866 MHz
node5: Total Memory: 512 MB
node5: Memory DIMM locations: Slot(s) 3 4
=head1 B<SEE ALSO>
rpower(1)

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

@ -1,22 +1,16 @@
=head1 NAME
rpower - remote power control
B<rpower> - remote power control of nodes
=head1 SYNOPSIS
B<rpower>
I<noderange>
B<[--nodeps]> B<on>|B<off>|B<stat>|B<state>|B<reset>|B<boot>|B<cycle>
B<rpower> I<noderange> [B<--nodeps>] {B<on>|B<off>|B<stat>|B<state>|B<reset>|B<boot>|B<cycle>}
B<rpower>
[B<-h>|B<--help>]
B<rpower>
[B<-v>|B<--version>]
B<rpower> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
I<rpower> controls the power for a single or range of nodes.
B<rpower> controls the power for a single or range of nodes, via the out-of-band path.
=head1 OPTIONS
@ -42,7 +36,7 @@ Send a hard reset.
If off, then power on.
If on, then hard reset.
The option is recommended over B<cycle>.
This option is recommended over B<cycle>.
=item B<cycle>
@ -52,66 +46,39 @@ Power off, then on.
Do not use dependency table (default is to use dependency table). Valid only with on|off|boot|reset|cycle for blade power method.
=item B<-h>, B<--help>
=item B<-h>|B<--help>
Help.
Prints out a brief help message.
Prints out a brief usage message.
=item B<-v>, B<--version>
Version.
Display the version number.
=back
=head1 ENVIRONMENT
=over 4
=back
=head1 EXAMPLES
=begin roff
=over 3
\fIrpower node4,node5 stat\fR
=item *
node4: on
.br
node5: off
B<rpower> I<node4,node5 stat>
\fIrpower node5 on\fR
node4: on
node5: off
node5: on
=item *
=end roff
B<rpower> I<node5 on>
=begin html
<TT><EM>rpower node5 on</EM></TT>
<br>
<br>
<TT>node4: on</TT>
<br>
<TT>node5: off</TT>
<br>
<br>
<TT><EM>rpower node5 on</EM></TT>
<br>
<br>
<TT>node5: on</TT>
node5: on
=end html
=back
=head1 FILES
=head1 SEE ALSO
/opt/xcat/bin/rpower
=head1 NOTES
This command is part of the xCAT software product.
noderange(3), rcons(1), rinv(1), rvitals(1), rscan(1)

58
xCAT-client-2.0/pods/man1/rsetboot.1.pod Normal file
View File

@ -0,0 +1,58 @@
=head1 NAME
B<rsetboot> - Sets the boot order for servers with BMC service processors.
=head1 SYNOPSIS
B<rsetboot> I<noderange> {B<hd>|B<net>|B<cd>|B<default>|B<stat>}
B<rsetboot> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
B<rsetboot> sets the boot media to be used on the next boot of the specified nodes.
=head1 OPTIONS
=over 7
=item B<hd>
Boot from the hard disk.
=item B<net>
Boot over the network, using a PXE or BOOTP broadcast.
=item B<cd>
Boot from the CD or DVD drive.
=item B<def>|B<default>
Boot using the default set in BIOS.
=item B<stat>
Display the current boot setting.
=back
=head1 EXAMPLES
rsetboot 1,3 net
rsetboot 14-56,70-203 stat
rsetboot 1,3,14-56,70-203 default
=head1 SEE ALSO
rsetboot(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

80
xCAT-client-2.0/pods/man1/rspconfig.1.pod Normal file
View File

@ -0,0 +1,80 @@
=head1 NAME
B<rspconfig> - remote power control of nodes
=head1 SYNOPSIS
B<rspconfig> I<noderange> {B<alert>|B<snmpdest>|B<community>|B<garp>}
B<rspconfig> I<noderange> B<alert>={B<on>|B<enable>|B<off>|B<disable>}
B<rspconfig> I<noderange> B<snmpdest>=I<snmpmanager-IP>
B<rspconfig> I<noderange> B<community>={B<public>|I<string>}
B<rspconfig> I<noderange> B<garp>=I<time>
B<rspconfig> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
B<rspconfig> configures various settings in the nodes' service processors. If only a keyword is
specified, without the B<=>, it displays the current value.
=head1 OPTIONS
=over 4
=item B<alert>={I<on>|I<enable>|I<off>|I<disable>}
Turn on or off SNMP alerts.
=item B<snmpdest>=I<snmpmanager-IP>
Set where the SNMP alerts should be sent to.
=item B<community>={B<public>|I<string>}
Set the SNMP commmunity value.
=item B<garp>=I<time>
Gratuitous ARP generation interval.
=item B<-h>|B<--help>
Prints out a brief usage message.
=item B<-v>, B<--version>
Display the version number.
=back
=head1 EXAMPLES
=over 3
=item *
To turn on SNMP alerts for node5:
B<rspconfig> I<node5> B<alert>=B<on>
node5: Alerts: enabled
=item *
To display the destination setting for SNMP alerts for node4:
B<rspconfig> I<node4 snmpdest>
node4: BMC SNMP Destination 1: 9.114.47.227
=back
=head1 SEE ALSO
noderange(3), rpower(1), rcons(1), rinv(1), rvitals(1), rscan(1)

38
xCAT-client-2.0/pods/man1/rspreset.1.pod Normal file
View File

@ -0,0 +1,38 @@
=head1 Name
B<rspreset> - remote hardware inventory
=head1 B<Synopsis>
B<rspreset> I<noderange>
B<rspreset> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<rspreset> resets the service processors associated with the specified nodes. It searches
the B<nodehm> table and associated tables to find the service processors associated with the nodes.
=head1 B<Options>
=over 7
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<rspreset> I<node5>
=head1 B<SEE ALSO>
rpower(1), nodehm(5)

105
xCAT-client-2.0/pods/man1/rvitals.1.pod Normal file
View File

@ -0,0 +1,105 @@
=head1 Name
B<rvitals> - remote hardware vitals
=head1 B<Synopsis>
B<rvitals> I<noderange> {B<temp>|B<voltage>|B<wattage>|B<fanspeed>|B<power>|B<leds>|B<summary>|B<all>}
B<rvitals> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<rvitals> retrieves hardware vital information from the on-board Service
Processor for a single or range of nodes and groups.
=head1 B<Options>
=over 7
=item B<cputemp>
Retrieves CPU temperatures.
=item B<disktemp>
Retrieves HD back plane temperatures.
=item B<ambtemp>
Retrieves ambient temperatures.
=item B<temp>
Retrieves all temperatures.
=item B<voltage>
Retrieves power supply and VRM voltage readings.
=item B<fanspeed>
Retrieves fan speeds.
=item B<power>
Retrieves power status.
=item B<powertime>
Retrieves total power uptime. This value only increases, unless
the Service Processor flash gets updated.
=item B<reboot>
Retrieves total number of reboots. This value only increases,
unless the Service Processor flash gets updated.
=item B<state>
Retrieves the system state.
=item B<all>
All of the above.
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<rvitals> I<node5> I<all>
node5: CPU 1 Temperature: + 29.00 C (+ 84.2 F)
node5: CPU 2 Temperature: + 19.00 C (+ 66.2 F)
node5: DASD Sensor 1 Temperature: + 32.00 C (+ 89.6 F)
node5: System Ambient Temperature Temperature: + 26.00 C (+ 78.8 F)
node5: +5V Voltage: + 5.01V
node5: +3V Voltage: + 3.29V
node5: +12V Voltage: + 11.98V
node5: +2.5V Voltage: + 2.52V
node5: VRM1 Voltage: + 1.61V
node5: VRM2 Voltage: + 1.61V
node5: Fan 1 Percent of max: 100%
node5: Fan 2 Percent of max: 100%
node5: Fan 3 Percent of max: 100%
node5: Fan 4 Percent of max: 100%
node5: Fan 5 Percent of max: 100%
node5: Fan 6 Percent of max: 100%
node5: Current Power Status On
node5: Power On Seconds 11855915
node5: Number of Reboots 930
node5: System State Booting OS or in unsupported OS
=head1 B<SEE ALSO>
rpower(1), rinv(1)

102
xCAT-client-2.0/pods/man1/wcons.1.pod Normal file
View File

@ -0,0 +1,102 @@
=head1 Name
wcons - windowed remote console
=head1 B<Synopsis>
B<wcons> [B<-t>|B<--tile>=I<n>] I<noderange>
B<wcons> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<wcons> provides access to the remote node serial console of a single or
range or nodes or groups.
B<wcons> is a simple front-end to rcons in an xterm session for each console.
=head1 B<Options>
=over 5
=item B<-t>|B<--tile>=I<n>
Tile B<wcons> windows from top left to bottom right. If I<n> is spec-
ified then tile I<n> across. If I<n> is not specified then tile to
edge of screen. If tiled B<wcons> windows reach bottom right, then
the windows start at top left overlaying existing B<wcons> windows.
=item B<-f>|B<--font>=I<font>
B<Note:> this option is not supported yet! Use Xwindows font I<font> for B<wcons> windows.
B<wcons> supports the following font aliases:
=over 25
=item B<Alias>
B<Font>
=item I<verysmall>|I<vs>
nil2
=item I<small>|I<s>
5x8
=item I<medium>|I<med>|I<m>
6x13
=item I<large>|I<l>|I<big>|I<b>
7x13
=item I<verylarge>|I<vl>|I<verybig>|I<vb>
10x20
=back
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Files>
B<nodehm> table -
xCAT node hardware management table. See L<nodehm(5)> for further details. This is used to determine the console access
method.
=head1 B<Examples>
B<wcons> I<node1-node5>
B<wcons> B<--tile> B<--font>=I<nil2> I<all>
B<wcons> B<-t> I<4> I<node1-node16>
B<wcons> B<-f> I<vs> B<-t> I<4> I<node1-node4>
=head1 B<Bugs>
Tile mode assumes that the width of the left window border is also the
width of the right and bottom window border. Most window managers
should not have a problem. If you really need support for a screwy
window manager let me know.
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<rcons(1)>

47
xCAT-client-2.0/pods/man1/wkill.1.pod Normal file
View File

@ -0,0 +1,47 @@
=head1 Name
B<wkill> - kill windowed remote consoles
=head1 B<Synopsis>
B<wkill> [I<noderange>]
B<wkill> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 B<Description>
B<wkill> will kill the wcons windows on your $DISPLAY for a single or
range or nodes or groups.
B<wkill> was written because I'm too lazy to point and click off 64 windows.
B<wkill> will only kill windows on your display and for only the
L<noderange(3)> you specify. If no L<noderange(3)> is specified, then all
wcons windows on your $DISPLAY will be killed.
=head1 B<Options>
=over 5
=item B<-h>|B<--help>
Print help.
=item B<-v>|B<--version>
Print version.
=back
=head1 B<Examples>
B<wkill> I<node1-node5>
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)>, L<wcons(1)>.

63
xCAT-client-2.0/pods/man1/xcoll.1.pod Normal file
View File

@ -0,0 +1,63 @@
=head1 B<NAME>
B<xcoll> - Formats and consolidates the output of the B<psh> command.
=head1 B<SYNOPSIS>
B<xcoll>
=head1 B<DESCRIPTION>
The B<xcoll> command formats and consolidates output from the B<psh> command. The B<xcoll>
command takes, as input, lines in the following format:
host_name: line of output from remote command
The B<xcoll> command formats the lines as follows and writes them to
standard output. Assume that the output from node3 and node4
is identical:
====================================
node1
====================================
.
.
lines from psh for node1 with hostnames stripped off
.
.
====================================
node2
====================================
.
.
lines from psh for node2 with hostnames stripped off
.
.
====================================
node3, node4
====================================
.
.
lines from psh for node 3 with hostnames stripped off
.
.
=head1 B<EXAMPLES>
=over 3
=item *
To display the results of a command issued on several nodes, in
the format used in the Description, enter:
B<psh> I<node1,node2,node3 cat /etc/passwd> | B<xcoll>
=back
=head1 B<SEE ALSO>
psh(1), xdshbak(1)

474
xCAT-client-2.0/pods/man1/xdsh.1.pod Normal file
View File

@ -0,0 +1,474 @@
=head1 B<NAME>
B<xdsh> - Concurrently runs commands on multiple nodes.
=head1 B<SYNOPSIS>
B<xdsh> I<noderange> [B<-B> I<bypass>] [B<-C> I<context>] [B<-e>] [B<-E> I<environment_file>] [B<-f> I<fanout>]
[B<-i>] [B<-K>] [B<-L>] [B<-l> I<userID>] [B<-m>] [B<-o>
I<node_options>] [B<-Q>] [B<-r> I<node_remote_shell>] [B<-s>] [B<-S> B<csh>|B<ksh>] [B<-t> I<timeout>]
[B<-T>] [B<-v>] [B<-X> I<env_list>] [B<-z>] I<command_list>
B<xdsh> [B<-h> | B<-V> | B<-q>]
=head1 B<DESCRIPTION>
The B<xdsh> command runs commands in parallel on remote nodes. The B<xdsh> command issues a
remote shell command for each target specified, and returns the output
from all targets,
formatted so that command results from all nodes can be managed.
The B<xdsh> command is an xCAT Distributed Shell Utility.
B<TARGET CONTEXT>:
The B<xdsh> command target context is the database where the target or
target group is defined. A default context can be configured using the
B<-C> I<context> flag or the B<DSH_CONTEXT> environment variable. If neither are
specified, the default context is B<XCAT>.
A context is enabled for use with a DSH Utilities command by installing
a context extension file in the B</opt/xcat/xdsh/Context> directory. The
target or target group context can be explicitly specified by qualify-
ing a target name with a context name, or implicitly defined by speci-
fying a default context for unqualified target names (See B<Target>
B<lists>).
B<TARGET> B<SPECIFICATION>:
A target is a node where a remote command will be executed. Node
targets are specified inputting the I<node_list> or I<nodegroups>.
If the local host is included as part of the targets, the I<command_list>
is executed directly on the local host and not through the configured
remote shell, unless a I<user_ID> is specified for execution with the
local host (see B<Remote> B<user>).
Node targets can also be specified using node ranges as supported by
xCAT. If the same target is specified more than once, the remote com-
mand will only be executed once on the specified target.
B<COMMAND> B<SPECIFICATION>:
The commands to execute on the remote targets are specified by the
I<command_list> B<xdsh> parameter, or executing a local script using the B<-e>
flag.
The syntax for the I<command_list> B<xdsh> parameter is as follows:
I<command>[; I<command>]...
where I<command> is the command to run on the remote
target. Quotation marks are required to ensure that all commands in the
list are executed remotely, and that any special characters are interpreted
correctly on the remote target. A script file on the local host can be
executed on each of the remote targets by using the B<-e>
flag. If B<-e> is specified, I<command_list> is the
script name and arguments to the script. For example:
xdsh hostname -e I<script_filename> [I<arguments>]...
The I<script_filename> file is copied to a random filename in the B</tmp>
directory on each remote target and then executed on the targets.
The B<xdsh> command does not work with any interactive commands, including
those that read from standard input.
B<REMOTE> B<SHELL> B<COMMAND>:
The B<xdsh> command uses a configurable remote shell command to execute
remote commands on the remote targets. Support is explicitly provided
for AIX Remote Shell and OpenSSH, but any secure remote command that
conforms to the IETF (Internet Engineering Task Force) Secure Remote
Command Protocol can be used.
The remote shell is determined as follows, in order of precedence:
1. The B<-r> flag.
2. The B<DSH_NODE_RSH> environment variable.
3. The default node remote shell as defined by the target I<context>.
4. The B</usr/bin/ssh> command.
The remote shell options are determined as follows, in order of prece-
dence:
1. The B<-o> flag.
2. The B<DSH_NODE_OPTS> environment variable.
B<REMOTE> B<SHELL> B<ENVIRONMENT>:
The shell environment used on the remote target defaults to the shell
defined for the I<user_ID> on the remote target. The command
syntax that B<xdsh> uses to form the remote commands can be specified using the B<-S>
flag. If B<-S> is not specified, the syntax defaults to B<sh> syntax.
When commands are executed on the remote target, the path used is
determined by the B<DSH_PATH> environment variable defined in the shell of
the current user. If B<DSH_PATH> is not set, the path used is the remote
shell default path. For example, to set the local path for the remote
targets, use:
DSH_PATH=$PATH
The B<-E> flag exports a local environment definition file to each remote
target. Environment variables specified in this file are defined in the
remote shell environment before the I<command_list> is executed.
B<COMMAND> B<EXECUTION>:
The maximum number of concurrent remote shell command processes (the
fanout) can be specified with the B<-f> flag or with the B<DSH_FANOUT>
environment variable. The fanout is only restricted by the number of remote
shell commands that can be run in parallel. You can experiment with the
B<DSH_FANOUT> value on your management server to see if higher values are
appropriate.
A timeout value for remote command execution can be specified with the
B<-t> flag or with the B<DSH_TIMEOUT> environment variable. If any remote
target does not provide output to either standard output or standard
error within the timeout value, B<xdsh> displays an error message and
exits.
If streaming mode is specified with the B<-s> flag, output is returned as
it becomes available from each target, instead of waiting for the
I<command_list> to complete on all targets before returning output. This can
improve performance but causes the output to be unsorted.
The B<-z> flag displays the exit code from the last command issued on the
remote node in I<command_list>. Note that OpenSSH behaves differently; it
returns the exit status of the last remote command issued as its exit
status. This affects the behavior of B<xdsh> and may require using the B<-c>
flag. If the command issued on the remote node is run in the
background, the exit status is not displayed.
The B<-m> flag monitors execution of the B<xdsh> command by printing status
messages to standard output. Each status message is preceded by B<dsh>.
The B<-T> flag provides diagnostic trace information for the execution of
the B<xdsh> command. Default settings and the actual remote shell commands
executed on the remote targets are displayed.
No error detection or recovery mechanism is provided for remote
targets. The B<xdsh> command output to standard error and standard output can
be analyzed to determine the appropriate course of action. In interac-
tive mode, if a command cannot be executed on a remote target (for
example, a remote shell command resulting in a non-zero return code),
subsequent commands are not sent to this node on this invocation of the
B<xdsh> command unless the B<-c> flag is specified.
B<COMMAND> B<OUTPUT>:
The B<xdsh> command waits until complete output is available from each
remote shell process and then displays that output before initiating
new remote shell processes. This default behavior is overridden by the
B<-s> flag.
The B<xdsh> command output consists of standard error and standard output
from the remote commands. The B<xdsh> standard output is the standard
output from the remote shell command. The B<xdsh> standard error is the
standard error from the remote shell command. Each line is prefixed with
the host name of the node that produced the output. The host name is
followed by the B<:> character and a command output line. A filter for
displaying identical outputs grouped by node is provided separately.
See the B<xdshbak> command for more information.
A command can be run silently using the B<-Q> flag; no output from each
target's standard output or standard error is displayed.
B<SIGNALS>:
Signal 2 (INT), Signal 3 (QUIT), and Signal 15 (TERM) are propagated to
the commands executing on the remote targets.
Signal 19 (CONT), Signal 17 (STOP), and Signal 18 (TSTP) default to
B<xdsh>; the B<xdsh> command responds normally to these signals, but the
signals do not have an effect on remotely executing commands. Other
signals are caught by B<xdsh> and have their default effects on the B<xdsh>
command; all current child processes, through propagation to remotely
running commands, are terminated (SIGTERM).
=head1 B<OPTIONS>
=over 5
=item B<-C>|B<--context> I<context>
The default context to use when resolving target names. The
I<context> value must correspond to a valid context extension
module in the B</opt/xcat/xdsh/Context> directory. For
example, the B</opt/xcat/xdsh/Context/DSH.pm> file is the module
for the B<DSH> context.
=item B<-e>|B<--execute>
Indicates that I<command_list> specifies a local script
filename and arguments to be executed on the remote targets.
The script file is copied to the remote targets and then
remotely executed with the given arguments. The
B<DSH_NODE_RCP> environment variables specify the remote copy
command to use to copy the script file to node targets.
=item B<-E>|B<--environment> I<environment_file>
Specifies that the I<environment_file> contains environment
variable definitions to export to the target before
executing the I<command_list>. The B<DSH_NODE_RCP> and environment
variables specify the remote copy command to use to export
the file to node targets.
=item B<-f>|B<--fanout> I<fanout_value>
Specifies a fanout value for the maximum number of concur-
rently executing remote shell processes. Serial execution
can be specified by indicating a fanout value of B<1>. If B<-f>
is not specified, a default fanout value of B<64> is used.
=item B<-h>|B<--help>
Displays usage information.
=item B<-K>|B<--ssh-setup>
Set up the SSH keys for the specified node list.
Currently, this must be run on the management node (not on a
remote client), because it forces itself into bypass mode.
=item B<-l>|B<--user> I<user_ID>
Specifies a remote user name to use for remote command exe-
cution.
=item B<-L>|B<--no-locale>
Specifies to not export the locale definitions of the local
host to the remote targets. Local host locale definitions
are exported by default to each remote target.
=item B<-m>|B<--monitor>
Monitors remote shell execution by displaying status
messages during execution on each target.
=item B<-o>|B<--node-options> I<node_options>
Specifies options to pass to the remote shell command for
node targets. The options must be specified within double
quotation marks ("") to distinguish them from B<xdsh> options.
The syntax for I<node_options>
=item B<-q>|B<--show-config>
Displays the current environment settings for all DSH
Utilities commands. This includes the values of all environment
variables and settings for all currently installed and
valid contexts. Each setting is prefixed with I<context>: to
identify the source context of the setting.
=item B<-Q>|B<--silent>
Specifies silent mode. No target output is written to stan-
dard output or standard error. Monitoring messages are
written to standard output.
=item B<-r>|B<--node-rsh> I<node_remote_shell>
Specifies the full path of the remote shell command used
for remote command execution on node targets.
=item B<-s>|B<--stream>
Specifies that output is returned as it becomes available
from each target, instead of waiting for the I<command_list>
to be completed on a target before returning output.
=item B<-S>|B<--syntax> B<csh>|B<ksh>
Specifies the shell syntax to be used on the remote target.
If not specified, the B<ksh> syntax is used.
=item B<-t>|B<--timeout> I<timeout>
Specifies the time, in seconds, to wait for output from any
currently executing remote targets. If no output is
available from any target in the specified I<timeout>, B<xdsh>
displays an error and terminates execution for the remote
targets that failed to respond. If I<timeout> is not specified,
B<xdsh> waits indefinitely to continue processing output from
all remote targets. When specified with the B<-i> flag, the
user is prompted for an additional timeout interval to wait
for output.
=item B<-T>|B<--trace>
Enables trace mode. The B<xdsh> command prints diagnostic
messages to standard output during execution to each target.
=item B<-v>|B<--verify>
Verifies each target before executing any remote commands
on the target. If a target is not responding, execution of
remote commands for the target is canceled. When specified
with the B<-i> flag, the user is prompted to retry the
verification request.
=item B<-V>|B<--version>
Displays the B<xdsh> command version information.
=item B<-X> I<env_list>
Ignore B<xdsh> environment variables. This option can take an
argument which is a comma separated list of environment
variable names that should B<NOT> be ignored. If there is no
argument to this option, or the argument is an empty
string, all B<xdsh> environment variables will be ignored.
This option is useful when running B<xdsh> from within other
scripts when you don't want the user's environment affecting
the behavior of xdsh.
=item B<-z>|B<--exit-status>
Displays the exit status for the last remotely executed
non-asynchronous command on each target. If the command
issued on the remote node is run in the background, the
exit status is not displayed.
Exit values for each remote shell execution are displayed in
messages from the B<xdsh> command, if the remote shell exit values are
non-zero. A non-zero return code from a remote shell indicates that
an error was encountered in the remote shell. This return code is
unrelated to the exit code of the remotely issued command. If a
remote shell encounters an error, execution of the remote command on
that target is bypassed.
The B<xdsh> command exit code is B<0> if the command executed without
errors and all remote shell commands finished with exit codes of B<0>.
If internal B<xdsh> errors occur or the remote shell commands do not
complete successfully, the B<xdsh> command exit value is greater than
B<0>. The exit value is increased by B<1> for each successive instance of
an unsuccessful remote command execution. If the remotely issued
command is run in the background, the exit code of the remotely
issued command is B<0>.
=back
=head1 B<Environment> B<Variables>
=over 4
=item B<DSH_CONTEXT>
Specifies the default context to use when resolving
targets. This variable is overridden by the B<-C> flag.
=item B<DSH_ENVIRONMENT>
Specifies a file that contains environment variable
definitions to export to the target before executing the remote
command. This variable is overridden by the B<-E> flag.
=item B<DSH_FANOUT>
Specifies the fanout value. This variable is overridden by
the B<-f> flag.
=item B<DSH_NODE_OPTS>
Specifies the options to use for the remote shell command
with node targets only. This variable is overridden by the
B<-o> flag.
=item B<DSH_NODE_RCP>
Specifies the full path of the remote copy command to use
to copy local scripts and local environment configuration
files to node targets.
=item B<DSH_NODE_RSH>
Specifies the full path of the remote shell to use for
remote command execution on node targets. This variable is
overridden by the B<-r> flag.
=item B<DSH_NODEGROUP_PATH>
Specifies a colon-separated list of directories that
contain node group files for the B<DSH> context. When the B<-a> flag
is specified in the B<DSH> context, a list of unique node
names is collected from all node group files in the path.
=item B<DSH_PATH>
Sets the command path to use on the targets. If B<DSH_PATH> is
not set, the default path defined in the profile of the
remote I<user_ID> is used.
=item B<DSH_SYNTAX>
Specifies the shell syntax to use on remote targets; B<ksh> or
B<csh>. If not specified, the B<ksh> syntax is assumed. This
variable is overridden by the B<-S> flag.
=item B<DSH_TIMEOUT>
Specifies the time, in seconds, to wait for output from
each remote target. This variable is overridden by the B<-t>
flag.
=head1 B<Security>
The B<xdsh> command has no security configuration requirements. All
remote command security requirements - configuration,
authentication, and authorization - are imposed by the underlying remote
command configured for B<xdsh>. The command assumes that authentication
and authorization is configured between the local host and the
remote targets. Interactive password prompting is not supported; an
error is displayed and execution is bypassed for a remote target if
password prompting occurs, or if either authorization or
authentication to the remote target fails. Security configurations as they
pertain to the remote environment and remote shell command are
userdefined.
=head1 B<Examples>
=over 3
=item *
To run the B<ps> command on node targets B<node1> and B<node2>, enter:
B<xdsh> I<node1,node2 ps>
=item *
To execute the commands contained in B<myfile> in the B<XCAT>
context on several node targets, with a fanout of B<1>, enter:
B<xdsh> I<node1,node2 -C XCAT -f 1 -e myfile>
=item *
To run the ps command on node1 and ignore all the dsh
environment variable except the DSH_NODE_OPTS, enter:
B<xdsh> I<node1 -X `DSH_NODE_OPTS' ps>
=back
=head1 B<Files>
B</opt/xcat/xdsh/Context/>
Location of the contexts available to use with DSH Utilities.
=head1 B<SEE ALSO>
xdshbak(1), noderange(3)

116
xCAT-client-2.0/pods/man1/xdshbak.1.pod Normal file
View File

@ -0,0 +1,116 @@
=head1 B<NAME>
B<xdshbak> - Formats the output of the B<xdsh> command.
=head1 B<SYNOPSIS>
B<xdshbak> [B<-c> | B<-x>]
=head1 B<DESCRIPTION>
The B<xdshbak> command formats output from the B<xdsh> command. The B<xdshbak>
command takes, as input, lines in the following format:
host_name: line of output from remote command
The B<xdshbak> command formats the lines as follows and writes them to
standard output. Assume that the output from node3 and node4
is identical, and the B<-c> (collapse) flag was specified:
HOSTS --------------------------------------------------------
node1
--------------------------------------------------------------
.
.
lines from xdsh for node1 with hostnames stripped off
.
.
HOSTS --------------------------------------------------------
node2
--------------------------------------------------------------
.
.
lines from xdsh for node2 with hostnames stripped off
.
.
HOSTS --------------------------------------------------------
node3, node4
--------------------------------------------------------------
.
.
lines from xdsh for node 3 with hostnames stripped off
.
.
When output is displayed from more than one node in collapsed form, the
host names are displayed alphabetically. When output is not collapsed,
output is displayed sorted alphabetically by host name. The B<xdshbak>
command writes "." for each 1000 lines of output processed (to show progress),
since it won't display the output until it has processed all of it.
If the B<-x> flag is specified, the extra header lines that xdshbak nor-
mally displays for each node will be omitted, and the hostname at the beginning
of each line is not stripped off, but B<xdshbak> still sorts
the output by hostname for easier viewing:
node1: lines from xdsh for node1
.
.
node2: lines from xdsh for node2
.
.
B<Standard> B<Error>
When the B<xdshbak> filter is used and standard error messages are gener-
ated, all error messages on standard error appear before all standard
output messages. This is true with and without the B<-c> flag.
=head1 B<OPTIONS>
=over 4
=item B<-c>
If the output from multiple nodes is identical it will be collapsed
and displayed only once.
=item B<-x>
Omit the extra header lines that xdshbak normally displays for
each node. This provides
more compact output, but xdshbak still sorts the output by
node name for easier viewing.
This option should not be used with B<-c>.
=head1 B<EXAMPLES>
=over 3
=item *
To display the results of a command issued on several nodes, in
the format used in the Description, enter:
B<xdsh> I<node1,node2,node3 cat /etc/passwd> | B<xdshbak>
=item *
To display the results of a command issued on several nodes with
identical output displayed only once, enter:
B<xdsh> I<host1,host2,host3 pwd> | B<xdshbak -c>
=item *
To display the results of a command issued on several nodes with
compact output and be sorted alphabetically by host name, enter:
B<xdsh> I<host1,host2,host3 date> | B<xdshbak -x>
=back
=head1 B<SEE ALSO>
xdsh(1), xcoll(1)

263
xCAT-client-2.0/pods/man3/noderange.3.pod Normal file
View File

@ -0,0 +1,263 @@
=head1 Name
B<noderange> - syntax for compactly expressing a list of node names
=head1 B<Synopsis>
I<Examples:>
node1,node2,node8,node20,group1
node14-node56,node70-node203,group1-group10
node1,node2,node8,node20,node14-node56,node70-node203
node[14-56]
all,-node129-node256,-frame01-frame03
/node.*
^/tmp/nodes
node10+5
10-15,-13
group1@group2
=head1 B<Description>
B<noderange> is a syntax that can be used in most xCAT commands to conve-
niently specify a list of nodes. The result is that the command will
be applied to a range of nodes, often in parallel.
B<noderange> is a comma-separated list. Each token (text between commas)
in the list can be any of the forms listed below:
Individual node or group:
I<node01>
I<group1>
A range of nodes or groups:
I<node01-node10> (equivalent to: node01,node02,node03,...node10)
I<group1-group3> (equivalent to: group1,group2,group3)
A regular expression match of nodes or groups:
I</node[345].*> (will match any nodes that start with node3, node4, or
node5)
I</group[12].*> (will match any groups that start with group1 or group2)
An incremented range of nodes:
I<node10+3> (equivalent to: node10,node11,node12,node13)
The full path of a file containing noderanges of nodes or groups:
I<^/tmp/nodelist>
A node shorthand range of nodes:
I<10-20> (if prefix is `node', equivalent to:
node10,node11,node12,...node20)
I<10+3> (if prefix is `node', equivalent to: node10,node11,node12,node13)
Or any combination:
I<node01-node30,node40,^/tmp/nodes,/node[13].*,2-10,node50+5>
Any individual B<noderange> may be prefixed with an exclusion operator
(default -) with the exception of the file operator (default ^).
The intersection operator @ calculates the intersection of the left and
right sides:
I<group1@group2> (will result in the list of nodes group1 and group2 have
in common)
Any combination or multiple combinations of inclusive and exclusive
ranges of nodes and groups is legal. There is no precedence implied in
the order of the arguments. Exclusive ranges have precedence over
inclusive.
Nodes have precedence over groups. If a node range match is made then
no group range match will be attempted.
All node names are validated against the nodelist table. Invalid nodes
are ignored and return nothing.
All group names are validated against the nodelist and nodetype table.
Invalid groups are ignored and return nothing.
Throughout this man page the term I<xCAT> I<Node> I<Format> will be used.
I<xCAT> I<Node> I<Format> is defined by the following regex:
^([A-Za-z-]+)([0-9]+)(([A-Za-z-]+[A-Za-z0-9-]*)*)
In plain english a node or group is in I<xCAT> I<Node> I<Format> if starting
from the begining there are one or more alpha characters of any case
and any number of - in any combination, followed by one or more num-
bers, then optionally followed by one alpha character of any case or
the - followed by any combination of case mixed alphanumerics and the
-.
B<noderange> supports node/group names in I<any> format. I<xCAT> I<Node> I<Format> is
B<not> required, however some node range methods used to determine range
will not be used. E.g. If using a B<noderange> of I<node1a-node9a> with a
B<nodelist> table only listing I<node1a> through I<node5a>, B<noderange> will enu-
merate then validate and return a proper range. If using a node range
of I<aa-az> with a B<nodelist> table only listing I<aa> through I<ay,> B<noderange>
will fail to return any values.
Example of I<xCAT> I<Node> I<Format> node/group names:
B< nodename prefix number suffix>
node1 node 1
node001 node 001
node-001 node- 001
node-foo-001-bar node-foo- 001 -bar
node-foo-1bar node-foo- 1 bar
foo1bar2 foo 1 bar2
rack01unit34 rack 01 unit34
unit34rack01 unit 34 rack01
pos0134 pos 0134
Example of non-I<xCAT> I<Node> I<Format> node/group names, but still valid:
aa
yellow
red
12foo
The supported B<noderange> syntaxes are checked for, and processed, in a
specific order. First B<noderange> checks for the multiple range operator
(default ,). Each range is also processed by B<noderange>.
Next B<noderange> checks for the file operator (default ^). If the file
exists (must be a full path name) each line will be processed as a
B<noderange>. Lines starting with I<#> or the file operator (default ^) are
ignored. Only one B<noderange> per line is read. All characters are
ignored after the first white space.
e.g.
^/tmp/nodes
where
cat /tmp/nodes outputs:
#my node list (this line ignored)
^/tmp/foo #ignored
node01 #node comment
node02
node03
node10-node20
/group[456].*
-node50
Next B<noderange> checks for the exclusion operator (default -) then con-
tinues. This operator supports nodes and groups. B<noderange> will not
confuse the exclusion or range operators with the - character in names.
Next B<noderange> checks for a numeric only range (e.g. 10-20, 5+3, or
just 10), then uses I<$XCAT>B<_>I<NODE>B<_>I<PREFIX> (default is `node') and
I<$XCAT>B<_>I<NODE>B<_>I<SUFFIX> (optional) as the defaults to complete the node
names. B<nodeRange> tries to be intelligent about detecting padding, so
you can specify `node001-node200' and it will add the proper number of
zeroes to make all numbers 3 digits. Noderange shorthand supports
nodes only. Noderange shorthand can be mixed with all other operators
except regex. i.e. exclusion, increment, range, and file may be used.
Next B<noderange> checks for the for the regular expression operator
(default /). Regular expressions offer the most flexibility. If you
are interested in learning regex read the book I<Mastering> I<Regular>
I<Expressions>. This operator supports nodes and groups.
Next B<noderange> checks for the increment range operator (default +).
Increment range operator noderanges are in the format:
I<valid>B<_>I<node>B<_>I<name>B<+>I<number>B<_>I<of>B<_>I<sequential>B<_>I<nodes>
e.g.
I<node10+5>
would yield node10 plus the next I<5> nodes.
This action is performed using two different methods. If
I<valid>B<_>I<node>B<_>I<name> is in I<xCAT> I<Node> I<Format> then the range is enumerated to
I<number>B<_>I<of>B<_>I<sequential>B<_>I<nodes>. If not in I<xCAT> I<Node> I<Format> then a sorted
B<nodelist> table is used to return the node range. This operator sup-
ports nodes only.
Next B<noderange> checks for a single node name or group name.
Next B<noderange> checks for the range operator (default -). Ranges are
performed first by validating that both the start and end nodes or
groups defining the range exist and if so the range is returned based
on the content of the B<nodelist> and B<nodetype> tables. If the start and
end nodes or groups defined in the range do not exist, I<and> if both are
in I<xCAT> I<Node> I<Format>, I<and> if both the prefix and suffix match, then the
range is enumerated and each node/group validated. Only valid
nodes/groups will be returned. B<noderange> will not confuse the exclu-
sion or range operators with the - character in names.
Last B<noderange> returns nothing if no match can be found.
B<noderange> uses the smallest integer to determine padding. e.g.
I<node1-node10> will generate a list of nodes with numbers 1, 2, 3, 4, 5,
6, 7, 8, 9, 10. I<node001-node010> will generate a list of nodes with
numbers 001, 002, 003, 004, 005, 006, 007, 008, 009, 010.
Multiple instances of a node name are treated as one instance. e.g.
I<node1-node10,node4,node4,node4> will generate a list of nodes numbered 1
through 10, the number 4 will only be listed once.
=head1 B<Examples>
I<all,-node5-node10>
Generates a list of all nodes (assuming all is a group) listed in the
B<nodelist> table less node5 through node10.
I<node1-node10,-node3-node5,node4>
Generates a list of nodes 1 through 10 less nodes 3,4,5. Note that
node4 is listed twice, first in the range and then at the end. Because
exclusion has precedence node4 will be excluded.
I<node1-node10,-node3,-node5>
Generates a list of nodes 1 through 10 less nodes 3 and 5.
I<-node17-node32,all>
Generates a list of all (assuming `all' is a group) nodes in the
B<nodelist> table less 17 through 32.
I<node1-node128,user1-user4>
Generates a list of nodes 1 through 128, and user nodes 1 through 4.
I<all,-rack1-rack3,-node100-node200,node150,-storage>
Generates a list of all nodes (assuming `all' is a group), less nodes
in groups rack1 through rack3 (assuming groups rack1, rack2, and rack3
are defined), less nodes 100 through 200, less nodes in the storage
group. Note that node150 is listed but is excluded.
I</node[23].*>
Generates a list of nodes matching the regex I<node[23].*>. That is all
nodes that start with node2 or node3 and end in anything or nothing.
E.g. node2, node3, node20, node30, node21234 all match.
=head1 B<SEE ALSO>
nodels(1)

27
xCAT-client-2.0/pods/man8/copycds.8.pod Normal file
View File

@ -0,0 +1,27 @@
=head1 NAME
B<copycds> - Copies Linux distributions and service levels from CDs to install directory.
=head1 SYNOPSIS
B<copycds> [{B<-n|--name|--osver>}=I<distroname>] [{B<-a|--arch>}=I<architecture>] I<1st.iso [2nd.iso ...]>
B<copycds> [B<-h>|B<--help>]
=head1 DESCRIPTION
The copycds command copies all contents of Distribution CDs or Service Pack CDs to the install directory as
designated in the B<site> table attribute: B<installdir>.
=head1 SEE ALSO
site(5)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

118
xCAT-client-2.0/pods/man8/makedns.8.pod Normal file
View File

@ -0,0 +1,118 @@
=head1 NAME
B<makedns> - sets up domain name services (DNS) from the entries in /etc/hosts.
=head1 SYNOPSIS
B<makedns> I<options>
B<makedns> [B<-h>|B<--help>]
=head1 DESCRIPTION
B<makedns> makes a DNS server from the /etc/hosts file entries. It also uses the following
attributes set in the B<site> table as default values: B<domain>, B<forwarders>, B<nameservers>.
The domain value can be overridden by the B<-d> option.
The netmasks from the B<networks> table will also be used if not overridden by the B<-n> option.
=head1 OPTIONS
=over 6
=item B<-d> I<domain>
The domain name to use. If not specified, the default used is the B<domain> attribute in the B<site> table.
=item B<-f> I<file>
A file containing more arguments for B<makedns>.
=item B<-z|-Z> nameserver
The hostname of a secondary nameserver to use.
=item B<-b> bootfile
Boot file to use.
=item B<-A>
Do aliases.
=item B<-M>
Do mx records.
=item B<-w>
Do wks.
=item B<-D>
Don't do domains.
=item B<-t>
Do txt records.
=item B<-u> I<user>
User?
=item B<-s> I<server ...>
Servers.
=item B<-m> I<mx>
mx records.
=item B<-c> I<pattern>
C patterns?
=item B<-e> I<pattern>
Elimination patterns?
=item B<-h> I<host>
Host.
=item B<-o> I<options>
Refresh, retry, expire, ttl options, separated by colons.
=item B<-i>
Force serial.
=item B<-H> I<file>
File to read the host entries from. Default is /etc/hosts.
=item B<-C> I<file>
Comments file.
=item B<-N> I<mask>
Default subnet mask.
=item B<-n> I<mask>
Subnet mask. If not specified, all the netmasks from the B<networks> table are used.
=back
=head1 SEE ALSO
site(5)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>

130
xCAT-client-2.0/share/man/man1/reventlog.1
View File

@ -1,130 +0,0 @@
.\" Process this file with
.\" groff -man -Tascii reventlog.1
.\"
.TH REVENTLOG 1 "Jan 2008" xCAT "xCAT"
.SH NAME
reventlog \- retrieve or clear remote hardware event logs
.SH SYNOPSIS
.B reventlog
[\fInoderange\fR] [\fInumber of entries\fR|\fIall\fR|\fIclear\fR]
.B reventlog
[\fI-h\fR|\fI--help\fR|\fI-v\fR|\fI--version\fR]
.SH DESCRIPTION
.B reventlog
can display any number of remote hardware event log entries
or clear them for a range of nodes. See
.BR noderange (3).
Hardware event logs are stored on each servers service processor.
.SH OPTIONS
.IP \fIn\fR
Retrieve \fIn\fR number of entries.
.IP \fBall\fR
Retrieve all entries.
.IP \fBclear\fR
Clear event logs.
.IP \fB-h\fR|\fB--help\fR
Print help.
.IP \fB-v\fR|\fB--version\fR
Print version.
.SH DIAGNOSTICS
The following diagnostics may be issued on stdout/stderr:
is not a node or a group
.RS
Node or group is not defined in
.BR nodelist.tab (5).
.RE
function not supported
.RS
Node does not support remote event log retrieval or remote event log retrieval method not supported.
.RE
ping to $SPN failed
.RS
Where $SPN = the Service Processor Network defined in
.BR mp.tab (5).
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
telnet timeout
.RS
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
connection refused
.RS
Returned if telnet fails. PCI MPA may be in use or telnet interface is locked up.
.BR mpareset (1)
can be used to reboot the PCI MPA.
.RE
unknown asma $host
.RS
Returned if not in /etc/hosts or DNS.
.RE
name lookup failure
.RS
Returned if not in DNS.
.RE
node not on asma $SPN
.RS
Where $SPN = the SPN defined for that node in in
.BR mp.tab (5).
Use
.BR mpncheck (1)
$SPN to verify. Check cabling and try
.BR
mpareset (1).
.RE
remote session timeout
.RS
Communication with SPN was successful but communication with node failed. Check cabling. Try removing power from node, wait 10 seconds, then restore.
.SH EXAMPLES
\fIreventlog node4,node5 5\fR
node4: SERVPROC I 09/06/00 15:23:33 Remote Login Successful User ID = USERID[00]
.br
node4: SERVPROC I 09/06/00 15:23:32 System spn1 started a RS485 connection with us[00]
.br
node4: SERVPROC I 09/06/00 15:22:35 RS485 connection to system spn1 has ended[00]
.br
node4: SERVPROC I 09/06/00 15:22:32 Remote Login Successful User ID = USERID[00]
.br
node4: SERVPROC I 09/06/00 15:22:31 System spn1 started a RS485 connection with us[00]
.br
node5: SERVPROC I 09/06/00 15:22:32 Remote Login Successful User ID = USERID[00]
.br
node5: SERVPROC I 09/06/00 15:22:31 System spn1 started a RS485 connection with us[00]
.br
node5: SERVPROC I 09/06/00 15:21:34 RS485 connection to system spn1 has ended[00]
.br
node5: SERVPROC I 09/06/00 15:21:30 Remote Login Successful User ID = USERID[00]
.br
node5: SERVPROC I 09/06/00 15:21:29 System spn1 started a RS485 connection with us[00]
.br
\fIreventlog node4,node5 clear\fR
node4: clear
.br
node5: clear
.SH "FILES"
.IX Header "FILES"
/opt/xcat/bin/reventlog
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.

148
xCAT-client-2.0/share/man/man1/rinv.1
View File

@ -1,148 +0,0 @@
.\" Process this file with
.\" groff -man -Tascii rinv.1
.\"
.TH RINV 1 "Jan 2008" xCAT "xCAT"
.SH NAME
rinv \- remote hardware inventory
.SH SYNOPSIS
.B rinv
[\fInoderange\fR] [\fIpci\fR|\fIconfig\fR|\fImodel\fR|\fIserial\fR|\fIasset\fR|\fIall\fR]
.B rinv
[\fI-h\fR|\fI--help\fR|\fI-v\fR|\fI--version\fR]
.SH DESCRIPTION
.B rinv
retrieves hardware configuration information from the on-board Service Processor
for a single or range of nodes and groups.
.SH OPTIONS
.IP \fBpci\fR
Retrieves PCI bus information.
.IP \fBconfig\fR
Retrieves number of processors, speed, total memory, and DIMM locations.
.IP \fBmodel\fR
Retrieves model number.
.IP \fBserial\fR
Retrieves serial number.
.IP \fBasset\fR
Retrieves asset tag. Usually it's the MAC address of eth0.
.IP \fBall\fR
All of the above.
.IP \fB-h\fR|\fB--help\fR
Print help.
.IP \fB-v\fR|\fB--version\fR
Print version.
.SH DIAGNOSTICS
The following diagnostics may be issued on stdout/stderr:
is not a node or a group
.RS
Node or group is not defined in
.BR nodelist.tab (5).
.RE
function not supported
.RS
Node does not support remote power control or remote power control method not supported.
.RE
ping to $SPN failed
.RS
Where $SPN = the Service Processor Network defined in
.BR mp.tab (5).
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
telnet timeout
.RS
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
connection refused
.RS
Returned if telnet fails. PCI MPA may be in use or telnet interface is locked up.
.BR mpareset (1)
can be used to reboot the PCI MPA.
.RE
unknown asma $host
.RS
Returned if not in /etc/hosts or DNS.
.RE
name lookup failure
.RS
Returned if not in DNS.
.RE
node not on asma $SPN
.RS
Where $SPN = the SPN defined for that node in in
.BR mp.tab (5).
Use
.BR mpncheck (1)
$SPN to verify. Check cabling and try
.BR
mpareset (1).
.RE
remote session timeout
.RS
Communication with SPN was successful but communication with node failed. Check cabling. Try removing power from node, wait 10 seconds, then restore.
.SH EXAMPLES
\fIrinv node5 all\fR
node5: Machine Type/Model 865431Z
.br
node5: Serial Number 23C5030
.br
node5: Asset Tag 00:06:29:1F:01:1A
.br
node5: PCI Information
.br
node5: Bus VendID DevID RevID Description Slot Pass/Fail
.br
node5: 0 1166 0009 06 Host Bridge 0 PASS
.br
node5: 0 1166 0009 06 Host Bridge 0 PASS
.br
node5: 0 5333 8A22 04 VGA Compatible Controller 0 PASS
.br
node5: 0 8086 1229 08 Ethernet Controller 0 PASS
.br
node5: 0 8086 1229 08 Ethernet Controller 0 PASS
.br
node5: 0 1166 0200 50 ISA Bridge 0 PASS
.br
node5: 0 1166 0211 00 IDE Controller 0 PASS
.br
node5: 0 1166 0220 04 Universal Serial Bus 0 PASS
.br
node5: 1 9005 008F 02 SCSI Bus Controller 0 PASS
.br
node5: 1 14C1 8043 03 Unknown Device Type 2 PASS
.br
node5: Machine Configuration Info
.br
node5: Number of Processors: 2
.br
node5: Processor Speed: 866 MHz
.br
node5: Total Memory: 512 MB
.br
node5: Memory DIMM locations: Slot(s) 3 4
.br
.SH "FILES"
.IX Header "FILES"
/opt/xcat/bin/rinv
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.

169
xCAT-client-2.0/share/man/man1/rvitals.1
View File

@ -1,169 +0,0 @@
.\" Process this file with
.\" groff -man -Tascii rvitals.1
.\"
.TH RVITALS 1 "Jan 2008" xCAT "xCAT"
.SH NAME
rvitals \- remote hardware vitals
.SH SYNOPSIS
.B rvitals
[\fInoderange\fR] [\fIcputemp\fR|\fIdisktemp\fR|\fIambtemp\fR|\fItemp\fR]
.B rvitals
[\fInoderange\fR] [\fIvoltage\fR|\fIfanspeed\fR|\fIpower\fR|\fIpowertime\fR]
.B rvitals
[\fInoderange\fR] [\fIreboots\fR|\fIstate\fR|\fIall\fR]
.B rvitals
[\fI-h\fR|\fI--help\fR|\fI-v\fR|\fI--version\fR]
.SH DESCRIPTION
.B rvitals
retrieves hardware vital information from the on-board Service Processor
for a single or range of nodes and groups.
.SH OPTIONS
.IP \fBcputemp\fR
Retrieves CPU temperatures.
.IP \fBdisktemp\fR
Retrieves HD back plane temperatures.
.IP \fBambtemp\fR
Retrieves ambient temperatures.
.IP \fBtemp\fR
Retrieves all temperatures.
.IP \fBvoltage\fR
Retrieves power supply and VRM voltage readings.
.IP \fBfanspeed\fR
Retrieves fan speeds.
.IP \fBpower\fR
Retrieves power status.
.IP \fBpowertime\fR
Retrieves total power uptime. This value only increases, unless the
Service Processor flash gets updated.
.IP \fBreboot\fR
Retrieves total number of reboots. This value only increases, unless the
Service Processor flash gets updated.
.IP \fBstate\fR
Retrieves the system state.
.IP \fBall\fR
All of the above.
.IP \fB-h\fR|\fB--help\fR
Print help.
.IP \fB-v\fR|\fB--version\fR
Print version.
.SH DIAGNOSTICS
The following diagnostics may be issued on stdout/stderr:
is not a node or a group
.RS
Node or group is not defined in
.BR nodelist.tab (5).
.RE
function not supported
.RS
Node does not support remote power control or remote power control method not supported.
.RE
ping to $SPN failed
.RS
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
telnet timeout
.RS
PCI MPA adapter may not have power. Check Ethernet cable and IP.
.RE
connection refused
.RS
Returned if telnet fails. PCI MPA may be in use or telnet interface is locked up.
.BR mpareset (1)
can be used to reboot the PCI MPA.
.RE
unknown asma $host
.RS
Returned if not in /etc/hosts or DNS.
.RE
name lookup failure
.RS
Returned if not in DNS.
.RE
node not on asma $SPN
.RS
Where $SPN = the SPN defined for that node in in
.BR mp.tab (5).
Use
.BR mpncheck (1)
$SPN to verify. Check cabling and try
.BR
mpareset (1).
.RE
remote session timeout
.RS
Communication with SPN was successful but communication with node failed. Check cabling. Try removing power from node, wait 10 seconds, then restore.
.SH EXAMPLES
\fIrvitals node5 all\fR
node5: CPU 1 Temperature: + 29.00 C (+ 84.2 F)
.br
node5: CPU 2 Temperature: + 19.00 C (+ 66.2 F)
.br
node5: DASD Sensor 1 Temperature: + 32.00 C (+ 89.6 F)
.br
node5: System Ambient Temperature Temperature: + 26.00 C (+ 78.8 F)
.br
node5: +5V Voltage: + 5.01V
.br
node5: +3V Voltage: + 3.29V
.br
node5: +12V Voltage: + 11.98V
.br
node5: +2.5V Voltage: + 2.52V
.br
node5: VRM1 Voltage: + 1.61V
.br
node5: VRM2 Voltage: + 1.61V
.br
node5: Fan 1 Percent of max: 100%
.br
node5: Fan 2 Percent of max: 100%
.br
node5: Fan 3 Percent of max: 100%
.br
node5: Fan 4 Percent of max: 100%
.br
node5: Fan 5 Percent of max: 100%
.br
node5: Fan 6 Percent of max: 100%
.br
node5: Current Power Status On
.br
node5: Power On Seconds 11855915
.br
node5: Number of Reboots 930
.br
node5: System State Booting OS or in unsupported OS
.br
.SH "FILES"
.IX Header "FILES"
/opt/xcat/bin/rvitals
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software product.

672
xCAT-client-2.0/share/man/man1/xdsh.1
View File

@ -1,672 +0,0 @@
.TH xdsh 12/13/07
xdsh Command
.PP
\fBPurpose
\fR
.PP
\fBxdsh\fR - Concurrently runs commands on multiple nodes.
.PP
\fBSyntax
\fR
.PP
\fBxdsh\fR \fB-h\fR
.PP
\fBxdsh\fR \fB-V\fR
.PP
\fBxdsh\fR \fB-q\fR
.PP
\fBxdsh\fR [[\fInode_list\fR]| [\fInodegroup\fR]]
[\fB-B\fR \fIbypass\fR]
[\fB-C\fR \fIcontext\fR] [\fB-e\fR]
[\fB-E\fR \fIenvironment_file\fR] [\fB-f\fR\fIfanout\fR]
[\fB-i\fR] [\fB-K\fR] [\fB-L\fR] [\fB-l\fR \fIuser_ID\fR]
[\fB-m\fR] [\fB-o\fR \fInode_options\fR]
[\fB-Q\fR] [\fB-r\fR \fInode_remote_shell\fR]
[\fB-s\fR] [\fB-S\fR \fBcsh\fR | \fBksh\fR] [\fB-t\fR \fItimeout\fR]
[\fB-T\fR] [\fB-v\fR] [\fB-X\fR \fIenv_list\fR] [\fB-z\fR]
[\fIcommand_list\fR]
.PP
.PP
\fBDescription
\fR
.PP
The \fBxdsh\fR command runs commands concurrently on remote nodes.
Targets can be selected from multiple contexts.
A context is a target database that contains the node definition.
The \fBxdsh\fR command issues a remote shell command for each
target specified, and returns the output from all targets,
formatted so that command results from all nodes
can be managed. \fB/usr/bin/rsh\fR is the model for the syntax and
security. The \fBxdsh\fR command is a xCAT Distributed Shell
Utility.
.PP
\fBTARGET CONTEXT\fR:
.PP
The \fBxdsh\fR command target context is the database where the target or
target group is defined. A default context can be configured using the
\fB-C\fR \fIcontext\fR flag or the \fBDSH_CONTEXT\fR
environment variable. If neither are specified, the default context is
\fBXCAT\fR.
.PP
A context is enabled for use with a DSH Utilities command by installing a
context extension file in the \fB/opt/xcat/xdsh/Context\fR
directory. The target or target group context can be explicitly
specified by qualifying a target name with a context name, or implicitly
defined by specifying a default context for unqualified target names (See
\fBTarget lists\fR).
.PP
\fBTARGET SPECIFICATION\fR:
.PP
A target is a node where a remote command will be
executed. Node targets are specified inputting the
\fInode_list\fR or \fInodegroups\fR.
.PP
If the local host is included as part of the targets, the
\fIcommand_list\fR is executed directly on the local host and not through
the configured remote shell, unless a \fIuser_ID\fR is specified for
execution with the local host (see \fBRemote user\fR).
.PP
Node targets can also be specified using node
ranges as supported by xCAT. If the same
target is specified more than once, the remote command will only be executed
once on the specified target.
.PP
\fBCOMMAND SPECIFICATION\fR:
.PP
The commands to execute on the remote targets are specified by the
\fIcommand_list\fR \fBxdsh\fR parameter,
or executing a local script using the \fB-e\fR
flag.
.PP
The syntax for the \fIcommand_list\fR \fBxdsh\fR parameter is as
follows:
.sp
.nf
"\fIcommand\fR[; \fIcommand\fR]..."\
.fi
.sp
.PP
where \fIcommand\fR is the command to run on the remote
target. Quotation marks are required to ensure that all commands in the
list are executed remotely, and that any special characters are interpreted
correctly on the remote target. A script file on the local host can be
executed on each of the remote targets by using the \fB-e\fR
flag. If \fB-e\fR is specified, \fIcommand_list\fR is the
script name and arguments to the script. For example:
.sp
.nf
xdsh hostname -e [\fIflags\fR] \fIscript_filename\fR [\fIarguments\fR]...
.fi
.sp
.PP
The \fIscript_filename\fR file is copied to a random filename in the
\fB/tmp\fR directory on each remote target and then executed on the
targets.
.PP
The \fBxdsh\fR command does not work with any interactive commands,
including those that read from standard input.
.PP
\fBREMOTE USER\fR:
.PP
The \fIuser_ID\fR to use for a remote target can be specified
using the \fB-l\fR (lowercase L) flag.
.PP
\fBREMOTE SHELL COMMAND\fR:
.PP
The \fBxdsh\fR command uses a configurable remote shell command to
execute remote commands on the remote targets. Support is explicitly
provided for AIX Remote Shell and OpenSSH, but any secure remote command that
conforms to the IETF (Internet Engineering Task Force) Secure Remote Command
Protocol can be used.
.PP
The remote shell is determined as follows, in order of
precedence:
.RS +3
.HP 3
1. The \fB-r\fR flag.
.HP 3
2. The \fBDSH_NODE_RSH\fR environment variable.
.HP 3
3. The default node remote shell as defined by the target
\fIcontext\fR.
.HP 3
4. The \fB/usr/bin/rsh\fR command.
.RE
.PP
The remote shell options are determined as follows, in
order of precedence:
.RS +3
.HP 3
1. The \fB-o\fR flag.
.HP 3
2. The \fBDSH_NODE_OPTS\fR environment variable.
.RE
.PP
\fBREMOTE SHELL ENVIRONMENT\fR:
.PP
The shell environment used on the remote target defaults to the shell
defined for the \fIuser_ID\fR used for remote command execution.
The command syntax used for remote command execution can be specified using
the \fB-S\fR flag. If \fB-S\fR is not specified, the
syntax defaults to \fBksh\fR syntax.
.PP
When commands are executed on the remote target, the path used is
determined by the \fBDSH_PATH\fR environment variable defined in the shell
of the current user. If \fBDSH_PATH\fR is not set, the path used is
the remote shell default path. For example, to set the local path for
the remote targets, use:
.sp
.nf
DSH_PATH=$PATH
.fi
.sp
.PP
The \fB-E\fR flag exports a local environment definition file to
each remote target. Environment variables specified in this file are
defined in the remote shell environment before the \fIcommand_list\fR is
executed.
.PP
\fBCOMMAND EXECUTION\fR:
.PP
The maximum number of concurrent remote shell command processes (the
fanout) can be specified with the \fB-f\fR flag or with the
\fBDSH_FANOUT\fR environment variable. The fanout is only restricted by the number of remote shell commands
that can be run in parallel. You can experiment with the
\fBDSH_FANOUT\fR value on your management server to see if higher values
are appropriate.
.PP
A timeout value for remote command execution can be specified with the
\fB-t\fR flag or with the \fBDSH_TIMEOUT\fR environment
variable. If any remote target does not provide output to either
standard output or standard error within the timeout value, \fBxdsh\fR
displays an error message and exits.
.PP
If streaming mode is specified with the \fB-s\fR flag, output is
returned as it becomes available from each target, instead of waiting for the
\fIcommand_list\fR to complete on all targets before returning
output. This can improve performance but causes the output to be
unsorted.
.PP
The \fB-z\fR flag displays the exit code from the last command
issued on the remote node in \fIcommand_list\fR. Note that OpenSSH
behaves differently; it returns the exit status of the last remote
command issued as its exit status. This affects the behavior of
\fBxdsh\fR and may require using the \fB-c\fR flag. If the
command issued on the remote node is run in the background, the exit status is
not displayed.
.PP
The \fB-m\fR flag monitors execution of the \fBxdsh\fR command
by printing status messages to standard output. Each status message is
preceded by \fBdsh>\fR.
.PP
The \fB-T\fR flag provides diagnostic trace information for the
execution of the \fBxdsh\fR command. Default settings and the actual
remote shell commands executed on the remote targets are displayed.
.PP
No error detection or recovery mechanism is provided for remote
targets. The \fBxdsh\fR command output to standard error and standard
output can be analyzed to determine the appropriate course of action.
In interactive mode, if a command cannot be executed on a remote target (for
example, a remote shell command resulting in a non-zero return code),
subsequent commands are not sent to this node on this invocation of the
\fBxdsh\fR command unless the \fB-c\fR flag is specified.
.PP
\fBCOMMAND OUTPUT\fR:
.PP
The \fBxdsh\fR command waits until complete output is available from each
remote shell process and then displays that output before initiating new
remote shell processes. This default behavior is overridden by the
\fB-s\fR flag.
.PP
The \fBxdsh\fR command output consists of standard error and standard
output from the remote commands. The \fBxdsh\fR standard output is
the standard output from the remote shell command. The \fBxdsh\fR
standard error is the standard error from the remote shell command.
Each line is prefixed with the host name of the node that produced the
output. The host name is followed by the \fB:\fR character and
a command output line. A filter for displaying identical outputs
grouped by node is provided separately. See the \fBxdshbak\fR command
for more information.
.PP
A command can be run silently using the \fB-Q\fR flag; no
output from each target's standard output or standard error is
displayed.
.PP
\fBSIGNALS\fR:
.PP
Signal 2 (INT), Signal 3 (QUIT), and Signal 15 (TERM) are propagated to the
commands executing on the remote targets.
.PP
Signal 19 (CONT), Signal 17 (STOP), and Signal 18 (TSTP) default to
\fBxdsh\fR; the \fBxdsh\fR command responds normally to these
signals, but the signals do not have an effect on remotely executing
commands. Other signals are caught by \fBxdsh\fR and have their
default effects on the \fBxdsh\fR command; all current child processes,
through propagation to remotely running commands, are terminated
(SIGTERM).
.PP
.PP
\fBParameters
\fR
.RS +3
\fB\fIcommand_list\fR
\fR
.RE
.RS +9
Specifies a list of commands to execute on the remote targets. The
syntax for the \fIcommand_list\fR parameter is as follows:
.sp
.nf
"\fIcommand\fR[; \fIcommand\fR..."
.fi
.sp
.RE
.PP
.RE
.RS +3
\fInode_list\fR
\fR
.RE
.RS +9
Specifies a list of node targets to include in the target list.
.sp
.RE
.RS +3
\fInodegroups\fR
.RS +9
Includes in the target list all nodes defined in the node groups specified
in the \fInodegroups\fR list.
\fR
.RE
\fBFlags
\fR
.RS +3
\fB-C | --context \fIcontext\fR
\fR
.RE
.RS +9
The default context to use when resolving target names. The
\fIcontext\fR value must correspond to a valid context extension module
in the \fB/opt/xcat/xdsh/Context\fR directory. For example, the
\fB/opt/xcat/xdsh/Context/DSH.pm\fR file is the module for the
\fBDSH\fR context.
.RE
.RS +3
\fB-e | --execute
\fR
.RE
.RS +9
Indicates that \fIcommand_list\fR specifies a local script filename
and arguments to be executed on the remote targets. The script file is
copied to the remote targets and then remotely executed with the given
arguments. The \fBDSH_NODE_RCP\fR
environment variables specify the remote copy command to use to copy the
script file to node targets.
.RE
.RS +3
\fB-E | --environment \fIenvironment_file\fR
\fR
.RE
.RS +9
Specifies that the \fIenvironment_file\fR contains environment
variable definitions to export to the target before executing the
\fIcommand_list\fR. The \fBDSH_NODE_RCP\fR and
environment variables specify the remote copy command
to use to export the file to node targets.
.RE
.RS +3
\fB-f | --fanout \fIfanout_value\fR
\fR
.RE
.RS +9
Specifies a fanout value for the maximum number of concurrently executing
remote shell processes. Serial execution can be specified by indicating
a fanout value of \fB1\fR. If \fB-f\fR is not specified, a
default fanout value of \fB64\fR is used.
.RE
.RS +3
\fB-h | --help
\fR
.RE
.RS +9
Displays usage information.
.RE
.RS +3
\fB-K | --ssh-setup
\fR
.RE
.RS +9
Set up the SSH keys for the specified node list. Currently, this must be run on the management node in bypass mode. Run: XCATBYPASS=1 xdsh <noderange> -K
.RE
.RS +3
\fB-l | --user \fIuser_ID\fR
\fR
.RE
.RS +9
Specifies a remote user name to use for remote command execution.
.RE
.RS +3
\fB-L | --no-locale
\fR
.RE
.RS +9
Specifies to not export the locale definitions of the local host to the
remote targets. Local host locale definitions are exported by default
to each remote target.
.RE
.RS +3
\fB-m | --monitor
\fR
.RE
.RS +9
Monitors remote shell execution by displaying status messages during
execution on each target.
.RE
.RS +3
\fB-o | --node-options \fInode_options\fR
\fR
.RE
.RS +9
Specifies options to pass to the remote shell command for node
targets. The options must be specified within double quotation marks
("") to distinguish them from \fBxdsh\fR options.
The syntax for \fInode_options\fR
.RE
.RS +3
\fB-q | --show-config
\fR
.RE
.RS +9
Displays the current environment settings for all DSH Utilities
commands. This includes the values of all environment variables and
settings for all currently installed and valid contexts. Each setting
is prefixed with \fIcontext\fR: to identify the source context of
the setting.
.RE
.RS +3
\fB-Q | --silent
\fR
.RE
.RS +9
Specifies silent mode. No target output is written to standard
output or standard error. Monitoring messages are written to standard
output.
.RE
.RS +3
\fB-r | --node-rsh \fInode_remote_shell\fR
\fR
.RE
.RS +9
Specifies the full path of the remote shell command used for remote
command execution on node targets.
.sp
.nf
[\fIcontext\fR:]\fIpath\fR[,[\fIcontext\fR:]\fIpath\fR]...
.fi
.sp
.RE
.RS +3
\fB-s | --stream
\fR
.RE
.RS +9
Specifies that output is returned as it becomes available from each
target, instead of waiting for the \fIcommand_list\fR to be completed on
a target before returning output.
.RE
.RS +3
\fB-S | --syntax csh | ksh
\fR
.RE
.RS +9
Specifies the shell syntax to be used on the remote target. If not
specified, the \fBksh\fR syntax is used.
.RE
.RS +3
\fB-t | --timeout \fItimeout\fR
\fR
.RE
.RS +9
Specifies the time, in seconds, to wait for output from any currently
executing remote targets. If no output is available from any target in
the specified \fItimeout\fR, \fBxdsh\fR displays an error and
terminates execution for the remote targets that failed to respond. If
\fItimeout\fR is not specified, \fBxdsh\fR waits indefinitely to
continue processing output from all remote targets. When specified with
the \fB-i\fR flag, the user is prompted for an additional timeout
interval to wait for output.
.RE
.RS +3
\fB-T | --trace
\fR
.RE
.RS +9
Enables trace mode. The \fBxdsh\fR command prints diagnostic
messages to standard output during execution to each target.
.RE
.RS +3
\fB-v | --verify
\fR
.RE
.RS +9
Verifies each target before executing any remote commands on the
target. If a target is not responding, execution of remote commands for
the target is canceled. When specified with the \fB-i\fR flag,
the user is prompted to retry the verification request.
.RE
.RS +3
\fB-V | --version
\fR
.RE
.RS +9
Displays \fBxdsh\fR command version information.
.RE
.RS +3
\fB-X \fIenv_list\fR
\fR
.RE
.RS +9
Ignore \fBxdsh\fR environment variables. This option can take an argument which is a comma separated list of environment variable names that should \fBNOT\fR be ignored. If there is no argument to this option, or the argument is an empty string, all \fBxdsh\fR environment variables will be ignored.
.RE
.RS +3
\fB-z | --exit-status
\fR
.RE
.RS +9
Displays the exit status for the last remotely executed non-asynchronous
command on each target. If the command issued on the remote node is run
in the background, the exit status is not displayed.
.RE
.PP
.PP
\fBExit Status
\fR
.PP
Exit values for each remote shell execution are displayed in messages from
the \fBxdsh\fR command, if the remote shell exit values are non-zero.
A non-zero return code from a remote shell indicates that an error was
encountered in the remote shell. This return code is unrelated to the
exit code of the remotely issued command. If a remote shell encounters
an error, execution of the remote command on that target is bypassed.
.PP
The \fBxdsh\fR command exit code is \fB0\fR if the command executed
without errors and all remote shell commands finished with exit codes of
\fB0\fR. If internal \fBxdsh\fR errors occur or the remote shell
commands do not complete successfully, the \fBxdsh\fR command exit value is
greater than \fB0\fR. The exit value is increased by \fB1\fR for
each successive instance of an unsuccessful remote command execution.
If the remotely issued command is run in the background, the exit code of the
remotely issued command is \fB0\fR.
.PP
.PP
\fBEnvironment Variables
\fR
.RS +3
\fBDSH_CONTEXT
\fR
.RE
.RS +9
Specifies the default context to use when resolving targets. This
variable is overridden by the \fB-C\fR flag.
.RE
.RS +3
\fBDSH_ENVIRONMENT
\fR
.RE
.RS +9
Specifies a file that contains environment variable definitions to export
to the target before executing the remote command. This variable is
overridden by the \fB-E\fR flag.
.RE
.RS +3
\fBDSH_FANOUT
\fR
.RE
.RS +9
Specifies the fanout value. This variable is overridden by the
\fB-f\fR flag.
.RE
.RS +3
\fBDSH_NODE_OPTS
\fR
.RE
.RS +9
Specifies the options to use for the remote shell command with node
targets only. This variable is overridden by the \fB-o\fR
flag.
.RE
.RS +3
\fBDSH_NODE_RCP
\fR
.RE
.RS +9
Specifies the full path of the remote copy command to use to copy local
scripts and local environment configuration files to node targets.
.RE
.RS +3
\fBDSH_NODE_RSH
\fR
.RE
.RS +9
Specifies the full path of the remote shell to use for remote command
execution on node targets. This variable is overridden by the
\fB-r\fR flag.
.RE
.RS +3
\fBDSH_NODEGROUP_PATH
\fR
.RE
.RS +9
Specifies a colon-separated list of directories that contain node group
files for the \fBDSH\fR context. When the \fB-a\fR flag is
specified in the \fBDSH\fR context, a list of unique node names is
collected from all node group files in the path.
.RE
.RS +3
\fBDSH_PATH
\fR
.RE
.RS +9
Sets the command path to use on the targets. If \fBDSH_PATH\fR
is not set, the default path defined in the profile of the remote
\fIuser_ID\fR is used.
.RE
.RS +3
\fBDSH_SYNTAX
\fR
.RE
.RS +9
Specifies the shell syntax to use on remote targets; \fBksh\fR or
\fBcsh\fR. If not specified, the \fBksh\fR syntax is
assumed. This variable is overridden by the \fB-S\fR
flag.
.RE
.RS +3
\fBDSH_TIMEOUT
\fR
.RE
.RS +9
Specifies the time, in seconds, to wait for output from each remote
target. This variable is overridden by the \fB-t\fR
flag.
.RE
.PP
.PP
\fBSecurity
\fR
.PP
The \fBxdsh\fR command has no security configuration requirements.
All remote command security requirements - configuration,
authentication, and authorization - are imposed by the underlying remote
command configured for \fBxdsh\fR. The command assumes that
authentication and authorization is configured between the local host and the
remote targets. Interactive password prompting is not supported;
an error is displayed and execution is bypassed for a remote target if
password prompting occurs, or if either authorization or authentication to the
remote target fails. Security configurations as they pertain to the
remote environment and remote shell command are user-defined.
.PP
.PP
\fBExamples
\fR
.PP
.RS +3
.HP 3
1. To run the \fBps\fR command on node targets \fBnode1\fR and
\fBnode2\fR, enter:
.sp
.nf
xdsh node1,node2 "ps"
.fi
.sp
.HP 3
2. To run the \fBps\fR command on each node target listed in the
\fBmyhosts\fR file, enter:
.sp
.HP 3
3. To execute the commands contained in \fBmyfile\fR in the XCAT
\fBcontext\fR on several node targets,
with a fanout of \fB1\fR,
enter:
.sp
.nf
xdsh node1,node2 -C XCAT -f 1 -e myfile
.fi
.sp
.HP 3
4. To run the ps command on node1 and ignore all the dsh environment
variable except the DSH_NODE_OPTS, enter:
.sp
.nf
xdsh node1 -X 'DSH_NODE_OPTS' ps
.fi
.sp
.RE
.PP
\fBImplementation Specifics
\fR
.PP
\fBFiles
\fR
.RS +3
\fB/opt/xcat/xdsh/Context/
\fR
.RE
.RS +9
Location of the contexts available to use with DSH Utilities.
.RE
.RS +3
\fB\fB/opt/xcat/bin/xdshbak\fR
\fR
.RE
.RS +9
Location of the command that is supplied as the back-end formatting
filter.
.RE
.PP
\fBLocation
\fR
.PP
\fB/opt/xcat/bin/xdsh\fR
.PP
.RE

179
xCAT-client-2.0/share/man/man1/xdshbak.1
View File

@ -1,179 +0,0 @@
.TH xdshbak 12/13/07
xdshbak Command
.PP
.PP
\fBPurpose
\fR
.PP
\fBxdshbak\fR - Presents formatted output from the \fBxdsh\fR
command.
.PP
.PP
\fBSyntax
\fR
.PP
\fBxdshbak\fR [\fB-c\fR |\fB -x\fR]
.PP
\fBDescription
\fR
.PP
The \fBxdshbak\fR command formats output from the \fBxdsh\fR
command. The \fBxdshbak\fR command takes lines in the following
format:
.sp
.nf
host_name: line of output from remote command
.fi
.sp
.PP
The \fBxdshbak\fR command formats the lines as follows and writes them
to standard output. Assume that the output from host_name3 and
host_name4 is identical, and the \fB-c\fR flag was specified:
.sp
.nf
HOSTS --------------------------------------------------------
host_name1
--------------------------------------------------------------
\ .
\ .
lines from xdsh with host_names stripped off
\ .
\ .
HOSTS --------------------------------------------------------
host_name2
--------------------------------------------------------------
\ .
\ .
lines from xdsh with host_names stripped off
\ .
\ .
HOSTS --------------------------------------------------------
host_name3 host_name4
--------------------------------------------------------------
\ .
\ .
lines from xdsh with host_names stripped off
\ .
\ .
.fi
.sp
.PP
When output is displayed from more than one node in collapsed form, the
host names are displayed alphabetically. When output is not collapsed,
output is displayed sorted alphabetically by host name. The
\fBxdshbak\fR command writes "." for each 1000 lines of output
filtered.
.PP
If the \fB-x\fR flag is specified, the extra header lines that xdshbak normally displays for each node will be omitted, and \fBxdshbak\fR still sorts the output by node name for easier viewing:
.sp
.nf
host_name1: lines from xdsh started
\ .
\ .
lines from xdsh continued
\ .
\ .
lines from xdsh ended
host_name2: lines from xdsh started
\ .
\ .
lines from xdsh continued
\ .
\ .
lines from xdsh ended
.fi
.sp
.PP
\fBParameters
\fR
.PP
None.
.PP
.PP
\fBFlags
\fR
.RS +3
\fB-c
\fR
.RE
.RS +9
Collapses identical output from more than one node so that it is displayed
only once.
.RE
.RS +3
\fB-x \fR
.RE
.RS +9
Omit the extra header lines that xdshbak normally displays for each node.
This provides
.RE
.RS +9
more compact output, but xdshbak still sorts the output by node name for easier viewing.
.RE
.RS +9
The flag should not be used with \fB-c\fR.
.RE
.PP
\fBSecurity
\fR
.PP
Security considerations are the same as those for the remote
shell command.
.PP
.PP
\fBExamples
\fR
.RS +3
.HP 3
1. To display the results of a command issued on several nodes, in the format
used in the Description, enter:
.sp
.nf
xdsh node1,node2,node3 cat /etc/passwd | xdshbak
.fi
.sp
.HP 3
2. To display the results of a command issued on several nodes with identical
output displayed only once, enter:
.sp
.nf
xdsh host1,host2,host3 pwd | xdshbak -c
.fi
.sp
.HP 3
3. To display the results of a command issued on several nodes with compact
output and be sorted alphabetically by host name, enter:
.sp
.nf
xdsh host1,host2,host3 date | xdshbak -x
.fi
.sp
.RE
.PP
.PP
\fBImplementation Specifics
\fR
.PP
This command is part of Extreme Cluster Systems Management (xCAT)
software.
.PP
.PP
\fBLocation
\fR
.PP
\fB/opt/xcat/bin/xdshbak\fR
.PP
.PP
\fBStandard Error
\fR
.PP
When the \fBxdshbak\fR filter is used and standard error messages are
generated, all error messages on standard error appear before all standard
output messages. This is true with and without the \fB-c\fR
flag.
.PP
.PP
\fBRelated Information
\fR
.PP
The \fBxdsh\fR command.

417
xCAT-client-2.0/share/man/man3/noderange.3
View File

@ -1,417 +0,0 @@
.\" Process this file with
.\" groff -man -Tascii noderange.3
.\"
.TH NODERANGE 3 "JUNE 2002" xCAT "xCAT"
.SH NAME
noderange \- generate a list of node names
.SH SYNOPSIS
.B noderange
[\fIcomma delimited nodelists and grouplists\fR]
.br
.I e.g.
.br
node1,node2,node8,node20,group1
.br
node14-node56,node70-node203,group1-group10
.br
node1,node2,node8,node20,node14-node56,node70-node203
.br
node[14-56]
.br
all,-node129-node256,-frame01-frame03
.br
/node.*
.br
^/tmp/nodes
.br
node10+5
.br
10-15,-13
.br
group1@group2
.br
.br
.SH DESCRIPTION
.B noderange
is a syntax that can be used in most xCAT commands to conveniently
specify a list of nodes. The result is that the command will
be applied to a range of nodes, often in parallel.
.B noderange
is a comma-separate list. Each token (text between commas) in the list can be any
of the forms listed below:
Individual node or group:
.I node01
.br
.I group1
.br
A range of nodes or groups:
.I node01-node10
(equivalent to: node01,node02,node03,...node10)
.br
.I group1-group3
(equivalent to: group1,group2,group3)
.br
A regular expression match of nodes or groups:
.I /node[345].*
(will match any nodes that start with node3, node4, or node5)
.br
.I /group[12].*
(will match any groups that start with group1 or group2)
.br
An incremented range of nodes:
.I node10+3
(equivalent to: node10,node11,node12,node13)
.br
The full path of a file containing noderanges of nodes or groups:
.I ^/tmp/nodelist
.br
A node shorthand range of nodes:
.I 10-20
(if prefix is 'node', equivalent to: node10,node11,node12,...node20)
.br
.I 10+3
(if prefix is 'node', equivalent to: node10,node11,node12,node13)
.br
Or any combination:
.I node01-node30,node40,^/tmp/nodes,/node[13].*,2-10,node50+5
.br
Any individual
.B noderange
may be prefixed with an exclusion operator
(default -) with the exception of the file operator (default ^).
The intersection operator @ calculates the intersection of the left and right sides:
.I group1@group2
(will result in the list of nodes group1 and group2 have in common)
Any combination or multiple combinations of inclusive
and exclusive ranges of nodes and groups is legal. There
is no precedence implied in the order of the
arguments. Exclusive ranges have precedence over inclusive.
Nodes have precedence over groups. If a node range match is made
then no group range match will be attempted.
All node names are validated against
the nodelist table.
Invalid nodes are ignored and return nothing.
All group names are validated against
the nodelist and nodetype table.
Invalid groups are ignored and return nothing.
Throughout this
man page the term
\fIxCAT Node Format\fR
will be used.
\fIxCAT Node Format\fR is defined by the following regex:
^([A-Za-z-]+)([0-9]+)(([A-Za-z-]+[A-Za-z0-9-]*)*)
In plain english a node or group is in
\fIxCAT Node Format\fR
if starting from the begining there are one or more
alpha characters of any case and any number of - in any
combination, followed by
one or more numbers, then optionally followed by one
alpha character of any case or the - followed by any
combination of case mixed alphanumerics and the -.
.B noderange
supports node/group names in
.I any
format.
\fIxCAT Node Format\fR
is
.B not
required, however some node range
methods used to determine range will not be used.
E.g. If using a
.B noderange
of
.I node1a-node9a
with a
.B nodelist
table only listing
.I node1a
through
.IR node5a ,
.B noderange
will enumerate then validate and return a proper
range. If using a node range of
.I aa-az
with a
.B nodelist
table only listing
.I aa
through
.IR ay,
.B noderange
will fail to return any values.
Example of
\fIxCAT Node Format\fR
node/group names:
.B nodename prefix number suffix
.br
node1 node 1
.br
node001 node 001
.br
node-001 node- 001
.br
node-foo-001-bar node-foo- 001 -bar
.br
node-foo-1bar node-foo- 1 bar
.br
foo1bar2 foo 1 bar2
.br
rack01unit34 rack 01 unit34
.br
unit34rack01 unit 34 rack01
.br
pos0134 pos 0134
.br
Example of non-\fIxCAT Node Format\fR
node/group names, but still valid:
aa
.br
yellow
.br
red
.br
12foo
.br
The supported
.B noderange
syntaxes are checked for, and processed, in a specific order. First
.B noderange
checks for the multiple range operator (default ,). Each range is
also processed by
.BR noderange .
Next
.B noderange
checks for the file operator (default ^). If the file exists (must be a full path name)
each line will be processed as a
.BR noderange .
Lines starting
with
.I #
or the file operator (default ^) are ignored. Only
one
.B noderange
per line is read. All characters are ignored
after the first white space.
e.g.
^/tmp/nodes
where
cat /tmp/nodes outputs:
#my node list (this line ignored)
.br
^/tmp/foo #ignored
.br
node01 #node comment
.br
node02
.br
node03
.br
node10-node20
.br
/group[456].*
.br
-node50
.br
Next
.B noderange
checks for the exclusion operator (default -) then continues.
This operator supports nodes and groups.
.B noderange
will not confuse the exclusion or range
operators with the
- character in names.
Next
.B noderange
checks for a numeric only range (e.g. 10-20, 5+3, or just 10), then uses
.I $XCAT_NODE_PREFIX
(default is 'node') and
.I $XCAT_NODE_SUFFIX
(optional)
as the defaults to complete the node names.
.B nodeRange
tries to be intelligent about detecting padding, so you can specify 'node001-node200'
and it will add the proper number of zeroes to make all numbers 3 digits.
Noderange shorthand supports nodes only. Noderange shorthand can
be mixed with all other operators except regex. i.e. exclusion,
increment, range, and file may be used.
Next
.B noderange
checks for the for the regular expression operator (default /).
Regular expressions offer the most flexibility. If you are
interested in learning regex read the book
\fIMastering Regular Expressions\fR.
This operator supports nodes and groups.
Next
.B noderange
checks for the increment range operator (default +). Increment
range operator noderanges are in the format:
.IB valid_node_name + number_of_sequential_nodes
e.g.
.I node10+5
would yield node10 plus the next
.I 5
nodes.
This action is performed using two different methods.
If
.I valid_node_name
is in
\fIxCAT Node Format\fR
then the range is enumerated to
.IR number_of_sequential_nodes .
If not in
\fIxCAT Node Format\fR
then a sorted
.B nodelist
table is used to return the node range.
This operator supports nodes only.
Next
.B noderange
checks for a single node name or group name.
Next
.B noderange
checks for the range operator (default -). Ranges are
performed first by validating that both the start
and end nodes or groups defining the range exist and if
so the range is returned based on the content of the
.B nodelist
and
.B nodetype
tables.
If the start and end nodes or groups
defined in the range do not exist,
.I and
if both are in
\fIxCAT Node Format\fR,
.I and
if both the prefix and suffix match,
then the range is enumerated and each node/group
validated. Only valid nodes/groups will be returned.
.B noderange
will not confuse the exclusion or range
operators with the
- character in names.
Last
.B noderange
returns nothing if no match can be found.
.B noderange
uses the smallest integer to determine
padding. e.g. \fInode1-node10\fR will generate a list of nodes
with numbers 1, 2, 3, 4, 5, 6, 7, 8, 9, 10. \fInode001-node010\fR will
generate a list of nodes with numbers 001, 002, 003, 004,
005, 006, 007, 008, 009, 010.
Multiple instances of a node name are treated as one
instance. e.g. \fInode1-node10,node4,node4,node4\fR will generate
a list of nodes numbered 1 through 10, the number 4
will only be listed once.
.SH EXAMPLES
.I all,-node5-node10
Generates a list of all nodes (assuming all is a group)
listed in the
.B nodelist
table less node5 through node10.
.I node1-node10,-node3-node5,node4
Generates a list of nodes 1 through 10 less nodes 3,4,5. Note
that node4 is listed twice, first in the range and then at
the end. Because exclusion has precedence node4 will be excluded.
.I node1-node10,-node3,-node5
Generates a list of nodes 1 through 10 less nodes 3 and 5.
.I -node17-node32,all
Generates a list of all (assuming 'all' is a group) nodes in the
.B nodelist
table less 17 through 32.
.I node1-node128,user1-user4
Generates a list of nodes 1 through 128, and user nodes 1 through 4.
.I all,-rack1-rack3,-node100-node200,node150,-storage
Generates a list of all nodes (assuming 'all' is a group), less
nodes in groups rack1 through rack3 (assuming groups rack1,
rack2, and rack3 are defined), less nodes 100 through
200, less nodes in the storage group. Note that
node150 is listed but is excluded.
.I /node[23].*
Generates a list of nodes matching the regex
.IR node[23].* .
That is all nodes that start with node2 or node3 and end in anything
or nothing. E.g. node2, node3, node20, node30, node21234 all match.
.SH "NOTES"
.IX Header "NOTES"
This command is part of the xCAT software.