-Fix the nodeset man page to more accurately reflect the state of things as they stand today.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1448 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
jbjohnso 2008-05-19 19:21:06 +00:00
parent ca60c1c8a2
commit 8cb5e923e9

View File

@ -4,15 +4,7 @@ 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<noderange>] [I<boot>|I<install>|I<stat>|I<iscsiboot>|I<netboot>|I<runcmd=bmcsetup>]
B<nodeset> [I<-h>|I<--help>|I<-v>|I<--version>]
@ -25,101 +17,46 @@ 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.
B<nodeset> will maniputale the boot configuration files of yaboot and pxelinux.0.
Assume that /tftpboot is the root for tftpd (set in B<site(5)>).
B<nodeset.pxe> makes changes to /tftpboot/pxelinux.0/{node hex ip}
B<nodeset> for pxe makes changes to /tftpboot/pxelinux.cfg/{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> for yaboot makes changes to /tftpboot/etc/{node hex ip}
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 B<site(5)>), where NODETYPE is
defined per node in B<nodetype(5)>, RESOURCE is defined per node or
group in B<noderes(5)>, and BOOTTYPE is defined per node in
B<nodehm(5)>.
=head1 B<Options>
=over 7
=item B<boot>
Instruct node to boot local harddisk 0 on next boot.
Instruct network boot loader to be skipped, generally meaning boot to hard disk
=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.
Prepare server for installing a node according to the table configuration. This will
typically mean an unattended install file is created (i.e. kickstart or autoyast),
install resources will be verified in tftp and the bulk transfer method (http, ftp, or nfs for example), and the boot loader configuration file will be written.
=item B<state>|B<stat>
=item B<stat>
Display the next boot state.
Display the current boot loader config file description for the nodes requested
=item B<stage2>
=item B<runcmd=bmcsetup>
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 B<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.
This instructs the node to boot to the xCAT nbfs environment and proceed to configure BMC
for basic remote access. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration table.
=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 B<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 B<rflash(1)>.
This instructs tho node to boot to the xCAT nbfs environment, and present a shell prompt on console.
The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems.
=item B<-h>|B<--help>
@ -137,11 +74,11 @@ Print version.
B<nodehm> table -
xCAT node hardware management file. See B<nodehm(5)> for fur-
ther details. This is used to determine the network boot type:
PXE, Etherboot, ELILO, or NA.
pxe or yaboot
B<noderes> table -
xCAT node resources file. See B<noderes(5)> for further
details. This is used to determine the node's resource group.
details.
B<nodetype> table -
xCAT node installation type file. See B<nodetype(5)> for fur-
@ -154,14 +91,6 @@ 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 B<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>