=head1 NAME

B<xcat> - extreme Cluster Administration Tool.

=head1 DESCRIPTION

Extreme Cluster Administration Toolkit (xCAT). xCAT is a scalable distributed computing management
and provisioning tool that provides a unified interface for hardware control, discovery, and
OS diskful/diskfree deployment.


=head1 XCAT DATABASE

All of the cluster configuration information is in the xCAT database.  See L<xcatdb(5)|xcatdb.5> for
descriptions of every table in the database.

=head1 XCAT COMMANDS

What follows is a short description of each xCAT command.  To get more information about a particular
command, see its man page.  Note that the commands are listed in alphabetical order B<within each section>,
i.e. all the commands in section 1, then the commands in section 3, etc.

=over 12

=item L<addkit(1)|addkit.1>

Install a kit on the xCAT management node

=item L<addkitcomp(1)|addkitcomp.1>

Assign kit components to osimage.

=item L<cfgve(1)|cfgve.1>

Configure the elements for a virtual environment.

=item L<cfm2xcat(1)|cfm2xcat.1>

Migrates the CFM setup in CSM to the xdcp rsync setup in xCAT. 

=item L<chdef(1)|chdef.1>

Change xCAT data object definitions.

=item L<chhypervisor(1)|chhypervisor.1>

Configure the virtualization hosts.

=item L<chkkitcomp(1)|chkkitcomp.1>

Check if kit component fits to osimage.

=item L<chkosimage(1)|chkosimage.1>

Use this xCAT command to check an xCAT osimage.

=item L<chvm(1)|chvm.1>

Changes HMC-, IVM-, and zVM-managed partition profiles or virtual machines. For Power 775, chvm could be used to change the octant configuration values for generating LPARs; change the I/O slots assignment to LPARs within the same CEC.

=item L<clonevm(1)|clonevm.1>

Create masters from virtual machines and virtual machines from masters.

=item L<csm2xcat(1)|csm2xcat.1>

Allows the migration of a CSM database to an xCAT database. 

=item L<db2sqlsetup(1)|db2sqlsetup.1>

Sets up the IBM DB2 for xCAT to use.  

=item L<dumpxCATdb(1)|dumpxCATdb.1>

dumps the xCAT db tables .

=item L<genimage(1)|genimage.1>

Generates a stateless image to be used for a diskless install.

=item L<getmacs(1)|getmacs.1>

Collects node MAC address.

=item L<gettab(1)|gettab.1>

select table rows, based on attribute criteria, and display specific attributes.

=item L<getxcatdocs(1)|getxcatdocs.1>

downloads the xCAT documentation and converts to HTML and PDF

=item L<groupfiles4dsh(1)|groupfiles4dsh.1>

Builds a directory of files for each defined nodegroup in xCAT. 

=item L<imgcapture(1)|imgcapture.1>

Captures an image from a Linux diskful node and create a diskless image on the management node.

=item L<imgexport(1)|imgexport.1>

Exports an xCAT image.

=item L<imgimport(1)|imgimport.1>

Imports an xCAT image or configuration file into the xCAT tables so that you can immediately begin deploying with it.

=item L<liteimg(1)|liteimg.1>

Modify statelite image by creating a series of links.

=item L<lsdef(1)|lsdef.1>

Use this command to list xCAT data object definitions.

=item L<lsflexnode(1)|lsflexnode.1>

Display the information of flexible node

=item L<lshwconn(1)|lshwconn.1>

Use this command to display the connection status for CEC and Frame nodes.

=item L<lskmodules(1)|lskmodules.1>

list kernel driver modules in rpms or driver disk image files

=item L<lslite(1)|lslite.1>

Display a summary of the statelite information.

=item L<lsslp(1)|lsslp.1>

Discovers selected networked services information within the same subnet.

=item L<lstree(1)|lstree.1>

Display the tree of service node hierarchy, hardware hierarchy, or VM hierarchy.

=item L<lsve(1)|lsve.1>

Lists detail attributes for a virtual environment.

=item L<lsvm(1)|lsvm.1>

Lists partition profile information for HMC-, IVM-, KVM-, Vmware- and zVM-managed nodes. For Power 775, it lists the LPARs' I/O slots information and CEC configuration.

=item L<lsxcatd(1)|lsxcatd.1>

lists xCAT daemon information.

=item L<mkdef(1)|mkdef.1>

Use this command to create xCAT data object definitions.

