commit the man5 man pages generated from perl-xCAT

docs/source/guides/admin-guides/references/man5/auditlog.5.rst

@@ -0,0 +1,116 @@
+
+##########
+auditlog.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **auditlog**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **auditlog Attributes:**\   \ *recid*\ , \ *audittime*\ , \ *userid*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *noderange*\ , \ *args*\ , \ *status*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+
+.. code-block:: perl
+
+  Audit Data log.
+
+
+
+********************
+auditlog Attributes:
+********************
+
+
+
+\ **recid**\ 
+ 
+ The record id.
+ 
+
+
+\ **audittime**\ 
+ 
+ The timestamp for the audit entry.
+ 
+
+
+\ **userid**\ 
+ 
+ The user running the command.
+ 
+
+
+\ **clientname**\ 
+ 
+ The client machine, where the command originated.
+ 
+
+
+\ **clienttype**\ 
+ 
+ Type of command: cli,java,webui,other.
+ 
+
+
+\ **command**\ 
+ 
+ Command executed.
+ 
+
+
+\ **noderange**\ 
+ 
+ The noderange on which the command was run.
+ 
+
+
+\ **args**\ 
+ 
+ The command argument list.
+ 
+
+
+\ **status**\ 
+ 
+ Allowed or Denied.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Do not use.  tabprune will not work if set to yes or 1
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/bootparams.5.rst

@@ -0,0 +1,100 @@
+
+############
+bootparams.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **bootparams**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **bootparams Attributes:**\   \ *node*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *addkcmdline*\ , \ *dhcpstatements*\ , \ *adddhcpstatements*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Current boot settings to be sent to systems attempting network boot for deployment, stateless, or other reasons.  Mostly automatically manipulated by xCAT.
+
+
+**********************
+bootparams Attributes:
+**********************
+
+
+
+\ **node**\ 
+ 
+ The node or group name
+ 
+
+
+\ **kernel**\ 
+ 
+ The kernel that network boot actions should currently acquire and use.  Note this could be a chained boot loader such as memdisk or a non-linux boot loader
+ 
+
+
+\ **initrd**\ 
+ 
+ The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel)
+ 
+
+
+\ **kcmdline**\ 
+ 
+ Arguments to be passed to the kernel
+ 
+
+
+\ **addkcmdline**\ 
+ 
+ User specified one or more parameters to be passed to the kernel. For the kernel options need to be persistent after installation, specify them with prefix "R::"
+ 
+
+
+\ **dhcpstatements**\ 
+ 
+ xCAT manipulated custom dhcp statements (not intended for user manipulation)
+ 
+
+
+\ **adddhcpstatements**\ 
+ 
+ Custom dhcp statements for administrator use (not implemneted yet)
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/boottarget.5.rst

@@ -0,0 +1,82 @@
+
+############
+boottarget.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **boottarget**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **boottarget Attributes:**\   \ *bprofile*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Specify non-standard initrd, kernel, and parameters that should be used for a given profile.
+
+
+**********************
+boottarget Attributes:
+**********************
+
+
+
+\ **bprofile**\ 
+ 
+ All nodes with a nodetype.profile value equal to this value and nodetype.os set to "boottarget", will use the associated kernel, initrd, and kcmdline.
+ 
+
+
+\ **kernel**\ 
+ 
+ The kernel that network boot actions should currently acquire and use.  Note this could be a chained boot loader such as memdisk or a non-linux boot loader
+ 
+
+
+\ **initrd**\ 
+ 
+ The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel)
+ 
+
+
+\ **kcmdline**\ 
+ 
+ Arguments to be passed to the kernel
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/cfgmgt.5.rst

@@ -0,0 +1,82 @@
+
+########
+cfgmgt.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **cfgmgt**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **cfgmgt Attributes:**\   \ *node*\ , \ *cfgmgr*\ , \ *cfgserver*\ , \ *roles*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Configuration management data for nodes used by non-xCAT osimage management services to install and configure software on a node.
+
+
+******************
+cfgmgt Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The node being managed by the cfgmgr service
+ 
+
+
+\ **cfgmgr**\ 
+ 
+ The name of the configuration manager service.  Currently 'chef' and 'puppet' are supported services.
+ 
+
+
+\ **cfgserver**\ 
+ 
+ The xCAT node name of the chef server or puppet master
+ 
+
+
+\ **roles**\ 
+ 
+ The roles associated with this node as recognized by the cfgmgr for the software that is to be installed and configured.  These role names map to chef recipes or puppet manifest classes that should be used for this node.  For example, chef OpenStack cookbooks have roles such as mysql-master,keystone, glance, nova-controller, nova-conductor, cinder-all.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/chain.5.rst

@@ -0,0 +1,88 @@
+
+#######
+chain.5
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **chain**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **chain Attributes:**\   \ *node*\ , \ *currstate*\ , \ *currchain*\ , \ *chain*\ , \ *ondiscover*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Controls what operations are done (and it what order) when a node is discovered and deployed.
+
+
+*****************
+chain Attributes:
+*****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **currstate**\ 
+ 
+ The current or next chain step to be executed on this node by xCAT-genesis.  Set by xCAT during node discovery or as a result of nodeset.
+ 
+
+
+\ **currchain**\ 
+ 
+ The chain steps still left to do for this node.  This attribute will be automatically adjusted by xCAT while xCAT-genesis is running on the node (either during node discovery or a special operation like firmware update).  During node discovery, this attribute is initialized from the chain attribute and updated as the chain steps are executed.
+ 
+
+
+\ **chain**\ 
+ 
+ A comma-delimited chain of actions to be performed automatically when this node is discovered. ("Discovered" means a node booted, but xCAT and DHCP did not recognize the MAC of this node. In this situation, xCAT initiates the discovery process, the last step of which is to run the operations listed in this chain attribute, one by one.) Valid values:  boot or reboot, install or netboot, runcmd=<cmd>, runimage=<URL>, shell, standby. (Default - same as no chain - it will do only the discovery.).  Example, for BMC machines use: runcmd=bmcsetup,shell.
+ 
+
+
+\ **ondiscover**\ 
+ 
+ This attribute is currently not used by xCAT.  The "nodediscover" operation is always done during node discovery.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/deps.5.rst

@@ -0,0 +1,82 @@
+
+######
+deps.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **deps**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **deps Attributes:**\   \ *node*\ , \ *nodedep*\ , \ *msdelay*\ , \ *cmd*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Describes dependencies some nodes have on others.  This can be used, e.g., by rpower -d to power nodes on or off in the correct order.
+
+
+****************
+deps Attributes:
+****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **nodedep**\ 
+ 
+ Comma-separated list of nodes or node groups it is dependent on.
+ 
+
+
+\ **msdelay**\ 
+ 
+ How long to wait between operating on the dependent nodes and the primary nodes.
+ 
+
+
+\ **cmd**\ 
+ 
+ Comma-seperated list of which operation this dependency applies to.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/discoverydata.5.rst

@@ -0,0 +1,190 @@
+
+###############
+discoverydata.5
+###############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **discoverydata**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **discoverydata Attributes:**\   \ *uuid*\ , \ *node*\ , \ *method*\ , \ *discoverytime*\ , \ *arch*\ , \ *cpucount*\ , \ *cputype*\ , \ *memory*\ , \ *mtm*\ , \ *serial*\ , \ *nicdriver*\ , \ *nicipv4*\ , \ *nichwaddr*\ , \ *nicpci*\ , \ *nicloc*\ , \ *niconboard*\ , \ *nicfirm*\ , \ *switchname*\ , \ *switchaddr*\ , \ *switchdesc*\ , \ *switchport*\ , \ *otherdata*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Discovery data which sent from genesis.
+
+
+*************************
+discoverydata Attributes:
+*************************
+
+
+
+\ **uuid**\ 
+ 
+ The uuid of the node which send out the discovery request.
+ 
+
+
+\ **node**\ 
+ 
+ The node name which assigned to the discovered node.
+ 
+
+
+\ **method**\ 
+ 
+ The method which handled the discovery request. The method could be one of: switch, blade, profile, sequential.
+ 
+
+
+\ **discoverytime**\ 
+ 
+ The last time that xCAT received the discovery message.
+ 
+
+
+\ **arch**\ 
+ 
+ The architecture of the discovered node. e.g. x86_64.
+ 
+
+
+\ **cpucount**\ 
+ 
+ The number of cores multiply by threads core supported for the discovered node. e.g. 192.
+ 
+
+
+\ **cputype**\ 
+ 
+ The cpu type of the discovered node. e.g. Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz
+ 
+
+
+\ **memory**\ 
+ 
+ The memory size of the discovered node. e.g. 198460852
+ 
+
+
+\ **mtm**\ 
+ 
+ The machine type model of the discovered node. e.g. 786310X
+ 
+
+
+\ **serial**\ 
+ 
+ The serial number of the discovered node. e.g. 1052EFB
+ 
+
+
+\ **nicdriver**\ 
+ 
+ The driver of the nic. The value should be comma separated <nic name!driver name>. e.g. eth0!be2net,eth1!be2net
+ 
+
+
+\ **nicipv4**\ 
+ 
+ The ipv4 address of the nic. The value should be comma separated <nic name!ipv4 address>. e.g. eth0!10.0.0.212/8
+ 
+
+
+\ **nichwaddr**\ 
+ 
+ The hardware address of the nic. The should will be comma separated <nic name!hardware address>. e.g. eth0!34:40:B5:BE:DB:B0,eth1!34:40:B5:BE:DB:B4
+ 
+
+
+\ **nicpci**\ 
+ 
+ The pic device of the nic. The value should be comma separated <nic name!pci device>. e.g. eth0!0000:0c:00.0,eth1!0000:0c:00.1
+ 
+
+
+\ **nicloc**\ 
+ 
+ The location of the nic. The value should be comma separated <nic name!nic location>. e.g. eth0!Onboard Ethernet 1,eth1!Onboard Ethernet 2
+ 
+
+
+\ **niconboard**\ 
+ 
+ The onboard info of the nic. The value should be comma separated <nic name!onboard info>. e.g. eth0!1,eth1!2
+ 
+
+
+\ **nicfirm**\ 
+ 
+ The firmware description of the nic. The value should be comma separated <nic name!fimware description>. e.g. eth0!ServerEngines BE3 Controller,eth1!ServerEngines BE3 Controller
+ 
+
+
+\ **switchname**\ 
+ 
+ The switch name which the nic connected to. The value should be comma separated <nic name!switch name>. e.g. eth0!c909f06sw01
+ 
+
+
+\ **switchaddr**\ 
+ 
+ The address of the switch which the nic connected to. The value should be comma separated <nic name!switch address>. e.g. eth0!192.168.70.120
+ 
+
+
+\ **switchdesc**\ 
+ 
+ The description of the switch which the nic connected to. The value should be comma separated <nic name!switch description>. e.g. eth0!IBM Flex System Fabric EN4093 10Gb Scalable Switch, flash image: version 7.2.6, boot image: version 7.2.6
+ 
+
+
+\ **switchport**\ 
+ 
+ The port of the switch that the nic connected to. The value should be comma separated <nic name!switch port>. e.g. eth0!INTA2
+ 
+
+
+\ **otherdata**\ 
+ 
+ The left data which is not parsed to specific attributes (The complete message comes from genesis)
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/domain.5.rst

@@ -0,0 +1,94 @@
+
+########
+domain.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **domain**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **domain Attributes:**\   \ *node*\ , \ *ou*\ , \ *authdomain*\ , \ *adminuser*\ , \ *adminpassword*\ , \ *type*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Mapping of nodes to domain attributes
+
+
+******************
+domain Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The node or group the entry applies to
+ 
+
+
+\ **ou**\ 
+ 
+ For an LDAP described machine account (i.e. Active Directory), the orginaztional unit to place the system.  If not set, defaults to cn=Computers,dc=your,dc=domain
+ 
+
+
+\ **authdomain**\ 
+ 
+ If a node should participate in an AD domain or Kerberos realm distinct from domain indicated in site, this field can be used to specify that
+ 
+
+
+\ **adminuser**\ 
+ 
+ Allow a node specific indication of Administrative user.  Most will want to just use passwd table to indicate this once rather than by node.
+ 
+
+
+\ **adminpassword**\ 
+ 
+ Allow a node specific indication of Administrative user password for the domain.  Most will want to ignore this in favor of passwd table.
+ 
+
+
+\ **type**\ 
+ 
+ Type, if any, of authentication domain to manipulate.  The only recognized value at the moment is activedirectory.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/eventlog.5.rst

@@ -0,0 +1,134 @@
+
+##########
+eventlog.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **eventlog**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **eventlog Attributes:**\   \ *recid*\ , \ *eventtime*\ , \ *eventtype*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *application*\ , \ *component*\ , \ *id*\ , \ *severity*\ , \ *message*\ , \ *rawdata*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Stores the events occurred.
+
+
+********************
+eventlog Attributes:
+********************
+
+
+
+\ **recid**\ 
+ 
+ The record id.
+ 
+
+
+\ **eventtime**\ 
+ 
+ The timestamp for the event.
+ 
+
+
+\ **eventtype**\ 
+ 
+ The type of the event.
+ 
+
+
+\ **monitor**\ 
+ 
+ The name of the monitor that monitors this event.
+ 
+
+
+\ **monnode**\ 
+ 
+ The node that monitors this event.
+ 
+
+
+\ **node**\ 
+ 
+ The node where the event occurred.
+ 
+
+
+\ **application**\ 
+ 
+ The application that reports the event.
+ 
+
+
+\ **component**\ 
+ 
+ The component where the event occurred.
+ 
+
+
+\ **id**\ 
+ 
+ The location or the resource name where the event occurred.
+ 
+
+
+\ **severity**\ 
+ 
+ The severity of the event. Valid values are: informational, warning, critical.
+ 
+
+
+\ **message**\ 
+ 
+ The full description of the event.
+ 
+
+
+\ **rawdata**\ 
+ 
+ 
+ .. code-block:: perl
+ 
+   The data that associated with the event.
+ 
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Do not use.  tabprune will not work if set to yes or 1
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/firmware.5.rst

@@ -0,0 +1,70 @@
+
+##########
+firmware.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **firmware**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **firmware Attributes:**\   \ *node*\ , \ *cfgfile*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Maps node to firmware values to be used for setup at node discovery or later
+
+
+********************
+firmware Attributes:
+********************
+
+
+
+\ **node**\ 
+ 
+ The node id.
+ 
+
+
+\ **cfgfile**\ 
+ 
+ The file to use.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/hosts.5.rst

@@ -0,0 +1,82 @@
+
+#######
+hosts.5
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **hosts**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **hosts Attributes:**\   \ *node*\ , \ *ip*\ , \ *hostnames*\ , \ *otherinterfaces*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+IP addresses and hostnames of nodes.  This info is optional and is only used to populate /etc/hosts and DNS via makehosts and makedns.  Using regular expressions in this table can be a quick way to populate /etc/hosts.
+
+
+*****************
+hosts Attributes:
+*****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **ip**\ 
+ 
+ The IP address of the node. This is only used in makehosts.  The rest of xCAT uses system name resolution to resolve node names to IP addresses.
+ 
+
+
+\ **hostnames**\ 
+ 
+ Hostname aliases added to /etc/hosts for this node. Comma or blank separated list.
+ 
+
+
+\ **otherinterfaces**\ 
+ 
+ Other IP addresses to add for this node.  Format: -<ext>:<ip>,<intfhostname>:<ip>,...
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/hwinv.5.rst

@@ -0,0 +1,88 @@
+
+#######
+hwinv.5
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **hwinv**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **hwinv Attributes:**\   \ *node*\ , \ *cputype*\ , \ *cpucount*\ , \ *memory*\ , \ *disksize*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The hareware inventory for the node.
+
+
+*****************
+hwinv Attributes:
+*****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **cputype**\ 
+ 
+ The cpu model name for the node.
+ 
+
+
+\ **cpucount**\ 
+ 
+ The number of cpus for the node.
+ 
+
+
+\ **memory**\ 
+ 
+ The size of the memory for the node in MB.
+ 
+
+
+\ **disksize**\ 
+ 
+ The size of the disks for the node in GB.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/hypervisor.5.rst

@@ -0,0 +1,108 @@
+
+############
+hypervisor.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **hypervisor**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **hypervisor Attributes:**\   \ *node*\ , \ *type*\ , \ *mgr*\ , \ *interface*\ , \ *netmap*\ , \ *defaultnet*\ , \ *cluster*\ , \ *datacenter*\ , \ *preferdirect*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Hypervisor parameters
+
+
+**********************
+hypervisor Attributes:
+**********************
+
+
+
+\ **node**\ 
+ 
+ The node or static group name
+ 
+
+
+\ **type**\ 
+ 
+ The plugin associated with hypervisor specific commands such as revacuate
+ 
+
+
+\ **mgr**\ 
+ 
+ The virtualization specific manager of this hypervisor when applicable
+ 
+
+
+\ **interface**\ 
+ 
+ The definition of interfaces for the hypervisor. The format is [networkname:interfacename:bootprotocol:IP:netmask:gateway] that split with | for each interface
+ 
+
+
+\ **netmap**\ 
+ 
+ Optional mapping of useful names to relevant physical ports.  For example, 10ge=vmnic_16.0&vmnic_16.1,ge=vmnic1 would be requesting two virtual switches to be created, one called 10ge with vmnic_16.0 and vmnic_16.1 bonded, and another simply connected to vmnic1.  Use of this allows abstracting guests from network differences amongst hypervisors
+ 
+
+
+\ **defaultnet**\ 
+ 
+ Optionally specify a default network entity for guests to join to if they do not specify.
+ 
+
+
+\ **cluster**\ 
+ 
+ Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor.
+ 
+
+
+\ **datacenter**\ 
+ 
+ Optionally specify a datacenter for the hypervisor to exist in (only applicable to VMWare)
+ 
+
+
+\ **preferdirect**\ 
+ 
+ If a mgr is declared for a hypervisor, xCAT will default to using the mgr for all operations.  If this is field is set to yes or 1, xCAT will prefer to directly communicate with the hypervisor if possible
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/ipmi.5.rst

