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

Major updates to man pages and linux cookbook, including addition of object definition man pages.

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1980 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers 2008-08-02 16:18:07 +00:00
parent 7b32c3c44f
commit deda80a245
81 changed files with 1037 additions and 506 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
perl-xCAT/db2man
View File

@ -19,13 +19,24 @@ use Pod::Html;
my $poddir = 'pods';
my $mandir = 'share/man';
my $htmldir = 'share/doc';
my $cachedir = '/tmp';
my $poddir5 = 'pods/man5';
my $poddir7 = 'pods/man7';
if (system("mkdir -p $poddir5")) { die "Error: could not create $poddir5.\n"; }
if (system("mkdir -p $poddir7")) { die "Error: could not create $poddir7.\n"; }
# Build the DB overview page.
print "Building PODs pages for the database tables...\n";
writesummarypage("$poddir5/xcatdb.5.pod", xCAT::Table->getDescriptions()),
writesummarypage("$poddir5/xcatdb.5.pod", xCAT::Table->getDescriptions(), \%{xCAT::Schema::defspec});
# Build the pad man page for each object definition
my $defspecref = \%{xCAT::Schema::defspec};
foreach my $defkey (keys %$defspecref) {
my $def = $defspecref->{$defkey};
my $attrs = $def->{'attrs'};
writedefmanpage("$poddir7/$defkey.7.pod", $defkey, $attrs);
}
# Build the pod man page for each table.
my $tabspecref = \%xCAT::Schema::tabspec;
@ -57,6 +68,8 @@ foreach my $podfile (@pods) {
# Build the html page for each pod.
#mkdir($htmldir) or die "Error: could not create $htmldir.\n";
print "Converting PODs to HTML pages...\n";
# have to clear the cache, because old entries can cause a problem
unlink("$cachedir/pod2htmd.tmp", "$cachedir/pod2htmi.tmp");
foreach my $podfile (@pods) {
my $htmlfile = $podfile;
$htmlfile =~ s/^$poddir/$htmldir/; # change the beginning of the path
@ -77,13 +90,13 @@ sub getPodList {
# 1st get toplevel dir listing
opendir(DIR, $poddir) or die "Error: could not read $poddir.\n";
my @topdir = grep !/^\./, readdir(DIR);
my @topdir = grep !/^\./, readdir(DIR); # /
close(DIR);
# Now go thru each subdir (these are man1, man3, etc.)
foreach my $mandir (@topdir) {
opendir(DIR, "$poddir/$mandir") or die "Error: could not read $poddir/$mandir.\n";
my @dir = grep !/^\./, readdir(DIR);
my @dir = grep !/^\./, readdir(DIR); # /
close(DIR);
foreach my $file (@dir) {
push @files, "$poddir/$mandir/$file";
@ -100,11 +113,11 @@ sub convertpod2html {
#TODO: use --css=<stylesheet> and --title=<pagetitle> to make the pages look better
pod2html($podfile,
"--outfile=$htmlfile",
"--podpath=man5",
"--podpath=man5:man7",
"--podroot=$poddir",
"--htmldir=$htmldir",
"--recurse",
"--cachedir=/tmp",
"--cachedir=$cachedir",
);
}
@ -123,6 +136,7 @@ sub convertpod2man {
sub writesummarypage {
my $file = shift; # relative path file name of the man page
my $descriptions = shift; # a hash containing the description of each table
my $defdescriptions = shift; # a hash containing the description of each object definition
open(FILE, ">$file") or die "Error: could not open $file for writing.\n";
@ -138,6 +152,11 @@ 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>.
Alternatively, the xCAT database can be viewed and edited as logical objects, instead of flat tables.
In this mode, xCAT takes care of which table each attribute should go in. To treat the database
as logical object definitions, use the commands: lsdef, mkdef, chdef, rmdef. See Object Definitions
below.
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
@ -230,18 +249,42 @@ expression B<($1-1)%14+1> will evaluate to 6.
See http://www.perl.com/doc/manual/html/pod/perlre.html for information on perl regular expressions.
=head1 OBJECT DEFINITIONS
Because it can get confusing what attributes need to go in what tables, the xCAT database can also
be viewed and edited as logical objects, instead of flat tables. Run B<lsdef> to see the list of
objects supported by xCAT. Use B<mkdef>, B<chdef>, and B<rmdef> to create, change, and delete objects.
be viewed and edited as logical objects, instead of flat tables. Use B<mkdef>, B<chdef>, B<lsdef>,
and B<rmdef> to create, change, list, and delete objects.
When using these commands, the object attributes will be stored in the same tables, as if you edited
the tables by hand. The only difference is that the object commands take care of knowing which tables
all of the information should go in.
=head1 TABLES
To run man for any of the object definitions below, use section 7. For example: B<man 7 node>
The object types are:
=over 2
EOS1
foreach my $def (sort keys %$defdescriptions) {
print FILE "\n=item L<$def(7)|$def.7>\n";
}
print FILE <<"EOS2";
=back
=head1 TABLES
To manipulate the tables directly, use B<nodels(1)>, B<chtab(8)>, B<tabdump(8)>, B<tabedit(8)>,
B<nodeadd(8)>, B<nodech(1)>.
To run man for any of the table descriptions below, use section 5. For example: B<man 5 nodehm>
The tables are:
=over 2
EOS2
foreach my $table (sort keys %$descriptions) {
print FILE "\n=item L<$table(5)|$table.5>\n\n".$descriptions->{$table}."\n";
}
@ -259,6 +302,89 @@ EOS3
}
# Create the man page for one object definition.
sub writedefmanpage {
my $file = shift; # relative path file name of the man page
my $defname = shift; # name of object
my $attrs = shift; # reference to the array of attributes
# Go thru the attributes, collecting the descriptions
# Note: this logic is loosely taken from DBobjectdefs.pm
my %attrlist; # holds the attr name as the key, and the description & tables as value
foreach my $this_attr (@$attrs) {
my $attr = $this_attr->{attr_name};
my $desc = $this_attr->{description};
my ($table, $at) = split(/\./, $this_attr->{tabentry});
if (!defined($desc)) {
# description key not there, so go to the corresponding
# entry in tabspec to get the description
my $schema = xCAT::Table->getTableSchema($table);
$desc = $schema->{descriptions}->{$at};
}
# Attr names can appear more than once, if they are in multiple tables.
# We will keep track of that based on the table attribute, because that can be duplicated too
if (!defined($attrlist{$attr})) {
$attrlist{$attr}->{'tables'} = []; # initialize the array, so we can check it below
}
my $tableattr = "$table.$at";
if (!grep(/^$tableattr$/, @{$attrlist{$attr}->{'tables'}})) {
# there can be multiple entries that refer to the same table attribute
# if this is a new table attribute, then save the attr name and description
push @{$attrlist{$attr}->{'tables'}}, $tableattr;
push @{$attrlist{$attr}->{'descriptions'}}, $desc;
}
}
open(FILE, ">$file") or die "Error: could not open $file for writing.\n";
print FILE <<"EOS1";
=head1 NAME
B<$defname> - a logical object definition in the xCAT database.
=head1 SYNOPSIS
EOS1
print FILE "B<$defname Attributes:> I<" . join('>, I<',sort(keys(%attrlist))) . ">\n";
print FILE <<"EOS2";
=head1 DESCRIPTION
Logical objects of this type are stored in the xCAT database in one or more tables. Use the following commands
to manipulate the objects: B<mkdef>, B<chdef>, B<lsdef>, and B<rmdef>. These commands will take care of
knowing which tables the object attributes should be stored in. The attribute list below shows, in
parentheses, what tables each attribute is stored in.
=head1 $defname Attributes:
=over 6
EOS2
foreach my $a (sort keys %attrlist) {
my $d = join("\nor\n", @{$attrlist{$a}->{'descriptions'}});
$d =~ s/\n/\n\n/sg; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them
my $t = '(' . join(', ',@{$attrlist{$a}->{'tables'}}) . ')';
#print FILE "\nB<$a> - $d\n";
print FILE "\n=item B<$a> $t\n\n$d\n";
}
print FILE <<"EOS3";
=back
=head1 SEE ALSO
B<mkdef(1)>, B<chdef(1)>, B<lsdef(1)>, B<rmdef(1)>
EOS3
close FILE;
}
# Create the man page for one table.
sub writepodmanpage {
my $file = shift; # relative path file name of the man page
@ -276,10 +402,9 @@ B<$tablename> - a table in the xCAT database.
=head1 SYNOPSIS
B<$tablename Attributes:>
EOS1
foreach my $a (@$colorder) { print FILE " I<$a>\n"; }
print FILE "B<$tablename Attributes:> I<" . join('>, I<',@$colorder) . ">\n";
print FILE <<"EOS2";
@ -295,7 +420,7 @@ EOS2
foreach my $a (@$colorder) {
my $d = $descriptions->{$a};
$d =~ s/\n/\n\n/; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them
$d =~ s/\n/\n\n/sg; # if there are newlines, double them so pod sees a blank line, otherwise pod will ignore them
#print FILE "\nB<$a> - $d\n";
print FILE "\n=item B<$a>\n\n$d\n";
}

17
perl-xCAT/perl-xCAT.spec
View File

@ -28,17 +28,10 @@ Includes xCAT::Table, xCAT::NodeRange, among others.
# All of the tarball source has been unpacked there and is in the same file structure
# as it is in svn.
# Build the pod version of the man pages for each DB table. It puts them in the man5 subdir.
# The convert the pods to man pages and html pages.
# Build the pod version of the man pages for each DB table. It puts them in the man5 and man7 subdirs.
# Then convert the pods to man pages and html pages.
./db2man
# Convert pods to man pages, e.g.: pod2man pods/man5/chain.5.pod share/man/man5/chain.1
# for i in pods/*/*.pod; do
# man="share/man${i#pods}" # the substitute form is not supported on aix: ${i/pods/share\/man}
# mkdir -p ${man%/*}
# pod2man $i ${man%.pod}
# done
%install
# The install phase puts all of the files in the paths they should be in when the rpm is
# installed on a system. The RPM_BUILD_ROOT is a simulated root file system and usually
@ -50,6 +43,8 @@ mkdir -p $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/data
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/perl-xCAT
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man5
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man5
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man7
mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man7
cp -r xCAT/* $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/
chmod 644 $RPM_BUILD_ROOT/%{prefix}/lib/perl/xCAT/*
@ -66,6 +61,10 @@ cp share/man/man5/* $RPM_BUILD_ROOT/%{prefix}/share/man/man5
chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/man/man5/*
cp share/doc/man5/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man5
chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man5/*
cp share/man/man7/* $RPM_BUILD_ROOT/%{prefix}/share/man/man7
chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/man/man7/*
cp share/doc/man7/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man7
chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man7/*
%clean
# This step does not happen until *after* the %files packaging below

6
perl-xCAT/xCAT/Schema.pm
View File

@ -460,9 +460,9 @@ site => {
" dhcpinterfaces (network interfaces DHCP should listen on. If same for all nodes, use simple comma-separated list of NICs. Also support: mn|eth1,eth2;service|bond0;compute|eth0)\n".
" forwarders (DNS servers at your site that can provide names outside of the cluster)\n".
" genpasswords (automatically generate random passwords for BMCs when configuring them)\n".
" defserialport (default if not specified for the node in nodehm table)\n".
" defserialspeed (default if not specified for the node in nodehm table)\n".
" defserialflow (default if not specified for the node in nodehm table)\n",
" defserialport (default serial port - currently only used by mknb)\n".
" defserialspeed (default serial speed - currently only used by mknb)\n".
" defserialflow (default serial flow - currently only used by mknb)\n",
value => 'The value of the attribute specified in the "key" column.',
comments => 'Any user-written notes.',
disable => "Set to 'yes' or '1' to comment out this row.",

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

@ -132,4 +132,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands.
L<mkdef(1)|mkdef.1>, L<lsdef(1)|lsdef.1>, L<rmdef(1)|rmdef.1>, L<xcatstanzafile(5)|xcatstanzafile.5>

28
xCAT-client/pods/man1/chvm.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<chvm> - Changes HMC- and IVM-managed partition profiles.
B<chvm> - Changes HMC- and IVM-managed partition profiles.
=head1 SYNOPSIS
I<chvm [-h| --help]>
I<chvm [-v| --version]>
@ -23,9 +23,9 @@ B<-h> Display usage message.
B<-p profile> Name of an existing partition profile.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
=head1 RETURN VALUE
@ -36,17 +36,17 @@ B<-V> Verbose output.
=head1 EXAMPLES
1. To change the partition profile for lpar4 using the configuration data in the file /tmp/lparfile, enter:
1. To change the partition profile for lpar4 using the configuration data in the file /tmp/lparfile, enter:
I<cat /tmp/lparfile | chvm lpar4>
I<cat /tmp/lparfile | chvm lpar4>
Output is similar to:
lpar4: Success
2. To change the partition profile for lpar4 to the existing profile 'prof1', enter:
2. To change the partition profile for lpar4 to the existing profile 'prof1', enter:
I<chvm lpar4 -p prof1>
I<chvm lpar4 -p prof1>
Output is similar to:
@ -54,14 +54,14 @@ lpar4: Success
=head1 FILES
/opt/xcat/bin/chvm
=head1 NOTES
=head1 SEE ALSO
L<mkvm(1)|mkvm.1>, L<lsvm(1)|lsvm.1>, L<rmvm(1)|rmvm.1>
This command is part of the xCAT software product.

5
xCAT-client/pods/man1/dumpxCATdb.1.pod
View File

@ -42,10 +42,9 @@ B<dumpxCATdb -p /tmp/db>
/opt/xcat/sbin/dumpxCATdb
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
See restorexCATdb
L<restorexCATdb(1)|restorexCATdb.1>

97
xCAT-client/pods/man1/genimage.1.pod
View File

@ -1,40 +1,78 @@
=head1 NAME
B<genimage> - Generates a stateless image to be used for a diskless install.
B<genimage> - Generates a stateless image to be used for a diskless install.
=head1 SYNOPSIS
I<genimage [-h| --help]>
I<genimage [-v| --version]>
B<genimage> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-r> I<additional_nics>] [B<-k> I<kernel_version>]
I<genimage [-i nodebootif] [ -n nodenetdrivers] [-r additional interfaces] [-o OS] [-p profile]>
B<genimage> [B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
Generates the stateless image .
The install dir is setup by using "installdir" attribute set in the site table.
The nodetype table "profile" attribute for the node should reflect the profile of the install image.
Generates a stateless image that can be used to boot xCAT nodes in a diskless mode. The packages included
(and excluded) in the image are specified by /opt/xcat/share/xcat/netboot/<OS>/<profile>.pkglist and
/opt/xcat/share/xcat/netboot/<OS>/<profile>.exlist. The generated image will be put in
/install/netboot/<OS>/<arch>/<profile>.
The B<genimage> command must be run on a system that is the same architecture as the nodes it will be
used on. If the management node is not the same architecture, copy the contents of
/opt/xcat/share/xcat/netboot/<OS> to a system that is the proper architecture, and mount /install from
the management node to that system.
The B<genimage> command will run geninitrd automatically. (You can run geninitrd yourself at a later time, if
you want to rebuild the initrd.) After your image is created, you can chroot to the
image, install any additional software you would like, or make modifications to files, and then run
B<packimage> to prepare the image for deployment.
This uses the package information from the /opt/xcat/share/xcat/netboot/[os] directory files for the profile input.
=head1 OPTIONS
=over 12
B<-h> Display usage message.
=item B<-o> I<OS>
B<-v> Command Version.
The operating system for the image: fedora8, rhel5, sles10, etc. The OS packages must be in
/install/<OS>/<arch> (use L<copycds(8)|copycds.8>).
B<-o> Operating system (fedora8, rhel5, sles10,etc)
=item B<-p> I<profile>
B<-p> Profile (compute,service)
The profile (e.g. compute, service) to use to create the image. This determines what package lists are
used from /opt/xcat/share/xcat/netboot/<OS> to create the image with. When deploying nodes with this image,
the nodes' nodetype.profile attribute must be set to this same value.
B<-i> Node Boot Interface (e.g. eth0)
=item B<-i> I<nodebootif>
B<-r> Other Interface (e.g. eth0)
The network interface the diskless node will boot over (e.g. eth0).
=item B<-n> I<nodenetdrivers>
The driver modules needed for the network interface. Note: the order that the drivers are specified in
is important.
=item B<-l> I<rootlimit>
The maximum size allowed for the root file system in the image. Specify in bytes, or can append k, m, or g.
=item B<-r> I<additional_nics>
Other network interfaces (e.g. eth1) in the image that should be configured via DHCP.
=item B<-k> I<kernel_version>
Use this flag if you want to use a specific version of the kernel in the image. Defaults to the first kernel found
in the install image.
=item B<-v|--version>
Display version.
=item B<-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
@ -43,24 +81,29 @@ B<-r> Other Interface (e.g. eth0)
1 An error has occurred.
=head1 EXAMPLES
1. To generate a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory. Change diretory to /opt/xcat/share/xcat/netboot/fedora and run:
=over 3
I<genimage -i eth0 -n tg3 -o fedora8 -p compute>
=item 1.
To generate a fedora8 image for a compute node architecture x86_64 and place it in the
/install/netboot/fedora8/x86_64/compute/rootimg directory: change directory to
/opt/xcat/share/xcat/netboot/fedora and run:
genimage -i eth0 -n tg3,bnx2 -o fedora8 -p compute
This would use the profile information from the /opt/xcat/share/xcat/netboot/fedora/compute* files.
=back
=head1 FILES
/opt/xcat/share/xcat/netboot/<OS>/genimage
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
packimage(1)
L<geninitrd(1)|geninitrd.1>, L<packimage(1)|packimage.1>

96
xCAT-client/pods/man1/geninitrd.1.pod Normal file
View File

@ -0,0 +1,96 @@
=head1 NAME
B<geninitrd> - Regenerates the initrd for a stateless image to be used for a diskless install.
=head1 SYNOPSIS
B<geninitrd> B<-i> I<nodebootif> B<-n> I<nodenetdrivers> B<-o> I<OS> B<-p> I<profile> [B<-l> I<rootlimit>] [B<-k> I<kernel_version>]
B<geninitrd> [B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
Regenerates the initrd that is part of a stateless image that is used to boot xCAT nodes in a diskless mode.
The generated initrd will be put in /install/netboot/<OS>/<arch>/<profile>.
The B<geninitrd> command must be run on a system that is the same architecture as the nodes it will be
used on. If the management node is not the same architecture, copy the contents of
/opt/xcat/share/xcat/netboot/<OS> to a system that is the proper architecture, and mount /install from
the management node to that system.
=head1 OPTIONS
=over 12
=item B<-o> I<OS>
The operating system for the image: fedora8, rhel5, sles10, etc. The OS packages must be in
/install/<OS>/<arch> (use L<copycds(8)|copycds.8>).
=item B<-p> I<profile>
The profile (e.g. compute, service) to use to create the image. This determines what package lists are
used from /opt/xcat/share/xcat/netboot/<OS> to create the image with. When deploying nodes with this image,
the nodes' nodetype.profile attribute must be set to this same value.
=item B<-i> I<nodebootif>
The network interface the diskless node will boot over (e.g. eth0).
=item B<-n> I<nodenetdrivers>
The driver modules needed for the network interface. Note: the order that the drivers are specified in
is important.
=item B<-l> I<rootlimit>
The maximum size allowed for the root file system in the image. Specify in bytes, or can append k, m, or g.
=item B<-k> I<kernel_version>
Use this flag if you want to use a specific version of the kernel in the image. Defaults to the first kernel found
in the install image.
=item B<-v>
Display version.
=item B<-h>
Display usage message.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
=over 3
=item 1.
To regenerate the initrd for a fedora8 image for a compute node architecture x86_64 and place it in the
/install/netboot/fedora8/x86_64/compute/rootimg directory: change directory to
/opt/xcat/share/xcat/netboot/fedora and run:
geninitrd -i eth0 -n tg3,bnx2 -o fedora8 -p compute
=back
=head1 FILES
/opt/xcat/share/xcat/netboot/<OS>/geninitrd
=head1 SEE ALSO
L<genimage(1)|genimage.1>, L<packimage(1)|packimage.1>

46
xCAT-client/pods/man1/getmacs.1.pod
View File

@ -1,14 +1,14 @@
=head1 NAME
B<getmacs> - Collects node MAC address.
B<getmacs> - Collects node MAC address.
=head1 SYNOPSIS
I<getmacs [-h| --help]>
I<getmacs [-v| --version]>
I<getmacs [-V| --verbose] noderange> [-f][-d][-S server -G gateway -C client]
I<getmacs [-V| --verbose] noderange> [-f][-d][-S server -G gateway -C client]
=head1 DESCRIPTION
@ -20,7 +20,7 @@ Note than on AIX systems, the returned MAC address is not colon-seperated (for e
B<-C> IP address of the partition.
B<-d> Display MAC only. The default is to write the first adapter MAC to the xCAT database.
B<-d> Display MAC only. The default is to write the first adapter MAC to the xCAT database.
B<-f> Force immediate shutdown of the partition.
@ -28,29 +28,29 @@ B<-G> Gateway IP address of the partition specified with the -C option.
B<-h> Display usage message.
B<-S> The IP address of the machine to ping.
B<-S> The IP address of the machine to ping.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
1. To retrieve the MAC address for the HMC-managed partition lpar4 and write the first adapter MAC to the xCAT database, enter:
1. To retrieve the MAC address for the HMC-managed partition lpar4 and write the first adapter MAC to the xCAT database, enter:
I<getmacs lpar4>
I<getmacs lpar4>
Output is similar to:
lpar4:
lpar4:
#Type Location Code MAC Address Full Path Name Ping Result
@ -58,13 +58,13 @@ ent U9133.55A.10B7D1G-V12-C4-T1 8e:e2:24:5c:f0:04 /vdevice/l-lan@30000004 virtu
2. To retrieve the MAC address for the HMC-managed partition lpar4 and display the result only, enter:
2. To retrieve the MAC address for the HMC-managed partition lpar4 and display the result only, enter:
I<getmacs lpar4 -d>
I<getmacs lpar4 -d>
Output is similar to:
lpar4:
lpar4:
#Type Location Code MAC Address Full Path Name Ping Result
@ -72,7 +72,7 @@ ent U9133.55A.10B7D1G-V12-C4-T1 8ee2245cf004 /vdevice/l-lan@30000004 virtual
3. To retrieve the MAC address while performing a ping test for the HMC-managed partition lpar4 and display the result only, enter:
3. To retrieve the MAC address while performing a ping test for the HMC-managed partition lpar4 and display the result only, enter:
I<getmacs lpar4 -d -S 9.3.6.49 -G 9.3.6.1 -C 9.3.6.234>
@ -81,16 +81,14 @@ I<getmacs lpar4 -d -S 9.3.6.49 -G 9.3.6.1 -C 9.3.6.234>
ent U9133.55A.10B7D1G-V12-C4-T1 8e:e2:24:5c:f0:04 /vdevice/l-lan@30000004 successful virtual
=head1 FILES
/opt/xcat/bin/getmac
/opt/xcat/bin/getmacs
=head1 NOTES
=head1 SEE ALSO
L<makedhcp(8)|makedhcp.8>
This command is part of the xCAT software product.

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

@ -73,4 +73,4 @@ The output would be similar to:
=head1 SEE ALSO
nodels(1), chtab(1), tabdump(1)
L<nodels(1)|nodels.1>, L<chtab(8)|chtab.8>, L<tabdump(8)|tabdump.8>

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

@ -153,4 +153,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef(1), chdef(1), rmdef(1), and xcatstanzafile(5) commands.
L<mkdef(1)|mkdef.1>, L<chdef(1)|chdef.1>, L<rmdef(1)|rmdef.1>, L<xcatstanzafile(5)|xcatstanzafile.5>

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

@ -131,9 +131,9 @@ Output is similar to:
/opt/xcat/bin/lsslp
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
L<rscan(1)|rscan.1>

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

@ -58,10 +58,9 @@ Output is similar to:
/opt/xcat/bin/lsvm
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
L<mkvm(1)|mkvm.1>, L<chvm(1)|chvm.1>, L<rmvm(1)|rmvm.1>

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

@ -132,4 +132,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the chdef(1), lsdef(1), rmdef(1), and xcatstanzafile(5) commands.
L<chdef(1)|chdef.1>, L<lsdef(1)|lsdef.1>, L<rmdef(1)|rmdef.1>, L<xcatstanzafile(5)|xcatstanzafile.5>

28
xCAT-client/pods/man1/mkdsklsnode.1.pod
View File

@ -1,22 +1,22 @@
=head1 NAME
B<mkdsklsnode> - Use this xCAT command to define and initialize AIX/NIM diskless machines.
B<mkdsklsnode> - Use this xCAT command to define and initialize AIX/NIM diskless machines.
=head1 SYNOPSIS
B<mkdsklsnode [-h|--help ]>
B<mkdsklsnode [-V] [-f|--force] [-n|--newname] [-i osimage_name] noderange [attr=val [attr=val ...]]>
B<mkdsklsnode [-V] [-f|--force] [-n|--newname] [-i osimage_name] noderange [attr=val [attr=val ...]]>
=head1 DESCRIPTION
This xCAT command can be used to define and/or initialize AIX/NIM diskless machines. Once this step is completed the xCAT rnetboot command may be used to initiate a network boot of the nodes.
The command can be used to define and initialize a new NIM machine object or it may be used to reinitialize an existing machine to use a different operating system image.
When creating a new NIM machine definition the default is to use the same name as the xCAT node name that is provided.
When creating a new NIM machine definition the default is to use the same name as the xCAT node name that is provided.
You can use the "-n" option of the mkdsklsnode command to create and initialize an alternate NIM machine definition for the same physical nodes. This option allows you to set up a new image to use when a node is next rebooted while the node is currently running. This is possible because the NIM name for a machine definition does not have to be the hostname of the node. This allows you to have multiple NIM machine definitions for the same physical node. The naming convention for the new NIM machine name is "<xcat_node_name>_<image_name>", (Ex. "node01_61spot"). Since all the NIM initialization can be done while the node is running the downtime for for the node is reduced to the time it takes to reboot.
You can use the "-n" option of the mkdsklsnode command to create and initialize an alternate NIM machine definition for the same physical nodes. This option allows you to set up a new image to use when a node is next rebooted while the node is currently running. This is possible because the NIM name for a machine definition does not have to be the hostname of the node. This allows you to have multiple NIM machine definitions for the same physical node. The naming convention for the new NIM machine name is "<xcat_node_name>_<image_name>", (Ex. "node01_61spot"). Since all the NIM initialization can be done while the node is running the downtime for for the node is reduced to the time it takes to reboot.
You can use the force option to reinitialize a node if it already has resources allocated or it is in the wrong NIM state. This option will reset the NIM node and deallocate resources before reinititializing. Use this option with caution since reinitializing a node will stop the node if it is currently running.
@ -35,15 +35,15 @@ Valid values:
=over 3
=item B<duplex>
=item B<duplex>
Specifies the duplex setting (optional). Used when defining the NIM machine. Use this setting to configure the client's network interface. This value can be full or half. The default is full. (ex. "duplex=full")
=item B<speed>
=item B<speed>
Specifies the speed setting (optional). Used when defining the NIM machine. This is the communication speed to use when configuring the client's network interface. This value can be 10, 100, or 1000. The default is 100. (ex. "speed=100")
=item B<psize>
=item B<psize>
Specifies the size in Megabytes of the paging space for the diskless node.(optional) Used when initializing the NIM machine. The minimum and default size is 64 MB of paging space. (ex. "psize=64")
@ -51,7 +51,7 @@ Specifies the size in Megabytes of the paging space for the diskless node.(optio
=item B<-f |--force>
Use the force option to reinitialize the NIM machines.
Use the force option to reinitialize the NIM machines.
=item B<-h |--help>
@ -79,11 +79,11 @@ Verbose mode.
=over 3
=item 0
=item 0
The command completed successfully.
=item 1
=item 1
An error has occurred.
@ -124,8 +124,8 @@ B<mkdsklsnode -n -i 61spot node02>
This command is part of the xCAT software product.
=head1 SEE ALSO
=head1 SEE ALSO
rmdsklsnode(1)
L<rmdsklsnode(1)|rmdsklsnode.1>

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

@ -1,6 +1,6 @@
=head1 NAME
B<mknimimage> - Use this xCAT command to create AIX image definitions.
B<mknimimage> - Use this xCAT command to create AIX image definitions.
=head1 SYNOPSIS
@ -10,7 +10,7 @@ B<mknimimage [-V] [-f|--force] [-l location] [-s image_source] [-i current_image
=head1 DESCRIPTION
This command may be used to create an AIX image. It will create both an xCAT osimage definition and the corresponding NIM resource definitions.
This command may be used to create an AIX image. It will create both an xCAT osimage definition and the corresponding NIM resource definitions.
This command will also install the NIM master software and configure NIM if needed.
@ -70,7 +70,7 @@ The NIM client machine to use to create a mksysb image.
=item B<-s image_source>
The source of software to use when creating the new NIM lpp_source resource. This could be a source directory, (ex. /dev/cd0), or a previously defined lpp_source resource name.
The source of software to use when creating the new NIM lpp_source resource. This could be a source directory, (ex. /dev/cd0), or a previously defined lpp_source resource name.
=item B<-t nimtype>
@ -86,11 +86,11 @@ Verbose mode.
=over 3
=item 0
=item 0
The command completed successfully.
=item 1
=item 1
An error has occurred.
@ -118,7 +118,7 @@ This command will use node27 to create a mksysb backup image and use that to def
B<mknimimage -m mksysb -b /tmp/backups/mysysbimage spot=myspot bosinst_data=mybdata>
This command defines a NIM mksysb resource using mysysbimage.
This command defines a NIM mksysb resource using mysysbimage.
5) Create a diskless image called 61spot using the AIX product media.
@ -141,8 +141,8 @@ B<mknimimage -t diskless -s 61cosi_lpp_source 611cosi tmp=mytmp home=myhome>
This command is part of the xCAT software product.
=head1 SEE ALSO
=head1 SEE ALSO
rmnimimage(1)
L<rmnimimage(1)|rmnimimage.1>

37
xCAT-client/pods/man1/mkvm.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<mkvm> - Creates HMC- and IVM-managed partitions.
B<mkvm> - Creates HMC- and IVM-managed partitions.
=head1 SYNOPSIS
I<mkvm [-h| --help]>
I<mkvm [-v| --version]>
@ -22,15 +22,15 @@ The mkvm command creates new partition(s) with the same profile/resources as the
B<-h> Display usage message.
B<-c> Copy partitions from srccec to destcec on single HMC.
B<-c> Copy partitions from srccec to destcec on single HMC.
B<-i> Starting numeric id of the newly created partitions.
B<-i> Starting numeric id of the newly created partitions.
B<-n> New partition name.
B<-n> New partition name.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
=head1 RETURN VALUE
@ -41,18 +41,18 @@ B<-V> Verbose output.
=head1 EXAMPLES
1. To create a new partition lpar5 based on the profile/resources of lpar4, enter:
1. To create a new partition lpar5 based on the profile/resources of lpar4, enter:
I<mkvm lpar4 -i 5 -n lpar5>
I<mkvm lpar4 -i 5 -n lpar5>
Output is similar to:
lpar5: Success
2. To create new partitions lpar5-lpar8 based on the profile/resources of lpar4, enter:
2. To create new partitions lpar5-lpar8 based on the profile/resources of lpar4, enter:
I<mkvm lpar4 -i 5 -n lpar5-lpar8>
I<mkvm lpar4 -i 5 -n lpar5-lpar8>
Output is similar to:
@ -65,24 +65,23 @@ lpar7: Success
lpar8: Success
3. To duplicate all the partitions associated with cec01 on cec02, enter:
3. To duplicate all the partitions associated with cec01 on cec02, enter:
I<mkvm cec01 -c cec02>
I<mkvm cec01 -c cec02>
Output is similar to:
cec01: Success
=head1 FILES
/opt/xcat/bin/mkvm
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
L<chvm(1)|chvm.1>, L<lsvm(1)|lsvm.1>, L<rmvm(1)|rmvm.1>

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

@ -79,11 +79,7 @@ The output looks like this:
/opt/xcat/bin/monls
=head1 NOTES
See monstart monstop
This command is part of the xCAT software product.
=head1 SEE ALSO
L<monstart(1)|monstart.1>, L<monstop(1)|monstop.1>

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

@ -68,11 +68,9 @@ where 2 is the number of minutes between the pings.
/opt/xcat/bin/monstart
=head1 NOTES
=head1 SEE ALSO
See monstop monls
This command is part of the xCAT software product.
L<monls(1)|monls.1>, L<monstop(1)|monstop.1>

28
xCAT-client/pods/man1/monstop.1.pod
View File

@ -1,10 +1,10 @@
=head1 NAME
B<monstop> - Stops a monitoring plug-in module to monitor the xCAT cluster.
=head1 SYNOPSIS
I<monstop [-h| --help]>
I<monstop [-v| --version]>
@ -15,20 +15,20 @@ I<monstop name>
=head1 DESCRIPTION
This command is used to unregister a monitoring plug-in module from the I<monitoring> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster.
This command is used to unregister a monitoring plug-in module from the I<monitoring> table. A monitoring plug-in module acts as a bridge that connects a 3rd party monitoring software and the xCAT cluster. Once unregistered, xCAT will ask the monitoring plug-in to stop the 3rd party software to monitor the xCAT cluster.
=head1 Parameters
I<name> is the name of the monitoring plug-in module in the I<monitoring> table.
I<name> is the name of the monitoring plug-in module in the I<monitoring> table.
=head1 OPTIONS
B<-h | -help> Display usage message.
B<-v | -version > Command Version.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-V | -verbose> Verbose output.
=head1 RETURN VALUE
@ -43,20 +43,18 @@ B<-V | -verbose> Verbose output.
monstop gangliamon
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<tabdump monitoring>.
Please note that gangliamon must have been registered in the xCAT I<monitoring> table. For a list of registered plug-in modules, use command I<tabdump monitoring>.
=head1 FILES
=head1 FILES
/opt/xcat/bin/monstop
=head1 NOTES
=head1 SEE ALSO
L<monstart(1)|monstart.1>, L<monls(1)|monls.1>
See monstart monls
This command is part of the xCAT software product.

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

@ -1,12 +1,12 @@
=head1 NAME
B<nimnodeset> - Use this xCAT command to initialize AIX/NIM standalone machines.
B<nimnodeset> - Use this xCAT command to initialize AIX/NIM standalone machines.
=head1 SYNOPSIS
B<nimnodeset [-h|--help ]>
B<nimnodeset [-V] [-f|--force] [-i osimage_name] noderange [attr=val [attr=val ...]]>
B<nimnodeset [-V] [-f|--force] [-i osimage_name] noderange [attr=val [attr=val ...]]>
=head1 DESCRIPTION
@ -33,7 +33,7 @@ val pairs must be specified last on the command line. These are used to specify
=item B<-f |--force>
Use the force option to reinitialize the NIM machines.
Use the force option to reinitialize the NIM machines.
=item B<-h |--help>
@ -41,7 +41,7 @@ Display usage message.
=item B<-i image_name>
The name of an existing xCAT osimage definition.
The name of an existing xCAT osimage definition.
=item B<noderange>
@ -57,11 +57,11 @@ Verbose mode.
=over 3
=item 0
=item 0
The command completed successfully.
=item 1
=item 1
An error has occurred.
@ -102,8 +102,8 @@ B<nimnodeset -i 611image node02 installp_bundle=sshbundle>
This command is part of the xCAT software product.
=head1 SEE ALSO
=head1 SEE ALSO
mknimimage(1), rnetboot(1)
L<mknimimage(1)|mknimimage.1>, L<rnetboot(1)|rnetboot.1>

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

@ -101,4 +101,4 @@ B< nodech> I<node1-node4 groups^=group1 groups,=group2>
=head1 SEE ALSO
nodels(1), nodeadd(1), noderange(5)
L<nodels(1)|nodels.1>, L<nodeadd(8)|nodeadd.8>, L<noderange(3)|noderange.3>

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

@ -1,6 +1,6 @@
=head1 NAME
B<nodels> - lists the nodes in the noderange.
B<nodels> - lists the nodes, and their attributes, from the xCAT database.
=head1 SYNOPSIS
@ -9,43 +9,41 @@ B<nodels> [I<noderange>] [B<-H> | B<--with-fieldname>] [I<table.column> | I<shor
B<nodels> [I<noderange>] [B<-H> | B<--with-fieldname>] [I<table>]
B<nodels> {B<-v> | B<--version>}
B<nodels> [B<-?> | B<-h> | B<--help>]
B<nodels> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The nodels command lists the nodes specified in the node range. If no noderange is provided, then all nodes are listed.
The B<nodels> command lists the nodes specified in the node range. If no noderange is provided, then all nodes are listed.
Additional attributes of the nodes will also be displayed if the table names and attribute names
are specified after the noderange in the form: I<table.column> . A few shortcut names can
also be used as aliases to common attributes:
=over 10
=over 15
=item I<groups>
=item B<groups>
nodelist.groups
=item I<tags>
=item B<tags>
nodelist.groups
=item I<mgt>
=item B<mgt>
nodehm.mgt
=item I<switch>
=item B<switch>
switch.switch
=back
The nodels command with a specific node and one or more table.attribute parameters is a good substitute
for grep'ing through the tab files, like was done in xCAT 1.x. This is because nodels will translate
The B<nodels> command with a specific node and one or more table.attribute parameters is a good substitute
for grep'ing through the tab files, as was typically done in xCAT 1.x. This is because nodels will translate
any regular expression rows in the tables into their meaning for the specified node. The tab* commands
will not do this, instead they will just display the single regular expression row.
will not do this, instead they will just display the regular expression row verbatim.
=head1 OPTIONS
@ -58,7 +56,7 @@ Command Version.
=item B<-H|--with-fieldname>
Force display table name and column name context for each result
Force display of table name and column name context for each result
=item B<-?|-h|--help>
@ -84,9 +82,9 @@ An error has occurred.
=head1 EXAMPLES
=over 2
=over 3
=item *
=item 1.
To list all defined nodes, enter:
@ -98,7 +96,7 @@ Output is similar to:
node2
node3
=item *
=item 2.
To list all defined attributes in a table for a node or noderange, enter:
@ -114,7 +112,7 @@ Output is similar to:
rra001a: noderes.node: rra001a
=item *
=item 3.
To list nodes in node group ppc, enter:
@ -126,7 +124,7 @@ Output is similar to:
ppcnode2
ppcnode3
=item *
=item 4.
To list the groups each node is part of:
@ -138,7 +136,7 @@ Output is similar to:
node2: groups: all,storage
node3: groups: all,blade
=item *
=item 5.
To list the groups each node is part of:
@ -150,7 +148,7 @@ Output is similar to:
node2: nodehm.power: ipmi
node3: nodehm.power: ipmi
=item *
=item 6.
To list the out-of-band mgt method for blade1:
@ -170,5 +168,5 @@ Output is similar to:
=head1 SEE ALSO
noderange(5)
L<noderange(3)|noderange.3>, L<tabdump(8)|tabdump.8>, L<lsdef(1)|lsdef.1>

22
xCAT-client/pods/man1/noderm.1.pod
View File

@ -1,10 +1,10 @@
=head1 NAME
B<noderm> -Removes the nodes in the noderange from all database table.
=head1 SYNOPSIS
I<noderm [-h| --help]>
I<noderm [-h| --help]>
@ -13,7 +13,7 @@ I<noderm noderange>
=head1 DESCRIPTION
The noderm command removes the nodes in the input node range.
The noderm command removes the nodes in the input node range.
=head1 OPTIONS
@ -30,19 +30,19 @@ B<-h> Display usage message.
=head1 EXAMPLES
1. To remove the nodes in noderange node1-node4, enter:
1. To remove the nodes in noderange node1-node4, enter:
I<noderm node1-node4>
I<noderm node1-node4>
=head1 FILES
/opt/xcat/bin/noderm
=head1 NOTES
=head1 SEE ALSO
L<nodels(1)|nodels.1>, L<nodeadd(8)|nodeadd.8>, L<noderange(3)|noderange.3>
This command is part of the xCAT software product.

34
xCAT-client/pods/man1/packimage.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<packimage> - Packs the stateless image from the chroot file system.
B<packimage> - Packs the stateless image from the chroot file system.
=head1 SYNOPSIS
I<packimage [-h| --help]>
I<packimage [-v| --version]>
@ -14,10 +14,10 @@ I<packimage [-o OS] [ -p profile] [-a architecture] [-m method]>
=head1 DESCRIPTION
Packs the stateless image from the chroot file system into a file system to be
Packs the stateless image from the chroot file system into a file system to be
sent to the node for a diskless install.
The install dir is setup by using "installdir" attribute set in the site table.
The nodetype table "profile" attribute for the node should reflect the profile of the install image.
The install dir is setup by using "installdir" attribute set in the site table.
The nodetype table "profile" attribute for the node should reflect the profile of the install image.
This uses the package information from the /opt/xcat/share/xcat/netboot/[os] directory files for the profile input.
@ -26,15 +26,15 @@ This uses the package information from the /opt/xcat/share/xcat/netboot/[os] dir
B<-h> Display usage message.
B<-v> Command Version.
B<-v> Command Version.
B<-o> Operating system (fedora8, rhel5, sles10,etc)
B<-o> Operating system (fedora8, rhel5, sles10,etc)
B<-p> Profile (compute,service)
B<-p> Profile (compute,service)
B<-a> Architecture (ppc64,x86_64,etc)
B<-a> Architecture (ppc64,x86_64,etc)
B<-m> Method (default cpio)
B<-m> Method (default cpio)
=head1 RETURN VALUE
@ -45,14 +45,14 @@ B<-m> Method (default cpio)
=head1 EXAMPLES
1. To pack a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory enter:
1. To pack a fedora8 image for a compute node architecture x86_64 and place it in the /install/netboot/fedora8/x86_64/compute/rootimg directory enter:
I<packimage -o fedora8 -p compute -a x86_64>
I<packimage -o fedora8 -p compute -a x86_64>
This would use the package information from the /opt/xcat/share/xcat/netboot/fedora/compute* files.
=head1 FILES
/opt/xcat/sbin/packimage
@ -62,6 +62,6 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
genimage(1)
L<genimage(1)|genimage.1>

4
xCAT-client/pods/man1/pcons.1.pod
View File

@ -26,8 +26,8 @@ Runs the a command to the noderange using the console.
=head1 AUTHOR
=head1 SEE ALSO
Egan Ford E<lt>egan@us.ibm.comE<gt>
L<psh(1)|psh.1>

5
xCAT-client/pods/man1/pping.1.pod
View File

@ -49,8 +49,7 @@ B<-v | version> version
node2: noping
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
=head1 SEE ALSO
L<psh(1)|psh.1>

5
xCAT-client/pods/man1/ppping.1.pod
View File

@ -45,8 +45,7 @@ B<-v | version> version
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
=head1 SEE ALSO
L<psh(1)|psh.1>, L<pping(1)|pping.1>

8
xCAT-client/pods/man1/rbeacon.1.pod
View File

@ -26,10 +26,4 @@ B<rbeacon> Turns beacon (a light on the front of the physical server) on/off/bli
=head1 SEE ALSO
noderange(3), rpower(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
L<noderange(3)|noderange.3>, L<rpower(1)|rpower.1>

7
xCAT-client/pods/man1/rbootseq.1.pod
View File

@ -79,10 +79,5 @@ Display the current boot sequence.
=head1 SEE ALSO
rsetboot(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
L<rsetboot(1)|rsetboot.1>

6
xCAT-client/pods/man1/rcons.1.pod
View File

@ -39,10 +39,6 @@ method.
B<rcons> I<node5>
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
B<rvid(1)>, L<wcons(1)|wcons.1>, B<wvid(1)>
L<wcons(1)|wcons.1>

30
xCAT-client/pods/man1/regnotif.1.pod
View File

@ -1,10 +1,10 @@
=head1 NAME
B<regnotif> - Registers a Perl module or a command that will get called when changes occur in the desired xCAT database tables.
=head1 SYNOPSIS
I<regnotif [-h| --help]>
I<regnotif [-v| --version]>
@ -20,19 +20,19 @@ This command is used to register a Perl module or a command to the xCAT notifica
=head1 Parameters
I<filename> is the full path name of the Perl module or command to be registered.
I<tablename> is the name of the table that the user is interested in.
I<filename> is the full path name of the Perl module or command to be registered.
I<tablename> is the name of the table that the user is interested in.
=head1 OPTIONS
B<-h | -help> Display usage message.
B<-v | -version > Command Version.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-V | -verbose> Verbose output.
B<-o | -operation> specifies the database table actions that the user is interested in. It is a comma separated list. 'a' for row addition, 'd' for row deletion and 'u' for row update.
B<-o | -operation> specifies the database table actions that the user is interested in. It is a comma separated list. 'a' for row addition, 'd' for row deletion and 'u' for row update.
=head1 RETURN VALUE
@ -45,21 +45,17 @@ B<-o | -operation> specifies the database table actions that the user is int
1. To register a Perl module that gets invoked when rows get added or deleted. in the nodelist and the nodehm tables, enter:
regnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm nodelist,nodhm -o a,d
2. To register a command that gets invoked when rows get updated in the switch table, enter:
regnotif /usr/bin/mycmd switch -o u
=head1 FILES
/opt/xcat/bin/regnotif
=head1 NOTES
=head1 SEE ALSO
See unregnotif
L<unregnotif(1)|unregnotif.1>
This command is part of the xCAT software product.

82
xCAT-client/pods/man1/replaycons.1.pod Normal file
View File

@ -0,0 +1,82 @@
=head1 NAME
B<replaycons> - replay the console output for a node
=head1 SYNOPSIS
B<replaycons> [I<node>] [I<bps>] [I<tail_amount>]
B<replaycons> [B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<replaycons> command reads the console log stored by conserver for this node, and displays it
in a way that simulates the original output of the console. Using the I<bps> value, it will throttle
the speed of the output play back. (The conserver logs are stored in /var/log/consoles.)
For now, replaycons must be run locally on the system on which the console log is stored. This is normally
that management node, but in a hierarchical cluster will usually be the service node.
=head1 OPTIONS
=over 10
=item I<bps>]
The display rate to use to play back the console output. Default is 19200.
=item I<tail_amount>
The place in the console log file to start play back, specified as the # of lines from the end.
=item B<-v|--version>
Command Version.
=item B<-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
=over 3
=item 0
The command completed successfully.
=item 1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To replay the console for node1 at the default rate, starting 2000 lines from the end:
replaycons 19200 2000
=back
=head1 FILES
/opt/xcat/bin/replaycons
=head1 SEE ALSO
L<rcons(1)|rcons.1>

6
xCAT-client/pods/man1/restorexCATdb.1.pod
View File

@ -42,10 +42,8 @@ B<restorexCATdb -p /tmp/db>
/opt/xcat/sbin/restorexCATdb
=head1 NOTES
This command is part of the xCAT software product.
See dumpxCATdb
=head1 SEE ALSO
L<dumpxCATdb(1)|dumpxCATdb.1>

4
xCAT-client/pods/man1/reventlog.1.pod
View File

@ -61,6 +61,6 @@ B<reventlog> I<node4,node5> I<clear>
node4: clear
node5: clear
=head1 B<SEE ALSO>
=head1 SEE ALSO
rpower(1), monstart(1)
L<rpower(1)|rpower.1>, L<monstart(1)|monstart.1>

12
xCAT-client/pods/man1/rinv.1.pod
View File

@ -84,11 +84,13 @@ Print version.
=head1 B<Examples>
=over 4
=item *
To retrieve all information available from blade node4, enter:
B<rinv> I<node5> I<all>
rinv node5 all
node5: Machine Type/Model 865431Z
node5: Serial Number 23C5030
@ -115,12 +117,14 @@ B<rinv> I<node5> I<all>
To retrieve 'config' information from the HMC-managed LPAR node3, enter:
B<rinv> I<node3> I<config>
rinv node3 config
node5: Machine Configuration Info
node5: Number of Processors: 1
node5: Total Memory (MB): 1024
=head1 B<SEE ALSO>
=back
rpower(1)
=head1 SEE ALSO
L<rpower(1)|rpower.1>

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

@ -99,4 +99,4 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the mkdef(1), chdef(1), lsdef(1), and xcatstanzafile(5) commands.
L<mkdef(1)|mkdef.1>, L<lsdef(1)|lsdef.1>, L<chdef(1)|chdef.1>, L<xcatstanzafile(5)|xcatstanzafile.5>

20
xCAT-client/pods/man1/rmdsklsnode.1.pod
View File

@ -1,20 +1,20 @@
=head1 NAME
B<rmdsklsnode> - Use this xCAT command to remove AIX/NIM diskless machine definitions.
B<rmdsklsnode> - Use this xCAT command to remove AIX/NIM diskless machine definitions.
=head1 SYNOPSIS
B<rmdsklsnode [-h | --help ]>
B<rmdsklsnode [-V] [-f|--force] [-i image_name] noderange>
B<rmdsklsnode [-V] [-f|--force] [-i image_name] noderange>
=head1 DESCRIPTION
Use this command to remove all NIM machine names that were created for the specified xCAT nodes.
Use this command to remove all NIM machine names that were created for the specified xCAT nodes.
The xCAT node definitions will not be removed.
The default is to assume that the NIM machine names are the same as the xCAT node names. If you had used the "-n" option when you created the NIM machine definitions with the mkdsklsnode command then the NIM machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions you must provide the name of the osimage that was used.
The default is to assume that the NIM machine names are the same as the xCAT node names. If you had used the "-n" option when you created the NIM machine definitions with the mkdsklsnode command then the NIM machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions you must provide the name of the osimage that was used.
Use the xCAT rmdef command to remove xCAT node definitions.
@ -24,7 +24,7 @@ Use the xCAT rmdef command to remove xCAT node definitions.
=item B<-f |--force>
Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not.
Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not.
=item B<-h |--help>
@ -48,11 +48,11 @@ Verbose mode.
=over 3
=item 0
=item 0
The command completed successfully.
=item 1
=item 1
An error has occurred.
@ -80,8 +80,8 @@ B<mkdsklsnode -f aixnodes>
This command is part of the xCAT software product.
=head1 SEE ALSO
=head1 SEE ALSO
mkdsklsnode(1)
L<mkdsklsnode(1)|mkdsklsnode.1>

14
xCAT-client/pods/man1/rmnimimage.1.pod
View File

@ -1,12 +1,12 @@
=head1 NAME
B<rmnimimage> - Use this xCAT command to remove an xCAT osimage definition and the associated NIM resources.
B<rmnimimage> - Use this xCAT command to remove an xCAT osimage definition and the associated NIM resources.
=head1 SYNOPSIS
B<rmnimimage [-h | --help ]>
B<rmnimimage [-V] osimage_name>
B<rmnimimage [-V] osimage_name>
=head1 DESCRIPTION
@ -40,11 +40,11 @@ Verbose mode.
=over 3
=item 0
=item 0
The command completed successfully.
=item 1
=item 1
An error has occurred.
@ -64,6 +64,6 @@ B<rmnimimage 53cosi>
This command is part of the xCAT software product.
=head1 SEE ALSO
=head1 SEE ALSO
mknimimage(1)
L<mknimimage(1)|mknimimage.1>

23
xCAT-client/pods/man1/rmvm.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<rmvm> - Removes HMC- and IVM-managed partitions.
B<rmvm> - Removes HMC- and IVM-managed partitions.
=head1 SYNOPSIS
I<rmvm [-h| --help]>
I<rmvm [-v| --version]>
@ -21,9 +21,9 @@ The rmvm command removes the partitions specified in noderange. If noderange is
B<-h> Display usage message.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
=head1 RETURN VALUE
@ -34,9 +34,9 @@ B<-V> Verbose output.
=head1 EXAMPLES
1. To remove the partition lpar3, enter:
1. To remove the partition lpar3, enter:
I<rmvm lpar3>
I<rmvm lpar3>
Output is similar to:
@ -54,14 +54,13 @@ Output is similar to:
=head1 FILES
/opt/xcat/bin/rmvm
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
L<mkvm(1)|mkvm.1>, L<lsvm(1)|lsvm.1>, L<chvm(1)|chvm.1>

6
xCAT-client/pods/man1/rnetboot.1.pod
View File

@ -18,7 +18,7 @@ system p nodes.
=head1 OPTIONS
B<-f> Force immediate shutdown of the partition.
B<-V> Verbose output.
B<-h> Display usage message.
@ -43,3 +43,7 @@ B<rnetboot 1,3,14-56,70-203>
B<rnetboot all,-129-256>
=head1 SEE ALSO
L<nodeset(8)|nodeset.8>

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

@ -79,6 +79,6 @@ B<rpower> I<node5 on>
=head1 SEE ALSO
noderange(3), rcons(1), rinv(1), rvitals(1), rscan(1)
L<noderange(3)|noderange.3>, L<rcons(1)|rcons.1>, L<rinv(1)|rinv.1>, L<rvitals(1)|rvitals.1>, L<rscan(1)|rscan.1>

35
xCAT-client/pods/man1/rscan.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<rscan> - Collects node information from one or more hardware control points.
=head1 SYNOPSIS
I<rscan [-h|--help]>
I<rscan [-v|--version]>
@ -16,7 +16,7 @@ I<rscan [-V|--verbose] noderange [-w][-x|-z]>
The rscan command lists hardware information for each node managed by the hardware control points specified in noderange.
Note that the first line of the output always contains information about the hardware control point itself. When using the rscan command to generate output for HMC or IVM hardware control points, note that FSPs and BPAs are included in the output.
=head1 OPTIONS
@ -25,15 +25,15 @@ Note that the first line of the output always contains information about the har
B<-h> Display usage message.
B<-v> Command Version.
B<-v> Command Version.
B<-V> Verbose output.
B<-V> Verbose output.
B<-w> Writes output to xCAT database.
B<-w> Writes output to xCAT database.
B<-x> XML format.
B<-x> XML format.
B<-z> Stanza formated output.
B<-z> Stanza formated output.
=head1 RETURN VALUE
@ -44,9 +44,9 @@ B<-z> Stanza formated output.
=head1 EXAMPLES
1. To list all nodes managed by HMC hmc01 in tabular format, enter:
1. To list all nodes managed by HMC hmc01 in tabular format, enter:
I<rscan hmc01>
I<rscan hmc01>
Output is similar to:
@ -61,7 +61,7 @@ Output is similar to:
lpar p6vios 1 9117-MMA 10F6F3D
2. To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter:
2. To list all nodes managed by IVM ivm02 in XML format and write the output to the xCAT database, enter:
I<rscan ivm02 -x -w>
@ -125,7 +125,7 @@ Output is similar to:
groups=bpa,all
mgt=hmc
Server-9119-590-SN02C5F9E:
Server-9119-590-SN02C5F9E:
objtype=node
type=fsp
id=10
@ -163,15 +163,12 @@ Output is similar to:
=head1 FILES
/opt/xcat/bin/rscan
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
L<lsslp(1)|lsslp.1>

8
xCAT-client/pods/man1/rsetboot.1.pod
View File

@ -49,10 +49,4 @@ Display the current boot setting.
=head1 SEE ALSO
rsetboot(1)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
L<rbootseq(1)|rbootseq.1>

48
xCAT-client/pods/man1/rspconfig.1.pod
View File

@ -21,7 +21,7 @@ B<rspconfig> I<noderange> B<community>={B<public>|I<string>}
B<rspconfig> I<noderange> {B<ip>|B<netmask>|B<gateway>|B<backupgateway>|B<garp>}
B<rspconfig> I<noderange> B<garp>={I<time>}
=head2 MPA specific:
B<rspconfig> I<noderange> {B<sshcfg>|B<snmpcfg>|B<pd1>|B<pd2>|B<network>|B<swnet>|B<ntp>|B<textid>}
@ -137,7 +137,7 @@ Allows loss of redundancy.
=item B<ntp>={[I<ntpenable>],[I<ntpserver>],[I<frequency>],[I<v3>]}
Get or set the MPA Network Time Protocol (NTP) parameters.
Get or set the MPA Network Time Protocol (NTP) parameters.
=item B<ntpenable>
@ -177,7 +177,7 @@ Get or set where the SNMP alerts should be sent to.
=item B<spdump>
Performs a service processor dump.
Performs a service processor dump.
=item B<sshcfg>={I<enable>|I<disable>}
@ -189,7 +189,7 @@ Set the Switch network parameters.
=item B<sysdump>
Performs a system dump.
Performs a system dump.
=item B<time>={I<hh:mm:ss>}
@ -240,10 +240,10 @@ To display the MPA network parameters for mm01:
B<rspconfig> I<mm01 network>
mm01: MM IP: 192.168.1.47
mm01: MM Hostname: MM001125C31F28
mm01: Gateway: 192.168.1.254
mm01: Subnet Mask: 255.255.255.224
mm01: MM IP: 192.168.1.47
mm01: MM Hostname: MM001125C31F28
mm01: Gateway: 192.168.1.254
mm01: Subnet Mask: 255.255.255.224
=item *
@ -251,10 +251,10 @@ To change the MPA network parameters with the values in the xCAT database for mm
B<rspconfig> I<mm01 network=*>
mm01: MM IP: 192.168.1.47
mm01: MM Hostname: mm01
mm01: Gateway: 192.168.1.254
mm01: Subnet Mask: 255.255.255.224
mm01: MM IP: 192.168.1.47
mm01: MM Hostname: mm01
mm01: Gateway: 192.168.1.254
mm01: Subnet Mask: 255.255.255.224
=item *
@ -262,7 +262,7 @@ To change only the gateway parameter for the MPA network mm01:
B<rspconfig> I<mm01 network=,,192.168.1.1,>
mm01: Gateway: 192.168.1.1
mm01: Gateway: 192.168.1.1
=item *
@ -270,7 +270,7 @@ To get the current power redundancy mode for power domain 1 on mm01:
B<rspconfig> I<mm01 pd1>
mm01: Redundant without performance impact
mm01: Redundant without performance impact
=item *
@ -278,7 +278,7 @@ To change the current power redundancy mode for power domain 1 on mm01 to non-re
B<rspconfig> I<mm01 pd1=nonred>
mm01: nonred
mm01: nonred
=item *
@ -286,10 +286,10 @@ To enable NTP with an NTP server address of 192.168.1.1, an update frequency of
B<rspconfig> I<mm01 ntp=enable,192.168.1.1,90,enable>
mm01: NTP: disabled
mm01: NTP Server: 192.168.1.1
mm01: NTP: 90 (minutes)
mm01: NTP: enabled
mm01: NTP: disabled
mm01: NTP Server: 192.168.1.1
mm01: NTP: 90 (minutes)
mm01: NTP: enabled
=item *
@ -297,7 +297,7 @@ To disable NTP v3 authentication only on mm01:
B<rspconfig> I<mm01 ntp=,,,disable>
mm01: NTP v3: disabled
mm01: NTP v3: disabled
=item *
@ -305,7 +305,7 @@ To disable Predictive Failure and L2 Failure deconfiguration policies on mm01:
B<rspconfig> I<mm01 decfg=disable:predictive,L3>
mm01: Success
mm01: Success
=item *
@ -313,7 +313,7 @@ To deconfigure processors 4 and 5 of Processing Unit 0 on mm01:
B<rspconfig> I<mm01 procedecfg=deconfigure:0:4,5>
mm01: Success
mm01: Success
=item *
@ -321,14 +321,14 @@ To deconfigure memory bank 9 and 10 of Processing Unit 0 on mm01:
B<rspconfig> I<mm01 memdecfg=deconfigure:bank:0:9,10>
mm01: Success
mm01: Success
=back
=head1 SEE ALSO
noderange(3), rpower(1), rcons(1), rinv(1), rvitals(1), rscan(1)
L<noderange(3)|noderange.3>, L<rpower(1)|rpower.1>, L<rcons(1)|rcons.1>, L<rinv(1)|rinv.1>, L<rvitals(1)|rvitals.1>, L<rscan(1)|rscan.1>

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

@ -35,4 +35,4 @@ B<rspreset> I<node5>
=head1 B<SEE ALSO>
rpower(1), nodehm(5)
L<rpower(1)|rpower.1>, nodehm(5)

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

@ -102,4 +102,4 @@ B<rvitals> I<node5> I<all>
=head1 B<SEE ALSO>
rpower(1), rinv(1)
L<rpower(1)|rpower.1>, L<rinv(1)|rinv.1>

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

@ -0,0 +1,67 @@
=head1 NAME
B<switchblade> - reassign the BladeCenter media tray and/or KVM to the specified blade
=head1 SYNOPSIS
B<switchblade> I<MM> {B<list> | B<stat>}
B<switchblade> I<node> {B<media> | B<mt> | B<kvm> | B<video> | B<both>} [I<slot_num>]
B<switchblade> [B<-h>|B<--help>|B<-v>|B<--version>]
=head1 DESCRIPTION
B<switchblade> assigns the BladeCenter media tray and/or KVM to the specified blade, so that they can be
used with that blade. If B<list> or B<stat> are specified instead, B<switchblade> will display the current
assignment. You can either specify a management module or a node (blade) to B<switchblade>. If the latter,
B<switchblade> will determine the management module of the node.
=head1 OPTIONS
=over 7
=item B<list>|B<stat>
Display which blade the media tray and KVM are currently assigned to.
=item B<media>|B<mt>
Assign the media tray to the specified blade.
=item B<kvm>|B<video>
Assign the KVM (video display) to the specified blade.
=item B<both>
Assign both the media tray and the KVM to the specified blade.
=item I<slot_num>
The slot # of the blade that the resources should be assigned to. If not specified, it will use the slot
# of the node specified.
=back
=head1 EXAMPLES
=over 3
=item 1.
Switch the media tray to be assigned to the blade in slot 4 (assume it is node4):
switchblade node4 media
Output will be like:
Media Tray slot: 4
=back
=head1 SEE ALSO
L<rbootseq(1)|rbootseq.1>

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

@ -67,4 +67,4 @@ The output would be similar to:
=head1 SEE ALSO
nodels(1), tabdump(1)
L<nodels(1)|nodels.1>, L<tabdump(8)|tabdump.8>

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

@ -1,10 +1,10 @@
=head1 NAME
B<unregnotif> - unregister a Perl module or a command that was watching for the changes of the desired xCAT database tables.
=head1 SYNOPSIS
I<unregnotif [-h| --help]>
I<unregnotif [-v| --version]>
@ -15,21 +15,21 @@ I<unregnotif I<filename>>
=head1 DESCRIPTION
This command is used to unregistered a Perl module or a command that was watching for the changes of the desired xCAT database tables.
This command is used to unregistered a Perl module or a command that was watching for the changes of the desired xCAT database tables.
=head1 Parameters
I<filename> is the full path name of the Perl module or command to be registered.
I<filename> is the full path name of the Perl module or command to be registered.
=head1 OPTIONS
B<-h | -help> Display usage message.
B<-v | -version > Command Version.
B<-v | -version > Command Version.
B<-V | -verbose> Verbose output.
B<-V | -verbose> Verbose output.
=head1 RETURN VALUE
@ -41,22 +41,17 @@ B<-V | -verbose> Verbose output.
1. To unregistered a Perl module, enter:
unregnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm
unregnotif /opt/xcat/lib/perl/xCAT_monitoring/mycode.pm
2. To register a command, enter:
unregnotif /usr/bin/mycmd
unregnotif /usr/bin/mycmd
=head1 FILES
/opt/xcat/bin/unregnotif
=head1 NOTES
=head1 SEE ALSO
See regnotif
This command is part of the xCAT software product.
L<regnotif(1)|regnotif.1>

16
xCAT-client/pods/man1/updateSNimage.1.pod
View File

@ -46,19 +46,3 @@ I<updateSNimage -p /install/netboot/fedora8/x86_64/test/rootimg>
I<updateSNimage -n 9.112.45.6 -p /install/netboot/fedora8/x86_64/test/rootimg>
=head1 FILES
$XCATROOT/bin/chdef
(The XCATROOT environment variable is set when xCAT is installed. The
default value is "/opt/xcat".)
=head1 NOTES
This command is part of the xCAT software product.
When going to a remote host, the command uses scp. It is best to have ssh keys setup so you will not be prompted for a password on each copy.

6
xCAT-client/pods/man1/wcons.1.pod
View File

@ -38,7 +38,7 @@ Print version.
See xterm(1). Any options other than those listed above are passed
directly to xterm. B<Note:> when given multiple nodes, wcons will
override B<-title> and tries to figure out optimal B<-geometry>
override B<-title> and tries to figure out optimal B<-geometry>
options for the xterms (however, B<-geometry> can still be
specified).
@ -68,10 +68,6 @@ 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)|noderange.3>, L<rcons(1)|rcons.1>, xterm(1)

5
xCAT-client/pods/man1/wkill.1.pod
View File

@ -38,10 +38,7 @@ Print version.
B<wkill> I<node1-node5>
=head1 B<Author>
Egan Ford <egan@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)|noderange.3>, L<wcons(1)|wcons.1>.
L<noderange(3)|noderange.3>, L<wcons(1)|wcons.1>

20
xCAT-client/pods/man1/xcat2nim.1.pod
View File

@ -1,9 +1,9 @@
=head1 NAME
B<xcat2nim> - Use this command to create and manage AIX NIM definitions based on xCAT object definitions.
=head1 SYNOPSIS
I<xcat2nim [-h|--help ]>
I<xcat2nim [-V|--verbose] [-a|--all] [-l|--list] [-u|--update] [-f|--force] [-r|--remove] [-t object-types] [-o object-names] [noderange] [attr=val [attr=val...]] >
@ -12,7 +12,7 @@ I<xcat2nim [-V|--verbose] [-a|--all] [-l|--list] [-u|--update] [-f|--force] [-r|
The xcat2nim command uses xCAT node and group object definitions to create, update, list, or remove corresponding NIM machine and group definitions.
The xCAT definitions must be created and the NIM master must be installed and configured before running this command.
The xCAT definitions must be created and the NIM master must be installed and configured before running this command.
xcat2nim uses xCAT database information, command line input, and default values to run the appropriate NIM commands.
@ -32,13 +32,13 @@ B<-l|--list> List NIM definitions corresponding to xCAT definitions.
B<noderange> A set of comma delimited node names and/or group names, (must be the first parameter). See the "noderange" man page for details on supported formats.
B<-o object-names> A set of comma delimited xCAT object names.
B<-o object-names> A set of comma delimited xCAT object names.
B<-t object-types> A set of comma delimited xCAT object types. Supported types include: node and group.
B<-r|--remove> Remove NIM definitions corresponding to xCAT definitions.
B<-u|--update> Update existing NIM definitions based on xCAT definitions.
B<-u|--update> Update existing NIM definitions based on xCAT definitions.
B<-V|--verbose> Verbose mode.
@ -56,7 +56,7 @@ I<xcat2nim -a>
2. To create NIM machine definitions for all xCAT node definitions.
I<xcat2nim -t node>
I<xcat2nim -t node>
3. To create a NIM machine definition corresponding to the xCAT clstrn01 node definition.
@ -92,7 +92,7 @@ I<xcat2nim -t group -r -o AIXnodes>
=head1 FILES
$XCATROOT/bin/xcat2nim
=head1 NOTES
@ -102,5 +102,5 @@ This command is part of the xCAT software product.
=head1 SEE ALSO
See the xCAT mkdef command for details on how to create the xCAT node and group object definitions.
L<mkdef(1)|mkdef.1>

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

@ -60,4 +60,4 @@ B<psh> I<node1,node2,node3 cat /etc/passwd> | B<xcoll>
=head1 B<SEE ALSO>
psh(1), xdshbak(1)
L<psh(1)|psh.1>, L<xdshbak(1)|xdshbak.1>

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

@ -362,4 +362,4 @@ Location of the contexts available to use with DSH Utilities.
=head1 B<SEE ALSO>
xdsh(1), noderange(3)
L<xdsh(1)|xdsh.1>, L<noderange(3)|noderange.3>

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

@ -472,4 +472,4 @@ Location of the contexts available to use with DSH Utilities.
=head1 B<SEE ALSO>
xdshbak(1), noderange(3)
L<xdshbak(1)|xdshbak.1>, L<noderange(3)|noderange.3>

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

@ -115,4 +115,4 @@ B<xdsh> I<host1,host2,host3 date> | B<xdshbak -x>
=head1 B<SEE ALSO>
xdsh(1), xcoll(1)
L<xdsh(1)|xdsh.1>, L<xcoll(1)|xcoll.1>

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

@ -11,7 +11,7 @@ B<xpbsnodes> [B<-h>|B<--help>] [B<-v>|B<--version>]
=head1 DESCRIPTION
B<xpbsnodes> is a front-end to PBS pbsnode but uses xCAT's noderange to specify nodes.
=head1 OPTIONS
@ -23,7 +23,7 @@ B<offline|off> Take nodes offline.
B<clear|online|on> Take nodes online.
B<stat|state> Display PBS node state.
B<stat|state> Display PBS node state.
=head1 RETURN VALUE
@ -45,10 +45,9 @@ B<stat|state> Display PBS node state.
/opt/torque/x86_64/bin/xpbsnodes
=head1 NOTES
=head1 SEE ALSO
This command is part of the xCAT software product.
See noderange, pbsnodes
L<noderange(3)|noderange.3>

2
xCAT-client/pods/man3/noderange.3.pod
View File

@ -260,4 +260,4 @@ E.g. node2, node3, node20, node30, node21234 all match.
=head1 B<SEE ALSO>
nodels(1)
L<nodels(1)|nodels.1>

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

@ -127,4 +127,4 @@ This file is part of xCAT software product.
=head1 SEE ALSO
See the mkdef(1), chdef(1), lsdef(1), and rmdef(1) commands.
L<mkdef(1)|mkdef.1>, L<lsdef(1)|lsdef.1>, L<rmdef(1)|rmdef.1>, L<chdef(1)|chdef.1>

6
xCAT-client/pods/man8/chtab.8.pod
View File

@ -64,8 +64,6 @@ I<chtab -d node=node1 nodetype>
/opt/xcat/bin/chtab
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
L<tabdump(8)|tabdump.8>, L<tabedit(8)|tabedit.8>

2
xCAT-client/pods/man8/copycds-cdrom.8.pod
View File

@ -21,7 +21,7 @@ designated in the B<site> table attribute: B<installdir>.
=head1 SEE ALSO
copycds(8)
L<copycds(8)|copycds.8>
=head1 AUTHOR

9
xCAT-client/pods/man8/copycds.8.pod
View File

@ -17,11 +17,4 @@ 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>
L<nodeset(8)|nodeset.8>, site(5), nodetype(5)

55
xCAT-client/pods/man8/makeconservercf.8.pod Normal file
View File

@ -0,0 +1,55 @@
=head1 NAME
B<makeconservercf> - creates the conserver configuration file from info in the xCAT database
=head1 SYNOPSIS
B<makeconservercf> [B<-l|--local>] [I<noderange>]
B<makeconservercf> [B<-h|--help|-v|--version>]
=head1 DESCRIPTION
The B<makeconservercf> command will write out the /etc/conserver.cf, using information from the nodehm table
and related tables (e.g. mp, ipmi, ppc). Normally, B<makeconservercf> will write all nodes to the conserver.cf
file. If a noderange is specified, it will write on those nodes to the file. In either case, if a node
does not have nodehm.cons set, it will not be written to the file.
In the case of a hierarchical cluster (i.e. one with service nodes) B<makeconservercf> will determine
which nodes will have their consoles accessed from the management node and which from a service node
(based on the nodehm.conserver attribute). The /etc/conserver.cf file will be created accordingly on
all relevant management/service nodes. If -l is specified, it will only create the local file.
=head1 OPTIONS
=over 10
=item B<-l|--local>
Only run B<makeconservercf> locally and create the local /etc/conserver.cf. The default is to also
run it on all service nodes, if there are any.
=item B<-v|--version>
Display version.
=item B<-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 SEE ALSO
L<rcons(1)|rcons.1>

97
xCAT-client/pods/man8/makedhcp.8.pod
View File

@ -4,48 +4,71 @@ B<makedhcp> - Creates new dhcp configuration files and updates live dhcp configu
=head1 SYNOPSIS
B<makedhcp> [-n]>
B<makedhcp> B<-n>
B<makedhcp> [-a]
B<makedhcp> B<-a>
B<makedhcp> [-a] [-d]
B<makedhcp> B<-a -d>
B<makedhcp> [-d] I<noderange>
B<makedhcp> B<-d> I<noderange>
B<makedhcp> I<noderange> [B<-s> I<statements>]
B<makedhcp> I<[h|--help]>
B<makedhcp> [I<-h|--help>]
=head1 DESCRIPTION
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 configures the DHCP daemon on the local system so that xCAT
can manage the nodes of the cluster during discovery, full install, diskless booting, and normal booting.
With the B<-n> option, B<makedhcp> will create a dhcpd.conf file, including certain general parameters
such as a dynamic range and omapi configuration.
With a noderange or the B<-a> option, makedhcp will inject configuration data (via omapi) pertinent to the
specified nodes that immediately takes effect without a restart of DHCP.
The B<makedhcp> command with the B<-a> option will create a dhcpd.leases file for all nodes. If the B<-d> flag is used with the B<-a> flag then it will delete all nodes dhcp service host definitions.
If the B<-d> flag is used with the B<-a> flag then it will delete all nodes' dhcp host definitions.
The B<-d> flag followed by a I<noderange> will delete the dhcp host definitons for the noderange.
The B<makedhcp> B<-d> flag followed with a <noderange> will delete the dhcp server host definitons for the noderange.
The B<makedhcp> command also uses the following attributes from the xCAT database:
B<site.dhcpinterfaces>, B<site.domain>,
B<networks.dynamicrange>, B<networks.dhcpserver>
The B<makedhcp> command also uses the following attributes from the xCAT database:
B<site.dhcpinterfaces>, B<site.domain>, B<networks.dynamicrange>, B<networks.dhcpserver>. See
the xcatdb man page for details about the database attributes.
=head1 OPTIONS
B<-h> Display usage message.
=over 12
B<-n> Create a new dhcpd.conf file.
=item B<-n>
B<-a> Define all nodes to the dhcp server.
Create a new dhcpd.conf file with a network statement for each network dhcpd should listen on.
The B<makedhcp> command will automatically restart dhcpd after this operation.
B<-a> <-d> Delete all defined nodes to the dhcp server.
=item B<-a>
B<-d> <noderange> Delete all defined nodes in the noderange to the dhcp server.
Define all nodes to the DHCP server. (Will only add nodes that can be reached, network-wise, by
this DHCP server.) The dhcpd daemon does not have to be restarted after this.
B<-s> For the input noderange, the argument will be interpreted like dhcpd.conf text.
=item I<noderange>
Add the specified nodes to the DHCP server configuration.
=item [B<-s> I<statements>]
For the input noderange, the argument will be interpreted like dhcpd.conf text.
=item B<-a -d>
Delete all nodes from the DHCP server configuration.
=item B<-d> I<noderange>
Delete all nodes in the noderange from the DHCP server configuration.
=item B<-h>
Display usage message.
=back
=head1 RETURN VALUE
@ -54,23 +77,33 @@ B<-s> For the input noderange, the argument will be interpreted like dh
1 An error has occurred.
=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).
=over 3
I<makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";'>
=item 1.
2. The following example, will update the dhcpd.conf file.
Add the network definitions to DHCP by updating the dhcpd.conf file:
I<makedhcp -n>
makedhcp -n
=item 2.
Define all nodes to the dhcp server:
makedhcp -a
=item 3.
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).
makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";'
=back
2. The following example, will define all nodes to the dhcp server.
=head1 SEE ALSO
I<makedhcp -a>
=head1 NOTES
This command is part of the xCAT software product.
L<noderange(3)|noderange.3>

7
xCAT-client/pods/man8/makedns.8.pod
View File

@ -109,10 +109,5 @@ Subnet mask. If not specified, all the netmasks from the B<networks> table are
=head1 SEE ALSO
site(5)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
L<makehosts(8)|makehosts.8>

11
xCAT-client/pods/man8/makehosts.8.pod
View File

@ -1,6 +1,6 @@
=head1 NAME
B<makedns> - sets up /etc/hosts from the xCAT hosts table.
B<makehosts> - sets up /etc/hosts from the xCAT hosts table.
=head1 SYNOPSIS
@ -8,14 +8,12 @@ B<makehosts> [B<-n>] [I<noderange>]
B<makehosts> {B<-h>|B<--help>}
=head1 DESCRIPTION
B<makehosts> updates the /etc/hosts file based on entries in the hosts table in the xCAT database.
If your node hostnames and IP addresses follow a regular pattern, you can use just a few regular expressions
in the hosts table and then easily generate /etc/hosts using makehosts.
=head1 OPTIONS
=over 6
@ -27,7 +25,6 @@ it will only replace the lines in the file that correspond to the nodes in the s
=back
=head1 EXAMPLES
=over 2
@ -45,8 +42,4 @@ IP addresses of 1.2.3.1, 1.2.3.2, etc.
=head1 SEE ALSO
hosts(5)
=head1 AUTHOR
Egan Ford E<lt>egan@us.ibm.comE<gt>
hosts(5), L<makedns(8)|makedns.8>

33
xCAT-client/pods/man8/makenetworks.8.pod Normal file
View File

@ -0,0 +1,33 @@
=head1 NAME
B<makenetworks> - populates the xCAT networks table, using network information from the local system
=head1 SYNOPSIS
B<makenetworks>
=head1 DESCRIPTION
The B<makenetworks> command is run by xCAT automatically, when xCAT is installed on the management node.
It queries the network configuration of the management node and uses that information to populate the
networks table in the xCAT database. After that, you may want to update the networks table manually to,
for example, disable the public network entry and add networks that service nodes are on that the management
node can't see directly.
You normally do not need to run the B<makenetworks> command yourself. But if you want to reset the networks
table to its original state, remove all the entries from it (using tabedit), and then run B<makenetworks>
again.
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 SEE ALSO
L<makedhcp(8)|makedhcp.8>

40
xCAT-client/pods/man8/mknb.8.pod Normal file
View File

@ -0,0 +1,40 @@
=head1 NAME
B<mknb> - creates a network boot root image for node discovery and flashing
=head1 SYNOPSIS
B<mknb> I<arch>
=head1 DESCRIPTION
The B<mknb> command is run by xCAT automatically, when xCAT is installed on the management node.
It creates a network boot root image (used for node discovery, BMC programming, and flashing)
for the same architecture that the management node is. So you normally do not need to run the B<mknb>
command yourself. If you have nodes of a different architecture
than the management node (e.g. ppc), you can run B<mknb> to create an additional network boot image for
that architecture.
=head1 OPTIONS
=over 12
=item I<arch>
The hardware architecture for which to build the boot image: x86, x86_64, ppc, ppc64
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 SEE ALSO
L<makedhcp(8)|makedhcp.8>

2
xCAT-client/pods/man8/nodeadd.8.pod
View File

@ -80,4 +80,4 @@ B<nodeadd> I<node1-node4 groups=all,rhel5 nodetype.os=rhel5>
=head1 SEE ALSO
nodels(1), nodech(1), noderange(5)
L<nodels(1)|nodels.1>, L<nodech(1)|nodech.1>, L<noderange(3)|noderange.3>

10
xCAT-client/pods/man8/nodeset.8.pod
View File

@ -41,7 +41,7 @@ Instruct network boot loader to be skipped, generally meaning boot to hard disk
=item B<install>
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),
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<stat>
@ -96,11 +96,7 @@ 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)|noderange.3>, L<nodels(1)|nodels.1>, L<nodestat(1)|nodestat.1>, B<rinstall(1)>,
B<rflash(1)>, L<makedhcp(8)|makedhcp.8>
L<noderange(3)|noderange.3>, L<nodels(1)|nodels.1>, L<nodestat(1)|nodestat.1>, L<rinstall(8)|rinstall.8>,
L<makedhcp(8)|makedhcp.8>

2
xCAT-client/pods/man8/rinstall.8.pod
View File

@ -57,4 +57,4 @@ Jarrod B Johnson <jbjohnso@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)|noderange.3>, L<winstall(8)|winstall.8>, L<rcons(1)|rcons.1>
L<noderange(3)|noderange.3>, L<winstall(8)|winstall.8>, L<rcons(1)|rcons.1>

48
xCAT-client/pods/man8/setupiscsidev.8.pod Normal file
View File

@ -0,0 +1,48 @@
=head1 NAME
B<setupiscsidev> - creates a LUN for a node to boot up with, using iSCSI
=head1 SYNOPSIS
B<setupiscsidev> [B<-s|--size>] I<noderange>
B<setupiscsidev> [B<-h|--help|-v|--version>]
=head1 DESCRIPTION
The B<setupiscsidev> command will create a LUN on the management node (or service node) for each node
specified. The LUN device can then be used by the node as an iSCSI device so the node can boot diskless,
stateful.
=head1 OPTIONS
=over 10
=item B<-s|--size>
The size of the LUN that should be created. Default is 4096.
=item B<-v|--version>
Display version.
=item B<-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 SEE ALSO
L<nodeset(8)|nodeset.8>

2
xCAT-client/pods/man8/tabdump.8.pod
View File

@ -84,4 +84,4 @@ To display a description of each column in the nodehm table:
=head1 SEE ALSO
tabrestore(1), tabedit(1), dumpxCATdb(1)
L<tabrestore(8)|tabrestore.8>, L<tabedit(8)|tabedit.8>, L<dumpxCATdb(1)|dumpxCATdb.1>

2
xCAT-client/pods/man8/tabedit.8.pod
View File

@ -69,4 +69,4 @@ To edit the site table:
=head1 SEE ALSO
tabrestore(1), tabdump(1), chtab(1)
L<tabrestore(8)|tabrestore.8>, L<tabdump(8)|tabdump.8>, L<chtab(8)|chtab.8>

2
xCAT-client/pods/man8/tabrestore.8.pod
View File

@ -71,4 +71,4 @@ restorexCATdb -p <restore directory:
=head1 SEE ALSO
tabdump(1), tabedit(1),dumpxCATdb(1)
L<tabdump(8)|tabdump.8>, L<tabedit(8)|tabedit.8>, L<dumpxCATdb(1)|dumpxCATdb.1>

2
xCAT-client/pods/man8/winstall.8.pod
View File

@ -47,4 +47,4 @@ Jarrod B Johnson <jbjohnso@us.ibm.com>
=head1 B<See> B<Also>
L<noderange(3)|noderange.3>, L<rinstall(8)|rinstall.8>, L<wcons(1)|wcons.1>
L<noderange(3)|noderange.3>, L<rinstall(8)|rinstall.8>, L<wcons(1)|wcons.1>

BIN
xCAT-client/share/doc/xCAT2.odt
View File

Binary file not shown.

BIN
xCAT-client/share/doc/xCAT2.pdf
View File

Binary file not shown.

10
xCAT-client/xpod2man
View File

@ -15,6 +15,7 @@ use Pod::Html;
my $poddir = 'pods';
my $mandir = 'share/man';
my $htmldir = 'share/doc';
my $cachedir = '/tmp';
my @pods = getPodList($poddir);
#foreach (@pods) { print "$_\n"; } exit;
@ -47,6 +48,8 @@ foreach my $podfile (@pods) {
# Build the html page for each pod.
#mkdir($htmldir) or die "Error: could not create $htmldir.\n";
print "Converting PODs to HTML pages...\n";
# have to clear the cache, because old entries can cause a problem
unlink("$cachedir/pod2htmd.tmp", "$cachedir/pod2htmi.tmp");
foreach my $podfile (@pods) {
my $htmlfile = $podfile;
$htmlfile =~ s/^$poddir/$htmldir/; # change the beginning of the path
@ -54,6 +57,7 @@ foreach my $podfile (@pods) {
my $hdir = $htmlfile;
$hdir =~ s|/[^/]*$||; # get rid of the basename part
if (system("mkdir -p $hdir")) { die "Error: could not create $hdir.\n"; }
#print "$podfile, $htmlfile, $poddir, $htmldir\n";
convertpod2html($podfile, $htmlfile, $poddir, $htmldir);
}
@ -67,13 +71,13 @@ sub getPodList {
# 1st get toplevel dir listing
opendir(DIR, $poddir) or die "Error: could not read $poddir.\n";
my @topdir = grep !/^\./, readdir(DIR);
my @topdir = grep !/^\./, readdir(DIR); # /
close(DIR);
# Now go thru each subdir (these are man1, man3, etc.)
foreach my $mandir (@topdir) {
opendir(DIR, "$poddir/$mandir") or die "Error: could not read $poddir/$mandir.\n";
my @dir = grep !/^\./, readdir(DIR);
my @dir = grep !/^\./, readdir(DIR); # /
close(DIR);
foreach my $file (@dir) {
push @files, "$poddir/$mandir/$file";
@ -152,7 +156,7 @@ sub convertpod2html {
"--podroot=$poddir",
"--htmldir=$htmldir",
"--recurse",
"--cachedir=/tmp",
"--cachedir=$cachedir",
);
}