=item L<mkdsklsnode(1)|mkdsklsnode.1>

Use this xCAT command to define and initialize AIX/NIM diskless machines.

=item L<mkflexnode(1)|mkflexnode.1>

Create a flexible node.

=item L<mkhwconn(1)|mkhwconn.1>

Sets up connections for CEC and Frame nodes to HMC nodes or hardware server.

=item L<mknimimage(1)|mknimimage.1>

Use this xCAT command to create xCAT osimage definitions and related AIX/NIM resources. The command can also be used to update an existing AIX diskless image(SPOT).

=item L<mkvm(1)|mkvm.1>

Creates HMC-, IVM-, and zVM-managed partitions or other virtual machines.

=item L<monadd(1)|monadd.1>

Registers a monitoring plug-in to the xCAT cluster.

=item L<moncfg(1)|moncfg.1>

Configures a 3rd party monitoring software to monitor the xCAT cluster.

=item L<mondecfg(1)|mondecfg.1>

Deconfigures a 3rd party monitoring software from monitoring the xCAT cluster.

=item L<monls(1)|monls.1>

Lists monitoring plug-in modules that can be used to monitor the xCAT cluster.

=item L<monrm(1)|monrm.1>

Unregisters a monitoring plug-in module from the xCAT cluster.

=item L<monshow(1)|monshow.1>

Shows event data for monitoring.

=item L<monstart(1)|monstart.1>

Starts a plug-in module to monitor the xCAT cluster.

=item L<monstop(1)|monstop.1>

Stops a monitoring plug-in module to monitor the xCAT cluster.

=item L<mysqlsetup(1)|mysqlsetup.1>

Sets up the MySQL database for xCAT to use.  

=item L<nimnodecust(1)|nimnodecust.1>

Use this xCAT command to customize AIX/NIM standalone machines.

=item L<nimnodeset(1)|nimnodeset.1>

Use this xCAT command to initialize AIX/NIM standalone machines.

=item L<nodeaddunmged(1)|nodeaddunmged.1>

Create a unmanaged node.

=item L<nodech(1)|nodech.1>

Changes nodes' attributes in the xCAT cluster database.

=item L<nodechmac(1)|nodechmac.1>

Updates the MAC address for a node.

=item L<nodechprofile(1)|nodechprofile.1>

updates a profile used by a node

=item L<nodediscoverls(1)|nodediscoverls.1>

List all discovered nodes

=item L<nodediscoverstart(1)|nodediscoverstart.1>

starts the node discovery process

=item L<nodediscoverstatus(1)|nodediscoverstatus.1>

gets the node discovery process status 

=item L<nodediscoverstop(1)|nodediscoverstop.1>

stops the node discovery process.

=item L<nodegrpch(1)|nodegrpch.1>

Changes attributes at the group level in the xCAT cluster database.

=item L<nodeimport(1)|nodeimport.1>

Create profiled nodes by importing hostinfo file.

=item L<nodels(1)|nodels.1>

lists the nodes, and their attributes, from the xCAT database.

=item L<nodepurge(1)|nodepurge.1>

Removes nodes.

=item L<noderefresh(1)|noderefresh.1>

Update nodes configurations by running associated kit plugins.

=item L<noderm(1)|noderm.1>

Removes the nodes in the noderange from all database table.

=item L<nodestat(1)|nodestat.1>

display the running status of each node in a noderange

=item L<packimage(1)|packimage.1>

Packs the stateless image from the chroot file system.

=item L<pasu(1)|pasu.1>

run the ASU to many nodes in parallel

=item L<pcons(1)|pcons.1>

Runs a command on the noderange using the out-of-band console.

=item L<pgsqlsetup(1)|pgsqlsetup.1>

Sets up the PostgreSQL database for xCAT to use.  

=item L<pping(1)|pping.1>

parallel ping the nodes.

=item L<ppping(1)|ppping.1>

parallel ping from nodes to other nodes in the cluster.

=item L<prsync(1)|prsync.1>

parallel rsync

=item L<pscp(1)|pscp.1>

parallel remote copy

=item L<psh(1)|psh.1>

parallel remote shell

=item L<rbeacon(1)|rbeacon.1>

Turns beacon on/off/blink or gives status of a node or noderange.

=item L<rbootseq(1)|rbootseq.1>

Persistently sets the order of boot devices for BladeCenter blades or PPC LPARs using Direct FSP Management (DFM).

=item L<rcons(1)|rcons.1>