@@ -0,0 +1,143 @@
+
+######
+ipmi.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **ipmi**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **ipmi Attributes:**\   \ *node*\ , \ *bmc*\ , \ *bmcport*\ , \ *taggedvlan*\ , \ *bmcid*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Settings for nodes that are controlled by an on-board BMC via IPMI.
+
+
+****************
+ipmi Attributes:
+****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **bmc**\ 
+ 
+ The hostname of the BMC adapater.
+ 
+
+
+\ **bmcport**\ 
+ 
+ 
+ .. code-block:: perl
+ 
+   In systems with selectable shared/dedicated ethernet ports,
+             this parameter can be used to specify the preferred port.  0
+             means use the shared port, 1 means dedicated, blank is to not
+             assign.
+  
+             The following special cases exist for IBM System x servers:
+  
+             For x3755 M3 systems, 0 means use the dedicated port, 1 means
+             shared, blank is to not assign.
+  
+         For certain systems which have a mezzaine or ML2 adapter, there is a second
+         value to include:
+  
+  
+             For x3750 M4 (Model 8722):
+  
+  
+             0 2   1st 1Gbps interface for LOM
+  
+             0 0   1st 10Gbps interface for LOM
+  
+             0 3   2nd 1Gbps interface for LOM
+  
+             0 1   2nd 10Gbps interface for LOM
+  
+  
+             For  x3750 M4 (Model 8752), x3850/3950 X6, dx360 M4, x3550 M4, and x3650 M4:
+  
+  
+             0     Shared (1st onboard interface)
+  
+             1     Dedicated
+  
+             2 0   First interface on ML2 or mezzanine adapter
+  
+             2 1   Second interface on ML2 or mezzanine adapter
+  
+             2 2   Third interface on ML2 or mezzanine adapter
+  
+             2 3   Fourth interface on ML2 or mezzanine adapter
+ 
+ 
+
+
+\ **taggedvlan**\ 
+ 
+ Have bmcsetup place the BMC on the specified vlan tag on a shared netwirk interface.  Some network devices may be incompatible with this option
+ 
+
+
+\ **bmcid**\ 
+ 
+ Unique identified data used by discovery processes to distinguish known BMCs from unrecognized BMCs
+ 
+
+
+\ **username**\ 
+ 
+ The BMC userid.  If not specified, the key=ipmi row in the passwd table is used as the default.
+ 
+
+
+\ **password**\ 
+ 
+ The BMC password.  If not specified, the key=ipmi row in the passwd table is used as the default.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/iscsi.5.rst

@@ -0,0 +1,124 @@
+
+#######
+iscsi.5
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **iscsi**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **iscsi Attributes:**\   \ *node*\ , \ *server*\ , \ *target*\ , \ *lun*\ , \ *iname*\ , \ *file*\ , \ *userid*\ , \ *passwd*\ , \ *kernel*\ , \ *kcmdline*\ , \ *initrd*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains settings that control how to boot a node from an iSCSI target
+
+
+*****************
+iscsi Attributes:
+*****************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **server**\ 
+ 
+ The server containing the iscsi boot device for this node.
+ 
+
+
+\ **target**\ 
+ 
+ The iscsi disk used for the boot device for this node.  Filled in by xCAT.
+ 
+
+
+\ **lun**\ 
+ 
+ LUN of boot device.  Per RFC-4173, this is presumed to be 0 if unset.  tgtd often requires this to be 1
+ 
+
+
+\ **iname**\ 
+ 
+ Initiator name.  Currently unused.
+ 
+
+
+\ **file**\ 
+ 
+ The path on the server of the OS image the node should boot from.
+ 
+
+
+\ **userid**\ 
+ 
+ The userid of the iscsi server containing the boot device for this node.
+ 
+
+
+\ **passwd**\ 
+ 
+ The password for the iscsi server containing the boot device for this node.
+ 
+
+
+\ **kernel**\ 
+ 
+ The path of the linux kernel to boot from.
+ 
+
+
+\ **kcmdline**\ 
+ 
+ The kernel command line to use with iSCSI for this node.
+ 
+
+
+\ **initrd**\ 
+ 
+ The initial ramdisk to use when network booting this node.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/kit.5.rst

@@ -0,0 +1,112 @@
+
+#####
+kit.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kit**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kit Attributes:**\   \ *kitname*\ , \ *basename*\ , \ *description*\ , \ *version*\ , \ *release*\ , \ *ostype*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+This table stores all kits added to the xCAT cluster.
+
+
+***************
+kit Attributes:
+***************
+
+
+
+\ **kitname**\ 
+ 
+ The unique generated kit name, when kit is added to the cluster.
+ 
+
+
+\ **basename**\ 
+ 
+ The kit base name
+ 
+
+
+\ **description**\ 
+ 
+ The Kit description.
+ 
+
+
+\ **version**\ 
+ 
+ The kit version
+ 
+
+
+\ **release**\ 
+ 
+ The kit release
+ 
+
+
+\ **ostype**\ 
+ 
+ The kit OS type.  Linux or AIX.
+ 
+
+
+\ **isinternal**\ 
+ 
+ A flag to indicated if the Kit is internally used. When set to 1, the Kit is internal. If 0 or undefined, the kit is not internal.
+ 
+
+
+\ **kitdeployparams**\ 
+ 
+ The file containing the default deployment parameters for this Kit.  These parameters are added to the OS Image definition.s list of deployment parameters when one or more Kit Components from this Kit are added to the OS Image.
+ 
+
+
+\ **kitdir**\ 
+ 
+ The path to Kit Installation directory on the Mgt Node.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/kitcomponent.5.rst

@@ -0,0 +1,148 @@
+
+##############
+kitcomponent.5
+##############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kitcomponent**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kitcomponent Attributes:**\   \ *kitcompname*\ , \ *description*\ , \ *kitname*\ , \ *kitreponame*\ , \ *basename*\ , \ *version*\ , \ *release*\ , \ *serverroles*\ , \ *kitpkgdeps*\ , \ *prerequisite*\ , \ *driverpacks*\ , \ *kitcompdeps*\ , \ *postbootscripts*\ , \ *genimage_postinstall*\ , \ *exlist*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+This table stores all kit components added to the xCAT cluster.
+
+
+************************
+kitcomponent Attributes:
+************************
+
+
+
+\ **kitcompname**\ 
+ 
+ The unique Kit Component name. It is auto-generated when the parent Kit is added to the cluster.
+ 
+
+
+\ **description**\ 
+ 
+ The Kit component description.
+ 
+
+
+\ **kitname**\ 
+ 
+ The Kit name which this Kit Component belongs to.
+ 
+
+
+\ **kitreponame**\ 
+ 
+ The Kit Package Repository name which this Kit Component belongs to.
+ 
+
+
+\ **basename**\ 
+ 
+ Kit Component basename.
+ 
+
+
+\ **version**\ 
+ 
+ Kit Component version.
+ 
+
+
+\ **release**\ 
+ 
+ Kit Component release.
+ 
+
+
+\ **serverroles**\ 
+ 
+ The types of servers that this Kit Component can install on.  Valid types are: mgtnode, servicenode, compute
+ 
+
+
+\ **kitpkgdeps**\ 
+ 
+ Comma-separated list of packages that this kit component depends on.
+ 
+
+
+\ **prerequisite**\ 
+ 
+ Prerequisite for this kit component, the prerequisite includes ospkgdeps,preinstall,preupgrade,preuninstall scripts
+ 
+
+
+\ **driverpacks**\ 
+ 
+ Comma-separated List of driver package names. These must be full names like: pkg1-1.0-1.x86_64.rpm.
+ 
+
+
+\ **kitcompdeps**\ 
+ 
+ Comma-separated list of kit components that this kit component depends on.
+ 
+
+
+\ **postbootscripts**\ 
+ 
+ Comma-separated list of postbootscripts that will run during the node boot.
+ 
+
+
+\ **genimage_postinstall**\ 
+ 
+ Comma-separated list of postinstall scripts that will run during the genimage.
+ 
+
+
+\ **exlist**\ 
+ 
+ Exclude list file containing the files/directories to exclude when building a diskless image.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/kitrepo.5.rst

@@ -0,0 +1,106 @@
+
+#########
+kitrepo.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kitrepo**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kitrepo Attributes:**\   \ *kitreponame*\ , \ *kitname*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ , \ *osarch*\ , \ *compat_osbasenames*\ , \ *kitrepodir*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+This table stores all kits added to the xCAT cluster.
+
+
+*******************
+kitrepo Attributes:
+*******************
+
+
+
+\ **kitreponame**\ 
+ 
+ The unique generated kit repo package name, when kit is added to the cluster.
+ 
+
+
+\ **kitname**\ 
+ 
+ The Kit name which this Kit Package Repository belongs to.
+ 
+
+
+\ **osbasename**\ 
+ 
+ The OS distro name which this repository is based on.
+ 
+
+
+\ **osmajorversion**\ 
+ 
+ The OS distro major version which this repository is based on.
+ 
+
+
+\ **osminorversion**\ 
+ 
+ The OS distro minor version which this repository is based on. If this attribute is not set, it means that this repo applies to all minor versions.
+ 
+
+
+\ **osarch**\ 
+ 
+ The OS distro arch which this repository is based on.
+ 
+
+
+\ **compat_osbasenames**\ 
+ 
+ List of compatible OS base names.
+ 
+
+
+\ **kitrepodir**\ 
+ 
+ The path to Kit Repository directory on the Mgt Node.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst

@@ -0,0 +1,68 @@
+
+################
+kvm_masterdata.5
+################
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kvm_masterdata**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kvm_masterdata Attributes:**\   \ *name*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Persistant store for KVM plugin for masters
+
+
+**************************
+kvm_masterdata Attributes:
+**************************
+
+
+
+\ **name**\ 
+ 
+ The name of the relevant master
+ 
+
+
+\ **xml**\ 
+ 
+ The XML description to be customized for clones of this master
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst

@@ -0,0 +1,70 @@
+
+##############
+kvm_nodedata.5
+##############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kvm_nodedata**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kvm_nodedata Attributes:**\   \ *node*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Persistant store for KVM plugin, not intended for manual modification.
+
+
+************************
+kvm_nodedata Attributes:
+************************
+
+
+
+\ **node**\ 
+ 
+ The node corresponding to the virtual machine
+ 
+
+
+\ **xml**\ 
+ 
+ The XML description generated by xCAT, fleshed out by libvirt, and stored for reuse
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/linuximage.5.rst

@@ -0,0 +1,190 @@
+
+############
+linuximage.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **linuximage**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **linuximage Attributes:**\   \ *imagename*\ , \ *template*\ , \ *boottarget*\ , \ *addkcmdline*\ , \ *pkglist*\ , \ *pkgdir*\ , \ *otherpkglist*\ , \ *otherpkgdir*\ , \ *exlist*\ , \ *postinstall*\ , \ *rootimgdir*\ , \ *kerneldir*\ , \ *nodebootif*\ , \ *otherifce*\ , \ *netdrivers*\ , \ *kernelver*\ , \ *krpmver*\ , \ *permission*\ , \ *dump*\ , \ *crashkernelsize*\ , \ *partitionfile*\ , \ *driverupdatesrc*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Information about a Linux operating system image that can be used to deploy cluster nodes.
+
+
+**********************
+linuximage Attributes:
+**********************
+
+
+
+\ **imagename**\ 
+ 
+ The name of this xCAT OS image definition.
+ 
+
+
+\ **template**\ 
+ 
+ The fully qualified name of the template file that will be used to create the OS installer configuration file for stateful installations (e.g.  kickstart for RedHat, autoyast for SLES).
+ 
+
+
+\ **boottarget**\ 
+ 
+ The name of the boottarget definition.  When this attribute is set, xCAT will use the kernel, initrd and kernel params defined in the boottarget definition instead of the default.
+ 
+
+
+\ **addkcmdline**\ 
+ 
+ User specified arguments to be passed to the kernel.  The user arguments are appended to xCAT.s default kernel arguments. For the kernel options need to be persistent after installation, specify them with prefix "R::".  This attribute is ignored if linuximage.boottarget is set.
+ 
+
+
+\ **pkglist**\ 
+ 
+ The fully qualified name of the file that stores the distro  packages list that will be included in the image. Make sure that if the pkgs in the pkglist have dependency pkgs, the dependency pkgs should be found in one of the pkgdir
+ 
+
+
+\ **pkgdir**\ 
+ 
+ The name of the directory where the distro packages are stored. It could be set multiple paths.The multiple paths must be seperated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other.
+ 
+
+
+\ **otherpkglist**\ 
+ 
+ The fully qualified name of the file that stores non-distro package lists that will be included in the image. It could be set multiple paths.The multiple paths must be seperated by ",".
+ 
+
+
+\ **otherpkgdir**\ 
+ 
+ The base directory where the non-distro packages are stored. Only 1 local directory supported at present.
+ 
+
+
+\ **exlist**\ 
+ 
+ The fully qualified name of the file that stores the file names and directory names that will be excluded from the image during packimage command.  It is used for diskless image only.
+ 
+
+
+\ **postinstall**\ 
+ 
+ The fully qualified name of the script file that will be run at the end of the genimage command. It could be set multiple paths.The multiple paths must be seperated by ",". It is used for diskless image only.
+ 
+
+
+\ **rootimgdir**\ 
+ 
+ The directory name where the image is stored.  It is generally used for diskless image. it also can be used in sysclone environment to specify where the image captured from golden client is stored. in sysclone environment, rootimgdir is generally assigned to some default value by xcat, but you can specify your own store directory. just one thing need to be noticed, wherever you save the image, the name of last level directory must be the name of image. for example, if your image name is testimage and you want to save this image under home directoy, rootimgdir should be assigned to value /home/testimage/
+ 
+
+
+\ **kerneldir**\ 
+ 
+ The directory name where the 3rd-party kernel is stored. It is used for diskless image only.
+ 
+
+
+\ **nodebootif**\ 
+ 
+ The network interface the stateless/statelite node will boot over (e.g. eth0)
+ 
+
+
+\ **otherifce**\ 
+ 
+ Other network interfaces (e.g. eth1) in the image that should be configured via DHCP
+ 
+
+
+\ **netdrivers**\ 
+ 
+ The ethernet device drivers of the nodes which will use this linux image, at least the device driver for the nodes' installnic should be included
+ 
+
+
+\ **kernelver**\ 
+ 
+ The version of linux kernel used in the linux image. If the kernel version is not set, the default kernel in rootimgdir will be used
+ 
+
+
+\ **krpmver**\ 
+ 
+ The rpm version of kernel packages (for SLES only). If it is not set, the default rpm version of kernel packages will be used.
+ 
+
+
+\ **permission**\ 
+ 
+ The mount permission of /.statelite directory is used, its default value is 755
+ 
+
+
+\ **dump**\ 
+ 
+ The NFS directory to hold the Linux kernel dump file (vmcore) when the node with this image crashes, its format is "nfs://<nfs_server_ip>/<kdump_path>". If you want to use the node's "xcatmaster" (its SN or MN), <nfs_server_ip> can be left blank. For example, "nfs:///<kdump_path>" means the NFS directory to hold the kernel dump file is on the node's SN, or MN if there's no SN.
+ 
+
+
+\ **crashkernelsize**\ 
+ 
+ the size that assigned to the kdump kernel. If the kernel size is not set, 256M will be the default value.
+ 
+
+
+\ **partitionfile**\ 
+ 
+ The path of the configuration file which will be used to partition the disk for the node. For stateful osimages,two types of files are supported: "<partition file absolute path>" which contains a partitioning definition that will be inserted directly into the generated autoinst configuration file and must be formatted for the corresponding OS installer (e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu).  "s:<partitioning script absolute path>" which specifies a shell script that will be run from the OS installer configuration file %pre section;  the script must write the correct partitioning definition into the file /tmp/partitionfile on the node which will be included into the configuration file during the install process. For statelite osimages, partitionfile should specify "<partition file absolute path>";  see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides  "<partition file absolute path>" or "s:<partitioning script absolute path>", the disk name(s) to partition must be specified in traditional, non-devfs format, delimited with space,  it can be specified in 2 forms: "d:<the absolute path of the disk name file>" which contains the disk name(s) to partition and "s:d:<the absolute path of the disk script>" which runs in pressed/early_command and writes the disk names into the "/tmp/boot_disk" . To support other specific partition methods such as RAID or LVM in Ubuntu, some additional preseed values should be specified, these values can be specified with "c:<the absolute path of the additional pressed config file>" which contains the additional pressed entries in "d-i ..." form and "s:c:<the absolute path of the additional pressed config script>" which runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma ","
+ 
+
+
+\ **driverupdatesrc**\ 
+ 
+ The source of the drivers which need to be loaded during the boot. Two types of driver update source are supported: Driver update disk and Driver rpm package. The value for this attribute should be comma separated sources. Each source should be the format tab:full_path_of_srouce_file. The tab keyword can be: dud (for Driver update disk) and rpm (for driver rpm). If missing the tab, the rpm format is the default. e.g. dud:/install/dud/dd.img,rpm:/install/rpm/d.rpm
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/litefile.5.rst

@@ -0,0 +1,98 @@
+
+##########
+litefile.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **litefile**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **litefile Attributes:**\   \ *image*\ , \ *file*\ , \ *options*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The litefile table specifies the directories and files on the statelite nodes that should be readwrite, persistent, or readonly overlay.  All other files in the statelite nodes come from the readonly statelite image.
+
+
+********************
+litefile Attributes:
+********************
+
+
+
+\ **image**\ 
+ 
+ The name of the image (as specified in the osimage table) that will use these options on this dir/file. You can also specify an image group name that is listed in the osimage.groups attribute of some osimages. 'ALL' means use this row for all images.
+ 
+
+
+\ **file**\ 
+ 
+ The full pathname of the file. e.g: /etc/hosts.  If the path is a directory, then it should be terminated with a '/'.
+ 
+
+
+\ **options**\ 
+ 
+ Options for the file:
+ 
+ 
+ .. code-block:: perl
+ 
+   tmpfs - It is the default option if you leave the options column blank. It provides a file or directory for the node to use when booting, its permission will be the same as the original version on the server. In most cases, it is read-write; however, on the next statelite boot, the original version of the file or directory on the server will be used, it means it is non-persistent. This option can be performed on files and directories..
+  
+   rw - Same as Above.Its name "rw" does NOT mean it always be read-write, even in most cases it is read-write. Please do not confuse it with the "rw" permission in the file system. 
+  
+   persistent - It provides a mounted file or directory that is copied to the xCAT persistent location and then over-mounted on the local file or directory. Anything written to that file or directory is preserved. It means, if the file/directory does not exist at first, it will be copied to the persistent location. Next time the file/directory in the persistent location will be used. The file/directory will be persistent across reboots. Its permission will be the same as the original one in the statelite location. It requires the statelite table to be filled out with a spot for persistent statelite. This option can be performed on files and directories. 
+  
+   con - The contents of the pathname are concatenated to the contents of the existing file. For this directive the searching in the litetree hierarchy does not stop when the first match is found. All files found in the hierarchy will be concatenated to the file when found. The permission of the file will be "-rw-r--r--", which means it is read-write for the root user, but readonly for the others. It is non-persistent, when the node reboots, all changes to the file will be lost. It can only be performed on files. Please do not use it for one directory.
+  
+   ro - The file/directory will be overmounted read-only on the local file/directory. It will be located in the directory hierarchy specified in the litetree table. Changes made to this file or directory on the server will be immediately seen in this file/directory on the node. This option requires that the file/directory to be mounted must be available in one of the entries in the litetree table. This option can be performed on files and directories.
+  
+   link - It provides one file/directory for the node to use when booting, it is copied from the server, and will be placed in tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to one file/directory in tmpfs. And the permission of the symbolic link is "lrwxrwxrwx", which is not the real permission of the file/directory on the node. So for some application sensitive to file permissions, it will be one issue to use "link" as its option, for example, "/root/.ssh/", which is used for SSH, should NOT use "link" as its option. It is non-persistent, when the node is rebooted, all changes to the file/directory will be lost. This option can be performed on files and directories. 
+  
+   link,con -  It works similar to the "con" option. All the files found in the litetree hierarchy will be concatenated to the file when found. The final file will be put to the tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to the file/directory in tmpfs. It is non-persistent, when the node is rebooted, all changes to the file will be lost. The option can only be performed on files. 
+  
+    link,persistent - It provides a mounted file or directory that is copied to the xCAT persistent location and then over-mounted to the tmpfs on the booted node, and finally the symbolic link in the local file system will be linked to the over-mounted tmpfs file/directory on the booted node. The file/directory will be persistent across reboots. The permission of the file/directory where the symbolic link points to will be the same as the original one in the statelite location. It requires the statelite table to be filled out with a spot for persistent statelite. The option can be performed on files and directories.
+  
+   link,ro - The file is readonly, and will be placed in tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to the tmpfs. It is non-persistent, when the node is rebooted, all changes to the file/directory will be lost. This option requires that the file/directory to be mounted must be available in one of the entries in the litetree table. The option can be performed on files and directories.
+ 
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/litetree.5.rst

