commit the man7 man pages generated from perl-xCAT

docs/source/guides/admin-guides/references/man7/auditlog.7.rst

@@ -0,0 +1,115 @@
+
+##########
+auditlog.7
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **auditlog**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **auditlog Attributes:**\   \ *args*\ , \ *audittime*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *comments*\ , \ *disable*\ , \ *noderange*\ , \ *recid*\ , \ *status*\ , \ *userid*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+********************
+auditlog Attributes:
+********************
+
+
+
+\ **args**\  (auditlog.args)
+ 
+ The command argument list.
+ 
+
+
+\ **audittime**\  (auditlog.audittime)
+ 
+ The timestamp for the audit entry.
+ 
+
+
+\ **clientname**\  (auditlog.clientname)
+ 
+ The client machine, where the command originated.
+ 
+
+
+\ **clienttype**\  (auditlog.clienttype)
+ 
+ Type of command: cli,java,webui,other.
+ 
+
+
+\ **command**\  (auditlog.command)
+ 
+ Command executed.
+ 
+
+
+\ **comments**\  (auditlog.comments)
+ 
+ Any user-provided notes.
+ 
+
+
+\ **disable**\  (auditlog.disable)
+ 
+ Do not use.  tabprune will not work if set to yes or 1
+ 
+
+
+\ **noderange**\  (auditlog.noderange)
+ 
+ The noderange on which the command was run.
+ 
+
+
+\ **recid**\  (auditlog.recid)
+ 
+ The record id.
+ 
+
+
+\ **status**\  (auditlog.status)
+ 
+ Allowed or Denied.
+ 
+
+
+\ **userid**\  (auditlog.userid)
+ 
+ The user running the command.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/boottarget.7.rst

@@ -0,0 +1,49 @@
+
+############
+boottarget.7
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **boottarget**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **boottarget Attributes:**\   \ **\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+**********************
+boottarget Attributes:
+**********************
+
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/eventlog.7.rst

@@ -0,0 +1,137 @@
+
+##########
+eventlog.7
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **eventlog**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **eventlog Attributes:**\   \ *application*\ , \ *comments*\ , \ *component*\ , \ *disable*\ , \ *eventtime*\ , \ *eventtype*\ , \ *id*\ , \ *message*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *rawdata*\ , \ *recid*\ , \ *severity*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+********************
+eventlog Attributes:
+********************
+
+
+
+\ **application**\  (eventlog.application)
+ 
+ The application that reports the event.
+ 
+
+
+\ **comments**\  (eventlog.comments)
+ 
+ Any user-provided notes.
+ 
+
+
+\ **component**\  (eventlog.component)
+ 
+ The component where the event occurred.
+ 
+
+
+\ **disable**\  (eventlog.disable)
+ 
+ Do not use.  tabprune will not work if set to yes or 1
+ 
+
+
+\ **eventtime**\  (eventlog.eventtime)
+ 
+ The timestamp for the event.
+ 
+
+
+\ **eventtype**\  (eventlog.eventtype)
+ 
+ The type of the event.
+ 
+
+
+\ **id**\  (eventlog.id)
+ 
+ The location or the resource name where the event occurred.
+ 
+
+
+\ **message**\  (eventlog.message)
+ 
+ The full description of the event.
+ 
+
+
+\ **monitor**\  (eventlog.monitor)
+ 
+ The name of the monitor that monitors this event.
+ 
+
+
+\ **monnode**\  (eventlog.monnode)
+ 
+ The node that monitors this event.
+ 
+
+
+\ **node**\  (eventlog.node)
+ 
+ The node where the event occurred.
+ 
+
+
+\ **rawdata**\  (eventlog.rawdata)
+ 
+ 
+ .. code-block:: perl
+ 
+   The data that associated with the event.
+ 
+ 
+
+
+\ **recid**\  (eventlog.recid)
+ 
+ The record id.
+ 
+
+
+\ **severity**\  (eventlog.severity)
+ 
+ The severity of the event. Valid values are: informational, warning, critical.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/firmware.7.rst