remotely accesses the serial console of a node

=item L<regnotif(1)|regnotif.1>

Registers a Perl module or a command that will get called when changes occur in the desired xCAT database tables.

=item L<renergy(1)|renergy.1>

remote energy management tool

=item L<replaycons(1)|replaycons.1>

replay the console output for a node

=item L<restartxcatd(1)|restartxcatd.1>

Restart the xCAT daemon (xcatd) on AIX.

=item L<restorexCATdb(1)|restorexCATdb.1>

restores the xCAT db tables .

=item L<reventlog(1)|reventlog.1>

retrieve or clear remote hardware event logs

=item L<rflash(1)|rflash.1>

Performs Licensed Internal Code (LIC) update support for HMC-attached POWER5 and POWER6 Systems, and POWER7 systems using Direct FSP management. 

=item L<rinv(1)|rinv.1>

Remote hardware inventory

=item L<rmdef(1)|rmdef.1>

Use this command to remove xCAT data object definitions.

=item L<rmdsklsnode(1)|rmdsklsnode.1>

Use this xCAT command to remove AIX/NIM diskless machine definitions.

=item L<rmflexnode(1)|rmflexnode.1>

Delete a flexible node.

=item L<rmhwconn(1)|rmhwconn.1>

Use this command to remove connections from CEC and Frame nodes to HMC nodes.

=item L<rmhypervisor(1)|rmhypervisor.1>

Remove the virtualization hosts.

=item L<rmigrate(1)|rmigrate.1>

Execute migration of a guest VM between hosts/hypervisors

=item L<rmimage(1)|rmimage.1>

Removes the Linux stateless or statelite image from the file system.

=item L<rmkit(1)|rmkit.1>

Remove Kits from xCAT

=item L<rmkitcomp(1)|rmkitcomp.1>

Remove kit components from osimage.

=item L<rmnimimage(1)|rmnimimage.1>

Use this xCAT command to remove NIM resources specified in an xCAT osimage definition.

=item L<rmvm(1)|rmvm.1>

Removes HMC-, IVM-, KVM-, Vmware- and zVM-managed partitions or virtual machines.

=item L<rnetboot(1)|rnetboot.1>

Cause the range of nodes to boot to network.

=item L<rollupdate(1)|rollupdate.1>

performs cluster rolling update

=item L<rpower(1)|rpower.1>

remote power control of nodes

=item L<rscan(1)|rscan.1>

Collects node information from one or more hardware control points.

=item L<rsetboot(1)|rsetboot.1>

Sets the boot device to be used for BMC-based servers for the next boot only.

=item L<rspconfig(1)|rspconfig.1>

Configures nodes' service processors

=item L<rspreset(1)|rspreset.1>

resets the service processors associated with the specified nodes

=item L<rvitals(1)|rvitals.1>

remote hardware vitals

=item L<sinv(1)|sinv.1>

Checks the software configuration of the nodes in the cluster. 

=item L<snmove(1)|snmove.1>

Move xCAT compute nodes to a different xCAT service node.

=item L<swapnodes(1)|swapnodes.1>

swap the location info in the db (all the attributes in the ppc table and the nodepos table) between 2 nodes. If swapping within a cec, it will assign the IO adapters that were assigned to the defective node to the available node. 

=item L<switchblade(1)|switchblade.1>

reassign the BladeCenter media tray and/or KVM to the specified blade

=item L<tabgrep(1)|tabgrep.1>

list table names in which an entry for the given node appears.

=item L<unregnotif(1)|unregnotif.1>

unregister a Perl module or a command that was watching for the changes of  the desired xCAT database tables.

=item L<updateSNimage(1)|updateSNimage.1>

Adds the needed Service Node configuration files to the install image.

=item L<updatenode(1)|updatenode.1>

Update nodes in an xCAT cluster environment.

=item L<wcons(1)|wcons.1>

windowed remote console

=item L<wkill(1)|wkill.1>

kill windowed remote consoles

=item L<wvid(1)|wvid.1>

windowed remote video console for nodes

=item L<xCATWorld(1)|xCATWorld.1>

Sample client program for xCAT.  

=item L<xcat(1)|xcat.1>

extreme Cluster Administration Tool.

=item L<xcat2nim(1)|xcat2nim.1>

Use this command to create and manage AIX NIM definitions based on xCAT node, group and network object definitions.  

=item L<xcatchroot(1)|xcatchroot.1>

Use this xCAT command to modify an xCAT AIX diskless operating system image.

