group.7
NAME
group - a logical object definition in the xCAT database.
SYNOPSIS
group Attributes: addkcmdline, arch, authdomain, authkey, authtype, bmc, bmcpassword, bmcport, bmcusername, bmcvlantag, cfgmgr, cfgmgtroles, cfgserver, chain, chassis, cmdmapping, community, cons, conserver, consoleenabled, consoleondemand, consport, cpucount, cputype, currchain, currstate, dhcpinterfaces, disksize, displayname, dockercpus, dockerflag, dockerhost, dockermemory, dockernics, 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, nicdevices, nicextraparams, nichostnameprefixes, nichostnamesuffixes, nicips, nicnetworks, nicsadapter, nictypes, nimserver, nodetype, ondiscover, os, osvolume, otherinterfaces, ou, outlet, parent, passwd.HMC, passwd.admin, passwd.celogin, passwd.general, passwd.hscroot, password, pdu, pdutype, postbootscripts, postscripts, power, pprofile, prescripts-begin, prescripts-end, primarynic, privkey, privtype, productkey, profile, protocol, provmethod, rack, room, routenames, seclevel, serial, serialflow, serialport, serialspeed, servicenode, setupconserver, setupdhcp, setupftp, setupipforward, setupldap, setupnameserver, setupnfs, setupnim, setupntp, setupproxydhcp, setuptftp, sfp, side, slot, slotid, slots, snmpauth, snmppassword, snmpprivacy, snmpuser, snmpusername, snmpversion, storagcontroller, storagetype, supernode, supportedarchs, supportproxydhcp, switch, switchinterface, switchport, switchtype, switchvlan, syslog, 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 kernel options for os provision process (no prefix) or the provisioned os (with prefix “R::”). Multiple options should be delimited with spaces(” “) and surrounded with quotes. To have the same option used for os provision process and for provisioned os, specify that option with and without the prefix: addkcmdline=”R::display=3 display=3”
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
authkey (pdu.authkey)
The authentication passphrase for SNMPv3
authtype (pdu.authtype)
The authentication protocol(MD5|SHA) to use for SNMPv3.
bmc (ipmi.bmc, openbmc.bmc)
The hostname of the BMC adapter.
or
The hostname of the BMC adapter.
bmcpassword (ipmi.password, openbmc.password)
The BMC password. If not specified, the key=ipmi row in the passwd table is used as the default.
or
The BMC password. If not specified, the key=openbmc row in the passwd table is used as the default.
bmcport (ipmi.bmcport)
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, openbmc.username)
The BMC userid. If not specified, the key=ipmi row in the passwd table is used as the default.
or
The BMC userid. If not specified, the key=openbmc row in the passwd table is used as the default.
bmcvlantag (ipmi.taggedvlan, openbmc.taggedvlan)
bmcsetup script will configure the network interface of the BMC to be tagged to the VLAN specified.
or
bmcsetup script will configure the network interface of the BMC to be tagged to the VLAN specified.
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 for the first time. (xCAT and the DHCP server do not recognize the MAC address of the node when xCAT initializes the discovery process.) The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=<cmd>, runimage=<URL>, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=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.
community (pdu.community)
The community string to use for SNMPv1/v2
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.
consoleenabled (nodehm.consoleenabled)
A flag field to indicate whether the node is registered in the console server. If ‘1’, console is enabled, if not set, console is not enabled.
consoleondemand (nodehm.consoleondemand)
This overrides the value from site.consoleondemand. Set to ‘yes’, ‘no’, ‘1’ (equivalent to ‘yes’), or ‘0’ (equivalent to ‘no’). If not set, the default is the value from site.consoleondemand.
consport (openbmc.consport)
The console port for OpenBMC.
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.
dockercpus (vm.cpus)
Number of CPUs the node should see.
dockerflag (vm.othersettings)
- This is a semicolon-delimited list of key-value pairs to be included in a vmx file of VMware or KVM. DO NOT use ‘chdef <node> -p|-m vmothersetting=…’ to add options to it or delete options from it because chdef uses commas, not semicolons, to separate items.
- Hugepage on POWER systems:
Specify the hugepage and/or bsr (Barrier Synchronization Register) values, e.g., ‘hugepage:1,bsr:2’.
- KVM CPU mode:
Specify how the host CPUs are utilized, e.g., ‘cpumode:host-passthrough’, ‘cpumode:host-model’. With the passthrough mode, the performance of x86 VMs can be improved significantly.
- KVM CPU pinning:
Specify which host CPUs are used, e.g., ‘vcpupin:’0-15,^8’, where ‘-’ denotes the range and ‘^’ denotes exclusion. This option allows a comma-delimited list.
- KVM memory binding:
Specify which nodes that host memory are used, e.g., ‘membind:0’, where the memory in node0 of the hypervisor is used. /sys/devices/system/node has node0 and node8 on some POWER systems, node0 and node1 on some x86_64 systems. This option allows a guest VM to access specific memory regions.
- PCI passthrough:
PCI devices can be assigned to a virtual machine for exclusive usage, e.g., ‘devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0’. A PCI device can also be expressed as ‘devpassthrough:0001:01:00.1’. The devices are put in a comma-delimited list. The PCI device names can be obtained by running virsh nodedev-list on the host.
- VM machine type:
Specify a machine type for VM creation on the host, e.g., ‘machine:pc’. Typical machine types are pc, q35, and pseries.
dockerhost (vm.host)
The system that currently hosts the VM
dockermemory (vm.memory)
Megabytes of memory the VM currently should be set to.
dockernics (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.
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)
Static or Dynamic. A static group is defined to contain a specific set of cluster nodes. A dynamic node group is one that has its members determined by specifying a selection criteria for node attributes.
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)
(Deprecated, use addkcmdline instead) 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…”. 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:04:05:0F!node6-eth1”). If there are multiple nics connected to Management Network(usually for bond), in order to make sure the OS deployment finished successfully, the macs of those nics must be able to resolve to same IP address. First, users have to create alias of the node for each mac in the Management Network through either: 1. adding the alias into /etc/hosts for the node directly or: 2. setting the alias to the “hostnames” attribute and then run “makehost” against the node. Then, configure the “mac” attribute of the node like “mac1!node|mac2!node-alias”. For the first mac address (mac1 in the example) set in “mac” attribute, do not need to set a “node name” string for it since the nodename of the node will be used for it by default.
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: openbmc, 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=<on|off>]![corec6=<on|off>]![pc3=<on|off>]![pc6=<on|off>]. e.g. cpufreq=on!corec6=off!pc3=on!pc6=off. Refer to the doc of mic to get more information for power management.
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 management 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:
Arch OS valid netboot options x86, x86_64 ALL pxe, xnba ppc64 <=rhel6, <=sles11.3 yaboot ppc64 >=rhels7, >=sles11.4 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.
- Format: eth0!<alias list>,eth1!<alias1 list>|<alias2 list>
For multiple aliases per nic use a space-separated list.
For example: eth0!moe larry curly,eth1!tom|jerry
niccustomscripts (nics.niccustomscripts)
Comma-separated list of custom scripts per NIC. <nic1>!<script1>,<nic2>!<script2>, e.g. eth0!configeth eth0, ib0!configib ib0. The xCAT object definition commands support to use niccustomscripts.<nicname> as the sub attribute .
nicdevices (nics.nicdevices)
Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . <nic1>!<dev1>|<dev3>,<nic2>!<dev2>, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices.<nicname> as the sub attributes.
nicextraparams (nics.nicextraparams)
- Comma-separated list of extra parameters that will be used for each NIC configuration.
- If only one ip address is associated with each NIC:
<nic1>!<param1=value1 param2=value2>,<nic2>!<param3=value3>, for example, eth0!MTU=1500,ib0!MTU=65520 CONNECTED_MODE=yes.
- If multiple ip addresses are associated with each NIC:
<nic1>!<param1=value1 param2=value2>|<param3=value3>,<nic2>!<param4=value4 param5=value5>|<param6=value6>, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes.
- The semicolon separator is needed if there are multiple values for extra parameters:
bond0!BONDING_OPTS=lacp_rate=1;miimon=100;mode=802.3ad
The xCAT object definition commands support to use nicextraparams.<nicname> as the sub attributes.
nichostnameprefixes (nics.nichostnameprefixes)
- Comma-separated list of hostname prefixes per NIC.
- If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,…, for example, eth0!eth0-,ib0!ib-
- If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,…, for example, eth0!eth0-|eth0-ipv6i-,ib0!ib-|ib-ipv6-.
The xCAT object definition commands support to use nichostnameprefixes.<nicname> as the sub attributes. Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9) and minus sign (-). 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.
- If only one ip address is associated with each NIC:
<nic1>!<ext1>,<nic2>!<ext2>,…, for example, eth0!-eth0,ib0!-ib0
- If multiple ip addresses are associated with each NIC:
<nic1>!<ext1>|<ext2>,<nic2>!<ext1>|<ext2>,…, for example, eth0!-eth0|-eth0-ipv6,ib0!-ib0|-ib0-ipv6.
The xCAT object definition commands support to use nichostnamesuffixes.<nicname> as the sub attributes.
Note: According to DNS rules a hostname must be a text string up to 24 characters drawn from the alphabet (A-Z), digits (0-9) and minus sign (-). 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:
<nic1>!<ip1>,<nic2>!<ip2>,…, for example, eth0!10.0.0.100,ib0!11.0.0.100
- To specify multiple ip addresses per NIC:
<nic1>!<ip1>|<ip2>,<nic2>!<ip1>|<ip2>,…, for example, eth0!10.0.0.100|fd55::214:5eff:fe15:849b,ib0!11.0.0.100|2001::214:5eff:fe15:849a. The xCAT object definition commands support to use nicips.<nicname> as the sub attributes.
Note: The primary IP address must also be stored in the hosts.ip attribute. The nichostnamesuffixes should specify one hostname suffix for each ip address.
nicnetworks (nics.nicnetworks)
- Comma-separated list of networks connected to each NIC.
- If only one ip address is associated with each NIC:
<nic1>!<network1>,<nic2>!<network2>, for example, eth0!10_0_0_0-255_255_0_0, ib0!11_0_0_0-255_255_0_0
- If multiple ip addresses are associated with each NIC:
<nic1>!<network1>|<network2>,<nic2>!<network1>|<network2>, for example, eth0!10_0_0_0-255_255_0_0|fd55:faaf:e1ab:336::/64,ib0!11_0_0_0-255_255_0_0|2001:db8:1:0::/64. The xCAT object definition commands support to use nicnetworks.<nicname> as the sub attributes.
nicsadapter (nics.nicsadapter)
Comma-separated list of NIC information collected by getadapter. <nic1>!<param1=value1 param2=value2>,<nic2>!<param4=value4 param5=value5>, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face
nictypes (nics.nictypes)
Comma-separated list of NIC types per NIC. <nic1>!<type1>,<nic2>!<type2>, e.g. eth0!Ethernet,ib0!Infiniband. The xCAT object definition commands support to use nictypes.<nicname> as the sub attributes.
nimserver (noderes.nimserver)
Not used for now. The NIM server for this node (as known by this node).
nodetype (nodetype.nodetype, pdu.nodetype)
A comma-delimited list of characteristics of this node. Valid values: ppc, blade, vm (virtual machine), osi (OS image), mm, mn, rsa, switch.
or
The node type should be pdu
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*, alma*, rocky*,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:
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: -<ext>:<ip>,<intfhostname>:<ip>,…
ou (domain.ou)
For an LDAP described machine account (i.e. Active Directory), the organizational unit to place the system. If not set, defaults to cn=Computers,dc=your,dc=domain
outlet (pdu.outlet)
The pdu outlet count
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, pdu.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
or
The remote login password. It can be for ssh or telnet. If it is for telnet, 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.
pdu (pduoutlet.pdu)
a comma-separated list of outlet number for each PDU, ex: pdu1:outlet1,pdu2:outlet1
pdutype (pdu.pdutype)
The type of pdu
postbootscripts (postscripts.postbootscripts)
Comma separated list of scripts that should be run on this node after diskful 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. Please note that the postbootscripts specified for “xcatdefaults” will be assigned to node automatically, they can not be removed from “postbootscripts” attribute of a node with “chdef -m” command
postscripts (postscripts.postscripts)
Comma separated list of scripts that should be run on this node after diskful 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. Please note that the postscripts specified for “xcatdefaults” will be assigned to node automatically, they can not be removed from “postscripts” attribute of a node with “chdef -m” command
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), 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), 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.
privkey (pdu.privkey)
The privacy passphrase to use for SNMPv3.
privtype (pdu.privtype)
The privacy protocol(AES|DES) to use for SNMPv3.
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)
Protocol 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.
seclevel (pdu.seclevel)
The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3.
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 console service on this service node? Valid values: 0, 1, or 2. If 0, it does not change the current state of the service. If 1, configures and starts conserver daemon. If 2, configures and starts goconserver daemon.
setupdhcp (servicenode.dhcpserver)
Do we set up DHCP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, runs makedhcp -n. If 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:1 or 0. If 1, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If 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:1 or 0. If 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:1 or 0. If 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, 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 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:1 or 0.If 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:1 or 0. If 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:1 or 0. If 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: 1 or 0. If 1, 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:1 or 0. If 1, configures and starts atftp. If 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)
<BPA>-<port> or <FSP>-<port>. The side information for the BPA/FSP. The side attribute refers to which BPA/FSP, A or B, which is determined by the slot value returned from lsslp command. It also lists the physical port within each BPA/FSP which is determined by the IP address order from the lsslp response. This information is used internally when communicating with the BPAs/FSPs
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: <slot rows>,<slot columns>,<slot orientation> Where:
<slot rows> = number of rows of slots in chassis <slot columns> = number of columns of slots in chassis <slot orientation> = set to 0 if slots are vertical, and set to 1 if slots of horizontal
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 string 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.
snmpuser (pdu.snmpuser)
The username to use for SNMPv3 communication, ignored for SNMPv1
snmpusername (switches.username)
The username to use for SNMPv3 communication, ignored for SNMPv1
snmpversion (pdu.snmpversion, switches.snmpversion)
The version to use to communicate with switch. SNMPv1 is assumed by default.
or
The version to use to communicate with switch. SNMPv1 is assumed by default.
storagcontroller (storage.controller)
The management address to attach/detach new volumes. In the scenario involving multiple controllers, this data must be passed as argument rather than by table value
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 switch. 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.
syslog (noderes.syslog)
To configure how to configure syslog for compute node. Valid values:blank(not set), ignore. blank - run postscript syslog; ignore - do NOT run postscript syslog
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: <hostname>/<urlpath>
usercomment (nodegroup.comments)
Any user-written notes.
userid (zvm.userid)
The z/VM userID of this node.
username (ppchcp.username, mpa.username, websrv.username, pdu.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
or
The remote login user name. It can be for ssh or telnet. If it is for telnet, 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 persistent storage separate of emulated hard drives for virtualization solutions that require persistent 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 is a semicolon-delimited list of key-value pairs to be included in a vmx file of VMware or KVM. DO NOT use ‘chdef <node> -p|-m vmothersetting=…’ to add options to it or delete options from it because chdef uses commas, not semicolons, to separate items.
- Hugepage on POWER systems:
Specify the hugepage and/or bsr (Barrier Synchronization Register) values, e.g., ‘hugepage:1,bsr:2’.
- KVM CPU mode:
Specify how the host CPUs are utilized, e.g., ‘cpumode:host-passthrough’, ‘cpumode:host-model’. With the passthrough mode, the performance of x86 VMs can be improved significantly.
- KVM CPU pinning:
Specify which host CPUs are used, e.g., ‘vcpupin:’0-15,^8’, where ‘-’ denotes the range and ‘^’ denotes exclusion. This option allows a comma-delimited list.
- KVM memory binding:
Specify which nodes that host memory are used, e.g., ‘membind:0’, where the memory in node0 of the hypervisor is used. /sys/devices/system/node has node0 and node8 on some POWER systems, node0 and node1 on some x86_64 systems. This option allows a guest VM to access specific memory regions.
- PCI passthrough:
PCI devices can be assigned to a virtual machine for exclusive usage, e.g., ‘devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0’. A PCI device can also be expressed as ‘devpassthrough:0001:01:00.1’. The devices are put in a comma-delimited list. The PCI device names can be obtained by running virsh nodedev-list on the host.
- VM machine type:
Specify a machine type for VM creation on the host, e.g., ‘machine:pc’. Typical machine types are pc, q35, and pseries.
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, reference manpage for ‘lsvm’.
vmstorage (vm.storage)
A list of storage files or devices to be used. i.e. dir:///cluster/vm/<nodename> or nfs://<server>/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:
- 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)