@@ -0,0 +1,82 @@
+
+##########
+litetree.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **litetree**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **litetree Attributes:**\   \ *priority*\ , \ *image*\ , \ *directory*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Directory hierarchy to traverse to get the initial contents of node files.  The files that are specified in the litefile table are searched for in the directories specified in this table.
+
+
+********************
+litetree Attributes:
+********************
+
+
+
+\ **priority**\ 
+ 
+ This number controls what order the directories are searched.  Directories are searched from smallest priority number to largest.
+ 
+
+
+\ **image**\ 
+ 
+ The name of the image (as specified in the osimage table) that will use this directory. You can also specify an image group name that is listed in the osimage.groups attribute of some osimages. 'ALL' means use this row for all images.
+ 
+
+
+\ **directory**\ 
+ 
+ The location (hostname:path) of a directory that contains files specified in the litefile table.  Variables are allowed.  E.g: $noderes.nfsserver://xcatmasternode/install/$node/#CMD=uname-r#/
+ 
+
+
+\ **mntopts**\ 
+ 
+ A comma-separated list of options to use when mounting the litetree directory.  (Ex. 'soft') The default is to do a 'hard' mount.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/mac.5.rst

@@ -0,0 +1,76 @@
+
+#####
+mac.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **mac**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **mac Attributes:**\   \ *node*\ , \ *interface*\ , \ *mac*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The MAC address of the node's install adapter.  Normally this table is populated by getmacs or node discovery, but you can also add entries to it manually.
+
+
+***************
+mac Attributes:
+***************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **interface**\ 
+ 
+ The adapter interface name that will be used to install and manage the node. E.g. eth0 (for linux) or en0 (for AIX).)
+ 
+
+
+\ **mac**\ 
+ 
+ The mac address or addresses for which xCAT will manage static bindings for this node.  This may be simply a mac address, which would be bound to the node name (such as "01:02:03:04:05:0E").  This may also be a "|" delimited string of "mac address!hostname" format (such as "01:02:03:04:05:0E!node5|01:02:03:05:0F!node6-eth1").
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/mic.5.rst

@@ -0,0 +1,106 @@
+
+#####
+mic.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **mic**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **mic Attributes:**\   \ *node*\ , \ *host*\ , \ *id*\ , \ *nodetype*\ , \ *bridge*\ , \ *onboot*\ , \ *vlog*\ , \ *powermgt*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The host, slot id and configuraton of the mic (Many Integrated Core).
+
+
+***************
+mic Attributes:
+***************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **host**\ 
+ 
+ The host node which the mic card installed on.
+ 
+
+
+\ **id**\ 
+ 
+ The device id of the mic node.
+ 
+
+
+\ **nodetype**\ 
+ 
+ The hardware type of the mic node. Generally, it is mic.
+ 
+
+
+\ **bridge**\ 
+ 
+ The virtual bridge on the host node which the mic connected to.
+ 
+
+
+\ **onboot**\ 
+ 
+ Set mic to autoboot when mpss start. Valid values: yes|no. Default is yes.
+ 
+
+
+\ **vlog**\ 
+ 
+ Set the Verbose Log to console. Valid values: yes|no. Default is no.
+ 
+
+
+\ **powermgt**\ 
+ 
+ Set the Power Management for mic node. This attribute is used to set the power management state that mic may get into when it is idle. Four states can be set: cpufreq, corec6, pc3 and pc6. The valid value for powermgt attribute should be [cpufreq=<on|off>]![corec6=<on|off>]![pc3=<on|off>]![pc6=<on|off>]. e.g. cpufreq=on!corec6=off!pc3=on!pc6=off. Refer to the doc of mic to get more information for power management.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Do not use.  tabprune will not work if set to yes or 1
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/monitoring.5.rst

@@ -0,0 +1,70 @@
+
+############
+monitoring.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **monitoring**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **monitoring Attributes:**\   \ *name*\ , \ *nodestatmon*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Controls what external monitoring tools xCAT sets up and uses.  Entries should be added and removed from this table using the provided xCAT commands monstart and monstop.
+
+
+**********************
+monitoring Attributes:
+**********************
+
+
+
+\ **name**\ 
+ 
+ The name of the mornitoring plug-in module.  The plug-in must be put in /lib/perl/xCAT_monitoring/.  See the man page for monstart for details.
+ 
+
+
+\ **nodestatmon**\ 
+ 
+ Specifies if the monitoring plug-in is used to feed the node status to the xCAT cluster.  Any one of the following values indicates "yes":  y, Y, yes, Yes, YES, 1.  Any other value or blank (default), indicates "no".
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/monsetting.5.rst

@@ -0,0 +1,76 @@
+
+############
+monsetting.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **monsetting**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **monsetting Attributes:**\   \ *name*\ , \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Specifies the monitoring plug-in specific settings. These settings will be used by the monitoring plug-in to customize the behavior such as event filter, sample interval, responses etc. Entries should be added, removed or modified by chtab command. Entries can also be added or modified by the monstart command when a monitoring plug-in is brought up.
+
+
+**********************
+monsetting Attributes:
+**********************
+
+
+
+\ **name**\ 
+ 
+ The name of the mornitoring plug-in module.  The plug-in must be put in /lib/perl/xCAT_monitoring/.  See the man page for monstart for details.
+ 
+
+
+\ **key**\ 
+ 
+ Specifies the name of the attribute. The valid values are specified by each monitoring plug-in. Use "monls name -d" to get a list of valid keys.
+ 
+
+
+\ **value**\ 
+ 
+ Specifies the value of the attribute.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/mp.5.rst

@@ -0,0 +1,82 @@
+
+####
+mp.5
+####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **mp**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **mp Attributes:**\   \ *node*\ , \ *mpa*\ , \ *id*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains the hardware control info specific to blades.  This table also refers to the mpa table, which contains info about each Management Module.
+
+
+**************
+mp Attributes:
+**************
+
+
+
+\ **node**\ 
+ 
+ The blade node name or group name.
+ 
+
+
+\ **mpa**\ 
+ 
+ The managment module used to control this blade.
+ 
+
+
+\ **id**\ 
+ 
+ The slot number of this blade in the BladeCenter chassis.
+ 
+
+
+\ **nodetype**\ 
+ 
+ The hardware type for mp node. Valid values: mm,cmm, blade.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/mpa.5.rst

@@ -0,0 +1,97 @@
+
+#####
+mpa.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **mpa**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **mpa Attributes:**\   \ *mpa*\ , \ *username*\ , \ *password*\ , \ *displayname*\ , \ *slots*\ , \ *urlpath*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains info about each Management Module and how to access it.
+
+
+***************
+mpa Attributes:
+***************
+
+
+
+\ **mpa**\ 
+ 
+ Hostname of the management module.
+ 
+
+
+\ **username**\ 
+ 
+ Userid to use to access the management module.
+ 
+
+
+\ **password**\ 
+ 
+ Password to use to access the management module.  If not specified, the key=blade row in the passwd table is used as the default.
+ 
+
+
+\ **displayname**\ 
+ 
+ Alternative name for BladeCenter chassis. Only used by PCM.
+ 
+
+
+\ **slots**\ 
+ 
+ The number of available slots in the chassis. For PCM, this attribute is used to store the number of slots in the following format:  <slot rows>,<slot columns>,<slot orientation>  Where:
+    <slot rows>  = number of rows of slots in chassis
+    <slot columns> = number of columns of slots in chassis
+    <slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal
+ 
+
+
+\ **urlpath**\ 
+ 
+ URL path for the Chassis web interface. The full URL is built as follows: <hostname>/<urlpath>
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/networks.5.rst

@@ -0,0 +1,158 @@
+
+##########
+networks.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **networks**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **networks Attributes:**\   \ *netname*\ , \ *net*\ , \ *mask*\ , \ *mgtifname*\ , \ *gateway*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nameservers*\ , \ *ntpservers*\ , \ *logservers*\ , \ *dynamicrange*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *nodehostname*\ , \ *ddnsdomain*\ , \ *vlanid*\ , \ *domain*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Describes the networks in the cluster and info necessary to set up nodes on that network.
+
+
+********************
+networks Attributes:
+********************
+
+
+
+\ **netname**\ 
+ 
+ Name used to identify this network definition.
+ 
+
+
+\ **net**\ 
+ 
+ The network address.
+ 
+
+
+\ **mask**\ 
+ 
+ The network mask.
+ 
+
+
+\ **mgtifname**\ 
+ 
+ The interface name of the management/service node facing this network.  !remote!<nicname> indicates a non-local network on a specific nic for relay DHCP.
+ 
+
+
+\ **gateway**\ 
+ 
+ The network gateway. It can be set to an ip address or the keyword <xcatmaster>, the keyword <xcatmaster> indicates the cluster-facing ip address configured on this management node or service node. Leaving this field blank means that there is no gateway for this network.
+ 
+
+
+\ **dhcpserver**\ 
+ 
+ The DHCP server that is servicing this network.  Required to be explicitly set for pooled service node operation.
+ 
+
+
+\ **tftpserver**\ 
+ 
+ The TFTP server that is servicing this network.  If not set, the DHCP server is assumed.
+ 
+
+
+\ **nameservers**\ 
+ 
+ A comma delimited list of DNS servers that each node in this network should use. This value will end up in the nameserver settings of the /etc/resolv.conf on each node in this network. If this attribute value is set to the IP address of an xCAT node, make sure DNS is running on it. In a hierarchical cluster, you can also set this attribute to "<xcatmaster>" to mean the DNS server for each node in this network should be the node that is managing it (either its service node or the management node).  Used in creating the DHCP network definition, and DNS configuration.
+ 
+
+
+\ **ntpservers**\ 
+ 
+ The ntp servers for this network.  Used in creating the DHCP network definition.  Assumed to be the DHCP server if not set.
+ 
+
+
+\ **logservers**\ 
+ 
+ The log servers for this network.  Used in creating the DHCP network definition.  Assumed to be the DHCP server if not set.
+ 
+
+
+\ **dynamicrange**\ 
+ 
+ The IP address range used by DHCP to assign dynamic IP addresses for requests on this network.  This should not overlap with entities expected to be configured with static host declarations, i.e. anything ever expected to be a node with an address registered in the mac table.
+ 
+
+
+\ **staticrange**\ 
+ 
+ The IP address range used to dynamically assign static IPs to newly discovered nodes.  This should not overlap with the dynamicrange nor overlap with entities that were manually assigned static IPs.  The format for the attribute value is:    <startip>-<endip>.
+ 
+
+
+\ **staticrangeincrement**\ 
+
+
+
+\ **nodehostname**\ 
+ 
+ A regular expression used to specify node name to network-specific hostname.  i.e. "/\z/-secondary/" would mean that the hostname of "n1" would be n1-secondary on this network.  By default, the nodename is assumed to equal the hostname, followed by nodename-interfacename.
+ 
+
+
+\ **ddnsdomain**\ 
+ 
+ A domain to be combined with nodename to construct FQDN for DDNS updates induced by DHCP.  This is not passed down to the client as "domain"
+ 
+
+
+\ **vlanid**\ 
+ 
+ The vlan ID if this network is within a vlan.
+ 
+
+
+\ **domain**\ 
+ 
+ The DNS domain name (ex. cluster.com).
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nics.5.rst

@@ -0,0 +1,141 @@
+
+######
+nics.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nics**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nics Attributes:**\   \ *node*\ , \ *nicips*\ , \ *nichostnamesuffixes*\ , \ *nichostnameprefixes*\ , \ *nictypes*\ , \ *niccustomscripts*\ , \ *nicnetworks*\ , \ *nicaliases*\ , \ *nicextraparams*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Stores NIC details.
+
+
+****************
+nics Attributes:
+****************
+
+
+
+\ **node**\ 
+ 
+ The node or group name.
+ 
+
+
+\ **nicips**\ 
+ 
+ Comma-separated list of IP addresses per NIC. To specify one ip address per NIC:
+                     <nic1>!<ip1>,<nic2>!<ip2>,..., for example, eth0!10.0.0.100,ib0!11.0.0.100
+                 To specify multiple ip addresses per NIC:
+                     <nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,..., for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
+                 Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
+ 
+
+
+\ **nichostnamesuffixes**\ 
+ 
+ Comma-separated list of hostname suffixes per NIC. 
+                         If only one ip address is associated with each NIC:
+                             <nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!-eth0,ib0!-ib0
+                         If multiple ip addresses are associcated with each NIC:
+                             <nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example,  eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6. 
+                         The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes. 
+                         Note:  According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnamesuffixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
+ 
+
+
+\ **nichostnameprefixes**\ 
+ 
+ Comma-separated list of hostname prefixes per NIC. 
+                         If only one ip address is associated with each NIC:
+                             <nic1>!<ext1>,<nic2>!<ext2>,..., for example, eth0!eth0-,ib0!ib-
+                         If multiple ip addresses are associcated with each NIC:
+                             <nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,..., for example,  eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-. 
+                         The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes. 
+                         Note:  According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9), minus sign (-),and period (.). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention
+ 
+
+
+\ **nictypes**\ 
+ 
+ Comma-separated list of NIC types per NIC. <nic1>!<type1>,<nic2>!<type2>, e.g. eth0!Ethernet,ib0!Infiniband. The xCAT object definition commands support to use nictypes.<nicname> as the sub attributes.
+ 
+
+
+\ **niccustomscripts**\ 
+ 
+ Comma-separated list of custom scripts per NIC.  <nic1>!<script1>,<nic2>!<script2>, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts.<nicname> as the sub attribute
+ .
+ 
+
+
+\ **nicnetworks**\ 
+ 
+ Comma-separated list of networks connected to each NIC.
+                 If only one ip address is associated with each NIC:
+                     <nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
+                 If multiple ip addresses are associated with each NIC:
+                     <nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
+ 
+
+
+\ **nicaliases**\ 
+ 
+ Comma-separated list of hostname aliases for each NIC.
+             Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
+ 			For multiple aliases per nic use a space-separated list.
+             For example: eth0!moe larry curly,eth1!tom|jerry
+ 
+
+
+\ **nicextraparams**\ 
+ 
+ Comma-separated list of extra parameters that will be used for each NIC configuration.
+                 If only one ip address is associated with each NIC:
+                     <nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
+                 If multiple ip addresses are associated with each NIC:
+                     <nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
+             The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nimimage.5.rst

@@ -0,0 +1,190 @@
+
+##########
+nimimage.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nimimage**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nimimage Attributes:**\   \ *imagename*\ , \ *nimtype*\ , \ *lpp_source*\ , \ *spot*\ , \ *root*\ , \ *dump*\ , \ *paging*\ , \ *resolv_conf*\ , \ *tmp*\ , \ *home*\ , \ *shared_home*\ , \ *res_group*\ , \ *nimmethod*\ , \ *script*\ , \ *bosinst_data*\ , \ *installp_bundle*\ , \ *mksysb*\ , \ *fb_script*\ , \ *shared_root*\ , \ *otherpkgs*\ , \ *image_data*\ , \ *configdump*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+All the info that specifies a particular AIX operating system image that can be used to deploy AIX nodes.
+
+
+********************
+nimimage Attributes:
+********************
+
+
+
+\ **imagename**\ 
+ 
+ User provided name of this xCAT OS image definition.
+ 
+
+
+\ **nimtype**\ 
+ 
+ The NIM client type- standalone, diskless, or dataless.
+ 
+
+
+\ **lpp_source**\ 
+ 
+ The name of the NIM lpp_source resource.
+ 
+
+
+\ **spot**\ 
+ 
+ The name of the NIM SPOT resource.
+ 
+
+
+\ **root**\ 
+ 
+ The name of the NIM root resource.
+ 
+
+
+\ **dump**\ 
+ 
+ The name of the NIM dump resource.
+ 
+
+
+\ **paging**\ 
+ 
+ The name of the NIM paging resource.
+ 
+
+
+\ **resolv_conf**\ 
+ 
+ The name of the NIM resolv_conf resource.
+ 
+
+
+\ **tmp**\ 
+ 
+ The name of the NIM tmp resource.
+ 
+
+
+\ **home**\ 
+ 
+ The name of the NIM home resource.
+ 
+
+
+\ **shared_home**\ 
+ 
+ The name of the NIM shared_home resource.
+ 
+
+
+\ **res_group**\ 
+ 
+ The name of a NIM resource group.
+ 
+
+
+\ **nimmethod**\ 
+ 
+ The NIM install method to use, (ex. rte, mksysb).
+ 
+
+
+\ **script**\ 
+ 
+ The name of a NIM script resource.
+ 
+
+
+\ **bosinst_data**\ 
+ 
+ The name of a NIM bosinst_data resource.
+ 
+
+
+\ **installp_bundle**\ 
+ 
+ One or more comma separated NIM installp_bundle resources.
+ 
+
+
+\ **mksysb**\ 
+ 
+ The name of a NIM mksysb resource.
+ 
+
+
+\ **fb_script**\ 
+ 
+ The name of a NIM fb_script resource.
+ 
+
+
+\ **shared_root**\ 
+ 
+ A shared_root resource represents a directory that can be used as a / (root) directory by one or more diskless clients.
+ 
+
+
+\ **otherpkgs**\ 
+ 
+ One or more comma separated installp or rpm packages.  The rpm packages must have a prefix of 'R:', (ex. R:foo.rpm)
+ 
+
+
+\ **image_data**\ 
+ 
+ The name of a NIM image_data resource.
+ 
+
+
+\ **configdump**\ 
+ 
+ Specifies the type of system dump to be collected. The values are selective, full, and none.  The default is selective.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nodegroup.5.rst

