From b37054d80375110f10740ff51d1774ce4448e617 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 23 Oct 2015 22:56:54 -0400 Subject: [PATCH] commit the man7 man pages generated from perl-xCAT --- .../references/man7/auditlog.7.rst | 115 ++ .../references/man7/boottarget.7.rst | 49 + .../references/man7/eventlog.7.rst | 137 ++ .../references/man7/firmware.7.rst | 67 + .../admin-guides/references/man7/group.7.rst | 1413 ++++++++++++++++ .../admin-guides/references/man7/index.rst | 8 + .../admin-guides/references/man7/kit.7.rst | 103 ++ .../references/man7/kitcomponent.7.rst | 139 ++ .../references/man7/kitrepo.7.rst | 97 ++ .../references/man7/monitoring.7.rst | 73 + .../references/man7/network.7.rst | 155 ++ .../admin-guides/references/man7/node.7.rst | 1449 +++++++++++++++++ .../references/man7/notification.7.rst | 73 + .../references/man7/osdistro.7.rst | 91 ++ .../references/man7/osdistroupdate.7.rst | 79 + .../references/man7/osimage.7.rst | 437 +++++ .../admin-guides/references/man7/policy.7.rst | 103 ++ .../admin-guides/references/man7/rack.7.rst | 85 + .../admin-guides/references/man7/route.7.rst | 85 + .../admin-guides/references/man7/site.7.rst | 67 + .../admin-guides/references/man7/zone.7.rst | 79 + 21 files changed, 4904 insertions(+) create mode 100644 docs/source/guides/admin-guides/references/man7/auditlog.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/boottarget.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/eventlog.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/firmware.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/group.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/index.rst create mode 100644 docs/source/guides/admin-guides/references/man7/kit.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/kitrepo.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/monitoring.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/network.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/node.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/notification.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/osdistro.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/osimage.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/policy.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/rack.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/route.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/site.7.rst create mode 100644 docs/source/guides/admin-guides/references/man7/zone.7.rst diff --git a/docs/source/guides/admin-guides/references/man7/auditlog.7.rst b/docs/source/guides/admin-guides/references/man7/auditlog.7.rst new file mode 100644 index 000000000..16d26347f --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/boottarget.7.rst b/docs/source/guides/admin-guides/references/man7/boottarget.7.rst new file mode 100644 index 000000000..fa8729eb7 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/eventlog.7.rst b/docs/source/guides/admin-guides/references/man7/eventlog.7.rst new file mode 100644 index 000000000..7837a6c39 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/firmware.7.rst b/docs/source/guides/admin-guides/references/man7/firmware.7.rst new file mode 100644 index 000000000..43a6da7cc --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst new file mode 100644 index 000000000..49b4db4f5 --- /dev/null +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -0,0 +1,1413 @@ + +####### +group.7 +####### + +.. highlight:: perl + + +**** +NAME +**** + + +\ **group**\ - a logical object definition in the xCAT database. + + +******** +SYNOPSIS +******** + + +\ **group Attributes:**\ \ *addkcmdline*\ , \ *arch*\ , \ *authdomain*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groupname*\ , \ *grouptype*\ , \ *hcp*\ , \ *height*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *membergroups*\ , \ *members*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nictypes*\ , \ *nimserver*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *serial*\ , \ *serialflow*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *wherevals*\ , \ *xcatmaster*\ + + +*********** +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. + + +***************** +group Attributes: +***************** + + + +\ **addkcmdline**\ (bootparams.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::" + + + +\ **arch**\ (nodetype.arch) + + The hardware architecture of this node. Valid values: x86_64, ppc64, x86, ia64. + + + +\ **authdomain**\ (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 + + + +\ **bmc**\ (ipmi.bmc) + + The hostname of the BMC adapater. + + + +\ **bmcpassword**\ (ipmi.password) + + The BMC password. If not specified, the key=ipmi row in the passwd table is used as the default. + + + +\ **bmcport**\ (ipmi.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 + + + + +\ **bmcusername**\ (ipmi.username) + + The BMC userid. If not specified, the key=ipmi row in the passwd table is used as the default. + + + +\ **cfgmgr**\ (cfgmgt.cfgmgr) + + The name of the configuration manager service. Currently 'chef' and 'puppet' are supported services. + + + +\ **cfgmgtroles**\ (cfgmgt.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. + + + +\ **cfgserver**\ (cfgmgt.cfgserver) + + The xCAT node name of the chef server or puppet master + + + +\ **chain**\ (chain.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=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell. + + + +\ **chassis**\ (nodepos.chassis) + + The BladeCenter chassis the blade is in. + + + +\ **cmdmapping**\ (nodehm.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. + + + +\ **cons**\ (nodehm.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. + + + +\ **conserver**\ (nodehm.conserver) + + The hostname of the machine where the conserver daemon is running. If not set, the default is the xCAT management node. + + + +\ **consoleondemand**\ (nodehm.consoleondemand) + + This overrides the value from site.consoleondemand; (0=no, 1=yes). Default is the result from site.consoleondemand. + + + +\ **cpucount**\ (hwinv.cpucount) + + The number of cpus for the node. + + + +\ **cputype**\ (hwinv.cputype) + + The cpu model name for the node. + + + +\ **currchain**\ (chain.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. + + + +\ **currstate**\ (chain.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. + + + +\ **dhcpinterfaces**\ (servicenode.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 + + + +\ **disksize**\ (hwinv.disksize) + + The size of the disks for the node in GB. + + + +\ **displayname**\ (mpa.displayname) + + Alternative name for BladeCenter chassis. Only used by PCM. + + + +\ **domainadminpassword**\ (domain.adminpassword) + + Allow a node specific indication of Administrative user password for the domain. Most will want to ignore this in favor of passwd table. + + + +\ **domainadminuser**\ (domain.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. + + + +\ **domaintype**\ (domain.type) + + Type, if any, of authentication domain to manipulate. The only recognized value at the moment is activedirectory. + + + +\ **getmac**\ (nodehm.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. + + + +\ **groupname**\ (nodegroup.groupname) + + Name of the group. + + + +\ **grouptype**\ (nodegroup.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. + + + +\ **hcp**\ (ppc.hcp, zvm.hcp) + + The hardware control point for this node (HMC, IVM, Frame or CEC). Do not need to set for BPAs and FSPs. + + or + + The hardware control point for this node. + + + +\ **height**\ (nodepos.height) + + The server height in U(s). + + + +\ **hostcluster**\ (hypervisor.cluster) + + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + + + +\ **hostinterface**\ (hypervisor.interface) + + The definition of interfaces for the hypervisor. The format is [networkname:interfacename:bootprotocol:IP:netmask:gateway] that split with | for each interface + + + +\ **hostmanager**\ (hypervisor.mgr) + + The virtualization specific manager of this hypervisor when applicable + + + +\ **hostnames**\ (hosts.hostnames) + + Hostname aliases added to /etc/hosts for this node. Comma or blank separated list. + + + +\ **hosttype**\ (hypervisor.type) + + The plugin associated with hypervisor specific commands such as revacuate + + + +\ **hwtype**\ (ppc.nodetype, zvm.nodetype, mp.nodetype, mic.nodetype) + + The hardware type of the node. Only can be one of fsp, bpa, cec, frame, ivm, hmc and lpar + + or + + The node type. Valid values: cec (Central Electronic Complex), lpar (logical partition), zvm (z/VM host operating system), and vm (virtual machine). + + or + + The hardware type for mp node. Valid values: mm,cmm, blade. + + or + + The hardware type of the mic node. Generally, it is mic. + + + +\ **id**\ (ppc.id, mp.id) + + For LPARs: the LPAR numeric id; for CECs: the cage number; for Frames: the frame number. + + or + + The slot number of this blade in the BladeCenter chassis. + + + +\ **initrd**\ (bootparams.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) + + + +\ **installnic**\ (noderes.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. + + + +\ **interface**\ (mac.interface) + + The adapter interface name that will be used to install and manage the node. E.g. eth0 (for linux) or en0 (for AIX).) + + + +\ **ip**\ (hosts.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. + + + +\ **iscsipassword**\ (iscsi.passwd) + + The password for the iscsi server containing the boot device for this node. + + + +\ **iscsiserver**\ (iscsi.server) + + The server containing the iscsi boot device for this node. + + + +\ **iscsitarget**\ (iscsi.target) + + The iscsi disk used for the boot device for this node. Filled in by xCAT. + + + +\ **iscsiuserid**\ (iscsi.userid) + + The userid of the iscsi server containing the boot device for this node. + + + +\ **kcmdline**\ (bootparams.kcmdline) + + Arguments to be passed to the kernel + + + +\ **kernel**\ (bootparams.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 + + + +\ **linkports**\ (switches.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. + + + +\ **mac**\ (mac.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"). + + + +\ **membergroups**\ (nodegroup.membergroups) + + This attribute stores a comma-separated list of nodegroups that this nodegroup refers to. This attribute is only used by PCM. + + + +\ **members**\ (nodegroup.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.) + + + +\ **memory**\ (hwinv.memory) + + The size of the memory for the node in MB. + + + +\ **mgt**\ (nodehm.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. + + + +\ **micbridge**\ (mic.bridge) + + The virtual bridge on the host node which the mic connected to. + + + +\ **michost**\ (mic.host) + + The host node which the mic card installed on. + + + +\ **micid**\ (mic.id) + + The device id of the mic node. + + + +\ **miconboot**\ (mic.onboot) + + Set mic to autoboot when mpss start. Valid values: yes|no. Default is yes. + + + +\ **micpowermgt**\ (mic.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=]![corec6=]![pc3=]![pc6=]. e.g. cpufreq=on!corec6=off!pc3=on!pc6=off. Refer to the doc of mic to get more information for power management. + + + +\ **micvlog**\ (mic.vlog) + + Set the Verbose Log to console. Valid values: yes|no. Default is no. + + + +\ **migrationdest**\ (vm.migrationdest) + + A noderange representing candidate destinations for migration (i.e. similar systems, same SAN, or other criteria that xCAT can use + + + +\ **monserver**\ (noderes.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. + + + +\ **mpa**\ (mp.mpa) + + The managment module used to control this blade. + + + +\ **mtm**\ (vpd.mtm) + + The machine type and model number of the node. E.g. 7984-6BU + + + +\ **nameservers**\ (noderes.nameservers) + + An optional node/group specific override for name server list. Most people want to stick to site or network defined nameserver configuration. + + + +\ **netboot**\ (noderes.netboot) + + The type of network booting to use for this node. Valid values: + + + .. code-block:: perl + + 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 + + + + +\ **nfsdir**\ (noderes.nfsdir) + + The path that should be mounted from the NFS server. + + + +\ **nfsserver**\ (noderes.nfsserver) + + The NFS or HTTP server for this node (as known by this node). + + + +\ **nicaliases**\ (nics.nicaliases) + + Comma-separated list of hostname aliases for each NIC. + + + .. code-block:: perl + + Format: eth0!,eth1!| + + For multiple aliases per nic use a space-separated list. + + For example: eth0!moe larry curly,eth1!tom|jerry + + + + +\ **niccustomscripts**\ (nics.niccustomscripts) + + Comma-separated list of custom scripts per NIC. !,!, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts. as the sub attribute + + . + + + +\ **nicextraparams**\ (nics.nicextraparams) + + Comma-separated list of extra parameters that will be used for each NIC configuration. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes. + + If multiple ip addresses are associated with each NIC: + + !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. + + The xCAT object definition commands support to use nicextraparams. as the sub attributes. + + + + +\ **nichostnameprefixes**\ (nics.nichostnameprefixes) + + Comma-separated list of hostname prefixes per NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!,..., for example, eth0!eth0-,ib0!ib- + + If multiple ip addresses are associcated with each NIC: + + !|,!|,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-. + + The xCAT object definition commands support to use nichostnameprefixes. 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 + + + + +\ **nichostnamesuffixes**\ (nics.nichostnamesuffixes) + + Comma-separated list of hostname suffixes per NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!,..., for example, eth0!-eth0,ib0!-ib0 + + If multiple ip addresses are associcated with each NIC: + + !|,!|,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6. + + The xCAT object definition commands support to use nichostnamesuffixes. 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 + + + + +\ **nicips**\ (nics.nicips) + + Comma-separated list of IP addresses per NIC. To specify one ip address per NIC: + + + .. code-block:: perl + + !,!,..., for example, eth0!10.0.0.100,ib0!11.0.0.100 + + To specify multiple ip addresses per NIC: + + !|,!|,..., 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. 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. + + + + +\ **nicnetworks**\ (nics.nicnetworks) + + Comma-separated list of networks connected to each NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!, 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: + + !|,!|, 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. as the sub attributes. + + + + +\ **nictypes**\ (nics.nictypes) + + Comma-separated list of NIC types per NIC. !,!, e.g. eth0!Ethernet,ib0!Infiniband. The xCAT object definition commands support to use nictypes. as the sub attributes. + + + +\ **nimserver**\ (noderes.nimserver) + + Not used for now. The NIM server for this node (as known by this node). + + + +\ **nodetype**\ (nodetype.nodetype) + + A comma-delimited list of characteristics of this node. Valid values: ppc, blade, vm (virtual machine), osi (OS image), mm, mn, rsa, switch. + + + +\ **ondiscover**\ (chain.ondiscover) + + This attribute is currently not used by xCAT. The "nodediscover" operation is always done during node discovery. + + + +\ **os**\ (nodetype.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. + + + +\ **osvolume**\ (storage.osvolume) + + Specification of what storage to place the node OS image onto. Examples include: + + + .. code-block:: perl + + 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) + + + + +\ **otherinterfaces**\ (hosts.otherinterfaces) + + Other IP addresses to add for this node. Format: -:,:,... + + + +\ **ou**\ (domain.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 + + + +\ **parent**\ (ppc.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). + + + +\ **passwd.HMC**\ (ppcdirect.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. + + + +\ **passwd.admin**\ (ppcdirect.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. + + + +\ **passwd.celogin**\ (ppcdirect.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. + + + +\ **passwd.general**\ (ppcdirect.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. + + + +\ **passwd.hscroot**\ (ppcdirect.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. + + + +\ **password**\ (ppchcp.password, mpa.password, websrv.password, switches.sshpassword) + + 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. + + or + + Password to use to access the management module. If not specified, the key=blade row in the passwd table is used as the default. + + or + + Password to use to access the web service. + + or + + 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. + + + +\ **postbootscripts**\ (postscripts.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. + + + +\ **postscripts**\ (postscripts.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. + + + +\ **power**\ (nodehm.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. + + + +\ **pprofile**\ (ppc.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 + + + +\ **prescripts-begin**\ (prescripts.begin) + + The scripts to be run at the beginning of the nodeset(Linux), + + + .. code-block:: perl + + 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) + + + + 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. + + + + +\ **prescripts-end**\ (prescripts.end) + + The scripts to be run at the end of the nodeset(Linux), + + + .. code-block:: perl + + nimnodeset(AIX),or mkdsklsnode(AIX) command. + + The format is the same as the 'begin' column. + + + + +\ **primarynic**\ (noderes.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. + + + +\ **productkey**\ (prodkey.key) + + The product key relevant to the aforementioned node/group and product combination + + + +\ **profile**\ (nodetype.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. + + + +\ **protocol**\ (switches.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. + + + +\ **provmethod**\ (nodetype.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. + + + +\ **rack**\ (nodepos.rack) + + The frame the node is in. + + + +\ **room**\ (nodepos.room) + + The room where the node is located. + + + +\ **routenames**\ (noderes.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. + + + +\ **serial**\ (vpd.serial) + + The serial number of the node. + + + +\ **serialflow**\ (nodehm.serialflow) + + The flow control value of the serial port for this node. For SOL this is typically 'hard'. + + + +\ **serialport**\ (nodehm.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**\ (nodehm.serialspeed) + + The speed of the serial port for this node. For SOL this is typically 19200. + + + +\ **servicenode**\ (noderes.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. + + + +\ **setupconserver**\ (servicenode.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. + + + +\ **setupdhcp**\ (servicenode.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. + + + +\ **setupftp**\ (servicenode.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 + + + +\ **setupipforward**\ (servicenode.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. + + + +\ **setupldap**\ (servicenode.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. + + + +\ **setupnameserver**\ (servicenode.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. + + + +\ **setupnfs**\ (servicenode.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. + + + +\ **setupnim**\ (servicenode.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. + + + +\ **setupntp**\ (servicenode.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. + + + +\ **setupproxydhcp**\ (servicenode.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. + + + +\ **setuptftp**\ (servicenode.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. + + + +\ **sfp**\ (ppc.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. + + + +\ **side**\ (vpd.side) + + - or -. 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 + + + +\ **slot**\ (nodepos.slot) + + The slot number of the blade in the chassis. For PCM, a comma-separated list of slot numbers is stored + + + +\ **slotid**\ (mp.id) + + The slot number of this blade in the BladeCenter chassis. + + + +\ **slots**\ (mpa.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: ,, Where: + + + .. code-block:: perl + + = number of rows of slots in chassis + + = number of columns of slots in chassis + + = set to 0 if slots are vertical, and set to 1 if slots of horizontal + + + + +\ **snmpauth**\ (switches.auth) + + The authentication protocol to use for SNMPv3. SHA is assumed if v3 enabled and this is unspecified + + + +\ **snmppassword**\ (switches.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. + + + +\ **snmpprivacy**\ (switches.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. + + + +\ **snmpusername**\ (switches.username) + + The username to use for SNMPv3 communication, ignored for SNMPv1 + + + +\ **snmpversion**\ (switches.snmpversion) + + The version to use to communicate with switch. SNMPv1 is assumed by default. + + + +\ **storagcontroller**\ (storage.controller) + + The management address to attach/detach new volumes. + + + .. code-block:: perl + + In the scenario involving multiple controllers, this data must be + + passed as argument rather than by table value + + + + +\ **storagetype**\ (storage.type) + + The plugin used to drive storage configuration (e.g. svc) + + + +\ **supernode**\ (ppc.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. + + + +\ **supportedarchs**\ (nodetype.supportedarchs) + + Comma delimited list of architectures this node can execute. + + + +\ **supportproxydhcp**\ (noderes.proxydhcp) + + To specify whether the node supports proxydhcp protocol. Valid values: yes or 1, no or 0. Default value is yes. + + + +\ **switch**\ (switch.switch) + + The switch hostname. + + + +\ **switchinterface**\ (switch.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. + + + +\ **switchport**\ (switch.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 + + + +\ **switchtype**\ (switches.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. + + + +\ **switchvlan**\ (switch.vlan) + + The ID for the tagged vlan that is created on this port using mkvlan and chvlan commands. + + + +\ **termport**\ (nodehm.termport) + + The port number on the terminal server that this node is connected to. + + + +\ **termserver**\ (nodehm.termserver) + + The hostname of the terminal server. + + + +\ **tftpdir**\ (noderes.tftpdir) + + The directory that roots this nodes contents from a tftp and related perspective. Used for NAS offload by using different mountpoints. + + + +\ **tftpserver**\ (noderes.tftpserver) + + The TFTP server for this node (as known by this node). If not set, it defaults to networks.tftpserver. + + + +\ **unit**\ (nodepos.u) + + The vertical position of the node in the frame + + + +\ **urlpath**\ (mpa.urlpath) + + URL path for the Chassis web interface. The full URL is built as follows: / + + + +\ **usercomment**\ (nodegroup.comments) + + Any user-written notes. + + + +\ **userid**\ (zvm.userid) + + The z/VM userID of this node. + + + +\ **username**\ (ppchcp.username, mpa.username, websrv.username, switches.sshusername) + + 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. + + or + + Userid to use to access the management module. + + or + + Userid to use to access the web service. + + or + + 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. + + + +\ **vmbeacon**\ (vm.beacon) + + This flag is used by xCAT to track the state of the identify LED with respect to the VM. + + + +\ **vmbootorder**\ (vm.bootorder) + + Boot sequence (i.e. net,hd) + + + +\ **vmcfgstore**\ (vm.cfgstore) + + Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data + + + +\ **vmcluster**\ (vm.cluster) + + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + + + +\ **vmcpus**\ (vm.cpus) + + Number of CPUs the node should see. + + + +\ **vmhost**\ (vm.host) + + The system that currently hosts the VM + + + +\ **vmmanager**\ (vm.mgr) + + The function manager for the virtual machine + + + +\ **vmmaster**\ (vm.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 + + + +\ **vmmemory**\ (vm.memory) + + Megabytes of memory the VM currently should be set to. + + + +\ **vmnicnicmodel**\ (vm.nicmodel) + + Model of NICs that will be provided to VMs (i.e. e1000, rtl8139, virtio, etc) + + + +\ **vmnics**\ (vm.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. + + + +\ **vmothersetting**\ (vm.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'. + + + +\ **vmphyslots**\ (vm.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'. + + + +\ **vmstorage**\ (vm.storage) + + A list of storage files or devices to be used. i.e. dir:///cluster/vm/ or nfs:///path/to/folder/ + + + +\ **vmstoragecache**\ (vm.storagecache) + + Select caching scheme to employ. E.g. KVM understands 'none', 'writethrough' and 'writeback' + + + +\ **vmstorageformat**\ (vm.storageformat) + + Select disk format to use by default (e.g. raw versus qcow2) + + + +\ **vmstoragemodel**\ (vm.storagemodel) + + Model of storage devices to provide to guest + + + +\ **vmtextconsole**\ (vm.textconsole) + + Tracks the Psuedo-TTY that maps to the serial port or console of a VM + + + +\ **vmvirtflags**\ (vm.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: + + + .. code-block:: perl + + 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] + + + + +\ **vmvncport**\ (vm.vncport) + + Tracks the current VNC display port (currently not meant to be set + + + +\ **webport**\ (websrv.port) + + The port of the web service. + + + +\ **wherevals**\ (nodegroup.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 !~. + + + +\ **xcatmaster**\ (noderes.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. + + + + +******** +SEE ALSO +******** + + +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/index.rst b/docs/source/guides/admin-guides/references/man7/index.rst new file mode 100644 index 000000000..5a40e6834 --- /dev/null +++ b/docs/source/guides/admin-guides/references/man7/index.rst @@ -0,0 +1,8 @@ +man7 +==== + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/docs/source/guides/admin-guides/references/man7/kit.7.rst b/docs/source/guides/admin-guides/references/man7/kit.7.rst new file mode 100644 index 000000000..e6062763f --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst b/docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst new file mode 100644 index 000000000..a5d222d13 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/kitrepo.7.rst b/docs/source/guides/admin-guides/references/man7/kitrepo.7.rst new file mode 100644 index 000000000..e5bf6c359 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/monitoring.7.rst b/docs/source/guides/admin-guides/references/man7/monitoring.7.rst new file mode 100644 index 000000000..b77bae541 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/network.7.rst b/docs/source/guides/admin-guides/references/man7/network.7.rst new file mode 100644 index 000000000..4a59f71ca --- /dev/null +++ b/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 , the keyword 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! 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 "" 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: -. + + + +\ **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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst new file mode 100644 index 000000000..2155da2d6 --- /dev/null +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -0,0 +1,1449 @@ + +###### +node.7 +###### + +.. highlight:: perl + + +**** +NAME +**** + + +\ **node**\ - a logical object definition in the xCAT database. + + +******** +SYNOPSIS +******** + + +\ **node Attributes:**\ \ *addkcmdline*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *arch*\ , \ *authdomain*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groups*\ , \ *hcp*\ , \ *height*\ , \ *hidden*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nictypes*\ , \ *nimserver*\ , \ *node*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *primarysn*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *serial*\ , \ *serialflow*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *status*\ , \ *statustime*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *xcatmaster*\ , \ *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. + + +**************** +node Attributes: +**************** + + + +\ **addkcmdline**\ (bootparams.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::" + + + +\ **appstatus**\ (nodelist.appstatus) + + A comma-delimited list of application status. For example: 'sshd=up,ftp=down,ll=down' + + + +\ **appstatustime**\ (nodelist.appstatustime) + + The date and time when appstatus was updated. + + + +\ **arch**\ (nodetype.arch) + + The hardware architecture of this node. Valid values: x86_64, ppc64, x86, ia64. + + + +\ **authdomain**\ (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 + + + +\ **bmc**\ (ipmi.bmc) + + The hostname of the BMC adapater. + + + +\ **bmcpassword**\ (ipmi.password) + + The BMC password. If not specified, the key=ipmi row in the passwd table is used as the default. + + + +\ **bmcport**\ (ipmi.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 + + + + +\ **bmcusername**\ (ipmi.username) + + The BMC userid. If not specified, the key=ipmi row in the passwd table is used as the default. + + + +\ **cfgmgr**\ (cfgmgt.cfgmgr) + + The name of the configuration manager service. Currently 'chef' and 'puppet' are supported services. + + + +\ **cfgmgtroles**\ (cfgmgt.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. + + + +\ **cfgserver**\ (cfgmgt.cfgserver) + + The xCAT node name of the chef server or puppet master + + + +\ **chain**\ (chain.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=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell. + + + +\ **chassis**\ (nodepos.chassis) + + The BladeCenter chassis the blade is in. + + + +\ **cmdmapping**\ (nodehm.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. + + + +\ **cons**\ (nodehm.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. + + + +\ **conserver**\ (nodehm.conserver) + + The hostname of the machine where the conserver daemon is running. If not set, the default is the xCAT management node. + + + +\ **consoleondemand**\ (nodehm.consoleondemand) + + This overrides the value from site.consoleondemand; (0=no, 1=yes). Default is the result from site.consoleondemand. + + + +\ **cpucount**\ (hwinv.cpucount) + + The number of cpus for the node. + + + +\ **cputype**\ (hwinv.cputype) + + The cpu model name for the node. + + + +\ **currchain**\ (chain.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. + + + +\ **currstate**\ (chain.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. + + + +\ **dhcpinterfaces**\ (servicenode.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 + + + +\ **disksize**\ (hwinv.disksize) + + The size of the disks for the node in GB. + + + +\ **displayname**\ (mpa.displayname) + + Alternative name for BladeCenter chassis. Only used by PCM. + + + +\ **domainadminpassword**\ (domain.adminpassword) + + Allow a node specific indication of Administrative user password for the domain. Most will want to ignore this in favor of passwd table. + + + +\ **domainadminuser**\ (domain.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. + + + +\ **domaintype**\ (domain.type) + + Type, if any, of authentication domain to manipulate. The only recognized value at the moment is activedirectory. + + + +\ **getmac**\ (nodehm.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. + + + +\ **groups**\ (nodelist.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 __. 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. + + + +\ **hcp**\ (ppc.hcp, zvm.hcp) + + The hardware control point for this node (HMC, IVM, Frame or CEC). Do not need to set for BPAs and FSPs. + + or + + The hardware control point for this node. + + + +\ **height**\ (nodepos.height) + + The server height in U(s). + + + +\ **hidden**\ (nodelist.hidden) + + Used to hide fsp and bpa definitions, 1 means not show them when running lsdef and nodels + + + +\ **hostcluster**\ (hypervisor.cluster) + + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + + + +\ **hostinterface**\ (hypervisor.interface) + + The definition of interfaces for the hypervisor. The format is [networkname:interfacename:bootprotocol:IP:netmask:gateway] that split with | for each interface + + + +\ **hostmanager**\ (hypervisor.mgr) + + The virtualization specific manager of this hypervisor when applicable + + + +\ **hostnames**\ (hosts.hostnames) + + Hostname aliases added to /etc/hosts for this node. Comma or blank separated list. + + + +\ **hosttype**\ (hypervisor.type) + + The plugin associated with hypervisor specific commands such as revacuate + + + +\ **hwtype**\ (ppc.nodetype, zvm.nodetype, mp.nodetype, mic.nodetype) + + The hardware type of the node. Only can be one of fsp, bpa, cec, frame, ivm, hmc and lpar + + or + + The node type. Valid values: cec (Central Electronic Complex), lpar (logical partition), zvm (z/VM host operating system), and vm (virtual machine). + + or + + The hardware type for mp node. Valid values: mm,cmm, blade. + + or + + The hardware type of the mic node. Generally, it is mic. + + + +\ **id**\ (ppc.id, mp.id) + + For LPARs: the LPAR numeric id; for CECs: the cage number; for Frames: the frame number. + + or + + The slot number of this blade in the BladeCenter chassis. + + + +\ **initrd**\ (bootparams.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) + + + +\ **installnic**\ (noderes.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. + + + +\ **interface**\ (mac.interface) + + The adapter interface name that will be used to install and manage the node. E.g. eth0 (for linux) or en0 (for AIX).) + + + +\ **ip**\ (hosts.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. + + + +\ **iscsipassword**\ (iscsi.passwd) + + The password for the iscsi server containing the boot device for this node. + + + +\ **iscsiserver**\ (iscsi.server) + + The server containing the iscsi boot device for this node. + + + +\ **iscsitarget**\ (iscsi.target) + + The iscsi disk used for the boot device for this node. Filled in by xCAT. + + + +\ **iscsiuserid**\ (iscsi.userid) + + The userid of the iscsi server containing the boot device for this node. + + + +\ **kcmdline**\ (bootparams.kcmdline) + + Arguments to be passed to the kernel + + + +\ **kernel**\ (bootparams.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 + + + +\ **linkports**\ (switches.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. + + + +\ **mac**\ (mac.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"). + + + +\ **memory**\ (hwinv.memory) + + The size of the memory for the node in MB. + + + +\ **mgt**\ (nodehm.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. + + + +\ **micbridge**\ (mic.bridge) + + The virtual bridge on the host node which the mic connected to. + + + +\ **michost**\ (mic.host) + + The host node which the mic card installed on. + + + +\ **micid**\ (mic.id) + + The device id of the mic node. + + + +\ **miconboot**\ (mic.onboot) + + Set mic to autoboot when mpss start. Valid values: yes|no. Default is yes. + + + +\ **micpowermgt**\ (mic.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=]![corec6=]![pc3=]![pc6=]. e.g. cpufreq=on!corec6=off!pc3=on!pc6=off. Refer to the doc of mic to get more information for power management. + + + +\ **micvlog**\ (mic.vlog) + + Set the Verbose Log to console. Valid values: yes|no. Default is no. + + + +\ **migrationdest**\ (vm.migrationdest) + + A noderange representing candidate destinations for migration (i.e. similar systems, same SAN, or other criteria that xCAT can use + + + +\ **monserver**\ (noderes.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. + + + +\ **mpa**\ (mp.mpa) + + The managment module used to control this blade. + + + +\ **mtm**\ (vpd.mtm) + + The machine type and model number of the node. E.g. 7984-6BU + + + +\ **nameservers**\ (noderes.nameservers) + + An optional node/group specific override for name server list. Most people want to stick to site or network defined nameserver configuration. + + + +\ **netboot**\ (noderes.netboot) + + The type of network booting to use for this node. Valid values: + + + .. code-block:: perl + + 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 + + + + +\ **nfsdir**\ (noderes.nfsdir) + + The path that should be mounted from the NFS server. + + + +\ **nfsserver**\ (noderes.nfsserver) + + The NFS or HTTP server for this node (as known by this node). + + + +\ **nicaliases**\ (nics.nicaliases) + + Comma-separated list of hostname aliases for each NIC. + + + .. code-block:: perl + + Format: eth0!,eth1!| + + For multiple aliases per nic use a space-separated list. + + For example: eth0!moe larry curly,eth1!tom|jerry + + + + +\ **niccustomscripts**\ (nics.niccustomscripts) + + Comma-separated list of custom scripts per NIC. !,!, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts. as the sub attribute + + . + + + +\ **nicextraparams**\ (nics.nicextraparams) + + Comma-separated list of extra parameters that will be used for each NIC configuration. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes. + + If multiple ip addresses are associated with each NIC: + + !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. + + The xCAT object definition commands support to use nicextraparams. as the sub attributes. + + + + +\ **nichostnameprefixes**\ (nics.nichostnameprefixes) + + Comma-separated list of hostname prefixes per NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!,..., for example, eth0!eth0-,ib0!ib- + + If multiple ip addresses are associcated with each NIC: + + !|,!|,..., for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-. + + The xCAT object definition commands support to use nichostnameprefixes. 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 + + + + +\ **nichostnamesuffixes**\ (nics.nichostnamesuffixes) + + Comma-separated list of hostname suffixes per NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!,..., for example, eth0!-eth0,ib0!-ib0 + + If multiple ip addresses are associcated with each NIC: + + !|,!|,..., for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6. + + The xCAT object definition commands support to use nichostnamesuffixes. 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 + + + + +\ **nicips**\ (nics.nicips) + + Comma-separated list of IP addresses per NIC. To specify one ip address per NIC: + + + .. code-block:: perl + + !,!,..., for example, eth0!10.0.0.100,ib0!11.0.0.100 + + To specify multiple ip addresses per NIC: + + !|,!|,..., 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. 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. + + + + +\ **nicnetworks**\ (nics.nicnetworks) + + Comma-separated list of networks connected to each NIC. + + + .. code-block:: perl + + If only one ip address is associated with each NIC: + + !,!, 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: + + !|,!|, 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. as the sub attributes. + + + + +\ **nictypes**\ (nics.nictypes) + + Comma-separated list of NIC types per NIC. !,!, e.g. eth0!Ethernet,ib0!Infiniband. The xCAT object definition commands support to use nictypes. as the sub attributes. + + + +\ **nimserver**\ (noderes.nimserver) + + Not used for now. The NIM server for this node (as known by this node). + + + +\ **node**\ (nodelist.node) + + The hostname of a node in the cluster. + + + +\ **nodetype**\ (nodetype.nodetype) + + A comma-delimited list of characteristics of this node. Valid values: ppc, blade, vm (virtual machine), osi (OS image), mm, mn, rsa, switch. + + + +\ **ondiscover**\ (chain.ondiscover) + + This attribute is currently not used by xCAT. The "nodediscover" operation is always done during node discovery. + + + +\ **os**\ (nodetype.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. + + + +\ **osvolume**\ (storage.osvolume) + + Specification of what storage to place the node OS image onto. Examples include: + + + .. code-block:: perl + + 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) + + + + +\ **otherinterfaces**\ (hosts.otherinterfaces) + + Other IP addresses to add for this node. Format: -:,:,... + + + +\ **ou**\ (domain.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 + + + +\ **parent**\ (ppc.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). + + + +\ **passwd.HMC**\ (ppcdirect.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. + + + +\ **passwd.admin**\ (ppcdirect.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. + + + +\ **passwd.celogin**\ (ppcdirect.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. + + + +\ **passwd.general**\ (ppcdirect.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. + + + +\ **passwd.hscroot**\ (ppcdirect.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. + + + +\ **password**\ (ppchcp.password, mpa.password, websrv.password, switches.sshpassword) + + 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. + + or + + Password to use to access the management module. If not specified, the key=blade row in the passwd table is used as the default. + + or + + Password to use to access the web service. + + or + + 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. + + + +\ **postbootscripts**\ (postscripts.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. + + + +\ **postscripts**\ (postscripts.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. + + + +\ **power**\ (nodehm.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. + + + +\ **pprofile**\ (ppc.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 + + + +\ **prescripts-begin**\ (prescripts.begin) + + The scripts to be run at the beginning of the nodeset(Linux), + + + .. code-block:: perl + + 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) + + + + 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. + + + + +\ **prescripts-end**\ (prescripts.end) + + The scripts to be run at the end of the nodeset(Linux), + + + .. code-block:: perl + + nimnodeset(AIX),or mkdsklsnode(AIX) command. + + The format is the same as the 'begin' column. + + + + +\ **primarynic**\ (noderes.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. + + + +\ **primarysn**\ (nodelist.primarysn) + + Not used currently. The primary servicenode, used by this node. + + + +\ **productkey**\ (prodkey.key) + + The product key relevant to the aforementioned node/group and product combination + + + +\ **profile**\ (nodetype.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. + + + +\ **protocol**\ (switches.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. + + + +\ **provmethod**\ (nodetype.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. + + + +\ **rack**\ (nodepos.rack) + + The frame the node is in. + + + +\ **room**\ (nodepos.room) + + The room where the node is located. + + + +\ **routenames**\ (noderes.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. + + + +\ **serial**\ (vpd.serial) + + The serial number of the node. + + + +\ **serialflow**\ (nodehm.serialflow) + + The flow control value of the serial port for this node. For SOL this is typically 'hard'. + + + +\ **serialport**\ (nodehm.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**\ (nodehm.serialspeed) + + The speed of the serial port for this node. For SOL this is typically 19200. + + + +\ **servicenode**\ (noderes.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. + + + +\ **setupconserver**\ (servicenode.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. + + + +\ **setupdhcp**\ (servicenode.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. + + + +\ **setupftp**\ (servicenode.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 + + + +\ **setupipforward**\ (servicenode.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. + + + +\ **setupldap**\ (servicenode.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. + + + +\ **setupnameserver**\ (servicenode.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. + + + +\ **setupnfs**\ (servicenode.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. + + + +\ **setupnim**\ (servicenode.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. + + + +\ **setupntp**\ (servicenode.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. + + + +\ **setupproxydhcp**\ (servicenode.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. + + + +\ **setuptftp**\ (servicenode.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. + + + +\ **sfp**\ (ppc.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. + + + +\ **side**\ (vpd.side) + + - or -. 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 + + + +\ **slot**\ (nodepos.slot) + + The slot number of the blade in the chassis. For PCM, a comma-separated list of slot numbers is stored + + + +\ **slotid**\ (mp.id) + + The slot number of this blade in the BladeCenter chassis. + + + +\ **slots**\ (mpa.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: ,, Where: + + + .. code-block:: perl + + = number of rows of slots in chassis + + = number of columns of slots in chassis + + = set to 0 if slots are vertical, and set to 1 if slots of horizontal + + + + +\ **snmpauth**\ (switches.auth) + + The authentication protocol to use for SNMPv3. SHA is assumed if v3 enabled and this is unspecified + + + +\ **snmppassword**\ (switches.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. + + + +\ **snmpprivacy**\ (switches.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. + + + +\ **snmpusername**\ (switches.username) + + The username to use for SNMPv3 communication, ignored for SNMPv1 + + + +\ **snmpversion**\ (switches.snmpversion) + + The version to use to communicate with switch. SNMPv1 is assumed by default. + + + +\ **status**\ (nodelist.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**\ (nodelist.statustime) + + The data and time when the status was updated. + + + +\ **storagcontroller**\ (storage.controller) + + The management address to attach/detach new volumes. + + + .. code-block:: perl + + In the scenario involving multiple controllers, this data must be + + passed as argument rather than by table value + + + + +\ **storagetype**\ (storage.type) + + The plugin used to drive storage configuration (e.g. svc) + + + +\ **supernode**\ (ppc.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. + + + +\ **supportedarchs**\ (nodetype.supportedarchs) + + Comma delimited list of architectures this node can execute. + + + +\ **supportproxydhcp**\ (noderes.proxydhcp) + + To specify whether the node supports proxydhcp protocol. Valid values: yes or 1, no or 0. Default value is yes. + + + +\ **switch**\ (switch.switch) + + The switch hostname. + + + +\ **switchinterface**\ (switch.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. + + + +\ **switchport**\ (switch.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 + + + +\ **switchtype**\ (switches.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. + + + +\ **switchvlan**\ (switch.vlan) + + The ID for the tagged vlan that is created on this port using mkvlan and chvlan commands. + + + +\ **termport**\ (nodehm.termport) + + The port number on the terminal server that this node is connected to. + + + +\ **termserver**\ (nodehm.termserver) + + The hostname of the terminal server. + + + +\ **tftpdir**\ (noderes.tftpdir) + + The directory that roots this nodes contents from a tftp and related perspective. Used for NAS offload by using different mountpoints. + + + +\ **tftpserver**\ (noderes.tftpserver) + + The TFTP server for this node (as known by this node). If not set, it defaults to networks.tftpserver. + + + +\ **unit**\ (nodepos.u) + + The vertical position of the node in the frame + + + +\ **updatestatus**\ (nodelist.updatestatus) + + The current node update status. Valid states are synced, out-of-sync,syncing,failed. + + + +\ **updatestatustime**\ (nodelist.updatestatustime) + + The date and time when the updatestatus was updated. + + + +\ **urlpath**\ (mpa.urlpath) + + URL path for the Chassis web interface. The full URL is built as follows: / + + + +\ **usercomment**\ (nodelist.comments) + + Any user-written notes. + + + +\ **userid**\ (zvm.userid) + + The z/VM userID of this node. + + + +\ **username**\ (ppchcp.username, mpa.username, websrv.username, switches.sshusername) + + 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. + + or + + Userid to use to access the management module. + + or + + Userid to use to access the web service. + + or + + 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. + + + +\ **vmbeacon**\ (vm.beacon) + + This flag is used by xCAT to track the state of the identify LED with respect to the VM. + + + +\ **vmbootorder**\ (vm.bootorder) + + Boot sequence (i.e. net,hd) + + + +\ **vmcfgstore**\ (vm.cfgstore) + + Optional location for persistant storage separate of emulated hard drives for virtualization solutions that require persistant store to place configuration data + + + +\ **vmcluster**\ (vm.cluster) + + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + + + +\ **vmcpus**\ (vm.cpus) + + Number of CPUs the node should see. + + + +\ **vmhost**\ (vm.host) + + The system that currently hosts the VM + + + +\ **vmmanager**\ (vm.mgr) + + The function manager for the virtual machine + + + +\ **vmmaster**\ (vm.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 + + + +\ **vmmemory**\ (vm.memory) + + Megabytes of memory the VM currently should be set to. + + + +\ **vmnicnicmodel**\ (vm.nicmodel) + + Model of NICs that will be provided to VMs (i.e. e1000, rtl8139, virtio, etc) + + + +\ **vmnics**\ (vm.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. + + + +\ **vmothersetting**\ (vm.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'. + + + +\ **vmphyslots**\ (vm.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'. + + + +\ **vmstorage**\ (vm.storage) + + A list of storage files or devices to be used. i.e. dir:///cluster/vm/ or nfs:///path/to/folder/ + + + +\ **vmstoragecache**\ (vm.storagecache) + + Select caching scheme to employ. E.g. KVM understands 'none', 'writethrough' and 'writeback' + + + +\ **vmstorageformat**\ (vm.storageformat) + + Select disk format to use by default (e.g. raw versus qcow2) + + + +\ **vmstoragemodel**\ (vm.storagemodel) + + Model of storage devices to provide to guest + + + +\ **vmtextconsole**\ (vm.textconsole) + + Tracks the Psuedo-TTY that maps to the serial port or console of a VM + + + +\ **vmvirtflags**\ (vm.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: + + + .. code-block:: perl + + 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] + + + + +\ **vmvncport**\ (vm.vncport) + + Tracks the current VNC display port (currently not meant to be set + + + +\ **webport**\ (websrv.port) + + The port of the web service. + + + +\ **xcatmaster**\ (noderes.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. + + + +\ **zonename**\ (nodelist.zonename) + + The name of the zone to which the node is currently assigned. If undefined, then it is not assigned to any zone. + + + + +******** +SEE ALSO +******** + + +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/notification.7.rst b/docs/source/guides/admin-guides/references/man7/notification.7.rst new file mode 100644 index 000000000..c93c46647 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/osdistro.7.rst b/docs/source/guides/admin-guides/references/man7/osdistro.7.rst new file mode 100644 index 000000000..f1a87361c --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst b/docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst new file mode 100644 index 000000000..17850864c --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/osimage.7.rst b/docs/source/guides/admin-guides/references/man7/osimage.7.rst new file mode 100644 index 000000000..a97ebd1fa --- /dev/null +++ b/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//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:///". If you want to use the node's "xcatmaster" (its SN or MN), can be left blank. For example, "nfs:///" 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 :. 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: "" 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:" 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 ""; see the xCAT Statelite documentation for the xCAT defined format of this configuration file.For Ubuntu, besides "" or "s:", 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:" which contains the disk name(s) to partition and "s:d:" 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:" which contains the additional pressed entries in "d-i ..." form and "s:c:" 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//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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/policy.7.rst b/docs/source/guides/admin-guides/references/man7/policy.7.rst new file mode 100644 index 000000000..5c9709647 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/rack.7.rst b/docs/source/guides/admin-guides/references/man7/rack.7.rst new file mode 100644 index 000000000..1403a7da0 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/route.7.rst b/docs/source/guides/admin-guides/references/man7/route.7.rst new file mode 100644 index 000000000..1cbef8fc8 --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/site.7.rst b/docs/source/guides/admin-guides/references/man7/site.7.rst new file mode 100644 index 000000000..c617ecd0f --- /dev/null +++ b/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)**\ + diff --git a/docs/source/guides/admin-guides/references/man7/zone.7.rst b/docs/source/guides/admin-guides/references/man7/zone.7.rst new file mode 100644 index 000000000..7dca58ceb --- /dev/null +++ b/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)**\ +