=item L<xcoll(1)|xcoll.1>

Formats and consolidates the output of the B<psh>, B<rinv> commands.

=item L<xdcp(1)|xdcp.1>

Concurrently copies files to or from multiple nodes. In addition, provides an option to use rsync to update the files on the nodes, or to an installation image on the local node.

=item L<xdsh(1)|xdsh.1>

Concurrently runs remote commands on multiple nodes (Management Node, Service Nodes, compute nodes), or an install image.

=item L<xdshbak(1)|xdshbak.1>

Formats the output of the B<xdsh> command.

=item L<xdshcoll(1)|xdshcoll.1>

Formats and consolidates the output of the B<xdsh,sinv> commands.

=item L<xpbsnodes(1)|xpbsnodes.1>

PBS pbsnodes front-end for a noderange.

=item L<noderange(3)|noderange.3>

syntax for compactly expressing a list of node names

=item L<xcatstanzafile(5)|xcatstanzafile.5>

Format of a stanza file that can be used with xCAT data object definition commands.

=item L<chtab(8)|chtab.8>

Add, delete or update rows in the database tables.

=item L<copycds-cdrom(8)|copycds-cdrom.8>

Client side wrapper for copycds supporting physical drives.

=item L<copycds(8)|copycds.8>

Copies Linux distributions and service levels from DVDs/ISOs to the xCAT /install directory.

=item L<makeconservercf(8)|makeconservercf.8>

creates the conserver configuration file from info in the xCAT database

=item L<makedhcp(8)|makedhcp.8>

Creates and updates DHCP configuration files.

=item L<makedns(8)|makedns.8>

sets up domain name services (DNS).

=item L<makehosts(8)|makehosts.8>

sets up /etc/hosts from the xCAT hosts table.

=item L<makeknownhosts(8)|makeknownhosts.8>

Make a known_hosts file under $ROOTHOME/.ssh for input noderange.

=item L<makenetworks(8)|makenetworks.8>

Gather cluster network information and add it to the xCAT database.

=item L<makeroutes(8)|makeroutes.8>

add or delete routes to/from the os route table on nodes.

=item L<mknb(8)|mknb.8>

creates a network boot root image for node discovery and flashing

=item L<mkrrbc(8)|mkrrbc.8>

Adds or deletes BladeCenter management module and switch node definitions in the xCAT cluster database.

=item L<mkrrnodes(8)|mkrrnodes.8>

Adds or deletes nodes in the xCAT cluster database.

=item L<nodeadd(8)|nodeadd.8>

Adds nodes to the xCAT cluster database.

=item L<nodeset(8)|nodeset.8>

set the boot state for a noderange

=item L<rinstall(8)|rinstall.8>

Begin installation on a noderange

=item L<rmosdistro(8)|rmosdistro.8>

remove OS Distro 

=item L<runsqlcmd(8)|runsqlcmd.8>

Runs sql command files against the current xCAT database.  

=item L<setupiscsidev(8)|setupiscsidev.8>

creates a LUN for a node to boot up with, using iSCSI

=item L<tabch(8)|tabch.8>

Add, delete or update rows in the database tables.

=item L<tabdump(8)|tabdump.8>

display an xCAT database table in CSV format.

=item L<tabedit(8)|tabedit.8>

view an xCAT database table in an editor and make changes.

=item L<tabprune(8)|tabprune.8>

Deletes records from the eventlog,auditlog,isnm_perf,isnm_perf_sum tables.

=item L<tabrestore(8)|tabrestore.8>

replaces the contents of an xCAT database table with the contents in a csv file.

=item L<winstall(8)|winstall.8>

Begin installation on a noderange and display in wcons

=item L<xcatconfig(8)|xcatconfig.8>

Sets up the  Management Node during the xCAT install.

=item L<xcatd(8)|xcatd.8>

The xCAT daemon 

=item L<xcatdebug(8)|xcatdebug.8>

Enable or disable the trace facilities for xCAT. (Only supports Linux Operating System)

=item L<xcatsetup(8)|xcatsetup.8>

Prime the xCAT database using naming conventions specified in a config file.

=item L<xcatsnap(8)|xcatsnap.8>

Gathers information for service about the current running xCAT environment.  

=item L<xcattest(1)|xcattest.1>

Run automated xCAT test cases.

=item L<buildkit(1)|buildkit.1>

Build product software kits to be installed in an xCAT cluster.

=back