@@ -0,0 +1,88 @@
+
+###########
+nodegroup.5
+###########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nodegroup**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nodegroup Attributes:**\   \ *groupname*\ , \ *grouptype*\ , \ *members*\ , \ *membergroups*\ , \ *wherevals*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains group definitions, whose membership is dynamic depending on characteristics of the node.
+
+
+*********************
+nodegroup Attributes:
+*********************
+
+
+
+\ **groupname**\ 
+ 
+ Name of the group.
+ 
+
+
+\ **grouptype**\ 
+ 
+ The only current valid value is dynamic.  We will be looking at having the object def commands working with static group definitions in the nodelist table.
+ 
+
+
+\ **members**\ 
+ 
+ The value of the attribute is not used, but the attribute is necessary as a place holder for the object def commands.  (The membership for static groups is stored in the nodelist table.)
+ 
+
+
+\ **membergroups**\ 
+ 
+ This attribute stores a comma-separated list of nodegroups that this nodegroup refers to. This attribute is only used by PCM.
+ 
+
+
+\ **wherevals**\ 
+ 
+ A list of "attr\*val" pairs that can be used to determine the members of a dynamic group, the delimiter is "::" and the operator \* can be ==, =~, != or !~.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nodehm.5.rst

@@ -0,0 +1,136 @@
+
+########
+nodehm.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nodehm**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nodehm Attributes:**\   \ *node*\ , \ *power*\ , \ *mgt*\ , \ *cons*\ , \ *termserver*\ , \ *termport*\ , \ *conserver*\ , \ *serialport*\ , \ *serialspeed*\ , \ *serialflow*\ , \ *getmac*\ , \ *cmdmapping*\ , \ *consoleondemand*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Settings that control how each node's hardware is managed.  Typically, an additional table that is specific to the hardware type of the node contains additional info.  E.g. the ipmi, mp, and ppc tables.
+
+
+******************
+nodehm Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **power**\ 
+ 
+ The method to use to control the power of the node. If not set, the mgt attribute will be used.  Valid values: ipmi, blade, hmc, ivm, fsp, kvm, esx, rhevm.  If "ipmi", xCAT will search for this node in the ipmi table for more info.  If "blade", xCAT will search for this node in the mp table.  If "hmc", "ivm", or "fsp", xCAT will search for this node in the ppc table.
+ 
+
+
+\ **mgt**\ 
+ 
+ The method to use to do general hardware management of the node.  This attribute is used as the default if power or getmac is not set.  Valid values: ipmi, blade, hmc, ivm, fsp, bpa, kvm, esx, rhevm.  See the power attribute for more details.
+ 
+
+
+\ **cons**\ 
+ 
+ The console method. If nodehm.serialport is set, this will default to the nodehm.mgt setting, otherwise it defaults to unused.  Valid values: cyclades, mrv, or the values valid for the mgt attribute.
+ 
+
+
+\ **termserver**\ 
+ 
+ The hostname of the terminal server.
+ 
+
+
+\ **termport**\ 
+ 
+ The port number on the terminal server that this node is connected to.
+ 
+
+
+\ **conserver**\ 
+ 
+ The hostname of the machine where the conserver daemon is running.  If not set, the default is the xCAT management node.
+ 
+
+
+\ **serialport**\ 
+ 
+ The serial port for this node, in the linux numbering style (0=COM1/ttyS0, 1=COM2/ttyS1).  For SOL on IBM blades, this is typically 1.  For rackmount IBM servers, this is typically 0.
+ 
+
+
+\ **serialspeed**\ 
+ 
+ The speed of the serial port for this node.  For SOL this is typically 19200.
+ 
+
+
+\ **serialflow**\ 
+ 
+ The flow control value of the serial port for this node.  For SOL this is typically 'hard'.
+ 
+
+
+\ **getmac**\ 
+ 
+ The method to use to get MAC address of the node with the getmac command. If not set, the mgt attribute will be used.  Valid values: same as values for mgmt attribute.
+ 
+
+
+\ **cmdmapping**\ 
+ 
+ The fully qualified name of the file that stores the mapping between PCM hardware management commands and xCAT/third-party hardware management commands for a particular type of hardware device.  Only used by PCM.
+ 
+
+
+\ **consoleondemand**\ 
+ 
+ This overrides the value from site.consoleondemand; (0=no, 1=yes). Default is the result from site.consoleondemand.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nodelist.5.rst

@@ -0,0 +1,124 @@
+
+##########
+nodelist.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nodelist**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nodelist Attributes:**\   \ *node*\ , \ *groups*\ , \ *status*\ , \ *statustime*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *primarysn*\ , \ *hidden*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *zonename*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The list of all the nodes in the cluster, including each node's current status and what groups it is in.
+
+
+********************
+nodelist Attributes:
+********************
+
+
+
+\ **node**\ 
+ 
+ The hostname of a node in the cluster.
+ 
+
+
+\ **groups**\ 
+ 
+ A comma-delimited list of groups this node is a member of.  Group names are arbitrary, except all nodes should be part of the 'all' group. Internal group names are designated by using __<groupname>.  For example, __Unmanaged, could be the internal name for a group of nodes that is not managed by xCAT. Admins should avoid using the __ characters when defining their groups.
+ 
+
+
+\ **status**\ 
+ 
+ The current status of this node.  This attribute will be set by xCAT software.  Valid values: defined, booting, netbooting, booted, discovering, configuring, installing, alive, standingby, powering-off, unreachable. If blank, defined is assumed. The possible status change sequenses are: For installaton: defined->[discovering]->[configuring]->[standingby]->installing->booting->booted->[alive],  For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->booted->[alive],  For booting: [alive/unreachable]->booting->[alive],  For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series dicovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. Please note that the status values will not reflect the real node status if you change the state of the node from outside of xCAT (i.e. power off the node using HMC GUI).
+ 
+
+
+\ **statustime**\ 
+ 
+ The data and time when the status was updated.
+ 
+
+
+\ **appstatus**\ 
+ 
+ A comma-delimited list of application status. For example: 'sshd=up,ftp=down,ll=down'
+ 
+
+
+\ **appstatustime**\ 
+ 
+ The date and time when appstatus was updated.
+ 
+
+
+\ **primarysn**\ 
+ 
+ Not used currently. The primary servicenode, used by this node.
+ 
+
+
+\ **hidden**\ 
+ 
+ Used to hide fsp and bpa definitions, 1 means not show them when running lsdef and nodels
+ 
+
+
+\ **updatestatus**\ 
+ 
+ The current node update status. Valid states are synced, out-of-sync,syncing,failed.
+ 
+
+
+\ **updatestatustime**\ 
+ 
+ The date and time when the updatestatus was updated.
+ 
+
+
+\ **zonename**\ 
+ 
+ The name of the zone to which the node is currently assigned. If undefined, then it is not assigned to any zone.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nodepos.5.rst

@@ -0,0 +1,100 @@
+
+#########
+nodepos.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nodepos**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nodepos Attributes:**\   \ *node*\ , \ *rack*\ , \ *u*\ , \ *chassis*\ , \ *slot*\ , \ *room*\ , \ *height*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains info about the physical location of each node.  Currently, this info is not used by xCAT, and therefore can be in whatevery format you want.  It will likely be used in xCAT in the future.
+
+
+*******************
+nodepos Attributes:
+*******************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **rack**\ 
+ 
+ The frame the node is in.
+ 
+
+
+\ **u**\ 
+ 
+ The vertical position of the node in the frame
+ 
+
+
+\ **chassis**\ 
+ 
+ The BladeCenter chassis the blade is in.
+ 
+
+
+\ **slot**\ 
+ 
+ The slot number of the blade in the chassis. For PCM, a comma-separated list of slot numbers is stored
+ 
+
+
+\ **room**\ 
+ 
+ The room where the node is located.
+ 
+
+
+\ **height**\ 
+ 
+ The server height in U(s).
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/noderes.5.rst

@@ -0,0 +1,178 @@
+
+#########
+noderes.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **noderes**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **noderes Attributes:**\   \ *node*\ , \ *servicenode*\ , \ *netboot*\ , \ *tftpserver*\ , \ *tftpdir*\ , \ *nfsserver*\ , \ *monserver*\ , \ *nfsdir*\ , \ *installnic*\ , \ *primarynic*\ , \ *discoverynics*\ , \ *cmdinterface*\ , \ *xcatmaster*\ , \ *current_osimage*\ , \ *next_osimage*\ , \ *nimserver*\ , \ *routenames*\ , \ *nameservers*\ , \ *proxydhcp*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Resources and settings to use when installing nodes.
+
+
+*******************
+noderes Attributes:
+*******************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **servicenode**\ 
+ 
+ A comma separated list of node names (as known by the management node) that provides most services for this node. The first service node on the list that is accessible will be used.  The 2nd node on the list is generally considered to be the backup service node for this node when running commands like snmove.
+ 
+
+
+\ **netboot**\ 
+ 
+ The type of network booting to use for this node.  Valid values:
+                        Arch                  OS                           valid netboot options 
+                        x86, x86_64           ALL                          pxe, xnba 
+                        ppc64                 <=rhel6, <=sles11            yaboot
+                        ppc64                 >=rhels7                     grub2,grub2-http,grub2-tftp
+                  ppc64le NonVirtualize       ALL                          petitboot
+                  ppc64le PowerKVM Guest      ALL                          grub2,grub2-http,grub2-tftp
+ 
+
+
+\ **tftpserver**\ 
+ 
+ The TFTP server for this node (as known by this node). If not set, it defaults to networks.tftpserver.
+ 
+
+
+\ **tftpdir**\ 
+ 
+ The directory that roots this nodes contents from a tftp and related perspective.  Used for NAS offload by using different mountpoints.
+ 
+
+
+\ **nfsserver**\ 
+ 
+ The NFS or HTTP server for this node (as known by this node).
+ 
+
+
+\ **monserver**\ 
+ 
+ The monitoring aggregation point for this node. The format is "x,y" where x is the ip address as known by the management node and y is the ip address as known by the node.
+ 
+
+
+\ **nfsdir**\ 
+ 
+ The path that should be mounted from the NFS server.
+ 
+
+
+\ **installnic**\ 
+ 
+ The network adapter on the node that will be used for OS deployment, the installnic can be set to the network adapter name or the mac address or the keyword "mac" which means that the network interface specified by the mac address in the mac table will be used.  If not set, primarynic will be used. If primarynic is not set too, the keyword "mac" will be used as default.
+ 
+
+
+\ **primarynic**\ 
+ 
+ This attribute will be deprecated. All the used network interface will be determined by installnic. The network adapter on the node that will be used for xCAT management, the primarynic can be set to the network adapter name or the mac address or the keyword "mac" which means that the network interface specified by the mac address in the mac table  will be used.  Default is eth0.
+ 
+
+
+\ **discoverynics**\ 
+ 
+ If specified, force discovery to occur on specific network adapters only, regardless of detected connectivity.  Syntax can be simply "eth2,eth3" to restrict discovery to whatever happens to come up as eth2 and eth3, or by driver name such as "bnx2:0,bnx2:1" to specify the first two adapters managed by the bnx2 driver
+ 
+
+
+\ **cmdinterface**\ 
+ 
+ Not currently used.
+ 
+
+
+\ **xcatmaster**\ 
+ 
+ The hostname of the xCAT service node (as known by this node).  This acts as the default value for nfsserver and tftpserver, if they are not set.  If xcatmaster is not set, the node will use whoever responds to its boot request as its master.  For the directed bootp case for POWER, it will use the management node if xcatmaster is not set.
+ 
+
+
+\ **current_osimage**\ 
+ 
+ Not currently used.  The name of the osimage data object that represents the OS image currently deployed on this node.
+ 
+
+
+\ **next_osimage**\ 
+ 
+ Not currently used.  The name of the osimage data object that represents the OS image that will be installed on the node the next time it is deployed.
+ 
+
+
+\ **nimserver**\ 
+ 
+ Not used for now. The NIM server for this node (as known by this node).
+ 
+
+
+\ **routenames**\ 
+ 
+ A comma separated list of route names that refer to rows in the routes table. These are the routes that should be defined on this node when it is deployed.
+ 
+
+
+\ **nameservers**\ 
+ 
+ An optional node/group specific override for name server list.  Most people want to stick to site or network defined nameserver configuration.
+ 
+
+
+\ **proxydhcp**\ 
+ 
+ To specify whether the node supports proxydhcp protocol. Valid values: yes or 1, no or 0. Default value is yes.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/nodetype.5.rst