@@ -0,0 +1,67 @@
+
+##########
+firmware.7
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **firmware**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **firmware Attributes:**\   \ *cfgfile*\ , \ *comments*\ , \ *disable*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+********************
+firmware Attributes:
+********************
+
+
+
+\ **cfgfile**\  (firmware.cfgfile)
+ 
+ The file to use.
+ 
+
+
+\ **comments**\  (firmware.comments)
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\  (firmware.disable)
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/index.rst

@@ -0,0 +1,8 @@
+man7
+====
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   *

docs/source/guides/admin-guides/references/man7/kit.7.rst

@@ -0,0 +1,103 @@
+
+#####
+kit.7
+#####
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kit**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kit Attributes:**\   \ *basename*\ , \ *description*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *kitname*\ , \ *ostype*\ , \ *release*\ , \ *version*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+***************
+kit Attributes:
+***************
+
+
+
+\ **basename**\  (kit.basename)
+ 
+ The kit base name
+ 
+
+
+\ **description**\  (kit.description)
+ 
+ The Kit description.
+ 
+
+
+\ **isinternal**\  (kit.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**\  (kit.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**\  (kit.kitdir)
+ 
+ The path to Kit Installation directory on the Mgt Node.
+ 
+
+
+\ **kitname**\  (kit.kitname)
+ 
+ The unique generated kit name, when kit is added to the cluster.
+ 
+
+
+\ **ostype**\  (kit.ostype)
+ 
+ The kit OS type.  Linux or AIX.
+ 
+
+
+\ **release**\  (kit.release)
+ 
+ The kit release
+ 
+
+
+\ **version**\  (kit.version)
+ 
+ The kit version
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst

@@ -0,0 +1,139 @@
+
+##############
+kitcomponent.7
+##############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kitcomponent**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kitcomponent Attributes:**\   \ *basename*\ , \ *description*\ , \ *driverpacks*\ , \ *exlist*\ , \ *genimage_postinstall*\ , \ *kitcompdeps*\ , \ *kitcompname*\ , \ *kitname*\ , \ *kitpkgdeps*\ , \ *kitreponame*\ , \ *postbootscripts*\ , \ *prerequisite*\ , \ *release*\ , \ *serverroles*\ , \ *version*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+************************
+kitcomponent Attributes:
+************************
+
+
+
+\ **basename**\  (kitcomponent.basename)
+ 
+ Kit Component basename.
+ 
+
+
+\ **description**\  (kitcomponent.description)
+ 
+ The Kit component description.
+ 
+
+
+\ **driverpacks**\  (kitcomponent.driverpacks)
+ 
+ Comma-separated List of driver package names. These must be full names like: pkg1-1.0-1.x86_64.rpm.
+ 
+
+
+\ **exlist**\  (kitcomponent.exlist)
+ 
+ Exclude list file containing the files/directories to exclude when building a diskless image.
+ 
+
+
+\ **genimage_postinstall**\  (kitcomponent.genimage_postinstall)
+ 
+ Comma-separated list of postinstall scripts that will run during the genimage.
+ 
+
+
+\ **kitcompdeps**\  (kitcomponent.kitcompdeps)
+ 
+ Comma-separated list of kit components that this kit component depends on.
+ 
+
+
+\ **kitcompname**\  (kitcomponent.kitcompname)
+ 
+ The unique Kit Component name. It is auto-generated when the parent Kit is added to the cluster.
+ 
+
+
+\ **kitname**\  (kitcomponent.kitname)
+ 
+ The Kit name which this Kit Component belongs to.
+ 
+
+
+\ **kitpkgdeps**\  (kitcomponent.kitpkgdeps)
+ 
+ Comma-separated list of packages that this kit component depends on.
+ 
+
+
+\ **kitreponame**\  (kitcomponent.kitreponame)
+ 
+ The Kit Package Repository name which this Kit Component belongs to.
+ 
+
+
+\ **postbootscripts**\  (kitcomponent.postbootscripts)
+ 
+ Comma-separated list of postbootscripts that will run during the node boot.
+ 
+
+
+\ **prerequisite**\  (kitcomponent.prerequisite)
+ 
+ Prerequisite for this kit component, the prerequisite includes ospkgdeps,preinstall,preupgrade,preuninstall scripts
+ 
+
+
+\ **release**\  (kitcomponent.release)
+ 
+ Kit Component release.
+ 
+
+
+\ **serverroles**\  (kitcomponent.serverroles)
+ 
+ The types of servers that this Kit Component can install on.  Valid types are: mgtnode, servicenode, compute
+ 
+
+
+\ **version**\  (kitcomponent.version)
+ 
+ Kit Component version.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/kitrepo.7.rst

@@ -0,0 +1,97 @@
+
+#########
+kitrepo.7
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **kitrepo**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **kitrepo Attributes:**\   \ *compat_osbasenames*\ , \ *kitname*\ , \ *kitrepodir*\ , \ *kitreponame*\ , \ *osarch*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+*******************
+kitrepo Attributes:
+*******************
+
+
+
+\ **compat_osbasenames**\  (kitrepo.compat_osbasenames)
+ 
+ List of compatible OS base names.
+ 
+
+
+\ **kitname**\  (kitrepo.kitname)
+ 
+ The Kit name which this Kit Package Repository belongs to.
+ 
+
+
+\ **kitrepodir**\  (kitrepo.kitrepodir)
+ 
+ The path to Kit Repository directory on the Mgt Node.
+ 
+
+
+\ **kitreponame**\  (kitrepo.kitreponame)
+ 
+ The unique generated kit repo package name, when kit is added to the cluster.
+ 
+
+
+\ **osarch**\  (kitrepo.osarch)
+ 
+ The OS distro arch which this repository is based on.
+ 
+
+
+\ **osbasename**\  (kitrepo.osbasename)
+ 
+ The OS distro name which this repository is based on.
+ 
+
+
+\ **osmajorversion**\  (kitrepo.osmajorversion)
+ 
+ The OS distro major version which this repository is based on.
+ 
+
+
+\ **osminorversion**\  (kitrepo.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.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/monitoring.7.rst

@@ -0,0 +1,73 @@
+
+############
+monitoring.7
+############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **monitoring**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **monitoring Attributes:**\   \ *comments*\ , \ *disable*\ , \ *name*\ , \ *nodestatmon*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+**********************
+monitoring Attributes:
+**********************
+
+
+
+\ **comments**\  (monitoring.comments)
+ 
+ Any user-written notes.
+ 
+
+
+\ **disable**\  (monitoring.disable)
+ 
+ Set to 'yes' or '1' to comment out this row.
+ 
+
+
+\ **name**\  (monitoring.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**\  (monitoring.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".
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/network.7.rst

@@ -0,0 +1,155 @@
+
+#########
+network.7
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **network**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **network Attributes:**\   \ *ddnsdomain*\ , \ *dhcpserver*\ , \ *domain*\ , \ *dynamicrange*\ , \ *gateway*\ , \ *logservers*\ , \ *mask*\ , \ *mgtifname*\ , \ *nameservers*\ , \ *net*\ , \ *netname*\ , \ *nodehostname*\ , \ *ntpservers*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *tftpserver*\ , \ *usercomment*\ , \ *vlanid*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+*******************
+network Attributes:
+*******************
+
+
+
+\ **ddnsdomain**\  (networks.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"
+ 
+
+
+\ **dhcpserver**\  (networks.dhcpserver)
+ 
+ The DHCP server that is servicing this network.  Required to be explicitly set for pooled service node operation.
+ 
+
+
+\ **domain**\  (networks.domain)
+ 
+ The DNS domain name (ex. cluster.com).
+ 
+
+
+\ **dynamicrange**\  (networks.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.
+ 
+
+
+\ **gateway**\  (networks.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.
+ 
+
+
+\ **logservers**\  (networks.logservers)
+ 
+ The log servers for this network.  Used in creating the DHCP network definition.  Assumed to be the DHCP server if not set.
+ 
+
+
+\ **mask**\  (networks.mask)
+ 
+ The network mask.
+ 
+
+
+\ **mgtifname**\  (networks.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.
+ 
+
+
+\ **nameservers**\  (networks.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.
+ 
+
+
+\ **net**\  (networks.net)
+ 
+ The network address.
+ 
+
+
+\ **netname**\  (networks.netname)
+ 
+ Name used to identify this network definition.
+ 
+
+
+\ **nodehostname**\  (networks.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.
+ 
+
+
+\ **ntpservers**\  (networks.ntpservers)
+ 
+ The ntp servers for this network.  Used in creating the DHCP network definition.  Assumed to be the DHCP server if not set.
+ 
+
+
+\ **staticrange**\  (networks.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**\  (networks.staticrangeincrement)
+
+
+
+\ **tftpserver**\  (networks.tftpserver)
+ 
+ The TFTP server that is servicing this network.  If not set, the DHCP server is assumed.
+ 
+
+
+\ **usercomment**\  (networks.comments)
+ 
+ Any user-written notes.
+ 
+
+
+\ **vlanid**\  (networks.vlanid)
+ 
+ The vlan ID if this network is within a vlan.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/notification.7.rst

@@ -0,0 +1,73 @@
+
+##############
+notification.7
+##############
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **notification**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **notification Attributes:**\   \ *comments*\ , \ *filename*\ , \ *tableops*\ , \ *tables*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+************************
+notification Attributes:
+************************
+
+
+
+\ **comments**\  (notification.comments)
+ 
+ Any user-written notes.
+ 
+
+
+\ **filename**\  (notification.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.
+ 
+
+
+\ **tableops**\  (notification.tableops)
+ 
+ Specifies the table operation to monitor for. Valid values:  "d" (rows deleted), "a" (rows added), "u" (rows updated).
+ 
+
+
+\ **tables**\  (notification.tables)
+ 
+ Comma-separated list of xCAT database tables to monitor.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/osdistro.7.rst

@@ -0,0 +1,91 @@
+
+##########
+osdistro.7
+##########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osdistro**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osdistro Attributes:**\   \ *arch*\ , \ *basename*\ , \ *dirpaths*\ , \ *majorversion*\ , \ *minorversion*\ , \ *osdistroname*\ , \ *type*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+********************
+osdistro Attributes:
+********************
+
+
+
+\ **arch**\  (osdistro.arch)
+ 
+ The OS distro arch (e.g. x86_64)
+ 
+
+
+\ **basename**\  (osdistro.basename)
+ 
+ The OS base name (e.g. rhels)
+ 
+
+
+\ **dirpaths**\  (osdistro.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,...)
+ 
+
+
+\ **majorversion**\  (osdistro.majorversion)
+ 
+ The OS distro major version.(e.g. 6)
+ 
+
+
+\ **minorversion**\  (osdistro.minorversion)
+ 
+ The OS distro minor version. (e.g. 2)
+ 
+
+
+\ **osdistroname**\  (osdistro.osdistroname)
+ 
+ Unique name (e.g. rhels6.2-x86_64)
+ 
+
+
+\ **type**\  (osdistro.type)
+ 
+ Linux or AIX
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst

@@ -0,0 +1,79 @@
+
+################
+osdistroupdate.7
+################
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osdistroupdate**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osdistroupdate Attributes:**\   \ *dirpath*\ , \ *downloadtime*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *usercomment*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+**************************
+osdistroupdate Attributes:
+**************************
+
+
+
+\ **dirpath**\  (osdistroupdate.dirpath)
+ 
+ Path to where OS distro update is stored. (e.g. /install/osdistroupdates/rhels6.2-x86_64-20120716-update)
+ 
+
+
+\ **downloadtime**\  (osdistroupdate.downloadtime)
+ 
+ The timestamp when OS distro update was downloaded..
+ 
+
+
+\ **osdistroname**\  (osdistroupdate.osdistroname)
+ 
+ The OS distro name to update. (e.g. rhels)
+ 
+
+
+\ **osupdatename**\  (osdistroupdate.osupdatename)
+ 
+ Name of OS update. (e.g. rhn-update1)
+ 
+
+
+\ **usercomment**\  (osdistroupdate.comments)
+ 
+ Any user-written notes.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/osimage.7.rst

@@ -0,0 +1,437 @@
+
+#########
+osimage.7
+#########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **osimage**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **osimage Attributes:**\   \ *addkcmdline*\ , \ *boottarget*\ , \ *bosinst_data*\ , \ *cfmdir*\ , \ *configdump*\ , \ *crashkernelsize*\ , \ *description*\ , \ *driverupdatesrc*\ , \ *dump*\ , \ *exlist*\ , \ *fb_script*\ , \ *groups*\ , \ *home*\ , \ *image_data*\ , \ *imagename*\ , \ *imagetype*\ , \ *installp_bundle*\ , \ *installto*\ , \ *isdeletable*\ , \ *kerneldir*\ , \ *kernelver*\ , \ *kitcomponents*\ , \ *krpmver*\ , \ *lpp_source*\ , \ *mksysb*\ , \ *netdrivers*\ , \ *nimmethod*\ , \ *nimtype*\ , \ *nodebootif*\ , \ *osarch*\ , \ *osdistroname*\ , \ *osname*\ , \ *osupdatename*\ , \ *osvers*\ , \ *otherifce*\ , \ *otherpkgdir*\ , \ *otherpkglist*\ , \ *otherpkgs*\ , \ *paging*\ , \ *partitionfile*\ , \ *permission*\ , \ *pkgdir*\ , \ *pkglist*\ , \ *postbootscripts*\ , \ *postinstall*\ , \ *postscripts*\ , \ *profile*\ , \ *provmethod*\ , \ *resolv_conf*\ , \ *root*\ , \ *rootfstype*\ , \ *rootimgdir*\ , \ *script*\ , \ *serverrole*\ , \ *shared_home*\ , \ *shared_root*\ , \ *spot*\ , \ *synclists*\ , \ *template*\ , \ *tmp*\ , \ *usercomment*\ , \ *winpepath*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+*******************
+osimage Attributes:
+*******************
+
+
+
+\ **addkcmdline**\  (linuximage.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.
+ 
+
+
+\ **boottarget**\  (linuximage.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.
+ 
+
+
+\ **bosinst_data**\  (nimimage.bosinst_data)
+ 
+ The name of a NIM bosinst_data resource.
+ 
+
+
+\ **cfmdir**\  (osimage.cfmdir)
+ 
+ CFM directory name for PCM. Set to /install/osimages/<osimage name>/cfmdir by PCM.
+ 
+
+
+\ **configdump**\  (nimimage.configdump)
+ 
+ Specifies the type of system dump to be collected. The values are selective, full, and none.  The default is selective.
+ 
+
+
+\ **crashkernelsize**\  (linuximage.crashkernelsize)
+ 
+ the size that assigned to the kdump kernel. If the kernel size is not set, 256M will be the default value.
+ 
+
+
+\ **description**\  (osimage.description)
+ 
+ OS Image Description
+ 
+
+
+\ **driverupdatesrc**\  (linuximage.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
+ 
+
+
+\ **dump**\  (linuximage.dump, nimimage.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.
+ 
+ or
+ 
+ The name of the NIM dump resource.
+ 
+
+
+\ **exlist**\  (linuximage.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.
+ 
+
+
+\ **fb_script**\  (nimimage.fb_script)
+ 
+ The name of a NIM fb_script resource.
+ 
+
+
+\ **groups**\  (osimage.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.
+ 
+
+
+\ **home**\  (nimimage.home)
+ 
+ The name of the NIM home resource.
+ 
+
+
+\ **image_data**\  (nimimage.image_data)
+ 
+ The name of a NIM image_data resource.
+ 
+
+
+\ **imagename**\  (osimage.imagename)
+ 
+ The name of this xCAT OS image definition.
+ 
+
+
+\ **imagetype**\  (osimage.imagetype)
+ 
+ The type of operating system image this definition represents (linux,AIX).
+ 
+
+
+\ **installp_bundle**\  (nimimage.installp_bundle)
+ 
+ One or more comma separated NIM installp_bundle resources.
+ 
+
+
+\ **installto**\  (winimage.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
+ 
+
+
+\ **isdeletable**\  (osimage.isdeletable)
+ 
+ A flag to indicate whether this image profile can be deleted.  This attribute is only used by PCM.
+ 
+
+
+\ **kerneldir**\  (linuximage.kerneldir)
+ 
+ The directory name where the 3rd-party kernel is stored. It is used for diskless image only.
+ 
+
+
+\ **kernelver**\  (linuximage.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
+ 
+
+
+\ **kitcomponents**\  (osimage.kitcomponents)
+ 
+ List of Kit Component IDs assigned to this OS Image definition.
+ 
+
+
+\ **krpmver**\  (linuximage.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.
+ 
+
+
+\ **lpp_source**\  (nimimage.lpp_source)
+ 
+ The name of the NIM lpp_source resource.
+ 
+
+
+\ **mksysb**\  (nimimage.mksysb)
+ 
+ The name of a NIM mksysb resource.
+ 
+
+
+\ **netdrivers**\  (linuximage.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
+ 
+
+
+\ **nimmethod**\  (nimimage.nimmethod)
+ 
+ The NIM install method to use, (ex. rte, mksysb).
+ 
+
+
+\ **nimtype**\  (nimimage.nimtype)
+ 
+ The NIM client type- standalone, diskless, or dataless.
+ 
+
+
+\ **nodebootif**\  (linuximage.nodebootif)
+ 
+ The network interface the stateless/statelite node will boot over (e.g. eth0)
+ 
+
+
+\ **osarch**\  (osimage.osarch)
+ 
+ The hardware architecture of this node.  Valid values: x86_64, ppc64, x86, ia64.
+ 
+
+
+\ **osdistroname**\  (osimage.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.
+ 
+
+
+\ **osname**\  (osimage.osname)
+ 
+ Operating system name- AIX or Linux.
+ 
+
+
+\ **osupdatename**\  (osimage.osupdatename)
+ 
+ A comma-separated list of OS distro updates to apply to this osimage.
+ 
+
+
+\ **osvers**\  (osimage.osvers)
+ 
+ The Linux operating system deployed on this node.  Valid values:  rhels\*,rhelc\*, rhas\*,centos\*,SL\*, fedora\*, sles\* (where \* is the version #).
+ 
+
+
+\ **otherifce**\  (linuximage.otherifce)
+ 
+ Other network interfaces (e.g. eth1) in the image that should be configured via DHCP
+ 
+
+
+\ **otherpkgdir**\  (linuximage.otherpkgdir)
+ 
+ The base directory where the non-distro packages are stored. Only 1 local directory supported at present.
+ 
+
+
+\ **otherpkglist**\  (linuximage.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 ",".
+ 
+
+
+\ **otherpkgs**\  (nimimage.otherpkgs)
+ 
+ One or more comma separated installp or rpm packages.  The rpm packages must have a prefix of 'R:', (ex. R:foo.rpm)
+ 
+
+
+\ **paging**\  (nimimage.paging)
+ 
+ The name of the NIM paging resource.
+ 
+
+
+\ **partitionfile**\  (linuximage.partitionfile, winimage.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 ","
+ 
+ or
+ 
+ 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
+ 
+
+
+\ **permission**\  (linuximage.permission)
+ 
+ The mount permission of /.statelite directory is used, its default value is 755
+ 
+
+
+\ **pkgdir**\  (linuximage.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.
+ 
+
+
+\ **pkglist**\  (linuximage.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
+ 
+
+
+\ **postbootscripts**\  (osimage.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.
+ 
+
+
+\ **postinstall**\  (linuximage.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.
+ 
+
+
+\ **postscripts**\  (osimage.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.
+ 
+
+
+\ **profile**\  (osimage.profile)
+ 
+ The node usage category. For example compute, service.
+ 
+
+
+\ **provmethod**\  (osimage.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.
+ 
+
+
+\ **resolv_conf**\  (nimimage.resolv_conf)
+ 
+ The name of the NIM resolv_conf resource.
+ 
+
+
+\ **root**\  (nimimage.root)
+ 
+ The name of the NIM root resource.
+ 
+
+
+\ **rootfstype**\  (osimage.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
+ 
+
+
+\ **rootimgdir**\  (linuximage.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/
+ 
+
+
+\ **script**\  (nimimage.script)
+ 
+ The name of a NIM script resource.
+ 
+
+
+\ **serverrole**\  (osimage.serverrole)
+ 
+ The role of the server created by this osimage.  Default roles: mgtnode, servicenode, compute, login, storage, utility.
+ 
+
+
+\ **shared_home**\  (nimimage.shared_home)
+ 
+ The name of the NIM shared_home resource.
+ 
+
+
+\ **shared_root**\  (nimimage.shared_root)
+ 
+ A shared_root resource represents a directory that can be used as a / (root) directory by one or more diskless clients.
+ 
+
+
+\ **spot**\  (nimimage.spot)
+ 
+ The name of the NIM SPOT resource.
+ 
+
+
+\ **synclists**\  (osimage.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.
+ 
+
+
+\ **template**\  (linuximage.template, winimage.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).
+ 
+ or
+ 
+ The fully qualified name of the template file that is used to create the windows unattend.xml file for diskful installation.
+ 
+
+
+\ **tmp**\  (nimimage.tmp)
+ 
+ The name of the NIM tmp resource.
+ 
+
+
+\ **usercomment**\  (linuximage.comments, nimimage.comments)
+ 
+ Any user-written notes.
+ 
+ or
+ 
+ Any user-provided notes.
+ 
+
+
+\ **winpepath**\  (winimage.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
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/policy.7.rst

@@ -0,0 +1,103 @@
+
+########
+policy.7
+########
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **policy**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **policy Attributes:**\   \ *commands*\ , \ *host*\ , \ *name*\ , \ *noderange*\ , \ *parameters*\ , \ *priority*\ , \ *rule*\ , \ *time*\ , \ *usercomment*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+******************
+policy Attributes:
+******************
+
+
+
+\ **commands**\  (policy.commands)
+ 
+ The list of commands that this rule applies to.  Default is "\*" (all commands).
+ 
+
+
+\ **host**\  (policy.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
+ 
+
+
+\ **name**\  (policy.name)
+ 
+ The username that is allowed to perform the commands specified by this rule.  Default is "\*" (all users).
+ 
+
+
+\ **noderange**\  (policy.noderange)
+ 
+ The Noderange that this rule applies to.  Default is "\*" (all nodes). Not supported with the \*def commands.
+ 
+
+
+\ **parameters**\  (policy.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.
+ 
+
+
+\ **priority**\  (policy.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.
+ 
+
+
+\ **rule**\  (policy.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.
+ 
+
+
+\ **time**\  (policy.time)
+ 
+ Time ranges that this command may be executed in.  This is not supported.
+ 
+
+
+\ **usercomment**\  (policy.comments)
+ 
+ Any user-written notes.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/rack.7.rst

@@ -0,0 +1,85 @@
+
+######
+rack.7
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **rack**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **rack Attributes:**\   \ *displayname*\ , \ *height*\ , \ *num*\ , \ *rackname*\ , \ *room*\ , \ *usercomment*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+****************
+rack Attributes:
+****************
+
+
+
+\ **displayname**\  (rack.displayname)
+ 
+ Alternative name for rack. Only used by PCM.
+ 
+
+
+\ **height**\  (rack.height)
+ 
+ Number of units which can be stored in the rack.
+ 
+
+
+\ **num**\  (rack.num)
+ 
+ The rack number.
+ 
+
+
+\ **rackname**\  (rack.rackname)
+ 
+ The rack name.
+ 
+
+
+\ **room**\  (rack.room)
+ 
+ The room in which the rack is located.
+ 
+
+
+\ **usercomment**\  (rack.comments)
+ 
+ Any user-written notes.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/route.7.rst

@@ -0,0 +1,85 @@
+
+#######
+route.7
+#######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **route**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **route Attributes:**\   \ *gateway*\ , \ *ifname*\ , \ *mask*\ , \ *net*\ , \ *routename*\ , \ *usercomment*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+*****************
+route Attributes:
+*****************
+
+
+
+\ **gateway**\  (routes.gateway)
+ 
+ The gateway that routes the ip traffic from the mn to the nodes. It is usually a service node.
+ 
+
+
+\ **ifname**\  (routes.ifname)
+ 
+ The interface name that facing the gateway. It is optional for IPv4 routes, but it is required for IPv6 routes.
+ 
+
+
+\ **mask**\  (routes.mask)
+ 
+ The network mask.
+ 
+
+
+\ **net**\  (routes.net)
+ 
+ The network address.
+ 
+
+
+\ **routename**\  (routes.routename)
+ 
+ Name used to identify this route.
+ 
+
+
+\ **usercomment**\  (routes.comments)
+ 
+ Any user-written notes.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/site.7.rst

@@ -0,0 +1,67 @@
+
+######
+site.7
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **site**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **site Attributes:**\   \ *installdir*\ , \ *master*\ , \ *xcatdport*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+****************
+site Attributes:
+****************
+
+
+
+\ **installdir**\  (site.value)
+ 
+ The installation directory
+ 
+
+
+\ **master**\  (site.value)
+ 
+ The management node
+ 
+
+
+\ **xcatdport**\  (site.value)
+ 
+ Port used by xcatd daemon on master
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+

docs/source/guides/admin-guides/references/man7/zone.7.rst

@@ -0,0 +1,79 @@
+
+######
+zone.7
+######
+
+.. highlight:: perl
+
+
+****
+NAME
+****
+
+
+\ **zone**\  - a logical object definition in the xCAT database.
+
+
+********
+SYNOPSIS
+********
+
+
+\ **zone Attributes:**\   \ *defaultzone*\ , \ *sshbetweennodes*\ , \ *sshkeydir*\ , \ *usercomment*\ , \ *zonename*\ 
+
+
+***********
+DESCRIPTION
+***********
+
+
+Logical objects of this type are stored in the xCAT database in one or more tables.  Use the following commands
+to manipulate the objects: \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ .  These commands will take care of
+knowing which tables the object attributes should be stored in.  The attribute list below shows, in
+parentheses, what tables each attribute is stored in.
+
+
+****************
+zone Attributes:
+****************
+
+
+
+\ **defaultzone**\  (zone.defaultzone)
+ 
+ If nodes are not assigned to any other zone, they will default to this zone. If value is set to yes or 1.
+ 
+
+
+\ **sshbetweennodes**\  (zone.sshbetweennodes)
+ 
+ Indicates whether passwordless ssh will be setup between the nodes of this zone. Values are yes/1 or no/0. Default is yes.
+ 
+
+
+\ **sshkeydir**\  (zone.sshkeydir)
+ 
+ Directory containing the shared root ssh RSA keys.
+ 
+
+
+\ **usercomment**\  (zone.comments)
+ 
+ Any user-provided notes.
+ 
+
+
+\ **zonename**\  (zone.zonename)
+ 
+ The name of the zone.
+ 
+
+
+
+********
+SEE ALSO
+********
+
+
+\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
+