@@ -0,0 +1,100 @@
+
+##########
+nodetype.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **nodetype**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **nodetype Attributes:**\   \ *node*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *provmethod*\ , \ *supportedarchs*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+A few hardware and software characteristics of the nodes.
+
+
+********************
+nodetype Attributes:
+********************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **os**\ 
+ 
+ The operating system deployed on this node.  Valid values: AIX, rhels\*,rhelc\*, rhas\*,centos\*,SL\*, fedora\*, sles\* (where \* is the version #). As a special case, if this is set to "boottarget", then it will use the initrd/kernel/parameters specified in the row in the boottarget table in which boottarget.bprofile equals nodetype.profile.
+ 
+
+
+\ **arch**\ 
+ 
+ The hardware architecture of this node.  Valid values: x86_64, ppc64, x86, ia64.
+ 
+
+
+\ **profile**\ 
+ 
+ The string to use to locate a kickstart or autoyast template to use for OS deployment of this node.  If the provmethod attribute is set to an osimage name, that takes precedence, and profile need not be defined.  Otherwise, the os, profile, and arch are used to search for the files in /install/custom first, and then in /opt/xcat/share/xcat.
+ 
+
+
+\ **provmethod**\ 
+ 
+ The provisioning method for node deployment. The valid values are install, netboot, statelite or an os image name from the osimage table. If an image name is specified, the osimage definition stored in the osimage table and the linuximage table (for Linux) or nimimage table (for AIX) are used to locate the files for templates, pkglists, syncfiles, etc. On Linux, if install, netboot or statelite is specified, the os, profile, and arch are used to search for the files in /install/custom first, and then in /opt/xcat/share/xcat.
+ 
+
+
+\ **supportedarchs**\ 
+ 
+ Comma delimited list of architectures this node can execute.
+ 
+
+
+\ **nodetype**\ 
+ 
+ A comma-delimited list of characteristics of this node.  Valid values: ppc, blade, vm (virtual machine), osi (OS image), mm, mn, rsa, switch.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/notification.5.rst

@@ -0,0 +1,76 @@
+
+##############
+notification.5
+##############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **notification**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **notification Attributes:**\   \ *filename*\ , \ *tables*\ , \ *tableops*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains registrations to be notified when a table in the xCAT database changes.  Users can add entries to have additional software notified of changes.  Add and remove entries using the provided xCAT commands regnotif and unregnotif.
+
+
+************************
+notification Attributes:
+************************
+
+
+
+\ **filename**\ 
+ 
+ The path name of a file that implements the callback routine when the monitored table changes.  Can be a perl module or a command.  See the regnotif man page for details.
+ 
+
+
+\ **tables**\ 
+ 
+ Comma-separated list of xCAT database tables to monitor.
+ 
+
+
+\ **tableops**\ 
+ 
+ Specifies the table operation to monitor for. Valid values:  "d" (rows deleted), "a" (rows added), "u" (rows updated).
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/osdistro.5.rst

@@ -0,0 +1,100 @@
+
+##########
+osdistro.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osdistro**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osdistro Attributes:**\   \ *osdistroname*\ , \ *basename*\ , \ *majorversion*\ , \ *minorversion*\ , \ *arch*\ , \ *type*\ , \ *dirpaths*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Information about all the OS distros in the xCAT cluster
+
+
+********************
+osdistro Attributes:
+********************
+
+
+
+\ **osdistroname**\ 
+ 
+ Unique name (e.g. rhels6.2-x86_64)
+ 
+
+
+\ **basename**\ 
+ 
+ The OS base name (e.g. rhels)
+ 
+
+
+\ **majorversion**\ 
+ 
+ The OS distro major version.(e.g. 6)
+ 
+
+
+\ **minorversion**\ 
+ 
+ The OS distro minor version. (e.g. 2)
+ 
+
+
+\ **arch**\ 
+ 
+ The OS distro arch (e.g. x86_64)
+ 
+
+
+\ **type**\ 
+ 
+ Linux or AIX
+ 
+
+
+\ **dirpaths**\ 
+ 
+ Directory paths where OS distro is store. There could be multiple paths if OS distro has more than one ISO image. (e.g. /install/rhels6.2/x86_64,...)
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/osdistroupdate.5.rst

@@ -0,0 +1,82 @@
+
+################
+osdistroupdate.5
+################
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osdistroupdate**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osdistroupdate Attributes:**\   \ *osupdatename*\ , \ *osdistroname*\ , \ *dirpath*\ , \ *downloadtime*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Information about the OS distro updates in the xCAT cluster
+
+
+**************************
+osdistroupdate Attributes:
+**************************
+
+
+
+\ **osupdatename**\ 
+ 
+ Name of OS update. (e.g. rhn-update1)
+ 
+
+
+\ **osdistroname**\ 
+ 
+ The OS distro name to update. (e.g. rhels)
+ 
+
+
+\ **dirpath**\ 
+ 
+ Path to where OS distro update is stored. (e.g. /install/osdistroupdates/rhels6.2-x86_64-20120716-update)
+ 
+
+
+\ **downloadtime**\ 
+ 
+ The timestamp when OS distro update was downloaded..
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/osimage.5.rst

@@ -0,0 +1,172 @@
+
+#########
+osimage.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osimage**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osimage Attributes:**\   \ *imagename*\ , \ *groups*\ , \ *profile*\ , \ *imagetype*\ , \ *description*\ , \ *provmethod*\ , \ *rootfstype*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *cfmdir*\ , \ *osname*\ , \ *osvers*\ , \ *osarch*\ , \ *synclists*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *serverrole*\ , \ *isdeletable*\ , \ *kitcomponents*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Basic information about an operating system image that can be used to deploy cluster nodes.
+
+
+*******************
+osimage Attributes:
+*******************
+
+
+
+\ **imagename**\ 
+ 
+ The name of this xCAT OS image definition.
+ 
+
+
+\ **groups**\ 
+ 
+ A comma-delimited list of image groups of which this image is a member.  Image groups can be used in the litefile and litetree table instead of a single image name. Group names are arbitrary.
+ 
+
+
+\ **profile**\ 
+ 
+ The node usage category. For example compute, service.
+ 
+
+
+\ **imagetype**\ 
+ 
+ The type of operating system image this definition represents (linux,AIX).
+ 
+
+
+\ **description**\ 
+ 
+ OS Image Description
+ 
+
+
+\ **provmethod**\ 
+ 
+ The provisioning method for node deployment. The valid values are install, netboot,statelite,boottarget,dualboot,sysclone. If boottarget is set, you must set linuximage.boottarget to the name of the boottarget definition. It is not used by AIX.
+ 
+
+
+\ **rootfstype**\ 
+ 
+ The filesystem type for the rootfs is used when the provmethod is statelite. The valid values are nfs or ramdisk. The default value is nfs
+ 
+
+
+\ **osdistroname**\ 
+ 
+ The name of the OS distro definition.  This attribute can be used to specify which OS distro to use, instead of using the osname,osvers,and osarch attributes. For \*kit commands,  the attribute will be used to read the osdistro table for the osname, osvers, and osarch attributes. If defined, the osname, osvers, and osarch attributes defined in the osimage table will be ignored.
+ 
+
+
+\ **osupdatename**\ 
+ 
+ A comma-separated list of OS distro updates to apply to this osimage.
+ 
+
+
+\ **cfmdir**\ 
+ 
+ CFM directory name for PCM. Set to /install/osimages/<osimage name>/cfmdir by PCM.
+ 
+
+
+\ **osname**\ 
+ 
+ Operating system name- AIX or Linux.
+ 
+
+
+\ **osvers**\ 
+ 
+ The Linux operating system deployed on this node.  Valid values:  rhels\*,rhelc\*, rhas\*,centos\*,SL\*, fedora\*, sles\* (where \* is the version #).
+ 
+
+
+\ **osarch**\ 
+ 
+ The hardware architecture of this node.  Valid values: x86_64, ppc64, x86, ia64.
+ 
+
+
+\ **synclists**\ 
+ 
+ The fully qualified name of a file containing a list of files to synchronize on the nodes. Can be a comma separated list of multiple synclist files. The synclist generated by PCM named /install/osimages/<imagename>/synclist.cfm is reserved for use only by PCM and should not be edited by the admin.
+ 
+
+
+\ **postscripts**\ 
+ 
+ Comma separated list of scripts that should be run on this image after diskfull installation or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute.  For AIX, use the postbootscripts attribute. See the site table runbootscripts attribute. Support will be added in the future for  the postscripts attribute to run the scripts before the reboot in AIX.
+ 
+
+
+\ **postbootscripts**\ 
+ 
+ Comma separated list of scripts that should be run on this after diskfull installation or diskless boot. On AIX these scripts are run during the processing of /etc/inittab.  On Linux they are run at the init.d time. xCAT automatically adds the scripts in the xcatdefaults.postbootscripts attribute to run first in the list. See the site table runbootscripts attribute.
+ 
+
+
+\ **serverrole**\ 
+ 
+ The role of the server created by this osimage.  Default roles: mgtnode, servicenode, compute, login, storage, utility.
+ 
+
+
+\ **isdeletable**\ 
+ 
+ A flag to indicate whether this image profile can be deleted.  This attribute is only used by PCM.
+ 
+
+
+\ **kitcomponents**\ 
+ 
+ List of Kit Component IDs assigned to this OS Image definition.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/passwd.5.rst

@@ -0,0 +1,88 @@
+
+########
+passwd.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **passwd**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **passwd Attributes:**\   \ *key*\ , \ *username*\ , \ *password*\ , \ *cryptmethod*\ , \ *authdomain*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains default userids and passwords for xCAT to access cluster components.  In most cases, xCAT will also actually set the userid/password in the relevant component when it is being configured or installed.  Userids/passwords for specific cluster components can be overidden in other tables, e.g. mpa, ipmi, ppchcp, etc.
+
+
+******************
+passwd Attributes:
+******************
+
+
+
+\ **key**\ 
+ 
+ The type of component this user/pw is for.  Valid values: blade (management module), ipmi (BMC), system (nodes), omapi (DHCP), hmc, ivm, cec, frame, switch.
+ 
+
+
+\ **username**\ 
+ 
+ The default userid for this type of component
+ 
+
+
+\ **password**\ 
+ 
+ The default password for this type of component
+ 
+
+
+\ **cryptmethod**\ 
+ 
+ Indicates the method that was used to encrypt the password attribute.  On AIX systems, if a value is provided for this attribute it indicates that the password attribute is encrypted.  If the cryptmethod value is not set it indicates the password is a simple string value. On Linux systems, the cryptmethod is not supported however the code attempts to auto-discover MD5 encrypted passwords.
+ 
+
+
+\ **authdomain**\ 
+ 
+ The domain in which this entry has meaning, e.g. specifying different domain administrators per active directory domain
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/performance.5.rst

@@ -0,0 +1,82 @@
+
+#############
+performance.5
+#############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **performance**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **performance Attributes:**\   \ *timestamp*\ , \ *node*\ , \ *attrname*\ , \ *attrvalue*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Describes the system performance every interval unit of time.
+
+
+***********************
+performance Attributes:
+***********************
+
+
+
+\ **timestamp**\ 
+ 
+ The time at which the metric was captured.
+ 
+
+
+\ **node**\ 
+ 
+ The node name.
+ 
+
+
+\ **attrname**\ 
+ 
+ The metric name.
+ 
+
+
+\ **attrvalue**\ 
+ 
+ The metric value.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/policy.5.rst

@@ -0,0 +1,106 @@
+
+########
+policy.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **policy**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **policy Attributes:**\   \ *priority*\ , \ *name*\ , \ *host*\ , \ *commands*\ , \ *noderange*\ , \ *parameters*\ , \ *time*\ , \ *rule*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The policy table in the xCAT database controls who has authority to run specific xCAT operations. It is basically the Access Control List (ACL) for xCAT. It is sorted on the priority field before evaluating.
+
+
+******************
+policy Attributes:
+******************
+
+
+
+\ **priority**\ 
+ 
+ The priority value for this rule.  This value is used to identify this policy data object (i.e. this rule) The table is sorted on this field with the lower the number the higher the priority. For example 1.0 is higher priority than 4.1 is higher than 4.9.
+ 
+
+
+\ **name**\ 
+ 
+ The username that is allowed to perform the commands specified by this rule.  Default is "\*" (all users).
+ 
+
+
+\ **host**\ 
+ 
+ The host from which users may issue the commands specified by this rule.  Default is "\*" (all hosts). Only all or one host is supported
+ 
+
+
+\ **commands**\ 
+ 
+ The list of commands that this rule applies to.  Default is "\*" (all commands).
+ 
+
+
+\ **noderange**\ 
+ 
+ The Noderange that this rule applies to.  Default is "\*" (all nodes). Not supported with the \*def commands.
+ 
+
+
+\ **parameters**\ 
+ 
+ A regular expression that matches the command parameters (everything except the noderange) that this rule applies to.  Default is "\*" (all parameters). Not supported with the \*def commands.
+ 
+
+
+\ **time**\ 
+ 
+ Time ranges that this command may be executed in.  This is not supported.
+ 
+
+
+\ **rule**\ 
+ 
+ Specifies how this rule should be applied.  Valid values are: allow, accept, trusted. Allow or accept  will allow the user to run the commands. Any other value will deny the user access to the commands. Trusted means that once this client has been authenticated via the certificate, all other information that is sent (e.g. the username) is believed without question.  This authorization should only be given to the xcatd on the management node at this time.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/postscripts.5.rst

@@ -0,0 +1,76 @@
+
+#############
+postscripts.5
+#############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **postscripts**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **postscripts Attributes:**\   \ *node*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The scripts that should be run on each node after installation or diskless boot.
+
+
+***********************
+postscripts Attributes:
+***********************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **postscripts**\ 
+ 
+ Comma separated list of scripts that should be run on this node after diskfull installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". xCAT automatically adds the postscripts from  the xcatdefaults.postscripts attribute of the table to run first on the nodes after install or diskless boot. For installation of RedHat, CentOS, Fedora, the scripts will be run before the reboot. For installation of SLES, the scripts will be run after the reboot but before the init.d process. For diskless deployment, the scripts will be run at the init.d time, and xCAT will automatically add the list of scripts from the postbootscripts attribute to run after postscripts list. For installation of AIX, the scripts will run after the reboot and acts the same as the postbootscripts attribute.  For AIX, use the postbootscripts attribute. Support will be added in the future for  the postscripts attribute to run the scripts before the reboot in AIX.
+ 
+
+
+\ **postbootscripts**\ 
+ 
+ Comma separated list of scripts that should be run on this node after diskfull installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". On AIX these scripts are run during the processing of /etc/inittab.  On Linux they are run at the init.d time. xCAT automatically adds the scripts in the xcatdefaults.postbootscripts attribute to run first in the list.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/ppc.5.rst

@@ -0,0 +1,106 @@
+
+#####
+ppc.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **ppc**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **ppc Attributes:**\   \ *node*\ , \ *hcp*\ , \ *id*\ , \ *pprofile*\ , \ *parent*\ , \ *nodetype*\ , \ *supernode*\ , \ *sfp*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+List of system p hardware: HMCs, IVMs, FSPs, BPCs, CECs, Frames.
+
+
+***************
+ppc Attributes:
+***************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **hcp**\ 
+ 
+ The hardware control point for this node (HMC, IVM, Frame or CEC).  Do not need to set for BPAs and FSPs.
+ 
+
+
+\ **id**\ 
+ 
+ For LPARs: the LPAR numeric id; for CECs: the cage number; for Frames: the frame number.
+ 
+
+
+\ **pprofile**\ 
+ 
+ The LPAR profile that will be used the next time the LPAR is powered on with rpower. For DFM, the pprofile attribute should be set to blank
+ 
+
+
+\ **parent**\ 
+ 
+ For LPARs: the CEC; for FSPs: the CEC; for CEC: the frame (if one exists); for BPA: the frame; for frame: the building block number (which consists 1 or more service nodes and compute/storage nodes that are serviced by them - optional).
+ 
+
+
+\ **nodetype**\ 
+ 
+ The hardware type of the node. Only can be one of fsp, bpa, cec, frame, ivm, hmc and lpar
+ 
+
+
+\ **supernode**\ 
+ 
+ Indicates the connectivity of this CEC in the HFI network. A comma separated list of 2 ids. The first one is the supernode number the CEC is part of. The second one is the logical location number (0-3) of this CEC within the supernode.
+ 
+
+
+\ **sfp**\ 
+ 
+ The Service Focal Point of this Frame. This is the name of the HMC that is responsible for collecting hardware service events for this frame and all of the CECs within this frame.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/ppcdirect.5.rst

@@ -0,0 +1,76 @@
+
+###########
+ppcdirect.5
+###########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **ppcdirect**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **ppcdirect Attributes:**\   \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Info necessary to use FSPs/BPAs to control system p CECs/Frames.
+
+
+*********************
+ppcdirect Attributes:
+*********************
+
+
+
+\ **hcp**\ 
+ 
+ Hostname of the FSPs/BPAs(for ASMI) and CECs/Frames(for DFM).
+ 
+
+
+\ **username**\ 
+ 
+ Userid of the FSP/BPA(for ASMI) and CEC/Frame(for DFM).  If not filled in, xCAT will look in the passwd table for key=fsp.  If not in the passwd table, the default used is admin.
+ 
+
+
+\ **password**\ 
+ 
+ Password of the FSP/BPA(for ASMI) and CEC/Frame(for DFM).  If not filled in, xCAT will look in the passwd table for key=fsp.  If not in the passwd table, the default used is admin.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/ppchcp.5.rst

@@ -0,0 +1,76 @@
+
+########
+ppchcp.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **ppchcp**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **ppchcp Attributes:**\   \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Info necessary to use HMCs and IVMs as hardware control points for LPARs.
+
+
+******************
+ppchcp Attributes:
+******************
+
+
+
+\ **hcp**\ 
+ 
+ Hostname of the HMC or IVM.
+ 
+
+
+\ **username**\ 
+ 
+ Userid of the HMC or IVM.  If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm.  If not in the passwd table, the default used is hscroot for HMCs and padmin for IVMs.
+ 
+
+
+\ **password**\ 
+ 
+ Password of the HMC or IVM.  If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm.  If not in the passwd table, the default used is abc123 for HMCs and padmin for IVMs.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/prescripts.5.rst

@@ -0,0 +1,106 @@
+
+############
+prescripts.5
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **prescripts**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **prescripts Attributes:**\   \ *node*\ , \ *begin*\ , \ *end*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The scripts that will be run at the beginning and the end of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
+
+
+**********************
+prescripts Attributes:
+**********************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **begin**\ 
+ 
+ The scripts to be run at the beginning of the nodeset(Linux),
+  nimnodeset(AIX) or mkdsklsnode(AIX) command.
+  The format is:
+    [action1:]s1,s2...[|action2:s3,s4,s5...]
+  where:
+   - action1 and action2 for Linux are the nodeset actions specified in the command. 
+     For AIX, action1 and action1 can be 'diskless' for mkdsklsnode command'
+     and 'standalone for nimnodeset command. 
+   - s1 and s2 are the scripts to run for action1 in order.
+   - s3, s4, and s5 are the scripts to run for actions2.
+  If actions are omitted, the scripts apply to all actions.
+  Examples:
+    myscript1,myscript2  (all actions)
+    diskless:myscript1,myscript2   (AIX)
+    install:myscript1,myscript2|netboot:myscript3   (Linux)
+ 
+ 
+ .. code-block:: perl
+ 
+   All the scripts should be copied to /install/prescripts directory.
+   The following two environment variables will be passed to each script: 
+     NODES a coma separated list of node names that need to run the script for
+     ACTION current nodeset action.
+  
+   If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script
+   will get invoked for each node in parallel, but no more than number of instances
+   will be invoked at at a time. If it is not specified, the script will be invoked
+   once for all the nodes.
+ 
+ 
+
+
+\ **end**\ 
+ 
+ The scripts to be run at the end of the nodeset(Linux),
+  nimnodeset(AIX),or mkdsklsnode(AIX) command. 
+  The format is the same as the 'begin' column.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/prodkey.5.rst

@@ -0,0 +1,76 @@
+
+#########
+prodkey.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **prodkey**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **prodkey Attributes:**\   \ *node*\ , \ *product*\ , \ *key*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Specify product keys for products that require them
+
+
+*******************
+prodkey Attributes:
+*******************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **product**\ 
+ 
+ A string to identify the product (for OSes, the osname would be used, i.e. wink28
+ 
+
+
+\ **key**\ 
+ 
+ The product key relevant to the aforementioned node/group and product combination
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/rack.5.rst

@@ -0,0 +1,88 @@
+
+######
+rack.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **rack**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **rack Attributes:**\   \ *rackname*\ , \ *displayname*\ , \ *num*\ , \ *height*\ , \ *room*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Rack information.
+
+
+****************
+rack Attributes:
+****************
+
+
+
+\ **rackname**\ 
+ 
+ The rack name.
+ 
+
+
+\ **displayname**\ 
+ 
+ Alternative name for rack. Only used by PCM.
+ 
+
+
+\ **num**\ 
+ 
+ The rack number.
+ 
+
+
+\ **height**\ 
+ 
+ Number of units which can be stored in the rack.
+ 
+
+
+\ **room**\ 
+ 
+ The room in which the rack is located.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/routes.5.rst

@@ -0,0 +1,88 @@
+
+########
+routes.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **routes**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **routes Attributes:**\   \ *routename*\ , \ *net*\ , \ *mask*\ , \ *gateway*\ , \ *ifname*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the servie node as gateway.
+
+
+******************
+routes Attributes:
+******************
+
+
+
+\ **routename**\ 
+ 
+ Name used to identify this route.
+ 
+
+
+\ **net**\ 
+ 
+ The network address.
+ 
+
+
+\ **mask**\ 
+ 
+ The network mask.
+ 
+
+
+\ **gateway**\ 
+ 
+ The gateway that routes the ip traffic from the mn to the nodes. It is usually a service node.
+ 
+
+
+\ **ifname**\ 
+ 
+ The interface name that facing the gateway. It is optional for IPv4 routes, but it is required for IPv6 routes.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/servicenode.5.rst

@@ -0,0 +1,142 @@
+
+#############
+servicenode.5
+#############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **servicenode**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **servicenode Attributes:**\   \ *node*\ , \ *nameserver*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nfsserver*\ , \ *conserver*\ , \ *monserver*\ , \ *ldapserver*\ , \ *ntpserver*\ , \ *ftpserver*\ , \ *nimserver*\ , \ *ipforward*\ , \ *dhcpinterfaces*\ , \ *proxydhcp*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+List of all Service Nodes and services that will be set up on the Service Node.
+
+
+***********************
+servicenode Attributes:
+***********************
+
+
+
+\ **node**\ 
+ 
+ The hostname of the service node as known by the Management Node.
+ 
+
+
+\ **nameserver**\ 
+ 
+ Do we set up DNS on this service node? Valid values: 2, 1, no or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **dhcpserver**\ 
+ 
+ Do we set up DHCP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, runs makedhcp -n. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **tftpserver**\ 
+ 
+ Do we set up TFTP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, configures and starts atftp. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **nfsserver**\ 
+ 
+ Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:yes or 1, no or 0.If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **conserver**\ 
+ 
+ Do we set up Conserver on this service node?  Valid values:yes or 1, no or 0. If yes, configures and starts conserver daemon. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **monserver**\ 
+ 
+ Is this a monitoring event collection point? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **ldapserver**\ 
+ 
+ Do we set up ldap caching proxy on this service node? Not supported on AIX.  Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **ntpserver**\ 
+ 
+ Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **ftpserver**\ 
+ 
+ Do we set up a ftp server on this service node? Not supported on AIX Valid values:yes or 1, no or 0. If yes, configure and start vsftpd.  (You must manually install vsftpd on the service nodes before this.) If no or 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes
+ 
+
+
+\ **nimserver**\ 
+ 
+ Not used. Do we set up a NIM server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **ipforward**\ 
+ 
+ Do we set up ip forwarding on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.
+ 
+
+
+\ **dhcpinterfaces**\ 
+ 
+ The network interfaces DHCP server should listen on for the target node. This attribute can be used for management node and service nodes.  If defined, it will override the values defined in site.dhcpinterfaces. This is a comma separated list of device names. !remote! indicates a non-local network for relay DHCP. For example: !remote!,eth0,eth1
+ 
+
+
+\ **proxydhcp**\ 
+ 
+ Do we set up proxydhcp service on this node? valid values: yes or 1, no or 0. If yes, the proxydhcp daemon will be enabled on this node.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/site.5.rst

@@ -0,0 +1,448 @@
+
+######
+site.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **site**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **site Attributes:**\   \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Global settings for the whole cluster.  This table is different from the 
+other tables in that each attribute is just named in the key column, rather 
+than having a separate column for each attribute. The following is a list of 
+attributes currently used by xCAT organized into categories.
+
+
+****************
+site Attributes:
+****************
+
+
+
+\ **key**\ 
+ 
+ Attribute Name:  Description
+ 
+ 
+ .. code-block:: perl
+ 
+   ------------
+  AIX ATTRIBUTES
+   ------------
+   nimprime :   The name of NIM server, if not set default is the AIX MN.
+                If Linux MN, then must be set for support of mixed cluster (TBD).
+  
+   useSSHonAIX:  (yes/1 or no/0). Default is yes.  The support for rsh/rcp is deprecated.
+   useNFSv4onAIX:  (yes/1 or no/0). If yes, NFSv4 will be used with NIM. If no,
+                 NFSv3 will be used with NIM. Default is no.
+  
+   -----------------
+  DATABASE ATTRIBUTES
+   -----------------
+   auditnosyslog: If set to 1, then commands will only be written to the auditlog table.
+                  This attribute set to 1 and auditskipcmds=ALL means no logging of commands.
+                  Default is to write to both the auditlog table and syslog.
+   auditskipcmds: List of commands and/or client types that will not be
+                  written to the auditlog table and syslog. See auditnosyslog.
+                  'ALL' means all cmds will be skipped. If attribute is null, all
+                  commands will be written.
+                  clienttype:web would skip all commands from the web client
+                  For example: tabdump,nodels,clienttype:web 
+                  will not log tabdump,nodels and any web client commands.
+  
+   databaseloc:    Directory where we create the db instance directory.
+                   Default is /var/lib. Only DB2 is currently supported.
+                   Do not use the directory in the site.installloc or
+                   installdir attribute. This attribute must not be changed
+                   once db2sqlsetup script has been run and DB2 has been setup.
+  
+   excludenodes:  A set of comma separated nodes and/or groups that would automatically
+                  be subtracted from any noderange, it can be used for excluding some
+                  failed nodes for any xCAT commands. See the 'noderange' manpage for
+                  details on supported formats.
+  
+   nodestatus:  If set to 'n', the nodelist.status column will not be updated during
+                the node deployment, node discovery and power operations. The default is to update.
+  
+   skiptables:  Comma separated list of tables to be skipped by dumpxCATdb
+  
+   skipvalidatelog:  If set to 1, then getcredentials and getpostscripts calls will not be logged in syslog.
+  
+   -------------
+  DHCP ATTRIBUTES
+   -------------
+   dhcpinterfaces:  The network interfaces DHCP should listen on.  If it is the same
+                    for all nodes, use a simple comma-separated list of NICs.  To
+                    specify different NICs for different nodes:
+                         xcatmn|eth1,eth2;service|bond0.
+                    In this example xcatmn is the name of the xCAT MN, and DHCP there
+                    should listen on eth1 and eth2.  On all of the nodes in group
+                    'service' DHCP should listen on the bond0 nic.
+  
+   dhcpsetup:  If set to 'n', it will skip the dhcp setup process in the nodeset cmd.
+  
+   dhcplease:  The lease time for the dhcp client. The default value is 43200.
+  
+   disjointdhcps:  If set to '1', the .leases file on a service node only contains
+                   the nodes it manages. The default value is '0'.
+                   '0' value means include all the nodes in the subnet.
+  
+   pruneservices:  Whether to enable service pruning when noderm is run (i.e.
+                   removing DHCP entries when noderm is executed)
+  
+   managedaddressmode: The mode of networking configuration during node provision.
+                       If set to 'static', the network configuration will be configured 
+                       in static mode based on the node and network definition on MN.
+                       If set to 'dhcp', the network will be configured with dhcp protocol.
+                       The default is 'dhcp'.
+  
+   ------------
+  DNS ATTRIBUTES
+   ------------
+   dnshandler:  Name of plugin that handles DNS setup for makedns.
+   domain:  The DNS domain name used for the cluster.
+  
+   forwarders:  The DNS servers at your site that can provide names outside of the
+                cluster. The makedns command will configure the DNS on the management
+                node to forward requests it does not know to these servers.
+                Note that the DNS servers on the service nodes will ignore this value
+                and always be configured to forward requests to the management node.
+  
+   master:  The hostname of the xCAT management node, as known by the nodes.
+  
+   nameservers:  A comma delimited list of DNS servers that each node in the cluster
+                 should use. This value will end up in the nameserver settings of the
+                 /etc/resolv.conf on each node. It is common (but not required) to set
+                 this attribute value to the IP addr of the xCAT management node, if
+                 you have set up the DNS on the management node by running makedns.
+                 In a hierarchical cluster, you can also set this attribute to
+                 "<xcatmaster>" to mean the DNS server for each node should be the
+                 node that is managing it (either its service node or the management
+                 node).
+  
+   externaldns:  To specify that external dns is used. If externaldns is set to any value
+                 then, makedns command will not start the local nameserver on xCAT MN. 
+                 Default is to start the local nameserver.
+  
+   dnsupdaters:  The value are ',' separated string which will be added to the zone config
+                 section. This is an interface for user to add configuration entries to
+                 the zone sections in named.conf.
+  
+   dnsinterfaces:  The network interfaces DNS server should listen on.  If it is the same
+                    for all nodes, use a simple comma-separated list of NICs.  To
+                    specify different NICs for different nodes:
+                         xcatmn|eth1,eth2;service|bond0.
+                    In this example xcatmn is the name of the xCAT MN, and DNS there
+                    should listen on eth1 and eth2.  On all of the nodes in group
+                    'service' DNS should listen on the bond0 nic.
+                    NOTE: if using this attribute to block certain interfaces, make sure
+                    the ip maps to your hostname of xCAT MN is not blocked since xCAT needs to
+                    use this ip to communicate with the local NDS server on MN.
+  
+   -------------------------
+  HARDWARE CONTROL ATTRIBUTES
+   -------------------------
+   blademaxp:  The maximum number of concurrent processes for blade hardware control.
+  
+   ea_primary_hmc:  The hostname of the HMC that the Integrated Switch Network
+                    Management Event Analysis should send hardware serviceable
+                    events to for processing and potentially sending to IBM.
+  
+   ea_backup_hmc:  The hostname of the HMC that the Integrated Switch Network
+                    Management Event Analysis should send hardware serviceable
+                    events to if the primary HMC is down.
+  
+   enableASMI:  (yes/1 or no/0). If yes, ASMI method will be used after fsp-api. If no,
+                 when fsp-api is used, ASMI method will not be used. Default is no.
+  
+   fsptimeout:  The timeout, in milliseconds, to use when communicating with FSPs.
+  
+   hwctrldispatch:  Whether or not to send hw control operations to the service
+                    node of the target nodes. Default is 'y'.(At present, this attribute
+                    is only used for IBM Flex System)
+  
+   ipmidispatch:  Whether or not to send ipmi hw control operations to the service
+                  node of the target compute nodes. Default is 'y'.
+  
+   ipmimaxp:  The max # of processes for ipmi hw ctrl. The default is 64. Currently,
+              this is only used for HP hw control.
+  
+   ipmiretries:  The # of retries to use when communicating with BMCs. Default is 3.
+  
+   ipmisdrcache:  If set to 'no', then the xCAT IPMI support will not cache locally
+                  the target node's SDR cache to improve performance.
+  
+   ipmitimeout:  The timeout to use when communicating with BMCs. Default is 2.
+                 This attribute is currently not used.
+  
+   maxssh:  The max # of SSH connections at any one time to the hw ctrl point for PPC
+            This parameter doesn't take effect on the rpower command.
+            It takes effects on other PPC hardware control command
+            getmacs/rnetboot/rbootseq and so on. Default is 8.
+  
+   syspowerinterval:  For system p CECs, this is the number of seconds the rpower
+                   command will wait between performing the action for each CEC.
+                   For system x IPMI servers, this is the number of seconds the
+                   rpower command will wait between powering on <syspowermaxnodes>
+                   nodes at a time.  This value is used to control the power on speed
+                   in large clusters. Default is 0.
+  
+   syspowermaxnodes:  The number of servers to power on at one time before waiting
+                      'syspowerinterval' seconds to continue on to the next set of
+                      nodes.  If the noderange given to rpower includes nodes served
+                      by different service nodes, it will try to spread each set of
+                      nodes across the service nodes evenly. Currently only used for
+                      IPMI servers and must be set if 'syspowerinterval' is set.
+  
+   powerinterval:  The number of seconds the rpower command to LPARs will wait between
+                   performing the action for each LPAR. LPARs of different HCPs
+                   (HMCs or FSPs) are done in parallel. This is used to limit the
+                   cluster boot up speed in large clusters. Default is 0.  This is
+                   currently only used for system p hardware.
+  
+   ppcmaxp:  The max # of processes for PPC hw ctrl. If there are more than ppcmaxp
+             hcps, this parameter will take effect. It will control the max number of
+             processes for PPC hardware control commands. Default is 64.
+  
+   ppcretry:  The max # of PPC hw connection attempts to HMC before failing.
+             It only takes effect on the hardware control commands through HMC. 
+             Default is 3.
+  
+   ppctimeout:  The timeout, in milliseconds, to use when communicating with PPC hw
+                through HMC. It only takes effect on the hardware control commands
+                through HMC. Default is 0.
+  
+   snmpc:  The snmp community string that xcat should use when communicating with the
+           switches.
+  
+   ---------------------------
+  INSTALL/DEPLOYMENT ATTRIBUTES
+   ---------------------------
+   cleanupxcatpost:  (yes/1 or no/0). Set to 'yes' or '1' to clean up the /xcatpost
+                     directory on the stateless and statelite nodes after the
+                     postscripts are run. Default is no.
+  
+   db2installloc:  The location which the service nodes should mount for
+                   the db2 code to install. Format is hostname:/path.  If hostname is
+                   omitted, it defaults to the management node. Default is /mntdb2.
+  
+   defserialflow:  The default serial flow - currently only used by the mknb command.
+  
+   defserialport:  The default serial port - currently only used by mknb.
+  
+   defserialspeed:  The default serial speed - currently only used by mknb.
+  
+   genmacprefix:  When generating mac addresses automatically, use this manufacturing
+                  prefix (e.g. 00:11:aa)
+  
+   genpasswords:  Automatically generate random passwords for BMCs when configuring
+                  them.
+  
+   installdir:  The local directory name used to hold the node deployment packages.
+  
+   installloc:  The location from which the service nodes should mount the 
+                deployment packages in the format hostname:/path.  If hostname is
+                omitted, it defaults to the management node. The path must
+                match the path in the installdir attribute.
+  
+   iscsidir:  The path to put the iscsi disks in on the mgmt node.
+  
+   mnroutenames:  The name of the routes to be setup on the management node.
+                  It is a comma separated list of route names that are defined in the
+                  routes table.
+  
+   runbootscripts:  If set to 'yes' the scripts listed in the postbootscripts
+                    attribute in the osimage and postscripts tables will be run during
+                    each reboot of stateful (diskful) nodes. This attribute has no
+                    effect on stateless and statelite nodes. Please run the following
+                    command after you change the value of this attribute: 
+                    'updatenode <nodes> -P setuppostbootscripts'
+  
+   precreatemypostscripts: (yes/1 or no/0). Default is no. If yes, it will  
+                instruct xCAT at nodeset and updatenode time to query the db once for
+                all of the nodes passed into the cmd and create the mypostscript file
+                for each node, and put them in a directory of tftpdir(such as: /tftpboot)
+                If no, it will not generate the mypostscript file in the tftpdir.
+  
+   setinstallnic:  Set the network configuration for installnic to be static.
+  
+   sharedtftp:  Set to 0 or no, xCAT should not assume the directory
+                in tftpdir is mounted on all on Service Nodes. Default is 1/yes.
+                If value is set to a hostname, the directory in tftpdir
+                will be mounted from that hostname on the SN
+  
+   sharedinstall: Indicates if a shared file system will be used for installation
+                 resources. Possible values are: 'no', 'sns', or 'all'.  'no' 
+                 means a shared file system is not being used.  'sns' means a
+                 shared filesystem is being used across all service nodes.
+                 'all' means that the management as well as the service nodes
+                 are all using a common shared filesystem. The default is 'no'.
+   xcatconfdir:  Where xCAT config data is (default /etc/xcat).
+  
+   xcatdebugmode:  the value of xcat debug mode. Currently supported values: 
+                   0: off(default); 1: on 
+  
+   --------------------
+  REMOTESHELL ATTRIBUTES
+   --------------------
+   nodesyncfiledir:  The directory on the node, where xdcp will rsync the files
+   SNsyncfiledir:  The directory on the Service Node, where xdcp will rsync the files
+                   from the MN that will eventually be rsync'd to the compute nodes.
+  
+   sshbetweennodes:  Comma separated list of groups of compute nodes to enable passwordless root 
+                     ssh during install, or xdsh -K. Default is ALLGROUPS.
+                     Set to NOGROUPS,if you do not wish to enabled any group of compute nodes.
+                     Service Nodes are not affected by this attribute
+                     they are always setup with
+                     passwordless root access to nodes and other SN.
+                     If using the zone table, this attribute in not used.
+  
+   -----------------
+  SERVICES ATTRIBUTES
+   -----------------
+   consoleondemand:  When set to 'yes', conserver connects and creates the console
+                     output only when the user opens the console. Default is no on
+                     Linux, yes on AIX.
+  
+   httpport:    The port number that the booting/installing nodes should contact the
+                http server on the MN/SN on. It is your responsibility to configure
+                the http server to listen on that port - xCAT will not do that.
+  
+   nmapoptions: Additional options for the nmap command. nmap is used in pping, 
+                nodestat, xdsh -v and updatenode commands. Sometimes additional 
+                performance tuning may be needed for nmap due to network traffic.
+                For example, if the network response time is too slow, nmap may not
+                give stable output. You can increase the timeout value by specifying 
+                '--min-rtt-timeout 1s'. xCAT will append the options defined here to 
+                the nmap command.
+  
+   ntpservers:  A comma delimited list of NTP servers for the service node and
+                the compute node to sync with. The keyword <xcatmaster> means that
+                the node's NTP server is the node that is managing it
+                (either its service node or the management node).
+  
+   extntpservers:  A comma delimited list of external NTP servers for the xCAT
+                   management node to sync with. If it is empty, the NTP server
+                   will use the management node's own hardware clock to calculate
+                   the system date and time
+  
+   svloglocal:  if set to 1, syslog on the service node will not get forwarded to the
+                mgmt node.
+  
+   timezone:  (e.g. America/New_York)
+  
+   tftpdir:  tftp directory path. Default is /tftpboot
+  
+   tftpflags:  The flags that used to start tftpd. Default is '-v -l -s /tftpboot 
+                 -m /etc/tftpmapfile4xcat.conf' if tftplfags is not set
+  
+   useNmapfromMN:  When set to yes, nodestat command should obtain the node status
+                   using nmap (if available) from the management node instead of the
+                   service node. This will improve the performance in a flat network.
+  
+   vsftp:       Default is 'n'. If set to 'y', the xcatd on the mn will automatically
+                bring up vsftpd.  (You must manually install vsftpd before this.
+                This setting does not apply to the service node. For sn
+                you need to set servicenode.ftpserver=1 if you want xcatd to
+                bring up vsftpd.
+  
+   -----------------------
+  VIRTUALIZATION ATTRIBUTES
+   -----------------------
+   usexhrm:  Have xCAT run its xHRM script when booting up KVM guests to set the
+             virtual network bridge up correctly. See
+             https://sourceforge.net/apps/mediawiki/xcat/index.php?title=XCAT_Virtualization_with_KVM#Setting_up_a_network_bridge
+  
+   vcenterautojoin:  When set to no, the VMWare plugin will not attempt to auto remove
+                     and add hypervisors while trying to perform operations.  If users
+                     or tasks outside of xCAT perform the joining this assures xCAT
+                     will not interfere.
+  
+   vmwarereconfigonpower:  When set to no, the VMWare plugin will make no effort to
+                           push vm.cpus/vm.memory updates from xCAT to VMWare.
+  
+   persistkvmguests:  Keep the kvm definition on the kvm hypervisor when you power off
+                      the kvm guest node. This is useful for you to manually change the 
+                      kvm xml definition file in virsh for debugging. Set anything means
+                      enable.
+  
+   --------------------
+  XCAT DAEMON ATTRIBUTES
+   --------------------
+   useflowcontrol:  (yes/1 or no/0). If yes, the postscript processing on each node
+                 contacts xcatd on the MN/SN using a lightweight UDP packet to wait
+                 until xcatd is ready to handle the requests associated with
+                 postscripts.  This prevents deploying nodes from flooding xcatd and
+                 locking out admin interactive use. This value works with the
+                 xcatmaxconnections and xcatmaxbatch attributes. Is not supported on AIX.
+                 If the value is no, nodes sleep for a random time before contacting
+                 xcatd, and retry. The default is no.
+                 See the following document for details:
+                 Hints_and_Tips_for_Large_Scale_Clusters
+  
+   xcatmaxconnections:  Number of concurrent xCAT protocol requests before requests
+                        begin queueing. This applies to both client command requests
+                        and node requests, e.g. to get postscripts. Default is 64.
+  
+   xcatmaxbatchconnections:  Number of concurrent xCAT connections allowed from the nodes.
+                        Value must be less than xcatmaxconnections. Default is 50.
+  
+   xcatdport:  The port used by the xcatd daemon for client/server communication.
+  
+   xcatiport:  The port used by xcatd to receive install status updates from nodes.
+  
+   xcatlport:  The port used by xcatd command log writer process to collect command output.
+  
+   xcatsslversion:  The ssl version by xcatd. Default is SSLv3.
+  
+   xcatsslciphers:  The ssl cipher by xcatd. Default is 3DES.
+ 
+ 
+
+
+\ **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.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/statelite.5.rst

@@ -0,0 +1,82 @@
+
+###########
+statelite.5
+###########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **statelite**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **statelite Attributes:**\   \ *node*\ , \ *image*\ , \ *statemnt*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The location on an NFS server where a nodes persistent files are stored.  Any file marked persistent in the litefile table will be stored in the location specified in this table for that node.
+
+
+*********************
+statelite Attributes:
+*********************
+
+
+
+\ **node**\ 
+ 
+ The name of the node or group that will use this location.
+ 
+
+
+\ **image**\ 
+ 
+ Reserved for future development, not used.
+ 
+
+
+\ **statemnt**\ 
+ 
+ The persistant read/write area where a node's persistent files will be written to, e.g: 10.0.0.1/state/.  The node name will be automatically added to the pathname, so 10.0.0.1:/state, will become 10.0.0.1:/state/<nodename>.
+ 
+
+
+\ **mntopts**\ 
+ 
+ A comma-separated list of options to use when mounting the persistent directory.  (Ex. 'soft') The default is to do a 'hard' mount.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/storage.5.rst

@@ -0,0 +1,121 @@
+
+#########
+storage.5
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **storage**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **storage Attributes:**\   \ *node*\ , \ *osvolume*\ , \ *size*\ , \ *state*\ , \ *storagepool*\ , \ *hypervisor*\ , \ *fcprange*\ , \ *volumetag*\ , \ *type*\ , \ *controller*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+
+*******************
+storage Attributes:
+*******************
+
+
+
+\ **node**\ 
+ 
+ The node name
+ 
+
+
+\ **osvolume**\ 
+ 
+ Specification of what storage to place the node OS image onto.  Examples include:
+                 localdisk (Install to first non-FC attached disk)
+                 usbdisk (Install to first USB mass storage device seen)
+                 wwn=0x50000393c813840c (Install to storage device with given WWN)
+ 
+
+
+\ **size**\ 
+ 
+ Size of the volume. Examples include: 10G, 1024M.
+ 
+
+
+\ **state**\ 
+ 
+ State of the volume. The valid values are: free, used, and allocated
+ 
+
+
+\ **storagepool**\ 
+ 
+ Name of storage pool where the volume is assigned.
+ 
+
+
+\ **hypervisor**\ 
+ 
+ Name of the hypervisor where the volume is configured.
+ 
+
+
+\ **fcprange**\ 
+ 
+ A range of acceptable fibre channels that the volume can use. Examples include: 3B00-3C00;4B00-4C00.
+ 
+
+
+\ **volumetag**\ 
+ 
+ A specific tag used to identify the volume in the autoyast or kickstart template.
+ 
+
+
+\ **type**\ 
+ 
+ The plugin used to drive storage configuration (e.g. svc)
+ 
+
+
+\ **controller**\ 
+ 
+ The management address to attach/detach new volumes.
+                        In the scenario involving multiple controllers, this data must be
+                        passed as argument rather than by table value
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/switch.5.rst

@@ -0,0 +1,88 @@
+
+########
+switch.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **switch**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **switch Attributes:**\   \ *node*\ , \ *switch*\ , \ *port*\ , \ *vlan*\ , \ *interface*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Contains what switch port numbers each node is connected to.
+
+
+******************
+switch Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **switch**\ 
+ 
+ The switch hostname.
+ 
+
+
+\ **port**\ 
+ 
+ The port number in the switch that this node is connected to. On a simple 1U switch, an administrator can generally enter the number as printed next to the ports, and xCAT will understand switch representation differences.  On stacked switches or switches with line cards, administrators should usually use the CLI representation (i.e. 2/0/1 or 5/8).  One notable exception is stacked SMC 8848M switches, in which you must add 56 for the proceeding switch, then the port number.  For example, port 3 on the second switch in an SMC8848M stack would be 59
+ 
+
+
+\ **vlan**\ 
+ 
+ The ID for the tagged vlan that is created on this port using mkvlan and chvlan commands.
+ 
+
+
+\ **interface**\ 
+ 
+ The interface name from the node perspective. For example, eth0. For the primary nic, it can be empty, the word "primary" or "primary:ethx" where ethx is the interface name.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/switches.5.rst

@@ -0,0 +1,120 @@
+
+##########
+switches.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **switches**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **switches Attributes:**\   \ *switch*\ , \ *snmpversion*\ , \ *username*\ , \ *password*\ , \ *privacy*\ , \ *auth*\ , \ *linkports*\ , \ *sshusername*\ , \ *sshpassword*\ , \ *protocol*\ , \ *switchtype*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Parameters to use when interrogating switches
+
+
+********************
+switches Attributes:
+********************
+
+
+
+\ **switch**\ 
+ 
+ The hostname/address of the switch to which the settings apply
+ 
+
+
+\ **snmpversion**\ 
+ 
+ The version to use to communicate with switch.  SNMPv1 is assumed by default.
+ 
+
+
+\ **username**\ 
+ 
+ The username to use for SNMPv3 communication, ignored for SNMPv1
+ 
+
+
+\ **password**\ 
+ 
+ The password strinng for SNMPv3 or community string for SNMPv1/SNMPv2.  Falls back to passwd table, and site snmpc value if using SNMPv1/SNMPv2.
+ 
+
+
+\ **privacy**\ 
+ 
+ The privacy protocol to use for v3. xCAT will use authNoPriv if this is unspecified. DES is recommended to use if v3 enabled, as it is the most readily available.
+ 
+
+
+\ **auth**\ 
+ 
+ The authentication protocol to use for SNMPv3.  SHA is assumed if v3 enabled and this is unspecified
+ 
+
+
+\ **linkports**\ 
+ 
+ The ports that connect to other switches. Currently, this column is only used by vlan configuration. The format is: "port_number:switch,port_number:switch...". Please refer to the switch table for details on how to specify the port numbers.
+ 
+
+
+\ **sshusername**\ 
+ 
+ The remote login user name. It can be for ssh or telnet. If it is for telnet, please set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key.
+ 
+
+
+\ **sshpassword**\ 
+ 
+ The remote login password. It can be for ssh or telnet. If it is for telnet, please set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key.
+ 
+
+
+\ **protocol**\ 
+ 
+ Prorocol for running remote commands for the switch. The valid values are: ssh, telnet. ssh is the default. If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. The passwd.comments attribute is used for protocol.
+ 
+
+
+\ **switchtype**\ 
+ 
+ The type of switch. It is used to identify the file name that implements the functions for this swithc. The valid values are: Mellanox, Cisco, BNT and Juniper.
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/token.5.rst

@@ -0,0 +1,76 @@
+
+#######
+token.5
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **token**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **token Attributes:**\   \ *tokenid*\ , \ *username*\ , \ *expire*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The token of users for authentication.
+
+
+*****************
+token Attributes:
+*****************
+
+
+
+\ **tokenid**\ 
+ 
+ It is a UUID as an unified identify for the user.
+ 
+
+
+\ **username**\ 
+ 
+ The user name.
+ 
+
+
+\ **expire**\ 
+ 
+ The expire time for this token.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/virtsd.5.rst

@@ -0,0 +1,96 @@
+
+########
+virtsd.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **virtsd**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **virtsd Attributes:**\   \ *node*\ , \ *sdtype*\ , \ *stype*\ , \ *location*\ , \ *host*\ , \ *cluster*\ , \ *datacenter*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The parameters which used to create the Storage Domain
+
+
+******************
+virtsd Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The name of the storage domain
+ 
+
+
+\ **sdtype**\ 
+ 
+ The type of storage domain. Valid values: data, iso, export
+ 
+
+
+\ **stype**\ 
+ 
+ The type of storge. Valid values: nfs, fcp, iscsi, localfs
+ 
+
+
+\ **location**\ 
+ 
+ The path of the storage
+ 
+
+
+\ **host**\ 
+ 
+ For rhev, a hypervisor host needs to be specified to manage the storage domain as SPM (Storage Pool Manager). But the SPM role will be failed over to another host when this host down.
+ 
+
+
+\ **cluster**\ 
+ 
+ A cluster of hosts
+ 
+
+
+\ **datacenter**\ 
+ 
+ A collection for all host, vm that will shared the same storages, networks.
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/vm.5.rst

@@ -0,0 +1,236 @@
+
+####
+vm.5
+####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **vm**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **vm Attributes:**\   \ *node*\ , \ *mgr*\ , \ *host*\ , \ *migrationdest*\ , \ *storage*\ , \ *storagemodel*\ , \ *storagecache*\ , \ *storageformat*\ , \ *cfgstore*\ , \ *memory*\ , \ *cpus*\ , \ *nics*\ , \ *nicmodel*\ , \ *bootorder*\ , \ *clockoffset*\ , \ *virtflags*\ , \ *master*\ , \ *vncport*\ , \ *textconsole*\ , \ *powerstate*\ , \ *beacon*\ , \ *datacenter*\ , \ *cluster*\ , \ *guestostype*\ , \ *othersettings*\ , \ *physlots*\ , \ *vidmodel*\ , \ *vidproto*\ , \ *vidpassword*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Virtualization parameters
+
+
+**************
+vm Attributes:
+**************
+
+
+
+\ **node**\ 
+ 
+ The node or static group name
+ 
+
+
+\ **mgr**\ 
+ 
+ The function manager for the virtual machine
+ 
+
+
+\ **host**\ 
+ 
+ The system that currently hosts the VM
+ 
+
+
+\ **migrationdest**\ 
+ 
+ A noderange representing candidate destinations for migration (i.e. similar systems, same SAN, or other criteria that xCAT can use
+ 
+
+
+\ **storage**\ 
+ 
+ A list of storage files or devices to be used.  i.e. dir:///cluster/vm/<nodename> or nfs://<server>/path/to/folder/
+ 
+
+
+\ **storagemodel**\ 
+ 
+ Model of storage devices to provide to guest
+ 
+
+
+\ **storagecache**\ 
+ 
+ Select caching scheme to employ.  E.g. KVM understands 'none', 'writethrough' and 'writeback'
+ 
+
+
+\ **storageformat**\ 
+ 
+ Select disk format to use by default (e.g. raw versus qcow2)
+ 
+
+
+\ **cfgstore**\ 
+ 
+ Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data
+ 
+
+
+\ **memory**\ 
+ 
+ Megabytes of memory the VM currently should be set to.
+ 
+
+
+\ **cpus**\ 
+ 
+ Number of CPUs the node should see.
+ 
+
+
+\ **nics**\ 
+ 
+ Network configuration parameters.  Of the general form [physnet:]interface,.. Generally, interface describes the vlan entity (default for native, tagged for tagged, vl[number] for a specific vlan.  physnet is a virtual switch name or port description that is used for some virtualization technologies to construct virtual switches.  hypervisor.netmap can map names to hypervisor specific layouts, or the descriptions described there may be used directly here where possible.
+ 
+
+
+\ **nicmodel**\ 
+ 
+ Model of NICs that will be provided to VMs (i.e. e1000, rtl8139, virtio, etc)
+ 
+
+
+\ **bootorder**\ 
+ 
+ Boot sequence (i.e. net,hd)
+ 
+
+
+\ **clockoffset**\ 
+ 
+ Whether to have guest RTC synced to "localtime" or "utc"  If not populated, xCAT will guess based on the nodetype.os contents.
+ 
+
+
+\ **virtflags**\ 
+ 
+ General flags used by the virtualization method.  For example, in Xen it could, among other things, specify paravirtualized setup, or direct kernel boot.  For a hypervisor/dom0 entry, it is the virtualization method (i.e. "xen").  For KVM, the following flag=value pairs are recognized:
+             imageformat=[raw|fullraw|qcow2]
+                 raw is a generic sparse file that allocates storage on demand
+                 fullraw is a generic, non-sparse file that preallocates all space
+                 qcow2 is a sparse, copy-on-write capable format implemented at the virtualization layer rather than the filesystem level
+             clonemethod=[qemu-img|reflink]
+                 qemu-img allows use of qcow2 to generate virtualization layer copy-on-write
+                 reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs 
+             placement_affinity=[migratable|user_migratable|pinned]
+ 
+
+
+\ **master**\ 
+ 
+ The name of a master image, if any, this virtual machine is linked to.  This is generally set by clonevm and indicates the deletion of a master that would invalidate the storage of this virtual machine
+ 
+
+
+\ **vncport**\ 
+ 
+ Tracks the current VNC display port (currently not meant to be set
+ 
+
+
+\ **textconsole**\ 
+ 
+ Tracks the Psuedo-TTY that maps to the serial port or console of a VM
+ 
+
+
+\ **powerstate**\ 
+ 
+ This flag is used by xCAT to track the last known power state of the VM.
+ 
+
+
+\ **beacon**\ 
+ 
+ This flag is used by xCAT to track the state of the identify LED with respect to the VM.
+ 
+
+
+\ **datacenter**\ 
+ 
+ Optionally specify a datacenter for the VM to exist in (only applicable to VMWare)
+ 
+
+
+\ **cluster**\ 
+ 
+ Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor.
+ 
+
+
+\ **guestostype**\ 
+ 
+ This allows administrator to specify an identifier for OS to pass through to virtualization stack.  Normally this should be ignored as xCAT will translate from nodetype.os rather than requiring this field be used
+ 
+
+
+\ **othersettings**\ 
+ 
+ This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'.
+ 
+
+
+\ **physlots**\ 
+ 
+ Specify the physical slots drc index that will assigned to the partition, the delimiter is ',', and the drc index must started with '0x'. For more details, please reference to manpage of 'lsvm'.
+ 
+
+
+\ **vidmodel**\ 
+ 
+ Model of video adapter to provide to guest.  For example, qxl in KVM
+ 
+
+
+\ **vidproto**\ 
+ 
+ Request a specific protocol for remote video access be set up.  For example, spice in KVM.
+ 
+
+
+\ **vidpassword**\ 
+ 
+ Password to use instead of temporary random tokens for VNC and SPICE access
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/vmmaster.5.rst

@@ -0,0 +1,120 @@
+
+##########
+vmmaster.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **vmmaster**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **vmmaster Attributes:**\   \ *name*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *storage*\ , \ *storagemodel*\ , \ *nics*\ , \ *vintage*\ , \ *originator*\ , \ *virttype*\ , \ *specializeparameters*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Inventory of virtualization images for use with clonevm.  Manual intervention in this table is not intended.
+
+
+********************
+vmmaster Attributes:
+********************
+
+
+
+\ **name**\ 
+ 
+ The name of a master
+ 
+
+
+\ **os**\ 
+ 
+ The value of nodetype.os at the time the master was captured
+ 
+
+
+\ **arch**\ 
+ 
+ The value of nodetype.arch at the time of capture
+ 
+
+
+\ **profile**\ 
+ 
+ The value of nodetype.profile at time of capture
+ 
+
+
+\ **storage**\ 
+ 
+ The storage location of bulk master information
+ 
+
+
+\ **storagemodel**\ 
+ 
+ The default storage style to use when modifying a vm cloned from this master
+ 
+
+
+\ **nics**\ 
+ 
+ The nic configuration and relationship to vlans/bonds/etc
+ 
+
+
+\ **vintage**\ 
+ 
+ When this image was created
+ 
+
+
+\ **originator**\ 
+ 
+ The user who created the image
+ 
+
+
+\ **virttype**\ 
+ 
+ The type of virtualization this image pertains to (e.g. vmware, kvm, etc)
+ 
+
+
+\ **specializeparameters**\ 
+ 
+ Implementation specific arguments, currently only "autoLogonCount=<number" for ESXi clonevme
+ 
+
+
+\ **comments**\ 
+
+
+
+\ **disable**\ 
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/vpd.5.rst

@@ -0,0 +1,94 @@
+
+#####
+vpd.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **vpd**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **vpd Attributes:**\   \ *node*\ , \ *serial*\ , \ *mtm*\ , \ *side*\ , \ *asset*\ , \ *uuid*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+The Machine type, Model, and Serial numbers of each node.
+
+
+***************
+vpd Attributes:
+***************
+
+
+
+\ **node**\ 
+ 
+ The node name or group name.
+ 
+
+
+\ **serial**\ 
+ 
+ The serial number of the node.
+ 
+
+
+\ **mtm**\ 
+ 
+ The machine type and model number of the node.  E.g. 7984-6BU
+ 
+
+
+\ **side**\ 
+ 
+ <BPA>-<port> or <FSP>-<port>. The side information for the BPA/FSP. The side attribute refers to which BPA/FSP, A or B, which is determined by the slot value returned from lsslp command. It also lists the physical port within each BPA/FSP which is determined by the IP address order from the lsslp response. This information is used internally when communicating with the BPAs/FSPs
+ 
+
+
+\ **asset**\ 
+ 
+ A field for administators to use to correlate inventory numbers they may have to accomodate
+ 
+
+
+\ **uuid**\ 
+ 
+ The UUID applicable to the node
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/websrv.5.rst

@@ -0,0 +1,82 @@
+
+########
+websrv.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **websrv**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **websrv Attributes:**\   \ *node*\ , \ *port*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Web service parameters
+
+
+******************
+websrv Attributes:
+******************
+
+
+
+\ **node**\ 
+ 
+ The web service hostname.
+ 
+
+
+\ **port**\ 
+ 
+ The port of the web service.
+ 
+
+
+\ **username**\ 
+ 
+ Userid to use to access the web service.
+ 
+
+
+\ **password**\ 
+ 
+ Password to use to access the web service.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/winimage.5.rst

@@ -0,0 +1,88 @@
+
+##########
+winimage.5
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **winimage**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **winimage Attributes:**\   \ *imagename*\ , \ *template*\ , \ *installto*\ , \ *partitionfile*\ , \ *winpepath*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Information about a Windows operating system image that can be used to deploy cluster nodes.
+
+
+********************
+winimage Attributes:
+********************
+
+
+
+\ **imagename**\ 
+ 
+ The name of this xCAT OS image definition.
+ 
+
+
+\ **template**\ 
+ 
+ The fully qualified name of the template file that is used to create the windows unattend.xml file for diskful installation.
+ 
+
+
+\ **installto**\ 
+ 
+ The disk and partition that the Windows will be deployed to. The valid format is <disk>:<partition>. If not set, default value is 0:1 for bios boot mode(legacy) and 0:3 for uefi boot mode; If setting to 1, it means 1:1 for bios boot and 1:3 for uefi boot
+ 
+
+
+\ **partitionfile**\ 
+ 
+ The path of partition configuration file. Since the partition configuration for bios boot mode and uefi boot mode are different, this configuration file can include both configurations if you need to support both bios and uefi mode. Either way, you must specify the boot mode in the configuration. Example of partition configuration file: [BIOS]xxxxxxx[UEFI]yyyyyyy. To simplify the setting, you also can set installto in partitionfile with section like [INSTALLTO]0:1
+ 
+
+
+\ **winpepath**\ 
+ 
+ The path of winpe which will be used to boot this image. If the real path is /tftpboot/winboot/winpe1/, the value for winpepath should be set to winboot/winpe1
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/xcatdb.5.rst

@@ -0,0 +1,746 @@
+
+########
+xcatdb.5
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+An overview of the xCAT database.
+
+
+***********
+DESCRIPTION
+***********
+
+
+The xCAT database contains user settings for the cluster and information gathered from the cluster.
+It consists of a series of tables, which are described below.  To get more information about a
+particular table, run man for that table name.  The tables can be manipulated directly using the
+\ **tabedit**\  or \ **chtab**\  commands.  They can be viewed using \ **nodels**\  or \ **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
+hierarchical/service node case.  To use a different database or a different location, create
+the file /etc/xcat/cfgloc.  See the appropriate xCAT docuementation for the format of the file for the database you choose. 
+The following example /etc/xcat/cfgloc file is for PostgreSQL:
+
+
+.. code-block:: perl
+
+  Pg:dbname=xcat;host=<mgmtnode>|<pgadminuserid>|<pgadminpasswd>
+
+
+where mgmtnode is the hostname of the management node adapter on the cluster side, and the pgadminuserid and pgadminpasswd are the database admin and password.
+
+GROUPS AND REGULAR EXPRESSIONS IN TABLES
+========================================
+
+
+The xCAT database has a number of tables, some with rows that are keyed by node name
+(such as noderes and nodehm) and others that are not keyed by node name (for example, the policy table).
+The tables that are keyed by node name have some extra features that enable a more
+template-based style to be used:
+
+Any group name can be used in lieu of a node name in the node field, and that row will then
+provide "default" attribute values for any node in that group.  A row with a specific node name
+can then override one or more attribute values for that specific node.  For example, if the nodehm table contains:
+
+
+.. code-block:: perl
+
+  #node,power,mgt,cons,termserver,termport,conserver,serialport,serialspeed,serialflow,getmac,cmdmapping,comments,disable
+  "mygroup",,"ipmi",,,,,,"19200",,,,,
+  "node1",,,,,,,,"115200",,,,,
+
+
+In the above example, the node group called mygroup sets mgt=ipmi and serialspeed=19200.  Any nodes that are in this group
+will have those attribute values, unless overridden.  For example, if node2 is a member of mygroup, it will automatically
+inherit these attribute values (even though it is not explicitly listed in this table).  In the case of node1 above, it
+inherits mgt=ipmi, but overrides the serialspeed to be 115200, instead of 19200.  A useful, typical way to use this
+capability is to create a node group for your nodes and for all the attribute values that are the same for every node,
+set them at the group level.  Then you only have to set attributes for each node that vary from node to node.
+
+xCAT extends the group capability so that it can also be used for attribute values that vary from node to node
+in a very regular pattern.  For example, if in the ipmi table you want the bmc attribute to be set to whatever the nodename is with
+"-bmc" appended to the end of it, then use this in the ipmi table:
+
+
+.. code-block:: perl
+
+  #node,bmc,bmcport,taggedvlan,bmcid,username,password,comments,disable
+  "compute","/\z/-bmc/",,,,,,,
+
+
+In this example, "compute" is a node group that contains all of the compute nodes.  The 2nd attribute (bmc) is a regular
+expression that is similar to a substitution pattern.  The 1st part "\z" matches the end of the node name and substitutes "-bmc", effectively appending it to the node name.
+
+Another example is if node1 is to have IP address 10.0.0.1, node2 is to have IP address 10.0.0.2, etc.,
+then this could be represented in the hosts table with the single row:
+
+
+.. code-block:: perl
+
+  #node,ip,hostnames,otherinterfaces,comments,disable
+  "compute","|node(\d+)|10.0.0.($1+0)|",,,,
+
+
+In this example, the regular expression in the ip attribute uses "|" to separate the 1st and 2nd part.  This means that
+xCAT will allow arithmetic operations in the 2nd part.  In the 1st part, "(\d+)", will match the number part of the node
+name and put that in a variable called $1.  The 2nd part
+is what value to give the ip attribute.  In this case it will set it to the string "10.0.0." and the number that is
+in $1.  (Zero is added to $1 just to remove any leading zeroes.)
+
+A more involved example is with the mp table.  If your blades have node names node01, node02, etc., and your chassis
+node names are cmm01, cmm02, etc., then you might have an mp table like:
+
+
+.. code-block:: perl
+
+  #node,mpa,id,nodetype,comments,disable
+  "blade","|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|","|\D+(\d+)|(($1-1)%14+1)|",,
+
+
+Before you panic, let me explain each column:
+
+
+\ **blade**\ 
+ 
+ This is a group name.  In this example, we are assuming that all of your blades belong to this
+ group.  Each time the xCAT software accesses the \ **mp**\  table to get the management module and slot number
+ of a specific blade (e.g. \ **node20**\ ), this row will match (because \ **node20**\  is in the \ **blade**\  group).
+ Once this row is matched for \ **node20**\ , then the processing described in the following items will take
+ place.
+ 
+
+
+\ **|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|**\ 
+ 
+ This is a perl substitution pattern that will produce the value for the second column of the table (the
+ management module hostname).  The text \ **\D+(\d+)**\  between the 1st two vertical bars is
+ a regular expression that matches the node
+ name that was searched for in this table (in this example \ **node20**\ ).  The text that matches
+ within the 1st set of parentheses is set to $1.  (If there was a 2nd set of parentheses, it would
+ be set to $2, and so on.)  In our case, the \D+ matches the non-numeric part of the name
+ (\ **node**\ ) and the \ **\d+**\  matches the numeric part (\ **20**\ ).  So $1 is set to \ **20**\ .  The text \ **cmm(sprintf('%02d',($1-1)/14+1))**\  between the
+ 2nd and 3rd vertical bars produces the string that should be used as the value for the mpa attribute for node20.
+ Since $1 is set to 20, the expression \ **($1-1)/14+1**\  equals
+ 19/14 + 1, which equals 2.  (The division is integer division,
+ so 19/14 equals 1.  Fourteen is used as the divisor, because there are 14 blades in each chassis.)  The value of 2 is then passed into sprintf() with a format string to add a leading
+ zero, if necessary, to always make the number two digits.  Lastly the string \ **cmm**\  is added to the beginning,
+ making the resulting string \ **cmm02**\ , which will be used as the hostname
+ of the management module.
+ 
+
+
+\ **|\D+(\d+)|(($1-1)%14+1)|**\ 
+ 
+ This item is similar to the one above.  This substituion pattern will produce the value for
+ the 3rd column (the chassis slot number for this blade).  Because this row was
+ the match for \ **node20**\ , the parentheses
+ within the 1st set of vertical bars will set $1 to 20.  Since % means modulo division, the
+ expression \ **($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.
+
+
+Easy Regular Expressions
+========================
+
+
+As of xCAT 2.8.1, you can use a modified version of the regular expression support described in the previous section. You do not need to enter the node information (1st part of the expression), it will be derived from the input nodename. You only need to supply the 2nd part of the expression to determine the value to give the attribute. For examples, see
+
+https://sourceforge.net/p/xcat/wiki/Listing_and_Modifying_the_Database/#easy-regular-expressions
+
+
+
+******************
+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.  Use \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ ,
+and \ **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.
+
+\ **xCAT Object Name Format**\ :
+================================
+
+
+\ **xCAT Object Name Format**\  is defined by the following regex:
+
+
+.. code-block:: perl
+
+  ^([A-Za-z-]+)([0-9]+)(([A-Za-z-]+[A-Za-z0-9-]*)*)
+
+
+In plain English, an object name is in \ **xCAT Object Name Format**\  if starting from the begining there are:
+
+
+\*
+ 
+ one or more alpha characters of any case and any number of "-" in any combination
+ 
+
+
+\*
+ 
+ followed by one or more numbers
+ 
+
+
+\*
+ 
+ then optionally followed by one alpha character of any case  or "-"
+ 
+
+
+\*
+ 
+ followed by any combination of case mixed alphanumerics and "-"
+ 
+
+
+
+\ **Object Types**\ 
+====================
+
+
+To run man for any of the object definitions below, use section 7.  For example:  \ **man 7 node**\ 
+
+The object types are:
+
+
+auditlog(7)|auditlog.7
+
+
+
+boottarget(7)|boottarget.7
+
+
+
+eventlog(7)|eventlog.7
+
+
+
+firmware(7)|firmware.7
+
+
+
+group(7)|group.7
+
+
+
+kit(7)|kit.7
+
+
+
+kitcomponent(7)|kitcomponent.7
+
+
+
+kitrepo(7)|kitrepo.7
+
+
+
+monitoring(7)|monitoring.7
+
+
+
+network(7)|network.7
+
+
+
+node(7)|node.7
+
+
+
+notification(7)|notification.7
+
+
+
+osdistro(7)|osdistro.7
+
+
+
+osdistroupdate(7)|osdistroupdate.7
+
+
+
+osimage(7)|osimage.7
+
+
+
+policy(7)|policy.7
+
+
+
+rack(7)|rack.7
+
+
+
+route(7)|route.7
+
+
+
+site(7)|site.7
+
+
+
+zone(7)|zone.7
+
+
+
+
+
+******
+TABLES
+******
+
+
+To manipulate the tables directly, use \ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ ,
+\ **nodeadd(8)**\ , \ **nodech(1)**\ .
+
+To run man for any of the table descriptions below, use section 5.  For example:  \ **man 5 nodehm**\ 
+
+The tables are:
+
+
+auditlog(5)|auditlog.5
+ 
+ 
+ .. code-block:: perl
+ 
+   Audit Data log.
+ 
+ 
+
+
+bootparams(5)|bootparams.5
+ 
+ Current boot settings to be sent to systems attempting network boot for deployment, stateless, or other reasons.  Mostly automatically manipulated by xCAT.
+ 
+
+
+boottarget(5)|boottarget.5
+ 
+ Specify non-standard initrd, kernel, and parameters that should be used for a given profile.
+ 
+
+
+cfgmgt(5)|cfgmgt.5
+ 
+ Configuration management data for nodes used by non-xCAT osimage management services to install and configure software on a node.
+ 
+
+
+chain(5)|chain.5
+ 
+ Controls what operations are done (and it what order) when a node is discovered and deployed.
+ 
+
+
+deps(5)|deps.5
+ 
+ Describes dependencies some nodes have on others.  This can be used, e.g., by rpower -d to power nodes on or off in the correct order.
+ 
+
+
+discoverydata(5)|discoverydata.5
+ 
+ Discovery data which sent from genesis.
+ 
+
+
+domain(5)|domain.5
+ 
+ Mapping of nodes to domain attributes
+ 
+
+
+eventlog(5)|eventlog.5
+ 
+ Stores the events occurred.
+ 
+
+
+firmware(5)|firmware.5
+ 
+ Maps node to firmware values to be used for setup at node discovery or later
+ 
+
+
+hosts(5)|hosts.5
+ 
+ IP addresses and hostnames of nodes.  This info is optional and is only used to populate /etc/hosts and DNS via makehosts and makedns.  Using regular expressions in this table can be a quick way to populate /etc/hosts.
+ 
+
+
+hwinv(5)|hwinv.5
+ 
+ The hareware inventory for the node.
+ 
+
+
+hypervisor(5)|hypervisor.5
+ 
+ Hypervisor parameters
+ 
+
+
+ipmi(5)|ipmi.5
+ 
+ Settings for nodes that are controlled by an on-board BMC via IPMI.
+ 
+
+
+iscsi(5)|iscsi.5
+ 
+ Contains settings that control how to boot a node from an iSCSI target
+ 
+
+
+kit(5)|kit.5
+ 
+ This table stores all kits added to the xCAT cluster.
+ 
+
+
+kitcomponent(5)|kitcomponent.5
+ 
+ This table stores all kit components added to the xCAT cluster.
+ 
+
+
+kitrepo(5)|kitrepo.5
+ 
+ This table stores all kits added to the xCAT cluster.
+ 
+
+
+kvm_masterdata(5)|kvm_masterdata.5
+ 
+ Persistant store for KVM plugin for masters
+ 
+
+
+kvm_nodedata(5)|kvm_nodedata.5
+ 
+ Persistant store for KVM plugin, not intended for manual modification.
+ 
+
+
+linuximage(5)|linuximage.5
+ 
+ Information about a Linux operating system image that can be used to deploy cluster nodes.
+ 
+
+
+litefile(5)|litefile.5
+ 
+ The litefile table specifies the directories and files on the statelite nodes that should be readwrite, persistent, or readonly overlay.  All other files in the statelite nodes come from the readonly statelite image.
+ 
+
+
+litetree(5)|litetree.5
+ 
+ Directory hierarchy to traverse to get the initial contents of node files.  The files that are specified in the litefile table are searched for in the directories specified in this table.
+ 
+
+
+mac(5)|mac.5
+ 
+ The MAC address of the node's install adapter.  Normally this table is populated by getmacs or node discovery, but you can also add entries to it manually.
+ 
+
+
+mic(5)|mic.5
+ 
+ The host, slot id and configuraton of the mic (Many Integrated Core).
+ 
+
+
+monitoring(5)|monitoring.5
+ 
+ Controls what external monitoring tools xCAT sets up and uses.  Entries should be added and removed from this table using the provided xCAT commands monstart and monstop.
+ 
+
+
+monsetting(5)|monsetting.5
+ 
+ Specifies the monitoring plug-in specific settings. These settings will be used by the monitoring plug-in to customize the behavior such as event filter, sample interval, responses etc. Entries should be added, removed or modified by chtab command. Entries can also be added or modified by the monstart command when a monitoring plug-in is brought up.
+ 
+
+
+mp(5)|mp.5
+ 
+ Contains the hardware control info specific to blades.  This table also refers to the mpa table, which contains info about each Management Module.
+ 
+
+
+mpa(5)|mpa.5
+ 
+ Contains info about each Management Module and how to access it.
+ 
+
+
+networks(5)|networks.5
+ 
+ Describes the networks in the cluster and info necessary to set up nodes on that network.
+ 
+
+
+nics(5)|nics.5
+ 
+ Stores NIC details.
+ 
+
+
+nimimage(5)|nimimage.5
+ 
+ All the info that specifies a particular AIX operating system image that can be used to deploy AIX nodes.
+ 
+
+
+nodegroup(5)|nodegroup.5
+ 
+ Contains group definitions, whose membership is dynamic depending on characteristics of the node.
+ 
+
+
+nodehm(5)|nodehm.5
+ 
+ Settings that control how each node's hardware is managed.  Typically, an additional table that is specific to the hardware type of the node contains additional info.  E.g. the ipmi, mp, and ppc tables.
+ 
+
+
+nodelist(5)|nodelist.5
+ 
+ The list of all the nodes in the cluster, including each node's current status and what groups it is in.
+ 
+
+
+nodepos(5)|nodepos.5
+ 
+ Contains info about the physical location of each node.  Currently, this info is not used by xCAT, and therefore can be in whatevery format you want.  It will likely be used in xCAT in the future.
+ 
+
+
+noderes(5)|noderes.5
+ 
+ Resources and settings to use when installing nodes.
+ 
+
+
+nodetype(5)|nodetype.5
+ 
+ A few hardware and software characteristics of the nodes.
+ 
+
+
+notification(5)|notification.5
+ 
+ Contains registrations to be notified when a table in the xCAT database changes.  Users can add entries to have additional software notified of changes.  Add and remove entries using the provided xCAT commands regnotif and unregnotif.
+ 
+
+
+osdistro(5)|osdistro.5
+ 
+ Information about all the OS distros in the xCAT cluster
+ 
+
+
+osdistroupdate(5)|osdistroupdate.5
+ 
+ Information about the OS distro updates in the xCAT cluster
+ 
+
+
+osimage(5)|osimage.5
+ 
+ Basic information about an operating system image that can be used to deploy cluster nodes.
+ 
+
+
+passwd(5)|passwd.5
+ 
+ Contains default userids and passwords for xCAT to access cluster components.  In most cases, xCAT will also actually set the userid/password in the relevant component when it is being configured or installed.  Userids/passwords for specific cluster components can be overidden in other tables, e.g. mpa, ipmi, ppchcp, etc.
+ 
+
+
+performance(5)|performance.5
+ 
+ Describes the system performance every interval unit of time.
+ 
+
+
+policy(5)|policy.5
+ 
+ The policy table in the xCAT database controls who has authority to run specific xCAT operations. It is basically the Access Control List (ACL) for xCAT. It is sorted on the priority field before evaluating.
+ 
+
+
+postscripts(5)|postscripts.5
+ 
+ The scripts that should be run on each node after installation or diskless boot.
+ 
+
+
+ppc(5)|ppc.5
+ 
+ List of system p hardware: HMCs, IVMs, FSPs, BPCs, CECs, Frames.
+ 
+
+
+ppcdirect(5)|ppcdirect.5
+ 
+ Info necessary to use FSPs/BPAs to control system p CECs/Frames.
+ 
+
+
+ppchcp(5)|ppchcp.5
+ 
+ Info necessary to use HMCs and IVMs as hardware control points for LPARs.
+ 
+
+
+prescripts(5)|prescripts.5
+ 
+ The scripts that will be run at the beginning and the end of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command.
+ 
+
+
+prodkey(5)|prodkey.5
+ 
+ Specify product keys for products that require them
+ 
+
+
+rack(5)|rack.5
+ 
+ Rack information.
+ 
+
+
+routes(5)|routes.5
+ 
+ Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the servie node as gateway.
+ 
+
+
+servicenode(5)|servicenode.5
+ 
+ List of all Service Nodes and services that will be set up on the Service Node.
+ 
+
+
+site(5)|site.5
+ 
+ Global settings for the whole cluster.  This table is different from the 
+ other tables in that each attribute is just named in the key column, rather 
+ than having a separate column for each attribute. The following is a list of 
+ attributes currently used by xCAT organized into categories.
+ 
+
+
+statelite(5)|statelite.5
+ 
+ The location on an NFS server where a nodes persistent files are stored.  Any file marked persistent in the litefile table will be stored in the location specified in this table for that node.
+ 
+
+
+storage(5)|storage.5
+
+
+
+switch(5)|switch.5
+ 
+ Contains what switch port numbers each node is connected to.
+ 
+
+
+switches(5)|switches.5
+ 
+ Parameters to use when interrogating switches
+ 
+
+
+token(5)|token.5
+ 
+ The token of users for authentication.
+ 
+
+
+virtsd(5)|virtsd.5
+ 
+ The parameters which used to create the Storage Domain
+ 
+
+
+vm(5)|vm.5
+ 
+ Virtualization parameters
+ 
+
+
+vmmaster(5)|vmmaster.5
+ 
+ Inventory of virtualization images for use with clonevm.  Manual intervention in this table is not intended.
+ 
+
+
+vpd(5)|vpd.5
+ 
+ The Machine type, Model, and Serial numbers of each node.
+ 
+
+
+websrv(5)|websrv.5
+ 
+ Web service parameters
+ 
+
+
+winimage(5)|winimage.5
+ 
+ Information about a Windows operating system image that can be used to deploy cluster nodes.
+ 
+
+
+zone(5)|zone.5
+ 
+ Defines a cluster zone for nodes that share root ssh key access to each other.
+ 
+
+
+zvm(5)|zvm.5
+ 
+ List of z/VM virtual servers.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **lsdef(1)**\ , \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man5/zone.5.rst

@@ -0,0 +1,82 @@
+
+######
+zone.5
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **zone**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **zone Attributes:**\   \ *zonename*\ , \ *sshkeydir*\ , \ *sshbetweennodes*\ , \ *defaultzone*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Defines a cluster zone for nodes that share root ssh key access to each other.
+
+
+****************
+zone Attributes:
+****************
+
+
+
+\ **zonename**\ 
+ 
+ The name of the zone.
+ 
+
+
+\ **sshkeydir**\ 
+ 
+ Directory containing the shared root ssh RSA keys.
+ 
+
+
+\ **sshbetweennodes**\ 
+ 
+ Indicates whether passwordless ssh will be setup between the nodes of this zone. Values are yes/1 or no/0. Default is yes.
+ 
+
+
+\ **defaultzone**\ 
+ 
+ If nodes are not assigned to any other zone, they will default to this zone. If value is set to yes or 1.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+

docs/source/guides/admin-guides/references/man5/zvm.5.rst

@@ -0,0 +1,88 @@
+
+#####
+zvm.5
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **zvm**\  - a table in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **zvm Attributes:**\   \ *node*\ , \ *hcp*\ , \ *userid*\ , \ *nodetype*\ , \ *parent*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+List of z/VM virtual servers.
+
+
+***************
+zvm Attributes:
+***************
+
+
+
+\ **node**\ 
+ 
+ The node name.
+ 
+
+
+\ **hcp**\ 
+ 
+ The hardware control point for this node.
+ 
+
+
+\ **userid**\ 
+ 
+ The z/VM userID of this node.
+ 
+
+
+\ **nodetype**\ 
+ 
+ The node type. Valid values: cec (Central Electronic Complex), lpar (logical partition), zvm (z/VM host operating system), and vm (virtual machine).
+ 
+
+
+\ **parent**\ 
+ 
+ The parent node. For LPAR, this specifies the CEC. For z/VM, this specifies the LPAR. For VM, this specifies the z/VM host operating system.
+ 
+
+
+\ **comments**\ 
+ 
+ Any user provided notes.
+ 
+
+
+\ **disable**\ 
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
+