diff --git a/docs/source/guides/admin-guides/references/man1/addkit.1.rst b/docs/source/guides/admin-guides/references/man1/addkit.1.rst index ee49d089f..7c64c139e 100644 --- a/docs/source/guides/admin-guides/references/man1/addkit.1.rst +++ b/docs/source/guides/admin-guides/references/man1/addkit.1.rst @@ -21,9 +21,9 @@ SYNOPSIS \ **addkit**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] -\ **addkit**\ [\ **-i | -**\ **-inspection**\ ] \ *kitlist*\ +\ **addkit**\ [\ **-i | -**\ **-inspection**\ ] \ *kitlist*\ -\ **addkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-p | -**\ **-path**\ \ *path*\ ] \ *kitlist*\ +\ **addkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-p | -**\ **-path**\ \ *path*\ ] \ *kitlist*\ *********** @@ -43,40 +43,40 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. + - -\ **-i|-**\ **-inspection**\ - +\ **-i|-**\ **-inspection**\ + Show the summary of the given kits + - -\ **-p|-**\ **-path**\ \ *path*\ - +\ **-p|-**\ **-path**\ \ *path*\ + The destination directory to which the contents of the kit tarfiles and/or kit deploy directories will be copied. When this option is not specified, the default destination directory will be formed from the installdir site attribute with ./kits subdirectory. + - -\ *kitlist*\ - +\ *kitlist*\ + A comma delimited list of kit_tarball_files or kit_deploy_directories to be added to the xCAT environment. Each entry can be an absolute or relative path. See xCAT documentation for more information on building kits. - + diff --git a/docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst b/docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst index 698c643c5..16a43358a 100644 --- a/docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **addkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] -\ **addkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-a | -**\ **-adddeps**\ ] [\ **-f | -**\ **-force**\ ] [\ **-n | -**\ **-noupgrade**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ +\ **addkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-a | -**\ **-adddeps**\ ] [\ **-f | -**\ **-force**\ ] [\ **-n | -**\ **-noupgrade**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ *********** @@ -40,60 +40,60 @@ OPTIONS -\ **-a|-**\ **-adddeps**\ - +\ **-a|-**\ **-adddeps**\ + Assign kitcomponent dependencies to the osimage. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Add kit component to osimage even if there is a mismatch in OS, version, arch, serverrole, or kitcompdeps + - -\ **-i**\ \ *osimage*\ - +\ **-i**\ \ *osimage*\ + The osimage name that the kit component is assigning to. + - -\ **-n|-**\ **-noupgrade**\ - +\ **-n|-**\ **-noupgrade**\ + 1. Allow multiple versions of kitcomponent to be installed into the osimage, instead of kitcomponent upgrade. - + 2. Kit components added by addkitcomp -n will be installed separately behind all other ones which have been added. + - -\ **-**\ **-noscripts**\ - +\ **-**\ **-noscripts**\ + Do not add kitcomponent's postbootscripts to osimage + - -\ *kitcompname_list*\ - +\ *kitcompname_list*\ + A comma-delimited list of valid full kit component names or kit component basenames that are to be added to the osimage. - + diff --git a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst index 92be62696..238924d21 100644 --- a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst @@ -23,7 +23,7 @@ SYNOPSIS \ **bmcdiscover**\ [\ **-v | -**\ **-version**\ ] -\ **bmcdiscover**\ [\ **-**\ **-sn**\ \ *SN_nodename*\ ] [\ **-s**\ \ *scan_method*\ ] [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] [\ **-z**\ ] [\ **-w**\ ] \ **-**\ **-range**\ \ *ip_ranges*\ +\ **bmcdiscover**\ [\ **-**\ **-sn**\ \ *SN_nodename*\ ] [\ **-s**\ \ *scan_method*\ ] [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] [\ **-z**\ ] [\ **-w**\ ] \ **-**\ **-range**\ \ *ip_ranges*\ *********** @@ -46,64 +46,64 @@ OPTIONS -\ **-**\ **-range**\ - +\ **-**\ **-range**\ + Specify one or more IP ranges acceptable to nmap. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), Ip range with "-" (10.1.2.0-100) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the \ **bmcdiscover**\ command may take a long time to return. + - -\ **-**\ **-sn**\ - +\ **-**\ **-sn**\ + Specify one or more service nodes on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, bmcdiscover will be dispatched to the specified SNs. Then, the nodename of the service node that 'bmcdiscover' is running on will be set to the 'servicenode' attribute of the discovered BMC node. + - -\ **-s**\ - +\ **-s**\ + Scan method (The only supported scan method at this time is \ **nmap**\ ) + - -\ **-z**\ - +\ **-z**\ + List the data returned in xCAT stanza format + - -\ **-w**\ - +\ **-w**\ + Write to the xCAT database. + - -\ **-i|-**\ **-bmcip**\ - +\ **-i|-**\ **-bmcip**\ + BMC IP address. + - -\ **-u|-**\ **-bmcuser**\ - +\ **-u|-**\ **-bmcuser**\ + BMC user name. + - -\ **-p|-**\ **-bmcpasswd**\ - +\ **-p|-**\ **-bmcpasswd**\ + BMC user password. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display version information - + diff --git a/docs/source/guides/admin-guides/references/man1/buildkit.1.rst b/docs/source/guides/admin-guides/references/man1/buildkit.1.rst index fcf4ec6ab..20dd710e6 100644 --- a/docs/source/guides/admin-guides/references/man1/buildkit.1.rst +++ b/docs/source/guides/admin-guides/references/man1/buildkit.1.rst @@ -49,23 +49,23 @@ For example, to create a new kit named "prodkit" in the directory /home/mykits/ 1. - + If no location is provided then the command will create a subdirectory called "prodkit" in the current directory "/home/mykits" and the new kit files will be created there. - - \ **cd /home/mykits**\ - - \ **buildkit create prodkit**\ - + + \ **cd /home/mykits**\ + + \ **buildkit create prodkit**\ + or - + 2. - + If a location is provided then the Kit files will be created there. Note that the Kit name does not necessarily have to be the directory name where the kit files are located. - - \ **buidkit create prodkit -l /home/mykits/prodkit**\ - + + \ **buidkit create prodkit -l /home/mykits/prodkit**\ + In both cases the /home/mykits/prodkit directory is created and the inital files for the kit are created in that directory. @@ -74,77 +74,77 @@ The following example illustrates the basic process for building a new Kit. In t 1. - + Change to the directory where you wish to create the Kit. - + 2. - + Create a template directory for your kit: - - \ **buildkit create mytstkit**\ - + + \ **buildkit create mytstkit**\ + 3. - + Change directory to the new "mytstkit" subdirectory that was just created. - - \ **cd mytstkit**\ - + + \ **cd mytstkit**\ + 4. - + Edit the buildkit configuration file for your kit: - - \ **vi buildkit.conf**\ - + + \ **vi buildkit.conf**\ + (See xCAT Kit documentation for details.) - + 5. - + Create all required files, scripts, plugins, and packages for your kit. - + 6. - + Validate your kit build configuration and fix any errors that are reported: - - \ **buildkit chkconfig**\ - + + \ **buildkit chkconfig**\ + 7. - + List the repos defined in your buildkit configuration file: - - \ **buildkit listrepo**\ - + + \ **buildkit listrepo**\ + 8. - + For each repo name listed, build the repository. Note that if you need to build repositories for OS distributions, versions, or architectures that do not match the current system, you may need to copy your kit template directory to an appropriate server to build that repository, and then copy the results back to your main build server. For example, to build a repo named "rhels6.3" you would run the following command. - - \ **buildkit buildrepo rhels6.3**\ - + + \ **buildkit buildrepo rhels6.3**\ + or, you can build all of the repos at one time if there are no OS or architecture dependencies for kitcomponent package builds or kitpackage builds: - - \ **buildkit buildrepo all**\ - + + \ **buildkit buildrepo all**\ + 9. - + Build the kit tar file: - - \ **buildkit buildtar**\ - + + \ **buildkit buildtar**\ + @@ -154,46 +154,46 @@ OPTIONS -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-k|-**\ **-kitversion**\ \ *version*\ - +\ **-k|-**\ **-kitversion**\ \ *version*\ + Product version. + - -\ **-l|-**\ **-kitloc**\ \ *kit_location*\ - +\ **-l|-**\ **-kitloc**\ \ *kit_location*\ + The directory location of the Kit files. + - -\ **-p|-**\ **-pkgdir**\ \ *package_directory_list*\ - +\ **-p|-**\ **-pkgdir**\ \ *package_directory_list*\ + A comma-separated list of directory locations for product RPMs. + - -\ **-r|-**\ **-kitrelease**\ \ *release*\ - +\ **-r|-**\ **-kitrelease**\ \ *release*\ + Product release. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. - + @@ -203,73 +203,73 @@ SUB-COMMANDS -\ **create**\ \ *kit_basename*\ - +\ **create**\ \ *kit_basename*\ + Creates a new kit build directory structure for kit \ *kit_basename*\ using the location specified on the command line or the current directory. The sample kit files from /opt/xcat/share/xcat/kits/kit_template are copied over, and the buildkit.conf file is modified for the specified \ *kit_basename*\ . + - -\ **chkconfig**\ - +\ **chkconfig**\ + Reads the buildkit.conf file, verifies that the file syntax is correct and that all specified files exist. + - -\ **listrepo**\ - +\ **listrepo**\ + Reads the buildkit.conf file, lists all Kit package repositories listed in the file, and reports the build status for each repository. - + \ **buildrepo**\ {\ *repo_name*\ | \ **all**\ } - + Reads the buildkit.conf file, and builds the specified Kit package repository. The built packages are placed in the directory /build/kit_repodir/\ *repo_name*\ . If \ **all**\ is specified, all kit repositories are built. - + \ **cleanrepo**\ {\ *repo_name*\ | \ **all**\ } - + Reads the buildkit.conf file, and deletes all the package files and package meta data files from the /build/kit_repodir/\ *repo_name*\ directory. If \ **all**\ is specified, all kit repository files are deleted. + - -\ **buildtar**\ - +\ **buildtar**\ + Reads the buildkit.conf file, validates that all kit repositories have been built, and builds the Kit tar file /\ *kitname*\ .tar.bz2. + - -\ **cleantar**\ - +\ **cleantar**\ + Reads the /buildkit.conf file and \ *deletes*\ the following: - - + + - Kit tar files matching /\ *kit_name\\*.tar.bz2*\ . - - - /build/\ *kit_name*\ - + + - /build/\ *kit_name*\ + - /rpmbuild - + - /tmp - + - /debbuild - + Caution: Make sure you back up any tar files you would like to keep before running this subcommand. + - -\ **cleanall**\ - +\ **cleanall**\ + Equivalent to running \ **buildkit cleanrepo all**\ and \ **buildkit cleantar**\ . + - -\ **addpkgs**\ - +\ **addpkgs**\ + \ *kit_tarfile*\ {\ **-p**\ | \ **-**\ **-pkgdir**\ \ *package_directory_list*\ } [\ **-k**\ | \ **-**\ **-kitversion**\ \ *version*\ ] [\ **-r**\ | \ **-**\ **-kitrelease**\ \ *release*\ ] - + Add product package rpms to a previously built kit tar file. This is used for partial product kits that are built and shipped separately from the product packages, and are identified with a \ *kit_tarfile*\ name of \ *kitname*\ .\ **NEED_PRODUCT_PKGS.tar.bz2**\ . Optionally, change the kit release and version values when building the new kit tarfile. If kitcomponent version and/or release values are defaulted to the kit values, those will also be changed and new kitcomponent rpms will be built. If kit or kitcomponent scripts, plugins, or other files specify name, release, or version substitution strings, these will all be replaced with the new values when built into the new complete kit tarfile \ *kit_location*\ /\ *new_kitname*\ .\ **tar.bz2**\ . - + @@ -280,15 +280,15 @@ RETURN VALUE 0 - + The command completed successfully. - + 1 - + An error has occurred. - + @@ -299,49 +299,49 @@ EXAMPLES 1. - + To create the sample kit shipped with the xCAT-buildkit rpm on a RHELS 6.3 server and naming it \ **mykit**\ , run the following commands: - - \ **cd /home/myuserid/kits**\ - - \ **buildkit create mykit**\ - - \ **cd mykit**\ - - \ **vi buildkit.conf**\ - - \ **buildkit chkconfig**\ - - \ **buildkit listrepo**\ - - \ **buildkit buildrepo all**\ - - \ **buildkit buildtar**\ - + + \ **cd /home/myuserid/kits**\ + + \ **buildkit create mykit**\ + + \ **cd mykit**\ + + \ **vi buildkit.conf**\ + + \ **buildkit chkconfig**\ + + \ **buildkit listrepo**\ + + \ **buildkit buildrepo all**\ + + \ **buildkit buildtar**\ + 2. - + To clean up a kit repository directory after build failures on a RHELS 6.3 server to prepare for a new kit repository build, run: - - \ **buildkit cleanrepo rhels6.3**\ - + + \ **buildkit cleanrepo rhels6.3**\ + 3. - + To clean up all kit build files, including a previously built kit tar file, run - - \ **buildkit cleanall**\ - + + \ **buildkit cleanall**\ + 4. - + To create a kit named "tstkit" located in /home/foobar/tstkit instead of the current working directory. - - \ **buildkit create tstkit -l /home/foobar/tstkit**\ - + + \ **buildkit create tstkit -l /home/foobar/tstkit**\ + diff --git a/docs/source/guides/admin-guides/references/man1/cfgve.1.rst b/docs/source/guides/admin-guides/references/man1/cfgve.1.rst index 636f8aede..a7c598257 100644 --- a/docs/source/guides/admin-guides/references/man1/cfgve.1.rst +++ b/docs/source/guides/admin-guides/references/man1/cfgve.1.rst @@ -77,51 +77,51 @@ OPTIONS \ **-c**\ To create the target object. - + For creating of \ **Storage Domain**\ , the target storage domain will be created first, then attached to data center and activated. - + The parameters that used to create the storage domain are gotten from 'virtsd' table. The detail parameters in the virtsd table: - - + + \ **virtsd.node**\ - The name of the storage domain. - + \ **virtsd.sdtype**\ - The type of storage domain. Valid value: data, iso, export. Default value is 'data'. - + \ **virtsd.stype**\ - The storage type. "nfs" or "localfs". - + \ **virtsd.location**\ - The location of the storage. \ **nfs**\ : Format: [nfsserver:nfspath]. The NFS export directory must be configured for read write access and must be owned by vdsm:kvm. \ **localfs**\ : "/data/images/rhev" is set by default. - + \ **virtsd.host**\ - A host must be specified for a storage domain as SPM (Storage Pool Manager) when initialize the storage domain. The role of SPM may be migrated to other host by rhev-m during the running of the datacenter (For example, when the current SPM encountered issue or going to maintenance status. - + \ **virtsd.datacenter**\ - The storage will be attached to. 'Default' data center is the default value. + - -\ **-d**\ \ *data center*\ - +\ **-d**\ \ *data center*\ + The name of data center. - + Specify the 'Data Center' that will be used for the object to be attached to. It is used by type. - + \ **-f**\ It can be used with \ **-r**\ to remove the target object by force. - + For removing of \ **Storage Domain**\ , if \ **-f**\ is specified, the storage domain will be deactivated and detached from data center before the removing. - + \ **-g**\ To activate the target object. @@ -132,73 +132,73 @@ OPTIONS -\ **-k**\ \ *storage type*\ - +\ **-k**\ \ *storage type*\ + To specify the type of the storage type when creating the data center. - + Supported type: nfs; localfs. + - -\ **-l**\ \ *cluster*\ - +\ **-l**\ \ *cluster*\ + Specify the cluster for the network to attach to. + - -\ **-m**\ \ *manager*\ - +\ **-m**\ \ *manager*\ + Specify the manager of the virtual environment. - + For RHEV, the FQDN (Fully Qualified Domain Name) of the rhev manager have to be specified. + - -\ **-n**\ \ *vlan ID*\ - +\ **-n**\ \ *vlan ID*\ + To specify the vlan number when creating a network. + - -\ **-o**\ \ *object*\ - +\ **-o**\ \ *object*\ + The name of the target object. + - -\ **-p**\ \ *cpu type*\ - +\ **-p**\ \ *cpu type*\ + To specify the cpu type when creating the cluster. \ **Intel Penryn Family**\ is default type. - + Supported type: \ **Intel Conroe Family**\ , \ **Intel Penryn Family**\ , \ **Intel Nehalem Family**\ , \ **Intel Westmere Family**\ , \ **AMD Opteron G1**\ , - \ **AMD Opteron G2**\ , \ **AMD Opteron G3**\ - + \ **AMD Opteron G2**\ , \ **AMD Opteron G3**\ + \ **-r**\ To remove the target object. - + For removing of \ **Storage Domain**\ , the storage space will be formatted after removing. - + \ **-s**\ To deactivate the target object. -\ **-t**\ \ *type*\ - +\ **-t**\ \ *type*\ + Specify the \ **type**\ of the target object. - + Supported types: \ **dc**\ - Data Center \ **cl**\ - Cluster \ **sd**\ - Storage Domain \ **nw**\ - Network \ **tpl**\ - Template - + @@ -219,53 +219,53 @@ EXAMPLES 1. To create the Storage Domain 'sd1', enter: - - + + .. code-block:: perl - + cfgve -t sd -m -o sd1 -c - - + + 2. To deactivate the Storage Domain 'sd1' from data center, enter: - - + + .. code-block:: perl - + cfgve -t sd -m -o sd1 -s - - + + 3. To remove the Storage Domain 'sd1', enter: - - + + .. code-block:: perl - + cfgve -t sd -m -o sd1 -r - - + + 4. To create the network 'nw1', enter: - - + + .. code-block:: perl - + cfgve -t nw -m -o nw1 -c - - + + 5. To remove the template 'tpl01', enter: - - + + .. code-block:: perl - + cfgve -t tpl -m -o tpl01 -r - - + + diff --git a/docs/source/guides/admin-guides/references/man1/cfm2xcat.1.rst b/docs/source/guides/admin-guides/references/man1/cfm2xcat.1.rst index e04b5e922..c43171ce3 100644 --- a/docs/source/guides/admin-guides/references/man1/cfm2xcat.1.rst +++ b/docs/source/guides/admin-guides/references/man1/cfm2xcat.1.rst @@ -15,7 +15,7 @@ NAME **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** @@ -25,7 +25,7 @@ NAME ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* diff --git a/docs/source/guides/admin-guides/references/man1/chdef.1.rst b/docs/source/guides/admin-guides/references/man1/chdef.1.rst index dedf478e6..a18531e3c 100644 --- a/docs/source/guides/admin-guides/references/man1/chdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chdef.1.rst @@ -44,94 +44,94 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. Use the help option to get a list of valid attributes for each object type. + - -\ **-d|-**\ **-dynamic**\ - +\ **-d|-**\ **-dynamic**\ + Use the dynamic option to change dynamic node groups definition. This option must be used with -w option. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-m|-**\ **-minus**\ - +\ **-m|-**\ **-minus**\ + If the value of the attribute is a list then this option may be used to remove one or more items from the list. + - -\ **-n**\ \ *new-name*\ - +\ **-n**\ \ *new-name*\ + Change the current object name to the new-name which is specified by the -n option. Objects of type site, group and monitoring cannot be renamed with the -n option. Note: For the \ **-n**\ option, only one node can be specified. For some special nodes such as fsp, bpa, frame, cec etc., their name is referenced in their own hcp attribute, or the hcp attribute of other nodes. If you use \ **-n**\ option, you must manually change all hcp attributes that refer to this name. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats. + - -\ **-o**\ \ *object-names*\ - +\ **-o**\ \ *object-names*\ + A set of comma delimited object names. + - -\ **-p|-**\ **-plus**\ - +\ **-p|-**\ **-plus**\ + This option will add the specified values to the existing value of the attribute. It will create a comma-separated list of values. + - -\ **-t**\ \ *object-types*\ - +\ **-t**\ \ *object-types*\ + A set of comma delimited object types. Use the help option to get a list of valid object types. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + \ **-w**\ \ *attr==val*\ \ **-w**\ \ *attr=~val*\ ... - + Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type. - + Operator descriptions: == Select nodes where the attribute value is exactly this value. != Select nodes where the attribute value is not this specific value. =~ Select nodes where the attribute value matches this regular expression. !~ Select nodes where the attribute value does not match this regular expression. - + Note: the operator !~ will be parsed by shell, if you want to use !~ in the selection string, use single quote instead. For example:-w 'mgt!~ipmi'. + - -\ **-z|-**\ **-stanza**\ - +\ **-z|-**\ **-stanza**\ + Indicates that the file being piped to the command is in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files. + - -\ **-u**\ - +\ **-u**\ + Fill in the attributes such as template file, pkglist file and otherpkglist file of osimage object based on the specified parameters. It will search "/install/custom/" directory first, and then "/opt/xcat/share/". - + Note: this option only works for objtype \ **osimage**\ . - + @@ -152,161 +152,161 @@ EXAMPLES 1. - + To change a site definition. - - + + .. code-block:: perl - + chdef -t site -o clustersite installdir=/xcatinstall - - + + 2. - + To change a basic node definition. - - + + .. code-block:: perl - + chdef -t node -o node01 groups="all,aix" - - + + (The group definitions are also created if they don't already exist.) - + 3. - + To add another group to the "groups" attribute in the previous example. - - + + .. code-block:: perl - + chdef -p -t node -o node01 groups="compute" - - + + 4. - + To remove the "all" group from the "groups" attribute in the previous example. - - + + .. code-block:: perl - + chdef -m -t node -o node01 groups="all" - - + + 5. - + To replace the current "groups" attribute value of "node01". - - + + .. code-block:: perl - + chdef -t node -o node01 groups="linux" - - + + 6. - + To add "node01" to the "members" attribute of a group definition called "LinuxNodes". - - + + .. code-block:: perl - + chdef -p -t group -o LinuxNodes members="node01" - - + + 7. - + To update a set of definitions based on information contained in the stanza file mystanzafile. - - + + .. code-block:: perl - + cat mystanzafile | chdef -z - - + + 8. - + To update a dynamic node group definition to add the cons=hmc wherevals pair. - - + + .. code-block:: perl - + chdef -t group -o dyngrp -d -p -w cons==hmc - - + + 9. - + To change the node object name from node1 to node2. - - + + .. code-block:: perl - + chdef -t node -o node1 -n node2 - - + + 10. - + To change the node hwtype, this command will change the value of ppc.nodetype. - - + + .. code-block:: perl - + chdef -t node -o node1 hwtype=lpar - - + + 11. - + To change the policy table for policy number 7.0 for admin1 - - + + .. code-block:: perl - + chdef -t policy -o 7.0 name=admin1 rule=allow - - + + 12. - + To change the node nic attributes - - + + .. code-block:: perl - + chdef -t node -o cn1 nicips.eth0="1.1.1.1|1.2.1.1" nicnetworks.eth0="net1|net2" nictypes.eth0="Ethernet" - - + + 13. - + To update an osimage definition. - - + + .. code-block:: perl - + chdef redhat6img -u provmethod=install - - + + diff --git a/docs/source/guides/admin-guides/references/man1/chhypervisor.1.rst b/docs/source/guides/admin-guides/references/man1/chhypervisor.1.rst index 84e617cb5..fdcfa8b50 100644 --- a/docs/source/guides/admin-guides/references/man1/chhypervisor.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chhypervisor.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **RHEV specific :**\ +\ **RHEV specific :**\ \ **chhypervisor**\ \ *noderange*\ [\ **-a**\ ] @@ -32,7 +32,7 @@ SYNOPSIS \ **chhypervisor**\ \ *noderange*\ [\ **-d**\ ] -\ **zVM specific :**\ +\ **zVM specific :**\ \ **chhypervisor**\ \ *noderange*\ [\ **-**\ **-adddisk2pool**\ \ *function*\ \ *region*\ \ *volume*\ \ *group*\ ] @@ -102,51 +102,51 @@ RHEV specific : \ **-a**\ Approve the host that to be added to cluster. - + Before approve, the status of the host must be 'pending_approval'. - + \ **-n**\ Configure the network interfaces for the host. - + Note: This operation only can be run when host is in 'maintenance mode'. Use \ **-d**\ to switch the host to 'maintenance' mode. - + The interfaces which configured in hypervisor.interface will be added to the network of RHEV. - + The format of hypervisor.interface is multiple [network:interfacename: protocol:IP:netmask:gateway] sections separated with '|'. For example: [rhevm2:eth0:static:10.1.0.236:255.255.255.0:0.0.0.0]. - - + + \ **network**\ - The logic network which has been created by 'cfgve -t nw' or the default management network 'rhevm'. - + \ **interfacename**\ - Physical network name: 'eth0','eth1'... - + \ **protocol**\ - To identify which boot protocol to use for the interface: dhcp or static. - + \ **IP**\ - The IP address for the interface. - + \ **netmask**\ - The network mask for the interface. - + \ **gateway**\ - The gateay for the interface. This field only can be set when the interface is added to 'rhevm' network. - + \ **-p**\ Configure the power management for the host. - + The power management must be configured for the rhev-h host to make the rhev-m to monitor the power status of the host, so that when certain host failed to function, rhev-m will fail over certain role like SPM to other active host. - + For rack mounted server, the bmc IP and user:password need to be set for the power management (These parameters are gotten from ipmi table). rhev-m uses the ipmi protocol to get the power status of the host. - + \ **-e**\ To activate the host. @@ -167,84 +167,84 @@ zVM specific : -\ **-**\ **-adddisk2pool**\ \ *function*\ \ *region*\ \ *volume*\ \ *group*\ - +\ **-**\ **-adddisk2pool**\ \ *function*\ \ *region*\ \ *volume*\ \ *group*\ + Add a disk to a disk pool defined in the EXTENT CONTROL. Function type can be either: (4) Define region as full volume and add to group OR (5) Add existing region to group. If the volume already exists in the EXTENT CONTROL, use function 5. If the volume does not exist in the EXTENT CONTROL, but is attached to SYSTEM, use function 4. + - -\ **-**\ **-addscsi**\ \ *device_number*\ \ *device_path*\ \ *option*\ \ *persist*\ - +\ **-**\ **-addscsi**\ \ *device_number*\ \ *device_path*\ \ *option*\ \ *persist*\ + Dynamically add a SCSI disk to a running z/VM system. + - -\ **-**\ **-addvlan**\ \ *name*\ \ *owner*\ \ *type*\ \ *transport*\ - +\ **-**\ **-addvlan**\ \ *name*\ \ *owner*\ \ *type*\ \ *transport*\ + Create a virtual network LAN. + - -\ **-**\ **-addvswitch**\ \ *name*\ \ *osa_dev_addr*\ \ *osa_exp_adapter*\ \ *controller*\ \ *connect (0, 1, or 2)*\ \ *memory_queue*\ \ *router*\ \ *transport*\ \ *vlan_id*\ \ *port_type*\ \ *update*\ \ *gvrp*\ \ *native_vlan*\ - +\ **-**\ **-addvswitch**\ \ *name*\ \ *osa_dev_addr*\ \ *osa_exp_adapter*\ \ *controller*\ \ *connect (0, 1, or 2)*\ \ *memory_queue*\ \ *router*\ \ *transport*\ \ *vlan_id*\ \ *port_type*\ \ *update*\ \ *gvrp*\ \ *native_vlan*\ + Create a virtual switch. + - -\ **-**\ **-addzfcp2pool**\ \ *pool*\ \ *status*\ \ *wwpn*\ \ *lun*\ \ *size*\ \ *owner*\ - +\ **-**\ **-addzfcp2pool**\ \ *pool*\ \ *status*\ \ *wwpn*\ \ *lun*\ \ *size*\ \ *owner*\ + Add a zFCP device to a device pool defined in xCAT. The device must have been carved up in the storage controller and configured with a WWPN/LUN before it can be added to the xCAT storage pool. z/VM does not have the ability to communicate directly with the storage controller to carve up disks dynamically. + - -\ **-**\ **-removediskfrompool**\ \ *function*\ \ *region*\ \ *group*\ - +\ **-**\ **-removediskfrompool**\ \ *function*\ \ *region*\ \ *group*\ + Remove a disk from a disk pool defined in the EXTENT CONTROL. Function type can be either: (1) Remove region, (2) Remove region from group, (3) Remove region from all groups, OR (7) Remove entire group . + - -\ **-**\ **-removescsi**\ \ *device_number*\ \ *persist (YES or NO)*\ - +\ **-**\ **-removescsi**\ \ *device_number*\ \ *persist (YES or NO)*\ + Delete a real SCSI disk. + - -\ **-**\ **-removevlan**\ \ *name*\ \ *owner*\ - +\ **-**\ **-removevlan**\ \ *name*\ \ *owner*\ + Delete a virtual network LAN. + - -\ **-**\ **-removevswitch**\ \ *name*\ - +\ **-**\ **-removevswitch**\ \ *name*\ + Delete a virtual switch. + - -\ **-**\ **-removezfcpfrompool**\ \ *pool*\ \ *lun*\ - +\ **-**\ **-removezfcpfrompool**\ \ *pool*\ \ *lun*\ + Remove a zFCP device from a device pool defined in xCAT. + - -\ **-**\ **-smcli**\ \ *function*\ \ *arguments*\ - +\ **-**\ **-smcli**\ \ *function*\ \ *arguments*\ + Execute a SMAPI function. A list of APIs supported can be found by using the help flag, e.g. chhypervisor pokdev61 --smcli -h. Specific arguments associated with a SMAPI function can be found by using the help flag for the function, e.g. chhypervisor pokdev61 --smcli Image_Query_DM -h. Only z/VM 6.2 and older SMAPI functions are supported at this time. Additional SMAPI functions will be added in subsequent zHCP versions. - + @@ -270,53 +270,53 @@ RHEV specific : 1. To approve the host 'host1', enter: - - + + .. code-block:: perl - + chhypervisor host1 -a - - + + 2. To configure the network interface for the host 'host1', enter: - - + + .. code-block:: perl - + chhypervisor host1 -n - - + + 3. To configure the power management for the host 'host1', enter: - - + + .. code-block:: perl - + chhypervisor host1 -p - - + + 4. To activate the host 'host1', enter: - - + + .. code-block:: perl - + chhypervisor host1 -e - - + + 5. To deactivate the host 'host1', enter: - - + + .. code-block:: perl - + chhypervisor host1 -d - - + + @@ -326,53 +326,53 @@ zVM specific : 1. To add a disk to a disk pool defined in the EXTENT CONTROL, enter: - - + + .. code-block:: perl - + chhypervisor pokdev61 --adddisk2pool 4 DM1234 DM1234 POOL1 - - + + 2. To add a zFCP device to a device pool defined in xCAT, enter: - - + + .. code-block:: perl - + chhypervisor pokdev61 --addzfcp2pool zfcp1 free 500501234567C890 4012345600000000 8G - - + + 3. To remove a region from a group in the EXTENT CONTROL, enter: - - + + .. code-block:: perl - + chhypervisor pokdev61 --removediskfrompool 2 DM1234 POOL1 - - + + 4. To remove a zFCP device from a device pool defined in xCAT, enter: - - + + .. code-block:: perl - + chhypervisor pokdev61 --removezfcpfrompool zfcp1 4012345600000000 500501234567C890 - - + + 5. To execute a SMAPI function (Image_Query_DM), enter: - - + + .. code-block:: perl - + chhypervisor pokdev61 --smcli Image_Query_DM -T LNX3 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst b/docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst index 841de9808..ffb675f04 100644 --- a/docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **chkkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] -\ **chkkitcomp**\ [\ **-V | -**\ **-verbose**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ +\ **chkkitcomp**\ [\ **-V | -**\ **-verbose**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ *********** @@ -42,34 +42,34 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. + - -\ **-i**\ \ *osimage*\ - +\ **-i**\ \ *osimage*\ + The name of the osimage to check against. + - -\ *kitcompname_list*\ - +\ *kitcompname_list*\ + A comma-delimited list of valid full kit component names or kit component basenames that are to be checked against the osimage. - + diff --git a/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst b/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst index f09ea69ae..2eb1ff057 100644 --- a/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chkosimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **chkosimage [-h | -**\ **-help ]**\ +\ **chkosimage [-h | -**\ **-help ]**\ -\ **chkosimage [-V] [-c|-**\ **-clean]**\ \ *osimage_name*\ +\ **chkosimage [-V] [-c|-**\ **-clean]**\ \ *osimage_name*\ *********** @@ -68,29 +68,29 @@ OPTIONS -\ **-c |-**\ **-clean**\ - +\ **-c |-**\ **-clean**\ + Remove any older versions of the rpms. Keep the version with the latest timestamp. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ *osimage_name*\ - +\ *osimage_name*\ + The name of the xCAT for AIX osimage definition. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + @@ -118,24 +118,24 @@ EXAMPLES 1. Check the XCAT osimage called "61image" to verify that the lpp_source directories contain all the software that is specified in the "installp_bundle" and "otherpkgs" attributes. - - + + .. code-block:: perl - + chkosimage -V 61image - - + + 2. Clean up the lpp_source directory for the osimage named "61img" by removing any older rpms with the same names but different versions. - - + + .. code-block:: perl - + chkosimage -c 61img - - + + diff --git a/docs/source/guides/admin-guides/references/man1/chvlan.1.rst b/docs/source/guides/admin-guides/references/man1/chvlan.1.rst index 917f8948e..0f749399b 100644 --- a/docs/source/guides/admin-guides/references/man1/chvlan.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chvlan.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **chvlan**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ [\ **-i | -**\ **-interface**\ \ *nic*\ ] -\ **chvlan**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-d | -**\ **-delete**\ +\ **chvlan**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-d | -**\ **-delete**\ \ **chvlan**\ [\ **-h | -**\ **-help**\ ] @@ -86,77 +86,77 @@ EXAMPLES 1. - + To add node1, node2 and node3 to vlan 3. - - + + .. code-block:: perl - + chvlan 3 -n node1,node2,node3 - - + + 2. - + To add node1, node2 and node3 to vlan 3 using eth1 interface. - - + + .. code-block:: perl - + chvlan 3 -n node1,node2,node3 -i eth1 - - + + 3. - + TO remove node1, node2 and node3 from vlan 3. - - + + .. code-block:: perl - + chvlan -n node1,node2,node3 -d - - + + 4. - + To add KVM guests node1 and node2 to vlan 3 - - + + .. code-block:: perl - + mkdef node1 arch=x86_64 groups=kvm,all installnic=mac primarynic=mac mgt=kvm netboot=pxe nfsserver=10.1.0.204 os=rhels6 profile=compute provmethod=install serialport=0 serialspeed=115200 vmcpus=1 vmhost=x3650n01 vmmemory=512 vmnics=br0 vmstorage=nfs://10.1.0.203/vms - + mkdef node2 arch=x86_64 groups=kvm,all installnic=mac primarynic=mac mgt=kvm netboot=pxe nfsserver=10.1.0.204 os=rhels6 profile=compute provmethod=install serialport=0 serialspeed=115200 vmcpus=1 vmhost=x3650n01 vmmemory=512 vmnics=br0 vmstorage=nfs://10.1.0.203/vms - + chvlan 3 -n node1,node2 - + mkvm node1,node2 -s 20G - + rpower node1,node2 on - + rinstall node1,node2 - - + + 5. - + To remove KVM guests node1 and node2 from vlan 3 - - + + .. code-block:: perl - + chvlan 3 -n node1,node2 -d - + rpower node1,node2 off - + rmvm node1,node2 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/chvlanports.1.rst b/docs/source/guides/admin-guides/references/man1/chvlanports.1.rst index 3ff3d6f5f..1f1e27fff 100644 --- a/docs/source/guides/admin-guides/references/man1/chvlanports.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chvlanports.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **chvlanports**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-i | -**\ **-interface**\ \ *nic*\ +\ **chvlanports**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-i | -**\ **-interface**\ \ *nic*\ -\ **chvlanports**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-i | -**\ **-interface**\ \ *nic*\ \ **-d | -**\ **-delete**\ +\ **chvlanports**\ \ *vlanid*\ \ **-n | -**\ **-nodes**\ \ *noderange*\ \ **-i | -**\ **-interface**\ \ *nic*\ \ **-d | -**\ **-delete**\ \ **chvlanports**\ [\ **-h | -**\ **-help**\ ] @@ -81,27 +81,27 @@ EXAMPLES 1. - + To add node1, node2 and node3 to vlan 3 using eth1 interface. - - + + .. code-block:: perl - + chvlanports 3 -n node1,node2,node3 -i eth1 - - + + 2. - + TO remove eth1 interface of node1, node2 and node3 from vlan 3. - - + + .. code-block:: perl - + chvlanports 3 -n node1,node2,node3 -i eth1 -d - - + + diff --git a/docs/source/guides/admin-guides/references/man1/chvm.1.rst b/docs/source/guides/admin-guides/references/man1/chvm.1.rst index a6c0f2bf7..dc8268623 100644 --- a/docs/source/guides/admin-guides/references/man1/chvm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chvm.1.rst @@ -38,7 +38,7 @@ PPC (using Direct FSP Management) specific: \ **chvm**\ \ *noderange*\ \ **-**\ **-p775**\ [\ **-p**\ \ *profile*\ ] -\ **chvm**\ \ *noderange*\ \ **-**\ **-p775**\ \ **-i id**\ [\ **-m**\ \ *memory_interleaving*\ ] \ **-r**\ \ *partition_rule*\ +\ **chvm**\ \ *noderange*\ \ **-**\ **-p775**\ \ **-i id**\ [\ **-m**\ \ *memory_interleaving*\ ] \ **-r**\ \ *partition_rule*\ \ **chvm**\ \ *noderange*\ [\ **lparname**\ ={ \* | \ *name*\ }] @@ -180,16 +180,16 @@ Common: -\ **-h**\ - +\ **-h**\ + Display usage message. + - -\ **-v**\ - +\ **-v**\ + Command Version. - + @@ -198,22 +198,22 @@ PPC (with HMC) specific: -\ **-p**\ \ *profile*\ - +\ **-p**\ \ *profile*\ + Name of an existing partition profile. + - -\ *attr*\ =\ *val*\ - +\ *attr*\ =\ *val*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. + - -\ **-V**\ - +\ **-V**\ + Verbose output. - + @@ -222,80 +222,80 @@ PPC (using Direct FSP Management) specific: -\ **-**\ **-p775**\ - +\ **-**\ **-p775**\ + Specify the operation is for Power 775 machines. + - -\ **-i**\ - +\ **-i**\ + Starting numeric id of the newly created partitions. For Power 775 using Direct FSP Management, the id value only could be \ **1**\ , \ **5**\ , \ **9**\ , \ **13**\ , \ **17**\ , \ **21**\ , \ **25**\ and \ **29**\ . Shall work with option \ **-**\ **-p775**\ . + - -\ **-m**\ - +\ **-m**\ + memory interleaving. The setting value only could be \ **1**\ or \ **2**\ . \ **2**\ means \ **non-interleaved**\ mode (also 2MC mode), the memory cannot be shared across the processors in an octant. \ **1**\ means \ **interleaved**\ mode (also 8MC mode) , the memory can be shared. The default value is \ **1**\ . Shall work with option \ **-**\ **-p775**\ . + - -\ **-r**\ - +\ **-r**\ + partition rule. Shall work with option \ **-**\ **-p775**\ . - + If all the octants configuration value are same in one CEC, it will be " \ **-r**\ \ **0-7**\ :\ *value*\ " . - + If the octants use the different configuration value in one cec, it will be "\ **-r**\ \ **0**\ :\ *value1*\ ,\ **1**\ :\ *value2*\ ,...\ **7**\ :\ *value7*\ ", or "\ **-r**\ \ **0**\ :\ *value1*\ ,\ **1-7**\ :\ *value2*\ " and so on. - + The octants configuration value for one Octant could be \ **1**\ , \ **2**\ , \ **3**\ , \ **4**\ , \ **5**\ . The meanings of the octants configuration value are as following: - - + + .. code-block:: perl - + 1 -- 1 partition with all cpus and memory of the octant 2 -- 2 partitions with a 50/50 split of cpus and memory 3 -- 3 partitions with a 25/25/50 split of cpus and memory 4 -- 4 partitions with a 25/25/25/25 split of cpus and memory 5 -- 2 partitions with a 25/75 split of cpus and memory + + - - -\ **-p**\ \ *profile*\ - +\ **-p**\ \ *profile*\ + Name of I/O slots assignment profile. Shall work with option \ **-**\ **-p775**\ . - + \ **lparname**\ ={\ **\\* | name**\ } - + Set LPAR name for the specified lpars. If '\*' specified, it means to get names from xCAT database and then set them for the specified lpars. If a string is specified, it only supports single node and the string will be set for the specified lpar. The user can use lsvm to check the lparnames for lpars. + - -\ **vmcpus=value**\ \ **vmmemory=value**\ \ **add_physlots=value**\ \ **vmothersetting=value**\ - +\ **vmcpus=value**\ \ **vmmemory=value**\ \ **add_physlots=value**\ \ **vmothersetting=value**\ + To specify the parameters that will be modified. - + \ **add_vmnics=value**\ \ **add_vmstorage=value**\ [\ **-**\ **-vios**\ ] - + To create new virtual adapter for the specified node. + - -\ **del_physlots=drc_index1,drc_index2...**\ - +\ **del_physlots=drc_index1,drc_index2...**\ + To delete physical slots which are specified by the \ *drc_index1,drc_index2...*\ . + - -\ **del_vadapter=slotid**\ - +\ **del_vadapter=slotid**\ + To delete a virtual adapter specified by the \ *slotid*\ . - + @@ -304,40 +304,40 @@ VMware/KVM specific: -\ **-a**\ \ *size*\ - +\ **-a**\ \ *size*\ + Add a new Hard disk with size defaulting to GB. Multiple can be added with comma separated values. + - -\ **-**\ **-cpus**\ \ *count*\ - +\ **-**\ **-cpus**\ \ *count*\ + Set the number of CPUs. + - -\ **-d**\ \ *disk*\ - +\ **-d**\ \ *disk*\ + Deregister the Hard disk but leave the backing files. Multiple can be done with comma separated values. The disks are specified by SCSI id. + - -\ **-**\ **-mem**\ \ *memory*\ - +\ **-**\ **-mem**\ \ *memory*\ + Set the memory, defaults to MB. + - -\ **-p**\ \ *disk*\ - +\ **-p**\ \ *disk*\ + Purge the Hard disk. Deregisters and deletes the files. Multiple can be done with comma separated values. The disks are specified by SCSI id. + - -\ **-**\ **-resize**\ \ *disk*\ =\ *size*\ - +\ **-**\ **-resize**\ \ *disk*\ =\ *size*\ + Change the size of the Hard disk. The disk in \ *qcow2*\ format can not be set to less than its current size. The disk in \ *raw*\ format can be resized smaller, use caution. Multiple disks can be resized by using comma separated \ *disk*\ \ **=**\ \ *size*\ pairs. The disks are specified by SCSI id. Size defaults to GB. - + @@ -346,38 +346,38 @@ KVM specific: -\ **-**\ **-cpupin hostcpuset**\ - +\ **-**\ **-cpupin hostcpuset**\ + To pin guest domain virtual CPUs to physical host CPUs specified with \ *hostcpuset*\ . \ *hostcpuset*\ is a list of physical CPU numbers. Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed. The '-' denotes the range and the '^' denotes exclusive. - + Note: The expression is sequentially evaluated, so "0-15,^8" is identical to "9-14,0-7,15" but not identical to "^8,0-15". + - -\ **-**\ **-membind numanodeset**\ - +\ **-**\ **-membind numanodeset**\ + It is possible to restrict a guest to allocate memory from the specified set of NUMA nodes \ *numanodeset*\ . If the guest vCPUs are also pinned to a set of cores located on that same set of NUMA nodes, memory access is local and improves memory access performance. + - -\ **-**\ **-devpassthru pcidevice1,pcidevice2...**\ - +\ **-**\ **-devpassthru pcidevice1,pcidevice2...**\ + The PCI passthrough gives a guest VM direct access to I/O devices \ *pcidevice1,pcidevice2...*\ . The PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively. The devices list are a list of comma separated PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. + - -\ **-**\ **-devdetach pcidevice1,pcidevice2...**\ - +\ **-**\ **-devdetach pcidevice1,pcidevice2...**\ + To detaching the PCI devices which are attached to VM guest via PCI passthrough from the VM guest. The devices list are a list of comma separated PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. - + @@ -386,62 +386,62 @@ zVM specific: -\ **-**\ **-add3390**\ \ *disk_pool*\ \ *device_address*\ \ *size*\ \ *mode*\ \ *read_password*\ \ *write_password*\ \ *multi_password*\ - +\ **-**\ **-add3390**\ \ *disk_pool*\ \ *device_address*\ \ *size*\ \ *mode*\ \ *read_password*\ \ *write_password*\ \ *multi_password*\ + Adds a 3390 (ECKD) disk to a virtual machine's directory entry. The device address can be automatically assigned by specifying 'auto'. The size of the disk can be specified in GB, MB, or the number of cylinders. + - -\ **-**\ **-add3390active**\ \ *device_address*\ \ *mode*\ - +\ **-**\ **-add3390active**\ \ *device_address*\ \ *mode*\ + Adds a 3390 (ECKD) disk that is defined in a virtual machine's directory entry to that virtual server's active configuration. + - -\ **-**\ **-add9336**\ \ *disk_pool*\ \ *device_address*\ \ *size*\ \ *mode*\ \ *read_password*\ \ *write_password*\ \ *multi_password*\ - +\ **-**\ **-add9336**\ \ *disk_pool*\ \ *device_address*\ \ *size*\ \ *mode*\ \ *read_password*\ \ *write_password*\ \ *multi_password*\ + Adds a 9336 (FBA) disk to a virtual machine's directory entry. The device address can be automatically assigned by specifying 'auto'. The size of the disk can be specified in GB, MB, or the number of blocks. + - -\ **-**\ **-adddisk2pool**\ \ *function*\ \ *region*\ \ *volume*\ \ *group*\ - +\ **-**\ **-adddisk2pool**\ \ *function*\ \ *region*\ \ *volume*\ \ *group*\ + Add a disk to a disk pool defined in the EXTENT CONTROL. Function type can be either: (4) Define region as full volume and add to group OR (5) Add existing region to group. The disk has to already be attached to SYSTEM. + - -\ **-**\ **-addnic**\ \ *device_address*\ \ *type*\ \ *device_count*\ - +\ **-**\ **-addnic**\ \ *device_address*\ \ *type*\ \ *device_count*\ + Adds a network adapter to a virtual machine's directory entry (case sensitive). + - -\ **-**\ **-addpagespool**\ \ *volume_addr*\ \ *volume_label*\ \ *volume_use*\ \ *system_config_name*\ \ *system_config_type*\ \ *parm_disk_owner*\ \ *parm_disk_number*\ \ *parm_disk_password*\ - +\ **-**\ **-addpagespool**\ \ *volume_addr*\ \ *volume_label*\ \ *volume_use*\ \ *system_config_name*\ \ *system_config_type*\ \ *parm_disk_owner*\ \ *parm_disk_number*\ \ *parm_disk_password*\ + Add a full volume page or spool disk to the virtual machine. + - -\ **-**\ **-addprocessor**\ \ *device_address*\ - +\ **-**\ **-addprocessor**\ \ *device_address*\ + Adds a virtual processor to a virtual machine's directory entry. + - -\ **-**\ **-addprocessoractive**\ \ *device_address*\ \ *type*\ - +\ **-**\ **-addprocessoractive**\ \ *device_address*\ \ *type*\ + Adds a virtual processor to a virtual machine's active configuration (case sensitive). + - -\ **-**\ **-addvdisk**\ \ *device_address*\ \ *size*\ - +\ **-**\ **-addvdisk**\ \ *device_address*\ \ *size*\ + Adds a v-disk to a virtual machine's directory entry. + - -\ **-**\ **-addzfcp**\ \ *pool*\ \ *device_address*\ \ *loaddev*\ \ *size*\ \ *tag*\ \ *wwpn*\ \ *lun*\ - +\ **-**\ **-addzfcp**\ \ *pool*\ \ *device_address*\ \ *loaddev*\ \ *size*\ \ *tag*\ \ *wwpn*\ \ *lun*\ + Add a zFCP device to a device pool defined in xCAT. The device must have been carved up in the storage controller and configured with a WWPN/LUN before it can be added to the xCAT storage pool. z/VM does not have the ability to communicate @@ -450,121 +450,121 @@ zVM specific: the WWPN and LUN are not given. The device address can be automatically assigned by specifying 'auto'. The WWPN/LUN can be set as the LOADDEV in the directory entry if (1) is specified as the 'loaddev'. + - -\ **-**\ **-connectnic2guestlan**\ \ *device_address*\ \ *lan*\ \ *owner*\ - +\ **-**\ **-connectnic2guestlan**\ \ *device_address*\ \ *lan*\ \ *owner*\ + Connects a given network adapter to a GuestLAN. + - -\ **-**\ **-connectnic2vswitch**\ \ *device_address*\ \ *vswitch*\ - +\ **-**\ **-connectnic2vswitch**\ \ *device_address*\ \ *vswitch*\ + Connects a given network adapter to a VSwitch. + - -\ **-**\ **-copydisk**\ \ *target_address*\ \ *source_node*\ \ *source_address*\ - +\ **-**\ **-copydisk**\ \ *target_address*\ \ *source_node*\ \ *source_address*\ + Copy a disk attached to a given virtual server. + - -\ **-**\ **-dedicatedevice**\ \ *virtual_device*\ \ *real_device*\ \ *mode*\ - +\ **-**\ **-dedicatedevice**\ \ *virtual_device*\ \ *real_device*\ \ *mode*\ + Adds a dedicated device to a virtual machine's directory entry. + - -\ **-**\ **-deleteipl**\ - +\ **-**\ **-deleteipl**\ + Deletes the IPL statement from the virtual machine's directory entry. + - -\ **-**\ **-disconnectnic**\ \ *device_address*\ - +\ **-**\ **-disconnectnic**\ \ *device_address*\ + Disconnects a given network adapter. + - -\ **-**\ **-formatdisk**\ \ *disk_address*\ \ *multi_password*\ - +\ **-**\ **-formatdisk**\ \ *disk_address*\ \ *multi_password*\ + Formats a disk attached to a given virtual server (only ECKD disks supported). The disk should not be linked to any other virtual server. This command is best used after add3390(). + - -\ **-**\ **-grantvswitch**\ \ *vswitch*\ - +\ **-**\ **-grantvswitch**\ \ *vswitch*\ + Grant vSwitch access for given virtual machine. + - -\ **-**\ **-purgerdr**\ - +\ **-**\ **-purgerdr**\ + Purge the reader belonging to the virtual machine + - -\ **-**\ **-removedisk**\ \ *device_address*\ - +\ **-**\ **-removedisk**\ \ *device_address*\ + Removes a minidisk from a virtual machine's directory entry. + - -\ **-**\ **-removenic**\ \ *device_address*\ - +\ **-**\ **-removenic**\ \ *device_address*\ + Removes a network adapter from a virtual machine's directory entry. + - -\ **-**\ **-removeprocessor**\ \ *device_address*\ - +\ **-**\ **-removeprocessor**\ \ *device_address*\ + Removes a processor from an active virtual machine's configuration. + - -\ **-**\ **-removeloaddev**\ \ *wwpn*\ \ *lun*\ - +\ **-**\ **-removeloaddev**\ \ *wwpn*\ \ *lun*\ + Removes the LOADDEV statement from a virtual machines's directory entry. + - -\ **-**\ **-removezfcp**\ \ *device_address*\ \ *wwpn*\ \ *lun*\ - +\ **-**\ **-removezfcp**\ \ *device_address*\ \ *wwpn*\ \ *lun*\ + Removes a given SCSI/FCP device belonging to the virtual machine. + - -\ **-**\ **-replacevs**\ \ *directory_entry*\ - +\ **-**\ **-replacevs**\ \ *directory_entry*\ + Replaces a virtual machine's directory entry. The directory entry can be echoed into stdin or a text file. + - -\ **-**\ **-setipl**\ \ *ipl_target*\ \ *load_parms*\ \ *parms*\ - +\ **-**\ **-setipl**\ \ *ipl_target*\ \ *load_parms*\ \ *parms*\ + Sets the IPL statement for a given virtual machine. + - -\ **-**\ **-setpassword**\ \ *password*\ - +\ **-**\ **-setpassword**\ \ *password*\ + Sets the password for a given virtual machine. + - -\ **-**\ **-setloaddev**\ \ *wwpn*\ \ *lun*\ - +\ **-**\ **-setloaddev**\ \ *wwpn*\ \ *lun*\ + Sets the LOADDEV statement in the virtual machine's directory entry. + - -\ **-**\ **-undedicatedevice**\ \ *device_address*\ - +\ **-**\ **-undedicatedevice**\ \ *device_address*\ + Delete a dedicated device from a virtual machine's active configuration and directory entry. - + diff --git a/docs/source/guides/admin-guides/references/man1/clonevm.1.rst b/docs/source/guides/admin-guides/references/man1/clonevm.1.rst index 0db09970f..0d6d341ee 100644 --- a/docs/source/guides/admin-guides/references/man1/clonevm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/clonevm.1.rst @@ -50,46 +50,46 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-b**\ \ *master_to_base_vms_upon*\ - +\ **-b**\ \ *master_to_base_vms_upon*\ + The master to base the clones upon + - -\ **-t**\ \ *master_to_be_made*\ - +\ **-t**\ \ *master_to_be_made*\ + The target master to copy a single VM's state to + - -\ **-d|-**\ **-detached**\ - +\ **-d|-**\ **-detached**\ + Explicitly request that the noderange be untethered from any masters. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Force cloning of a powered on VM. Implies \ **-d**\ if the VM is on. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + @@ -110,23 +110,23 @@ EXAMPLES 1. Creating a master named \ *appserver*\ from a node called \ *vm1*\ : - - + + .. code-block:: perl - + clonevm vm1 -t appserver - - + + 2. Cleating 30 VMs from a master named \ *appserver*\ : - - + + .. code-block:: perl - + clonevm vm1-vm30 -b appserver - - + + diff --git a/docs/source/guides/admin-guides/references/man1/configfpc.1.rst b/docs/source/guides/admin-guides/references/man1/configfpc.1.rst index 71fedfd73..1801eeee5 100644 --- a/docs/source/guides/admin-guides/references/man1/configfpc.1.rst +++ b/docs/source/guides/admin-guides/references/man1/configfpc.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **configfpc**\ \ **-i**\ \ *interface*\ +\ **configfpc**\ \ **-i**\ \ *interface*\ -\ **configfpc**\ \ **-i**\ \ *interface*\ \ **-**\ **-ip**\ \ *default ip address*\ +\ **configfpc**\ \ **-i**\ \ *interface*\ \ **-**\ **-ip**\ \ *default ip address*\ \ **configfpc**\ [\ **-V | -**\ **-verbose**\ ] @@ -55,22 +55,22 @@ OPTIONS -\ **-i**\ \ *interface*\ - +\ **-i**\ \ *interface*\ + Use this flag to specify which xCAT MN interface (example: eth4) that is connected to the NeXtScale FPCs. This option is required. + - -\ **-**\ **-ip**\ \ *default ip address*\ - +\ **-**\ **-ip**\ \ *default ip address*\ + Use this flag to override the default ip address of 192.168.0.100 with a new address. + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Verbose mode - + @@ -81,22 +81,22 @@ EXAMPLES 1. To discover and configure all NeXtScale Fan Power Controllers (FPCs) connected on eth0 interface. - - + + .. code-block:: perl - + configfpc -i eth0 - - + + 2. To override the default ip address and run in Verbose mode. - - + + .. code-block:: perl - + configfpc -i eth0 --ip 196.68.0.100 -V - - + + diff --git a/docs/source/guides/admin-guides/references/man1/csm2xcat.1.rst b/docs/source/guides/admin-guides/references/man1/csm2xcat.1.rst index a6ef13d9b..cd06071a9 100644 --- a/docs/source/guides/admin-guides/references/man1/csm2xcat.1.rst +++ b/docs/source/guides/admin-guides/references/man1/csm2xcat.1.rst @@ -73,7 +73,7 @@ EXAMPLES .. code-block:: perl cat node.stanza | chdef -z - + cat device.stanza | chdef -z diff --git a/docs/source/guides/admin-guides/references/man1/db2sqlsetup.1.rst b/docs/source/guides/admin-guides/references/man1/db2sqlsetup.1.rst index 6bb891cae..0f1c23227 100644 --- a/docs/source/guides/admin-guides/references/man1/db2sqlsetup.1.rst +++ b/docs/source/guides/admin-guides/references/man1/db2sqlsetup.1.rst @@ -61,52 +61,52 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Displays verbose messages. + - -\ **-i|-**\ **-init**\ - +\ **-i|-**\ **-init**\ + The init option is used to setup an installed DB2 database on AIX or Linux (p-Series) so that xCAT can use the database. This must be combined with either the -S or -C flag to indicate whether we are setting up the Server or the Client. With the -S flag, it involves creating the xcatdb database, the xcatdb instance id, allowing access to the xcatdb database by the Management Node. It also backs up the current xCAT database and restores it into the newly setup xcatdb DB2 database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the DB2 database and restarts the xcatd daemon using the database. + - -\ **-p|-**\ **-passwd**\ - +\ **-p|-**\ **-passwd**\ + The password change option is to change the database access password for the DB2 xcatdb database. If -S is input then it will only change the password on the DB2 Server (MN). If -C is input it will only change on the DB2 clients (SN). If neither -S or -C are input with this flag, then it will change both the DB2 Server and Clients. When changing the password the xcatd daemon will be stopped and restarted. Any other tools accessing the database should also be stopped before changing and restarted after changing. + - -\ **-S|-C**\ - +\ **-S|-C**\ + This options says whether to setup the Server (-S) on the Management Node, or the Client (-C) on the Service Nodes. + - -\ **-N|-**\ **-nostart**\ - +\ **-N|-**\ **-nostart**\ + This option with the -S flag will create the database, but will not backup and restore xCAT tables into the database. It will create the cfgloc file such that the next start of xcatd will try and contact the database. This can be used to setup the xCAT DB2 database during or before install. + - -\ **-o|-**\ **-setupODBC**\ - +\ **-o|-**\ **-setupODBC**\ + This option sets up the ODBC /etc/../odbcinst.ini, /etc/../odbc.ini and the .odbc.ini file in roots home directory will be created and initialized to run off the xcatdb DB2 database. - + @@ -136,64 +136,64 @@ EXAMPLES 1. To setup DB2 Server for xCAT to run on the DB2 xcatdb database, on the MN: - - + + .. code-block:: perl - + db2sqlsetup -i -S - - + + 2. To setup DB2 Client for xCAT to run on the DB2 xcatdb database, on the SN: - - + + .. code-block:: perl - + db2sqlsetup -i -C - - + + 3. To setup the ODBC for DB2 xcatdb database access, on the MN : - - + + .. code-block:: perl - + db2sqlsetup -o -S - - + + 4. To setup the ODBC for DB2 xcatdb database access, on the SN : - - + + .. code-block:: perl - + db2sqlsetup -o -C - - + + 5. - + To setup the DB2 database but not start xcat running with it: - - + + .. code-block:: perl - + db2sqlsetup -i -S -N - - + + 6. To change the DB2 xcatdb password on both the Management and Service Nodes: - - + + .. code-block:: perl - + db2sqlsetup -p - - + + diff --git a/docs/source/guides/admin-guides/references/man1/dumpxCATdb.1.rst b/docs/source/guides/admin-guides/references/man1/dumpxCATdb.1.rst index dabcca42b..af89c9fef 100644 --- a/docs/source/guides/admin-guides/references/man1/dumpxCATdb.1.rst +++ b/docs/source/guides/admin-guides/references/man1/dumpxCATdb.1.rst @@ -93,7 +93,7 @@ EXAMPLES .. code-block:: perl chtab key=skiptables site.value="hosts,passwd" - + dumpxCATdb -p /tmp/db @@ -103,7 +103,7 @@ EXAMPLES .. code-block:: perl export XCAT_SKIPTABLES="hosts,passwd" - + dumpxCATdb -p /tmp/db diff --git a/docs/source/guides/admin-guides/references/man1/genimage.1.rst b/docs/source/guides/admin-guides/references/man1/genimage.1.rst index 1e869d7ad..d28fd3880 100644 --- a/docs/source/guides/admin-guides/references/man1/genimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/genimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **genimage**\ +\ **genimage**\ -\ **genimage**\ [\ **-o**\ \ *osver*\ ] [\ **-a**\ \ *arch*\ ] [\ **-p**\ \ *profile*\ ] [\ **-i**\ \ *nodebootif*\ ] [\ **-n**\ \ *nodenetdrivers*\ ] [\ **-**\ **-onlyinitrd**\ ] [\ **-r**\ \ *otherifaces*\ ] [\ **-k**\ \ *kernelver*\ ] [\ **-g**\ \ *krpmver*\ ] [\ **-m**\ \ *statelite*\ ] [\ **-l**\ \ *rootlimitsize*\ ] [\ **-**\ **-permission**\ \ *permission*\ ] [\ **-**\ **-interactive**\ ] [\ **-**\ **-dryrun**\ ] [\ **-**\ **-ignorekernelchk**\ ] [\ **-**\ **-noupdate**\ ] \ *imagename*\ +\ **genimage**\ [\ **-o**\ \ *osver*\ ] [\ **-a**\ \ *arch*\ ] [\ **-p**\ \ *profile*\ ] [\ **-i**\ \ *nodebootif*\ ] [\ **-n**\ \ *nodenetdrivers*\ ] [\ **-**\ **-onlyinitrd**\ ] [\ **-r**\ \ *otherifaces*\ ] [\ **-k**\ \ *kernelver*\ ] [\ **-g**\ \ *krpmver*\ ] [\ **-m**\ \ *statelite*\ ] [\ **-l**\ \ *rootlimitsize*\ ] [\ **-**\ **-permission**\ \ *permission*\ ] [\ **-**\ **-interactive**\ ] [\ **-**\ **-dryrun**\ ] [\ **-**\ **-ignorekernelchk**\ ] [\ **-**\ **-noupdate**\ ] \ *imagename*\ \ **genimage**\ [\ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ] @@ -42,9 +42,9 @@ The \ **genimage**\ command will generate two initial ramdisks for \ **stateles After your image is generated, you can chroot to the image, install any additional software you would like, or make modifications to files, and then run the following command to prepare the image for deployment. -for stateless: \ **packimage**\ +for stateless: \ **packimage**\ -for statelite: \ **liteimg**\ +for statelite: \ **liteimg**\ Besides prompting for some parameter values, the \ **genimage**\ command takes default guesses for the parameters not specified or not defined in the \ *osimage*\ and \ *linuximage*\ tables. It also assumes default answers for questions from the yum/zypper command when installing rpms into the image. Use \ **-**\ **-interactive**\ flag if you want the yum/zypper command to prompt you for the answers. @@ -70,135 +70,135 @@ OPTIONS -\ **-a**\ \ *arch*\ - +\ **-a**\ \ *arch*\ + The hardware architecture of this node: x86_64, ppc64, x86, ia64, etc. If omitted, the current hardware architecture will be used. + - -\ **-o**\ \ *osver*\ - +\ **-o**\ \ *osver*\ + The operating system for the image: fedora8, rhel5, sles10, etc. The OS packages must be in /install// (use copycds(8)|copycds.8). + - -\ **-p**\ \ *profile*\ - +\ **-p**\ \ *profile*\ + The profile (e.g. compute, service) to use to create the image. This determines what package lists are used from /opt/xcat/share/xcat/netboot/ to create the image with. When deploying nodes with this image, the nodes' nodetype.profile attribute must be set to this same value. + - -\ **-i**\ \ *nodebootif*\ - +\ **-i**\ \ *nodebootif*\ + This argument is now optional, and allows you to specify the network boot interface to be configured in the image (e.g. eth0). If not specified, the interface will be determined and configured during the network boot process. + - -\ **-n**\ \ *nodenetdrivers*\ - +\ **-n**\ \ *nodenetdrivers*\ + This argument is now optional, and allows you to specify the driver modules needed for the network interface(s) on your stateless nodes. If you do not specify this option, the default is to include all recent IBM xSeries network drivers. - + If specified, \ *nodenetdrivers*\ should be a comma separated list of network drivers to be used by the stateless nodes (Ie.: -n tg3,e1000). Note that the drivers will be loaded in the order that you list them, which may prove important in some cases. + - -\ **-l**\ \ *rootlimit*\ - +\ **-l**\ \ *rootlimit*\ + The maximum size allowed for the root file system in the image. Specify in bytes, or can append k, m, or g. + - -\ **-**\ **-onlyinitrd**\ - +\ **-**\ **-onlyinitrd**\ + Regenerates the initrd for a stateless image to be used for a diskless install. - + Regenerates the initrd that is part of a stateless/statelite image that is used to boot xCAT nodes in a stateless/stateli te mode. - + The \ **genimage -**\ **-onlyinitrd**\ command will generate two initial ramdisks, one is \ **initrd-statelite.gz**\ for \ **statelite**\ mode, the other one is \ **initrd-stateless.gz**\ for \ **stateless**\ mode. + - -\ **-**\ **-permission**\ \ *permission*\ - +\ **-**\ **-permission**\ \ *permission*\ + The mount permission of \ **/.statelite**\ directory for \ **statelite**\ mode, which is only used for \ **statelite**\ mode, and the default permission is 755. + - -\ **-r**\ \ *otherifaces*\ - +\ **-r**\ \ *otherifaces*\ + Other network interfaces (e.g. eth1) in the image that should be configured via DHCP. + - -\ **-k**\ \ *kernelver*\ - +\ **-k**\ \ *kernelver*\ + Use this flag if you want to use a specific version of the kernel in the image. Defaults to the first kernel found in the install image. + - -\ **-g**\ \ *krpmver*\ - +\ **-g**\ \ *krpmver*\ + Use this flag to specify the rpm version for kernel packages in the image. It must be present if -k flag is specified in the command for SLES. Generally, the value of -g is the part after \ **linux-**\ and before \ **.rpm**\ in a kernel rpm name. - + \ **-m**\ statelite - + This flag is for Ubuntu, Debian and Fedora12 only. Use this flag to specify if you want to generate statelite image. The default is to generate stateless image for these three operating systems. For others, this flag is invalid because both stateless and statelite images will be generated with this command. + - -\ **-**\ **-interactive**\ - +\ **-**\ **-interactive**\ + This flag allows the user to answer questions from yum/zypper command when installing rpms into the image. If it is not specified, '-y' will be passed to the yum command and '--non-interactive --no-gpg-checks' will be passed to the zypper command as default answers. + - -\ **-**\ **-dryrun**\ - +\ **-**\ **-dryrun**\ + This flag shows the underlying call to the os specific genimage function. The user can copy and the paste the output to run the command on another machine that does not have xCAT installed. + - -\ **-t**\ \ *tmplimit*\ - +\ **-t**\ \ *tmplimit*\ + (Deprecated) This flag allows the user to setup the /tmp and the /var/tmp file system sizes. This flag is no longer supported. You can overwrite any file system size using the .postinstall script where you can create a new /etc/fstab file. + - -\ **-**\ **-ignorekernelchk**\ - +\ **-**\ **-ignorekernelchk**\ + Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel. + - -\ **-**\ **-noupdate**\ - +\ **-**\ **-noupdate**\ + This flag allows the user to bypass automatic package updating when installing other packages. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display version. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -219,53 +219,53 @@ EXAMPLES 1 To prompt the user for inputs: - - + + .. code-block:: perl - + genimage - - + + 2 To generate an image using information from an osimage definition: - - + + .. code-block:: perl - + genimage myimagename - - + + 3 To run genimage in test mode without actually generating an image: - - + + .. code-block:: perl - + genimage --dryrun myimagename - - + + 4 To generate an image and have yum/zypper prompt for responses: - - + + .. code-block:: perl - + genimage myimagename --interactive - - + + 5 To generate an image, replacing some values in the osimage definition: - - + + .. code-block:: perl - + genimage -i eth0 -n tg3 myimagename - - + + diff --git a/docs/source/guides/admin-guides/references/man1/geninitrd.1.rst b/docs/source/guides/admin-guides/references/man1/geninitrd.1.rst index fa871f0aa..2e224ff8c 100644 --- a/docs/source/guides/admin-guides/references/man1/geninitrd.1.rst +++ b/docs/source/guides/admin-guides/references/man1/geninitrd.1.rst @@ -31,7 +31,7 @@ DESCRIPTION Generate the initrd for the osimage: \ **imagename**\ which is an xCAT object of \ *osimage*\ type. -\ **Diskful Osimage**\ +\ **Diskful Osimage**\ If the \ **imagename**\ is a stateful one (The provmethod attribute for the osimage is 'install'), @@ -57,7 +57,7 @@ to get all the rpm packages and then search the drivers from the rpm packages. Refer to the doc: Using_Linux_Driver_Update_Disk -\ **Stateless Osimage**\ +\ **Stateless Osimage**\ If the \ **imagename**\ is a stateless one (The provmethod attribute for the osimage is 'netboot'), @@ -82,10 +82,10 @@ Parameters \ *imagename*\ specifies the name of an os image definition to be used. The specification for the image is stored in the \ *osimage*\ table and \ *linuximage*\ table. -\ **-**\ **-ignorekernelchk**\ - +\ **-**\ **-ignorekernelchk**\ + Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel. - + @@ -106,13 +106,13 @@ EXAMPLES 1 To generate initrd for the osimage \ **myimagename**\ : - - + + .. code-block:: perl - + geninitrd myimagename - - + + diff --git a/docs/source/guides/admin-guides/references/man1/getmacs.1.rst b/docs/source/guides/admin-guides/references/man1/getmacs.1.rst index ced794535..a38bc1abf 100644 --- a/docs/source/guides/admin-guides/references/man1/getmacs.1.rst +++ b/docs/source/guides/admin-guides/references/man1/getmacs.1.rst @@ -72,63 +72,63 @@ OPTIONS ******* -\ **-**\ **-arp**\ +\ **-**\ **-arp**\ Read MAC address with ARP protocol. -\ **-C**\ +\ **-C**\ Specify the IP address of the partition for ping test. The default is to read from xCAT database if no \ **-C**\ specified. -\ **-d**\ +\ **-d**\ Display MAC only. The default is to write the first valid adapter MAC to the xCAT database. -\ **-D**\ +\ **-D**\ Perform discovery for mac address. By default, it will run ping test to test the connection between adapter and xCAT management node. Use '--noping' can skip the ping test to save time. Be aware that in this way, the lpars will be reset. -\ **-f**\ +\ **-f**\ Force immediate shutdown of the partition. This flag must be used with -D flag. -\ **-F**\ +\ **-F**\ Specify filters to select the correct adapter. Acceptable filters are Type, MAC_Address, Phys_Port_Loc, Adapter, Port_Group, Phys_Port, Logical_Port, VLan, VSwitch, Curr_Conn_Speed. -\ **-G**\ +\ **-G**\ Gateway IP address of the partition. The default is to read from xCAT database if no \ **-G**\ specified. -\ **-h**\ +\ **-h**\ Display usage message. -\ **-M**\ +\ **-M**\ Return multiple MAC addresses for the same adapter or port, if available from the hardware. For some network adapters (e.g. HFI) the MAC can change when there are some recoverable internal errors. In this case, the hardware can return several MACs that the adapter can potentially have, so that xCAT can put all of them in DHCP. This allows successful booting, even after a MAC change, but on Linux at this time, it can also cause duplicate IP addresses, so it is currently not recommended on Linux. By default (without this flag), only a single MAC address is returned for each adapter. -\ **-**\ **-noping**\ +\ **-**\ **-noping**\ Only can be used with '-D' to display all the available adapters with mac address but do NOT run ping test. -\ **-o**\ +\ **-o**\ Read MAC address when the lpar is in openfirmware state. This option mush be used with [\ **-D**\ ] option to perform ping test. Before use \ **-o**\ , the lpar must be in openfirmware state. -\ **-S**\ +\ **-S**\ The IP address of the machine to ping. The default is to read from xCAT database if no \ **-S**\ specified. -\ **-v**\ +\ **-v**\ Command Version. -\ **-V**\ +\ **-V**\ Verbose output. -\ **-i**\ +\ **-i**\ Specify the interface whose mac address will be collected and written into mac table. If 4 mac addresses are returned by option '-d', they all are the mac addresses of the blade. The N can start from 0(map to the eth0 of the blade) to 3. If 5 mac addresses are returned, the 1st mac address must be the mac address of the blade's FSP, so the N will start from 1(map to the eth0 of the blade) to 4. diff --git a/docs/source/guides/admin-guides/references/man1/getslnodes.1.rst b/docs/source/guides/admin-guides/references/man1/getslnodes.1.rst index 9c4979fa5..34a34f3f3 100644 --- a/docs/source/guides/admin-guides/references/man1/getslnodes.1.rst +++ b/docs/source/guides/admin-guides/references/man1/getslnodes.1.rst @@ -65,16 +65,16 @@ OPTIONS -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. - + @@ -95,39 +95,39 @@ EXAMPLES 1. - + Display information about all of the nodes in your SoftLayer account: - - + + .. code-block:: perl - + getslnodes - - + + 2. - + Display information about all of the nodes whose hostname starts with foo: - - + + .. code-block:: perl - + getslnodes foo - - + + 3. - + Create xCAT node defintions in the xCAT DB for all of the nodes in your SoftLayer account: - - + + .. code-block:: perl - + getslnodes | mkdef -z - - + + diff --git a/docs/source/guides/admin-guides/references/man1/gettab.1.rst b/docs/source/guides/admin-guides/references/man1/gettab.1.rst index 71bb19c0f..b158b6122 100644 --- a/docs/source/guides/admin-guides/references/man1/gettab.1.rst +++ b/docs/source/guides/admin-guides/references/man1/gettab.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **gettab**\ [\ **-H**\ | \ **-**\ **-with-fieldname**\ ] \ *key=value,... table.attribute ...*\ +\ **gettab**\ [\ **-H**\ | \ **-**\ **-with-fieldname**\ ] \ *key=value,... table.attribute ...*\ \ **gettab**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ ] @@ -41,17 +41,17 @@ OPTIONS -\ **-H|-**\ **-with-fieldname**\ - +\ **-H|-**\ **-with-fieldname**\ + Always display table.attribute name next to result. By default, this is done only if more than one table.attribute is requested. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -77,39 +77,39 @@ EXAMPLES 1. To display setting for \ **master**\ (management node) in the site table: - - + + .. code-block:: perl - + gettab -H key=master site.value - - + + The output would be similar to: - - + + .. code-block:: perl - + site.value: mgmtnode.cluster.com - - + + 2. To display the first node or group name that has \ **mgt**\ set to \ **blade**\ in the nodehm table: - - + + .. code-block:: perl - + gettab mgt=blade nodehm.node - - + + The output would be similar to: - - + + .. code-block:: perl - + blades - - + + diff --git a/docs/source/guides/admin-guides/references/man1/groupfiles4dsh.1.rst b/docs/source/guides/admin-guides/references/man1/groupfiles4dsh.1.rst index 8ebbde2dd..3a2675767 100644 --- a/docs/source/guides/admin-guides/references/man1/groupfiles4dsh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/groupfiles4dsh.1.rst @@ -82,7 +82,7 @@ To use with dsh: export DSH_CONTEXT=DSH ( default unless CSM is installed) export DSH_NODE_RSH=/bin/ssh (default is rsh) export DSH_NODEGROUP_PATH= /tmp/nodegroupfiles - + dsh -N all date (where all is a group defined in xCAT) dsh -a date (will look in all nodegroupfiles and build a list of all nodes) diff --git a/docs/source/guides/admin-guides/references/man1/imgcapture.1.rst b/docs/source/guides/admin-guides/references/man1/imgcapture.1.rst index 5e2546dbb..663064609 100644 --- a/docs/source/guides/admin-guides/references/man1/imgcapture.1.rst +++ b/docs/source/guides/admin-guides/references/man1/imgcapture.1.rst @@ -58,80 +58,80 @@ OPTIONS -\ **-t | -**\ **-type**\ - +\ **-t | -**\ **-type**\ + Specify the osimage type you want to capture, two types are supported: diskless and sysclone. + - -\ **-p|-**\ **-profile**\ \ *profile*\ - +\ **-p|-**\ **-profile**\ \ *profile*\ + Assign \ *profile*\ as the profile of the image to be created. + - -\ **-o|-**\ **-osimage**\ \ *osimage*\ - +\ **-o|-**\ **-osimage**\ \ *osimage*\ + The osimage name. + - -\ **-i**\ \ *nodebootif*\ - +\ **-i**\ \ *nodebootif*\ + The network interface the diskless node will boot over (e.g. eth0), which is used by the \ **genimage**\ command to generate initial ramdisks. + - -\ **-n**\ \ *nodenetdrivers*\ - +\ **-n**\ \ *nodenetdrivers*\ + The driver modules needed for the network interface, which is used by the \ **genimage**\ command to generate initial ramdisks. - + By default, the \ **genimage**\ command can provide drivers for the following network interfaces: - + For x86 or x86_64 platform: - - + + .. code-block:: perl - + tg3 bnx2 bnx2x e1000 e1000e igb m1x_en - - + + For ppc64 platform: - - + + .. code-block:: perl - + e1000 e1000e igb ibmveth ehea - - + + For S390x: - - + + .. code-block:: perl - + qdio ccwgroup - - + + If the network interface is not in the above list, you'd better specify the driver modules with this option. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display the version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + diff --git a/docs/source/guides/admin-guides/references/man1/imgexport.1.rst b/docs/source/guides/admin-guides/references/man1/imgexport.1.rst index c9359d8cf..3626725f1 100644 --- a/docs/source/guides/admin-guides/references/man1/imgexport.1.rst +++ b/docs/source/guides/admin-guides/references/man1/imgexport.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **imgexport [-h| -**\ **-help]**\ +\ **imgexport [-h| -**\ **-help]**\ \ **imgexport**\ \ *image_name*\ [\ *destination*\ ] [[\ **-e | -**\ **-extra**\ \ *file:dir*\ ] ... ] [\ **-p | -**\ **-postscripts**\ \ *node_name*\ ] [\ **-v | -**\ **-verbose**\ ] @@ -72,40 +72,40 @@ OPTIONS -\ **-e|-**\ **-extra**\ \ *srcfile:destdir*\ - +\ **-e|-**\ **-extra**\ \ *srcfile:destdir*\ + Pack up extra files. If \ *destdir*\ is omitted, the destination directory will be the same as the source directory. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-p|-**\ **-postscripts**\ \ *node_name*\ - +\ **-p|-**\ **-postscripts**\ \ *node_name*\ + Get the names of the postscripts and postbootscripts for the given node and pack them into the image. + - -\ **-v|-**\ **-verbose**\ - +\ **-v|-**\ **-verbose**\ + Verbose output. + - -\ *image_name*\ - +\ *image_name*\ + The name of the image. Use \ **lsdef -t osimage**\ to find out all the image names. + - -\ *destination*\ - +\ *destination*\ + The output bundle file name. - + diff --git a/docs/source/guides/admin-guides/references/man1/imgimport.1.rst b/docs/source/guides/admin-guides/references/man1/imgimport.1.rst index df19fae09..e813f3377 100644 --- a/docs/source/guides/admin-guides/references/man1/imgimport.1.rst +++ b/docs/source/guides/admin-guides/references/man1/imgimport.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **imgimport [-h|-**\ **-help]**\ +\ **imgimport [-h|-**\ **-help]**\ \ **imgimport**\ \ *bundle_file_name*\ [\ **-p | -**\ **-postscripts**\ \ *nodelist*\ ] [\ **-f | -**\ **-profile**\ \ *new_profile*\ ] [\ **-v | -**\ **-verbose**\ ] @@ -91,28 +91,28 @@ OPTIONS -\ **-f|-**\ **-profile**\ \ *new_profile*\ - +\ **-f|-**\ **-profile**\ \ *new_profile*\ + Import the image with a new profile name. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-p|-**\ **-postscripts**\ \ *nodelist*\ - +\ **-p|-**\ **-postscripts**\ \ *nodelist*\ + Import the postscripts. The postscripts contained in the image will be set in the postscripts table for \ *nodelist*\ . + - -\ **-v|-**\ **-verbose**\ - +\ **-v|-**\ **-verbose**\ + Verbose output. - + diff --git a/docs/source/guides/admin-guides/references/man1/liteimg.1.rst b/docs/source/guides/admin-guides/references/man1/liteimg.1.rst index 8235e1717..a2b0f6588 100644 --- a/docs/source/guides/admin-guides/references/man1/liteimg.1.rst +++ b/docs/source/guides/admin-guides/references/man1/liteimg.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **liteimg [-h| -**\ **-help]**\ +\ **liteimg [-h| -**\ **-help]**\ -\ **liteimg [-v| -**\ **-version]**\ +\ **liteimg [-v| -**\ **-version]**\ -\ **liteimg**\ \ *imagename*\ +\ **liteimg**\ \ *imagename*\ *********** @@ -36,24 +36,24 @@ It creates 2 levels of indirection so that files can be modified while in their image state as well as during runtime. For example, a file like <$imgroot>/etc/ntp.conf will have the following operations done to it: -\ * mkdir -p $imgroot/.default/etc*\ +\ * mkdir -p $imgroot/.default/etc*\ -\ * mkdir -p $imgroot/.statelite/tmpfs/etc*\ +\ * mkdir -p $imgroot/.statelite/tmpfs/etc*\ -\ * mv $imgroot/etc/ntp.conf $imgroot/.default/etc*\ +\ * mv $imgroot/etc/ntp.conf $imgroot/.default/etc*\ -\ * cd $imgroot/.statelite/tmpfs/etc*\ +\ * cd $imgroot/.statelite/tmpfs/etc*\ -\ * ln -sf ../../../.default/etc/ntp.conf .*\ +\ * ln -sf ../../../.default/etc/ntp.conf .*\ -\ * cd $imgroot/etc*\ +\ * cd $imgroot/etc*\ -\ * ln -sf ../.statelite/tmpfs/etc/ntp.conf .*\ +\ * ln -sf ../.statelite/tmpfs/etc/ntp.conf .*\ When finished, the original file will reside in \ *$imgroot/.default/etc/ntp.conf*\ . \ *$imgroot/etc/ntp.conf*\ will link to \ *$imgroot/.statelite/tmpfs/etc/ntp.conf*\ which will in turn link to -\ *$imgroot/.default/etc/ntp.conf*\ +\ *$imgroot/.default/etc/ntp.conf*\ Note: If you make any changes to your litefile table after running liteimg then you will need to rerun liteimg again. diff --git a/docs/source/guides/admin-guides/references/man1/lsdef.1.rst b/docs/source/guides/admin-guides/references/man1/lsdef.1.rst index 85cf5b30f..e5585d61b 100644 --- a/docs/source/guides/admin-guides/references/man1/lsdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsdef.1.rst @@ -45,113 +45,113 @@ OPTIONS -\ **-a|-**\ **-all**\ - +\ **-a|-**\ **-all**\ + Display all definitions. For performance consideration, the auditlog and eventlog objects will not be listed. To list auditlog or eventlog objects, use lsdef -t auditlog or lsdef -t eventlog instead. + - -\ **-c|-**\ **-compress**\ - +\ **-c|-**\ **-compress**\ + Display information in compressed mode, each output line has format ": ". The output can be passed to command xcoll or xdshbak for formatted output. The -c flag must be used with -i flag. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-i**\ \ *attr-list*\ - +\ **-i**\ \ *attr-list*\ + Comma separated list of attribute names to display. + - -\ **-l|-**\ **-long**\ - +\ **-l|-**\ **-long**\ + List the complete object definition. + - -\ **-s|-**\ **-short**\ - +\ **-s|-**\ **-short**\ + Only list the object names. + - -\ **-S**\ - +\ **-S**\ + List all the hidden nodes (FSP/BPA nodes) with other ones. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats. + - -\ **-o**\ \ *object-names*\ - +\ **-o**\ \ *object-names*\ + A set of comma delimited object names. - + \ **-**\ **-template**\ [\ *template-object-name*\ ] - + Show the object definition templates \ *template-object-name*\ shipped in xCAT. If no \ *template-object-name*\ is specified, all the object definition templates of the specified type \ **-t**\ \ *object-types*\ will be listed. Use \ **-a|-**\ **-all**\ option to list all the object definition templates. + - -\ **-**\ **-osimage**\ - +\ **-**\ **-osimage**\ + Show all the osimage information for the node. + - -\ **-**\ **-nics**\ - +\ **-**\ **-nics**\ + Show the nics configuration information for the node. + - -\ **-t**\ \ *object-types*\ - +\ **-t**\ \ *object-types*\ + A set of comma delimited object types. Use the help option to get a list of valid objects. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + \ **-w**\ \ *attr==val*\ \ **-w**\ \ *attr=~val*\ ... - + Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. Use the help option to get a list of valid attributes for each object type. - + Operator descriptions: == Select nodes where the attribute value is exactly this value. != Select nodes where the attribute value is not this specific value. =~ Select nodes where the attribute value matches this regular expression. !~ Select nodes where the attribute value does not match this regular expression. - + Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. + - -\ **-z|-**\ **-stanza**\ - +\ **-z|-**\ **-stanza**\ + Display output in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files. - + @@ -172,253 +172,253 @@ EXAMPLES 1. - + To display a description of all the valid attributes that could be used when defining an xCAT node. - - + + .. code-block:: perl - + lsdef -t node -h - - + + 2. - + To get a list of all the objects that have been defined. - - + + .. code-block:: perl - + lsdef OR lsdef -a - - + + 3. - + To get all the attributes of the node1 - - + + .. code-block:: perl - + lsdef node1 OR lsdef -t node node1 OR lsdef -t node -o node1 - - + + 4. - + To get the object name of node1 instead of all the attributes - - + + .. code-block:: perl - + lsdef -s node1 - - + + 5. - + To get a list of all the network definitions. - - + + .. code-block:: perl - + lsdef -t network - - + + 6. - + To get a complete listing of all network definitions. - - + + .. code-block:: perl - + lsdef -l -t network - - + + 7. - + To list the whole xCAT database and write it to a stanza file. (backup database) - - + + .. code-block:: perl - + lsdef -a -l -z > mydbstanzafile - - + + 8. - + To list the MAC and install adapter name for each node. - - + + .. code-block:: perl - + lsdef -t node -i mac,installnic - - + + 9. - + To list an osimage definition named "aix53J". - - + + .. code-block:: perl - + lsdef -t osimage -l -o aix53J - - + + 10. - + To list all node definitions that have a status value of "booting". - - + + .. code-block:: perl - + lsdef -t node -w status==booting - - + + 11. - + To list all the attributes of the group "service". - - + + .. code-block:: perl - + lsdef -l -t group -o service - - + + 12. - + To list all the attributes of the nodes that are members of the group "service". - - + + .. code-block:: perl - + lsdef -t node -l service - - + + 13. - + To get a listing of object definitions that includes information about what xCAT database tables are used to store the data. - - + + .. code-block:: perl - + lsdef -V -l -t node -o node01 - - + + 14. - + To list the hidden nodes that can't be seen with other flags. The hidden nodes are FSP/BPAs. - - + + .. code-block:: perl - + lsdef -S - - + + 15. - + To list the nodes status and use xcoll to format the output. - - + + .. code-block:: perl - + lsdef -t node -i status -c | xcoll - - + + 16. - + To display the description for some specific attributes that could be used when defining an xCAT node. - - + + .. code-block:: perl - + lsdef -t node -h -i profile,pprofile - - + + 17. - + To display the nics configuration information for node cn1. - - + + .. code-block:: perl - + lsdef cn1 --nics - - + + 18. - + To list all the object definition templates shipped in xCAT. - - + + .. code-block:: perl - + lsdef --template -a - - + + 19. - + To display the details of "node" object definition template "ppc64le-template" shipped in xCAT. - - + + .. code-block:: perl - + lsdef -t node --template ppc64le-template - - + + 20. - + To list all the "node" object definition templates shipped in xCAT. - - + + .. code-block:: perl - + lsdef -t node --template - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsdocker.1.rst b/docs/source/guides/admin-guides/references/man1/lsdocker.1.rst index 239e7408d..67b5fd0fa 100644 --- a/docs/source/guides/admin-guides/references/man1/lsdocker.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsdocker.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **lsdocker**\ \ *noderange*\ [\ **-l | -**\ **-logs**\ ] -\ **lsdocker**\ \ *dockerhost*\ +\ **lsdocker**\ \ *dockerhost*\ \ **lsdocker**\ [\ **-h | -**\ **-help**\ ] @@ -42,7 +42,7 @@ OPTIONS -\ **-l|-**\ **-logs**\ +\ **-l|-**\ **-logs**\ @@ -56,40 +56,40 @@ EXAMPLES 1. To get info for docker instance "host01c01" - - + + .. code-block:: perl - + lsdocker host01c01 - - + + Output is similar to: - - + + .. code-block:: perl - + host01c01: 50800dfd8b5f ubuntu /bin/bash 2016-01-13T06:32:59 running /host01c01 - - + + 2. To get info for running docker instance on dockerhost "host01" - - + + .. code-block:: perl - + lsdocker host01 - - + + Output is similar to: - - + + .. code-block:: perl - + host01: 50800dfd8b5f ubuntu /bin/bash 2016-1-13 - 1:32:59 Up 12 minutes /host01c01 host01: 875ce11d5987 ubuntu /bin/bash 2016-1-21 - 1:12:37 Up 5 seconds /host01c02 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsflexnode.1.rst b/docs/source/guides/admin-guides/references/man1/lsflexnode.1.rst index 68c3d604a..e72fc0ce0 100644 --- a/docs/source/guides/admin-guides/references/man1/lsflexnode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsflexnode.1.rst @@ -23,7 +23,7 @@ SYNOPSIS \ **lsflexnode**\ [\ **-v**\ | \ **-**\ **-version**\ ] -\ **lsflexnode**\ \ *noderange*\ +\ **lsflexnode**\ \ *noderange*\ *********** @@ -55,16 +55,16 @@ OPTIONS -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display the usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the version information. - + @@ -76,102 +76,102 @@ ATTRIBUTES The meaning of attributes which displayed by the \ **lsflexnode**\ . The word 'node' in this section means \ **Blade slot node**\ . -\ **Complex**\ - +\ **Complex**\ + The unique numeric identifier for a complex installed in the chassis. + - -\ **Partition number**\ - +\ **Partition number**\ + The number of partitions currently defined for this complex. + - -\ **Complex node number**\ - +\ **Complex node number**\ + The number of nodes existing in this complex, regardless of their assignment to any given partition. + - -\ **Partition**\ - +\ **Partition**\ + The unique numeric identifier for a partition defined within a complex installed in the chassis. + - -\ **Partition Mode**\ - +\ **Partition Mode**\ + The currently configured mode of this partition. It can be 'partition' or 'standalone'. + - -\ **Partition node number**\ - +\ **Partition node number**\ + The number of nodes currently defined for this partition. + - -\ **Partition status**\ - +\ **Partition status**\ + The current power status of this partition when the partition has a valid partition configuration. It can be 'poweredoff', 'poweredon', 'resetting' or 'invalid'. + - -\ **Node**\ - +\ **Node**\ + The unique numeric identifier for this node, unique within the partition. If this node does not belong to a partition, the slot number will be displayed. + - -\ **Node state**\ - +\ **Node state**\ + The physical power state of this node. It can be 'poweredoff', 'poweredon' or 'resetting'. + - -\ **Node slot**\ - +\ **Node slot**\ + The base slot number where the node exists in the chassis. + - -\ **Node resource**\ - +\ **Node resource**\ + A string providing a summary overview of the resources provided by this node. It includes the CPU number, CPU frequency and Memory size. + - -\ **Node type**\ - +\ **Node type**\ + The general categorization of the node. It can be 'processor', 'memory' or 'io'. + - -\ **Node role**\ - +\ **Node role**\ + Indicates if the node is assigned to a partition, and if so, provides an indication of whether the node is the primary node of the partition or not. + - -\ **Flexnode state**\ - +\ **Flexnode state**\ + The state of a flexible node. It is the state of the partition which this node belongs to. If this node does NOT belong to a partition, the value should be 'invalid'. - + It can be 'poweredoff', 'poweredon', 'resetting' or 'invalid'. + - -\ **Complex id**\ - +\ **Complex id**\ + The identifier of the complex this node belongs to. + - -\ **Partition id**\ - +\ **Partition id**\ + The identifier of the partition this node belongs to. - + @@ -182,18 +182,18 @@ EXAMPLES 1 Display all the \ **Complex**\ , \ **Partition**\ and \ **Blade slot node**\ which managed by a AMM. - - + + .. code-block:: perl - + lsflexnode amm1 - - + + The output: - - + + .. code-block:: perl - + amm1: Complex - 24068 amm1: ..Partition number - 1 amm1: ..Complex node number - 2 @@ -214,23 +214,23 @@ EXAMPLES amm1: ......Node type - processor amm1: ......Node resource - 2 (1866 MHz) / 8 (2 GB) amm1: ......Node role - unassigned - - + + 2 Display a flexible node. - - + + .. code-block:: perl - + lsflexnode blade1 - - + + The output: - - + + .. code-block:: perl - + blade1: Flexnode state - poweredoff blade1: Complex id - 24068 blade1: Partition id - 1 @@ -239,8 +239,8 @@ EXAMPLES blade1: Slot14: Node type - processor blade1: Slot14: Node resource - 2 (1866 MHz) / 8 (2 GB) blade1: Slot14: Node role - secondary - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lshwconn.1.rst b/docs/source/guides/admin-guides/references/man1/lshwconn.1.rst index e3ae23a33..017ef1cc2 100644 --- a/docs/source/guides/admin-guides/references/man1/lshwconn.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lshwconn.1.rst @@ -27,14 +27,14 @@ PPC (with HMC) specific: ======================== -\ **lshwconn**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ +\ **lshwconn**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ PPC (without HMC, using FSPAPI) specific: ========================================= -\ **lshwconn**\ \ *noderange*\ \ **-T**\ \ *tooltype*\ +\ **lshwconn**\ \ *noderange*\ \ **-T**\ \ *tooltype*\ @@ -52,22 +52,22 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. + - -\ **-T**\ - +\ **-T**\ + The tooltype is used to communicate to the CEC/Frame. The value could be lpar or fnm. The tooltype value lpar is for xCAT and fnm is for CNM. - + @@ -88,66 +88,66 @@ EXAMPLES 1. - + To display connection status for all CEC nodes in node group CEC: - - + + .. code-block:: perl - + lshwconn cec - - + + Output is similar to: - - + + .. code-block:: perl - + cec1: ipaddr=192.168.200.245,alt_ipaddr=unavailable,state=Connected cec2: Connection not found - - + + 2. - + To display connection status for Frame node frame1: - - + + .. code-block:: perl - + lshwconn frame1 - - + + Output is similar to: - - + + .. code-block:: perl - + frame1: side=a,ipaddr=192.168.200.247,alt_ipaddr=unavailable,state=Connected frame1: side=b,ipaddr=192.168.200.248,alt_ipaddr=unavailable,state=Connected - - + + 3. - + To display connection status for all CEC nodes in node group CEC to hardware server, and using lpar tooltype: - - + + .. code-block:: perl - + lshwconn cec -T lpar - - + + Output is similar to: - - + + .. code-block:: perl - + cec1: sp=primary,ipadd=40.3.7.1,alt_ipadd=unavailable,state=LINE UP cec2: Connection not found - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lskit.1.rst b/docs/source/guides/admin-guides/references/man1/lskit.1.rst index c845cadb3..07081e15d 100644 --- a/docs/source/guides/admin-guides/references/man1/lskit.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskit.1.rst @@ -46,44 +46,44 @@ OPTIONS -\ **-F|-**\ **-framework**\ \ *kit_path_name*\ - +\ **-F|-**\ **-framework**\ \ *kit_path_name*\ + Use this option to display the framework values of the specified Kit tarfile. This information is retreived directly from the tarfile and can be done before the Kit has been defined in the xCAT database. This option cannot be combined with other options. + - -\ **-K|-**\ **-kitattr**\ \ *kitattr_names*\ - +\ **-K|-**\ **-kitattr**\ \ *kitattr_names*\ + Where \ *kitattr_names*\ is a comma-delimited list of kit attribute names. The names correspond to attribute names in the \ **kit**\ table. The \ **lskit**\ command will only display the specified kit attributes. + - -\ **-R|-**\ **-repoattr**\ \ *repoattr_names*\ - +\ **-R|-**\ **-repoattr**\ \ *repoattr_names*\ + Where \ *repoattr_names*\ is a comma-delimited list of kit repository attribute names. The names correspond to attribute names in the \ **kitrepo**\ table. The \ **lskit**\ command will only display the specified kit repository attributes. + - -\ **-C|-**\ **-compattr**\ \ *compattr_names*\ - +\ **-C|-**\ **-compattr**\ \ *compattr_names*\ + where \ *compattr_names*\ is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the \ **kitcomponent**\ table. The \ **lskit**\ command will only display the specified kit component attributes. + - -\ *kit_names*\ - +\ *kit_names*\ + is a comma-delimited list of kit names. The \ **lskit**\ command will only display the kits matching these names. + - -\ **-x|-**\ **-xml|-**\ **-XML**\ - +\ **-x|-**\ **-xml|-**\ **-XML**\ + Need XCATXMLTRACE=1 env when using -x|--xml|--XML, for example: XCATXMLTRACE=1 lskit -x testkit-1.0.0 Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + ... @@ -95,58 +95,58 @@ OPTIONS ... - - + + Each tag contains info for one kit. The info inside is structured as follows: - - + + .. code-block:: perl - + The sub-tag contains the kit's basic info. The sub-tags store info about the kit's repositories. The sub-tags store info about the kit's components. - - + + The data inside is returned as: - - + + .. code-block:: perl - + ... - + ... ... - + ... ... + + - - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -172,64 +172,64 @@ EXAMPLES 1. To list all kits, enter: - - + + .. code-block:: perl - + lskit - - + + 2. To list the kit "kit-test1-1.0-Linux", enter: - - + + .. code-block:: perl - + lskit kit-test1-1.0-Linux - - + + 3. To list the kit "kit-test1-1.0-Linux" for selected attributes, enter: - - + + .. code-block:: perl - + lskit -K basename,description -R kitreponame -C kitcompname kit-test1-1.0-Linux - - + + 4. To list the framework value of a Kit tarfile. - - + + .. code-block:: perl - + lskit -F /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2 - - + + Output is similar to: - - + + .. code-block:: perl - + Extracting the kit.conf file from /myhome/mykits/pperte-1.3.0.2-0-x86_64.tar.bz2. Please wait. - + kitframework=2 compatible_kitframeworks=0,1,2 - - + + 5. To list kit "testkit-1.0-1" with XML tags, enter: - - + + .. code-block:: perl - + XCATXMLTRACE=1 lskit -x testkit-1.0-1 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst b/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst index 615db005a..895a065e1 100644 --- a/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst @@ -44,38 +44,38 @@ OPTIONS -\ **-C|-**\ **-compattr**\ \ *compattr_names*\ - +\ **-C|-**\ **-compattr**\ \ *compattr_names*\ + where \ *compattr_names*\ is a comma-delimited list of kit component attribute names. The names correspond to attribute names in the \ **kitcomponent**\ table. The \ **lskitcomp**\ command will only display the specified kit component attributes. + - -\ **-O|-**\ **-osdistro**\ \ *os_distro*\ - +\ **-O|-**\ **-osdistro**\ \ *os_distro*\ + where \ *os_distro*\ is the name of an osdistro in \ **osdistro**\ table. The \ **lskitcomp**\ command will only display the kit components matching the specified osdistro. + - -\ **-S|-**\ **-serverrole**\ \ *server_role*\ - +\ **-S|-**\ **-serverrole**\ \ *server_role*\ + where \ *server_role*\ is the name of a server role. The typical server roles are: mgtnode, servicenode, computenode, loginnode, storagennode. The \ **lskitcomp**\ command will only display the kit components matching the specified server role. + - -\ *kitcomp_names*\ - +\ *kitcomp_names*\ + is a comma-delimited list of kit component names. The \ **lskitcomp**\ command will only display the kit components matching the specified names. + - -\ **-x|-**\ **-xml|-**\ **-XML**\ - +\ **-x|-**\ **-xml|-**\ **-XML**\ + Need XCATXMLTRACE=1 env when using -x|--xml|--XML. Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + ... @@ -87,52 +87,52 @@ OPTIONS ... - - + + Each tag contains info for a group of kit components belonging to the same kit. The info inside is structured as follows: - - + + .. code-block:: perl - + The sub-tag contains the kit's name. The sub-tags store info about the kit's components. - - + + The data inside is returned as: - - + + .. code-block:: perl - + ... - + ... ... + + - - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -158,75 +158,75 @@ EXAMPLES 1. - + To list all kit components, enter: - - + + .. code-block:: perl - + lskitcomp - - + + 2. - + To list the kit component "comp-server-1.0-1-rhels-6-x86_64", enter: - - + + .. code-block:: perl - + lskitcomp comp-server-1.0-1-rhels-6-x86_64 - - + + 3. - + To list the kit component "comp-server-1.0-1-rhels-6-x86_64" for selected kit component attributes, enter: - - + + .. code-block:: perl - + lskitcomp -C kitcompname,desc comp-server-1.0-1-rhels-6-x86_64 - - + + 4. - + To list kit components compatible with "rhels-6.2-x86_64" osdistro, enter: - - + + .. code-block:: perl - + lskitcomp -O rhels-6.2-x86_64 - - + + 5. - + To list kit components compatible with "rhels-6.2-x86_64" osdistro and "computenode" server role, enter: - - + + .. code-block:: perl - + lskitcomp -O rhels-6.2-x86_64 -S computenode - - + + 6. - + To list the kit component "testkit-compute-1.0-1-ubuntu-14.04-ppc64el" with XML tags, enter: - - + + .. code-block:: perl - + XCATXMLTRACE=1 lskitcomp -x testkit-compute-1.0-1-ubuntu-14.04-ppc64el - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lskitdeployparam.1.rst b/docs/source/guides/admin-guides/references/man1/lskitdeployparam.1.rst index 099688d2d..28cc34092 100644 --- a/docs/source/guides/admin-guides/references/man1/lskitdeployparam.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskitdeployparam.1.rst @@ -44,25 +44,25 @@ OPTIONS -\ **-k|-**\ **-kitname**\ \ *kit_names*\ - +\ **-k|-**\ **-kitname**\ \ *kit_names*\ + Where \ *kit_names*\ is a comma-delimited list of kit names. The \ **lskitdeployparam**\ command will only display the deployment parameters for the kits with the matching names. + - -\ **-c|-**\ **-compname**\ \ *comp_names*\ - +\ **-c|-**\ **-compname**\ \ *comp_names*\ + Where \ *comp_names*\ is a comma-delimited list of kit component names. The \ **lskitdeployparam**\ command will only display the deployment parameters for the kit components with the matching names. + - -\ **-x|-**\ **-xml|-**\ **-XML**\ - +\ **-x|-**\ **-xml|-**\ **-XML**\ + Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + KIT_KIT1_PARAM1 @@ -76,26 +76,26 @@ OPTIONS ... + + - - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -121,27 +121,27 @@ EXAMPLES 1. - + To list kit deployment parameters for kit "kit-test1-1.0-Linux", enter: - - + + .. code-block:: perl - + lskitdeployparam -k kit-test1-1.0-Linux - - + + 2. - + To list kit deployment parameters for kit component "comp-server-1.0-1-rhels-6-x86_64", enter: - - + + .. code-block:: perl - + lskitdeployparam -c comp-server-1.0-1-rhels-6-x86_64 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lskmodules.1.rst b/docs/source/guides/admin-guides/references/man1/lskmodules.1.rst index 39042bd4e..f2787f892 100644 --- a/docs/source/guides/admin-guides/references/man1/lskmodules.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lskmodules.1.rst @@ -40,63 +40,63 @@ OPTIONS -\ **-i|-**\ **-osimage**\ \ *osimage_names*\ - +\ **-i|-**\ **-osimage**\ \ *osimage_names*\ + where \ *osimage_names*\ is a comma-delimited list of xCAT database osimage object names. For each \ *osimage_name*\ , lskmodules will use the entries in osimage.driverupdatesrc for the rpms and driver disk image files to search. + - -\ **-c|-**\ **-kitcomponent**\ \ *kitcomponent_names*\ - +\ **-c|-**\ **-kitcomponent**\ \ *kitcomponent_names*\ + where \ *kitcomponent_names*\ is a comma-delimited list of xCAT database kitcomponent object names. For each \ *kitcomponent_name*\ , lskmodules will use the entries in kitcomponent.driverpacks for the rpm list and the repodir of the kitcomponent.kitreponame for the location of the rpm files to search. + - -\ **-o|-**\ **-osdistro**\ \ *osdistro_names*\ - +\ **-o|-**\ **-osdistro**\ \ *osdistro_names*\ + where \ *osdistro_names*\ is a comma-delimited list of xCAT database osdistro object names. For each \ *osdistro_name*\ , lskmodules will search each /Packages/kernel-.rpm file. + - -\ **-u|-**\ **-osdistroupdate**\ \ *osdistroupdate_names*\ - +\ **-u|-**\ **-osdistroupdate**\ \ *osdistroupdate_names*\ + where \ *osdistroupdate_names*\ is a comma-delimited list of xCAT database osdistroupdate table entries. For each \ *osdistroupdate_name*\ , lskmodules will search the /kernel-.rpm file. + - -\ **-x|-**\ **-xml|-**\ **-XML**\ - +\ **-x|-**\ **-xml|-**\ **-XML**\ + Return the output with XML tags. The data is returned as: - - + + .. code-block:: perl - + xxx.ko this is module xxx - - + + This option is intended for use by other programs. The XML will not be displayed. To view the returned XML, set the XCATSHOWXML=yes environment variable before running this command. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -122,15 +122,15 @@ EXAMPLES 1. - + To list the kernel modules included in the driverpacks shipped with kitcomponent kit1_comp1-x86_64, enter: - - + + .. code-block:: perl - + lskmodules -c kit1_comp1-x86_64 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lslite.1.rst b/docs/source/guides/admin-guides/references/man1/lslite.1.rst index ebff6f37b..fce8f56e9 100644 --- a/docs/source/guides/admin-guides/references/man1/lslite.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lslite.1.rst @@ -38,28 +38,28 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-i**\ \ *imagename*\ - +\ **-i**\ \ *imagename*\ + The name of an existing xCAT osimage definition. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. - + @@ -80,61 +80,61 @@ EXAMPLES 1. - + To list the statelite information for an xCAT node named "node01". - - + + .. code-block:: perl - + lslite node01 - - + + Output is similar to: - - + + .. code-block:: perl - + >>>Node: node01 - + Osimage: 61img - + Persistent directory (statelite table): xcatmn1:/statelite - + Litefiles (litefile table): tmpfs,rw /etc/adjtime tmpfs,rw /etc/lvm/.cache tmpfs,rw /etc/mtab ........ - + Litetree path (litetree table): 1,MN:/etc 2,server1:/etc - - + + 2. - + To list the statelite information for an xCAT osimage named "osimage01". - - + + .. code-block:: perl - + lslite -i osimage01 - - + + Output is similar to: - - + + .. code-block:: perl - + tmpfs,rw /etc/adjtime tmpfs,rw /etc/lvm/.cache tmpfs,rw /etc/mtab ........ - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsslp.1.rst b/docs/source/guides/admin-guides/references/man1/lsslp.1.rst index 89add6b84..66772f3b4 100644 --- a/docs/source/guides/admin-guides/references/man1/lsslp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsslp.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **lsslp [-h| -**\ **-help]**\ +\ **lsslp [-h| -**\ **-help]**\ -\ **lsslp [-v| -**\ **-version]**\ +\ **lsslp [-v| -**\ **-version]**\ \ **lsslp**\ [\ *noderange*\ ] [\ **-V**\ ] [\ **-i**\ \ *ip[,ip..]*\ ] \ **[-w] [-r|-x|-z] [-n] [-s CEC|FRAME|MM|IVM|RSA|HMC|CMM|IMM2|FSP]**\ [\ **-t**\ \ *tries*\ ] [\ **-I**\ ] [\ **-C**\ \ *counts*\ ] [\ **-T**\ \ *timeout*\ ] [\ **-**\ **-vpdtable**\ ] @@ -251,7 +251,7 @@ Output is similar to: id=0 mac=00:14:5E:F0:5C:FD otherinterfaces=50.0.0.5 - + bpa01: objtype=node nodetype=bpa @@ -271,7 +271,7 @@ Output is similar to: .. code-block:: perl lsslp -s CEC - + device type-model serial-number side ip-addresses hostname FSP 9117-MMB 105EBEP A-1 20.0.0.138 20.0.0.138 FSP 9117-MMB 105EBEP B-1 20.0.0.139 20.0.0.139 @@ -292,7 +292,7 @@ Output is similar to: .. code-block:: perl These nodes defined in database but can't be discovered: f17c00bpcb_b,f17c01bpcb_a,f17c01bpcb_b,f17c02bpcb_a, - + device type-model serial-number side ip-addresses hostname bpa 9458-100 BPCF017 A-0 40.17.0.1 f17c00bpca_a bpa 9458-100 BPCF017 B-0 40.17.0.2 f17c00bpcb_a @@ -305,7 +305,7 @@ Output is similar to: lsslp CEC1-CEC3 or lsslp CEC1,CEC2,CEC3 - + device type-model serial-number side ip-addresses hostname FSP 9A01-100 0P1P336 A-0 192.168.200.34 192.168.200.34 FSP 9A01-100 0P1P336 B-0 192.168.200.35 192.168.200.35 diff --git a/docs/source/guides/admin-guides/references/man1/lstree.1.rst b/docs/source/guides/admin-guides/references/man1/lstree.1.rst index 677690c31..e6a4eeddf 100644 --- a/docs/source/guides/admin-guides/references/man1/lstree.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lstree.1.rst @@ -38,34 +38,34 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-s|-**\ **- servicenode**\ - +\ **-s|-**\ **- servicenode**\ + Show the tree of service node hierarchy. + - -\ **-H|-**\ **-hardwaremgmt**\ - +\ **-H|-**\ **-hardwaremgmt**\ + Show the tree of hardware hierarchy. + - -\ **-**\ **-v|-**\ **-virtualmachine**\ - +\ **-**\ **-v|-**\ **-virtualmachine**\ + Show the tree of VM hierarchy. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. - + @@ -86,173 +86,173 @@ EXAMPLES 1. To display the tree of service node hierarchy for all the nodes. - - + + .. code-block:: perl - + lstree -s - - + + Output is similar to: - - + + .. code-block:: perl - + Service Node: mysn01 |__mycn01 |__mycn02 |__mycn03 - + Service Node: mysn02 |__mycn11 |__mycn12 |__mycn13 ...... - - + + 2. - + To display the tree of service node hierarchy for service node "mysn01". - - + + .. code-block:: perl - + lstree -s mysn01 - - + + Output is similar to: - - + + .. code-block:: perl - + Service Node: mysn01 |__mycn01 |__mycn02 |__mycn03 - - + + 3. - + To display the tree of hardware hierarchy for all the nodes. - - + + .. code-block:: perl - + lstree -H - - + + Output is similar to: - - + + .. code-block:: perl - + HMC: myhmc01 |__Frame: myframe01 |__CEC: mycec01 |__CEC: mycec02 ...... - + Service Focal Point: myhmc02 |__Frame: myframe01 |__CEC: mycec01 |__CEC: mycec02 |__CEC: mycec03 ...... - + Management Module: mymm01 |__Blade 1: js22n01 |__Blade 2: js22n02 |__Blade 3: js22n03 ...... - + BMC: 192.168.0.1 |__Server: x3650n01 - - + + 4. To display the tree of hardware hierarchy for HMC "myhmc01". - - + + .. code-block:: perl - + lstree -H myhmc01 - - + + Output is similar to: - - + + .. code-block:: perl - + HMC: myhmc01 |__Frame: myframe01 |__CEC: mycec01 |__CEC: mycec02 ...... - - + + 5. To display the tree of VM hierarchy for all the nodes. - - + + .. code-block:: perl - + lstree -v - - + + Output is similar to: - - + + .. code-block:: perl - + Server: hs22n01 |__ hs22vm1 - + Server: x3650n01 |__ x3650n01kvm1 |__ x3650n01kvm2 - - + + 6. To display the tree of VM hierarchy for the node "x3650n01". - - + + .. code-block:: perl - + lstree -v x3650n01 - - + + Output is similar to: - - + + .. code-block:: perl - + Server: x3650n01 |__ x3650n01kvm1 |__ x3650n01kvm2 - - + + 7. To display both the hardware tree and VM tree for all nodes. - - + + .. code-block:: perl - + lstree - - + + Output is similar to: - - + + .. code-block:: perl - + HMC: myhmc01 |__Frame: myframe01 |__CEC: mycec01 @@ -265,7 +265,7 @@ EXAMPLES |__LPAR 2: node12 |__LPAR 3: node13 ...... - + Service Focal Point: myhmc02 |__Frame: myframe01 |__CEC: mycec01 @@ -279,7 +279,7 @@ EXAMPLES |__LPAR 2: node22 |__LPAR 3: node23 ...... - + Management Module: mymm01 |__Blade 1: hs22n01 |__hs22n01vm1 @@ -288,13 +288,13 @@ EXAMPLES |__hs22n02vm1 |__hs22n02vm2 ...... - + BMC: 192.168.0.1 |__Server: x3650n01 |__ x3650n01kvm1 |__ x3650n01kvm2 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsve.1.rst b/docs/source/guides/admin-guides/references/man1/lsve.1.rst index ab01f49fb..8ffd7b3b0 100644 --- a/docs/source/guides/admin-guides/references/man1/lsve.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsve.1.rst @@ -36,7 +36,7 @@ manager of virtual environment. xCAT needs it to access the RHEV manager. The mandatory parameter \ **-t**\ \ *type*\ is used to specify the type of the target object. -Basically, \ **lsve**\ command supports three types of object: \ **dc**\ , \ **cl**\ , \ **sd**\ , \ **nw**\ +Basically, \ **lsve**\ command supports three types of object: \ **dc**\ , \ **cl**\ , \ **sd**\ , \ **nw**\ and \ **tpl**\ . The parameter \ **-o object**\ is used to specify which object to list. If no \ **-o**\ is specified, @@ -54,9 +54,9 @@ OPTIONS \ **-m**\ Specify the manager of the virtual environment. - + For RHEV, the FQDN (Fully Qualified Domain Name) of the rhev manager have to be specified. - + \ **-o**\ The target object to display. @@ -64,19 +64,19 @@ OPTIONS \ **-t**\ Specify the \ **type**\ of the target object. - + Supported types: - - + + .. code-block:: perl - + B - Data Center (For type of 'dc', all the elements belongs to the data center will be listed.) B - Cluster B - Storage Domain (To get the status of Storage Doamin, show it from I it attached to. B - Network B - Template - - + + @@ -97,18 +97,18 @@ EXAMPLES 1. To list the data center 'Default', enter: - - + + .. code-block:: perl - + lsve -t dc -m -o Default - - + + Output is similar to: - - + + .. code-block:: perl - + datacenters: [Default] description: The default Data Center state: up @@ -148,44 +148,44 @@ EXAMPLES state: ok stateless: false type: desktop - - + + 2. To list the cluster 'Default', enter: - - + + .. code-block:: perl - + lsve -t cl -m -o Default - - + + Output is similar to: - - + + .. code-block:: perl - + cpu: Intel Westmere Family description: The default server cluster memory_hugepage: true memory_overcommit: 10 - - + + 3. To list the Storage Domain 'image', enter: - - + + .. code-block:: perl - + lsve -t sd -m -o image - - + + Output is similar to: - - + + .. code-block:: perl - + storagedomains: [image] available: 55834574848 committed: 13958643712 @@ -197,44 +197,44 @@ EXAMPLES storage_type: nfs type: data used: 9663676416 - - + + 4. To list the network 'rhevm', enter: - - + + .. code-block:: perl - + lsve -t nw -m -o rhevm - - + + Output is similar to: - - + + .. code-block:: perl - + networks: [rhevm] description: Management Network state: operational stp: false - - + + 5. To list the template 'tpl01', enter: - - + + .. code-block:: perl - + lsve -t tpl -m -o tpl01 - - + + Output is similar to: - - + + .. code-block:: perl - + templates: [tpl01] bootorder: network cpucore: 2 @@ -245,8 +245,8 @@ EXAMPLES state: ok stateless: false type: server - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsvlan.1.rst b/docs/source/guides/admin-guides/references/man1/lsvlan.1.rst index e9a797b8c..00a70be90 100644 --- a/docs/source/guides/admin-guides/references/man1/lsvlan.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsvlan.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **lsvlan**\ +\ **lsvlan**\ \ **lsvlan**\ [\ *vlanid*\ ] @@ -76,54 +76,54 @@ EXAMPLES 1. To list all the vlans in the cluster - - + + .. code-block:: perl - + lsvlan - - + + Output is similar to: - - + + .. code-block:: perl - + vlan 3: subnet 10.3.0.0 netmask 255.255.0.0 - + vlan 4: subnet 10.4.0.0 netmask 255.255.0.0 - - + + 2. To list the details for vlan3 - - + + .. code-block:: perl - + lsvlan 3 - - + + Output is similar to: - - + + .. code-block:: perl - + vlan 3 subnet 10.3.0.0 netmask 255.255.0.0 - + hostname ip address node vm host v3n1 10.3.0.1 c68m4hsp06 v3n2 10.3.0.2 x3455n01 v3n3 10.3.0.3 x3650n01 v3n4 10.3.0.4 x3650n01kvm1 x3650n01 v3n5 10.3.0.5 x3650n01kvm2 x3650n01 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/lsvm.1.rst b/docs/source/guides/admin-guides/references/man1/lsvm.1.rst index 4b7f5dd20..12cd9662d 100644 --- a/docs/source/guides/admin-guides/references/man1/lsvm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsvm.1.rst @@ -19,35 +19,35 @@ SYNOPSIS ******** -\ **lsvm**\ [\ **-h**\ | \ **-**\ **-help]**\ +\ **lsvm**\ [\ **-h**\ | \ **-**\ **-help]**\ \ **lsvm**\ [\ **-v**\ | \ **-**\ **-version**\ ] -\ **lsvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ +\ **lsvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ -\ **lsvm**\ [\ **-a**\ | \ **-**\ **-all**\ ] \ *noderange*\ +\ **lsvm**\ [\ **-a**\ | \ **-**\ **-all**\ ] \ *noderange*\ For PPC (using Direct FSP Management): ====================================== -\ **lsvm**\ [\ **-l**\ | \ **-**\ **-long**\ ] \ **-**\ **-p775**\ \ *noderange*\ +\ **lsvm**\ [\ **-l**\ | \ **-**\ **-long**\ ] \ **-**\ **-p775**\ \ *noderange*\ -\ **lsvm**\ \ *noderange*\ +\ **lsvm**\ \ *noderange*\ For KVM and VMware ================== -\ **lsvm**\ \ *noderange*\ +\ **lsvm**\ \ *noderange*\ For zVM: ======== -\ **lsvm**\ \ *noderange*\ +\ **lsvm**\ \ *noderange*\ @@ -101,27 +101,27 @@ OPTIONS ******* -\ **-h**\ +\ **-h**\ Display usage message. -\ **-v**\ +\ **-v**\ Command version. -\ **-V**\ +\ **-V**\ Verbose output. -\ **-a**\ +\ **-a**\ List all the profiles for one partition -\ **-**\ **-p775**\ +\ **-**\ **-p775**\ Specify the operation is for Power 775 machines. -\ **-l**\ +\ **-l**\ Show lparnames for lpars. It shall work with option \ **-**\ **-p775**\ . diff --git a/docs/source/guides/admin-guides/references/man1/lsxcatd.1.rst b/docs/source/guides/admin-guides/references/man1/lsxcatd.1.rst index 51a5ecb35..86b95f19b 100644 --- a/docs/source/guides/admin-guides/references/man1/lsxcatd.1.rst +++ b/docs/source/guides/admin-guides/references/man1/lsxcatd.1.rst @@ -36,34 +36,34 @@ OPTIONS -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-d|-**\ **-database**\ - +\ **-d|-**\ **-database**\ + Displays information about the current database being used by xCAT. + - -\ **-t|-**\ **-nodetype**\ - +\ **-t|-**\ **-nodetype**\ + Displays whether the node is a Management Node or a Service Node. + - -\ **-a|-**\ **-all**\ - +\ **-a|-**\ **-all**\ + Displays all information about the daemon supported by the command. - + @@ -84,44 +84,44 @@ EXAMPLES 1. - + To display information about the current database: - - + + .. code-block:: perl - + lsxcatd -d - - + + Output is similar to: - - + + .. code-block:: perl - + cfgloc=Pg:dbname=xcatdb;host=7.777.47.250|xcatadm dbengine=Pg dbname=xcatdb dbhost=7.777.47.250 dbadmin=xcatadm - - + + 2. - + To display all information: - - + + .. code-block:: perl - + lsxcatd -a - - + + Output is similar to: - - + + .. code-block:: perl - + Version 2.8.5 (git commit 0d4888af5a7a96ed521cb0e32e2c918a9d13d7cc, built Tue Jul 29 02:22:47 EDT 2014) This is a Management Node cfgloc=mysql:dbname=xcatdb;host=9.114.34.44|xcatadmin @@ -129,8 +129,8 @@ EXAMPLES dbname=xcatdb dbhost=9.114.34.44 dbadmin=xcatadmin - - + + diff --git a/docs/source/guides/admin-guides/references/man1/makentp.1.rst b/docs/source/guides/admin-guides/references/man1/makentp.1.rst index 3632e838a..866d2e20f 100644 --- a/docs/source/guides/admin-guides/references/man1/makentp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/makentp.1.rst @@ -11,11 +11,11 @@ SYNOPSIS ******** -\ **makentp [-h|-**\ **-help]**\ +\ **makentp [-h|-**\ **-help]**\ -\ **makentp [-v|-**\ **-version]**\ +\ **makentp [-v|-**\ **-version]**\ -\ **makentp [-a|-**\ **-all] [-V|-**\ **-verbose]**\ +\ **makentp [-a|-**\ **-all] [-V|-**\ **-verbose]**\ *********** @@ -41,28 +41,28 @@ OPTIONS -\ **-a|-**\ **-all**\ - +\ **-a|-**\ **-all**\ + Setup NTP servers for both management node and the service node. If management node has SLES installed and used as \ *ntpservers*\ , it is recommanded to use the \ **setupntp**\ postscript to set up NTP server for service nodes. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + @@ -83,23 +83,23 @@ EXAMPLES 1. To setup NTP server on the management node: - - + + .. code-block:: perl - + makentp - - + + 2. To setup NTP servers on both management node and the service node: - - + + .. code-block:: perl - + makentp -a - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mkdef.1.rst b/docs/source/guides/admin-guides/references/man1/mkdef.1.rst index ddc68d3e8..066084735 100644 --- a/docs/source/guides/admin-guides/references/man1/mkdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkdef.1.rst @@ -38,89 +38,89 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. Use the help option to get a list of valid attributes for each object type. - + Note: when creating node object definitions, the 'groups' attribute is required. + - -\ **-d|-**\ **-dynamic**\ - +\ **-d|-**\ **-dynamic**\ + Use the dynamic option to create dynamic node groups. This option must be used with -w option. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Use the force option to re-create object definitions. This option removes the old definition before creating the new one. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. (must be the first parameter) See the "noderange" man page for details on supported formats. + - -\ **-o**\ \ *object-names*\ - +\ **-o**\ \ *object-names*\ + A set of comma delimited object names. + - -\ **-t**\ \ *object-types*\ - +\ **-t**\ \ *object-types*\ + A set of comma delimited object types. Use the help option to get a list of valid object types. + - -\ **-**\ **-template**\ \ *template-object-name*\ - +\ **-**\ **-template**\ \ *template-object-name*\ + Name of the xCAT shipped object definition template or an existing object, from which the new object definition will be created. The newly created object will inherit the attributes of the template definition unless the attribute is specified in the arguments of \ **mkdef**\ command. If there are a template and an existing object with the same name \ *template-object-name*\ , the template object takes precedence over the existing object. For the details of xCAT shipped object definition templates, refer to the manpage of \ **-**\ **-template**\ option in lsdef(1)|lsdef.1. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + \ **-w**\ \ *attr==val*\ \ **-w**\ \ *attr=~val*\ ... - + Use one or multiple -w flags to specify the selection string that can be used to select objects. The operators ==, !=, =~ and !~ are available. For mkdef command, the -w flag only makes sense for creating dynamic node group. Use the help option to get a list of valid attributes for each object type. - + Operator descriptions: == Select nodes where the attribute value is exactly this value. != Select nodes where the attribute value is not this specific value. =~ Select nodes where the attribute value matches this regular expression. !~ Select nodes where the attribute value does not match this regular expression. - + Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. + - -\ **-z|-**\ **-stanza**\ - +\ **-z|-**\ **-stanza**\ + Indicates that the file being piped to the command is in stanza format. See the xcatstanzafile man page for details on using xCAT stanza files. + - -\ **-u**\ - +\ **-u**\ + Fill in the attributes such as template file, pkglist file and otherpkglist file of osimage object based on the specified parameters. It will search "/install/custom/" directory first, and then "/opt/xcat/share/". The \ *provmethod*\ and \ *profile*\ must be specified. If \ *osvers*\ or \ *osarch*\ is not specified, the corresponding value of the management node will be used. - + Note: this option only works for objtype \ **osimage**\ . - + @@ -141,173 +141,173 @@ EXAMPLES 1. - + To create a site definition. - - + + .. code-block:: perl - + mkdef -t site -o clustersite installdir=/xcatinstall - - + + 2. - + To create a basic node definition. - - + + .. code-block:: perl - + mkdef -t node -o node01 groups="all,aix" - - + + 3. - + To re-create the current definition of "node01". - - + + .. code-block:: perl - + mkdef -f -t node -o node01 nodetype=osi groups="linux" - - + + (The group definitions are also created if they don't already exist.) - + 4. - + To create a set of different types of definitions based on information contained in a stanza file. - - + + .. code-block:: perl - + cat defstanzafile | mkdef -z - - + + 5. - + To create a group definition called LinuxNodes containing the nodes clstrn01 and clstrn02. - - + + .. code-block:: perl - + mkdef -t group -o LinuxNodes members="clstrn01,clstrn02" - - + + 6. - + To create a node definition for an FSP node using the attributes provided by the group fspnodes. - - + + .. code-block:: perl - + mkdef -t node fspn1 groups=fspnodes nodetype=fsp - - + + 7. - + To create node definitions for a set of node host names contained in the node range "node1,node2,node3" - - + + .. code-block:: perl - + mkdef -t node node1,node2,node3 power=hmc groups="all,aix" - - + + 8. - + To create a dynamic node group definition called HMCMgtNodes containing all the HMC managed nodes" - - + + .. code-block:: perl - + mkdef -t group -o HMCMgtNodes -d -w mgt==hmc -w cons==hmc - - + + 9. - + To create a dynamic node group definition called SLESNodes containing all the SLES nodes - - + + .. code-block:: perl - + mkdef -t group -o SLESNodes -d -w "os=~^sles[0-9]+$" - - + + 10. - + To create a entry (7.0) in the policy table for user admin1 - - + + .. code-block:: perl - + mkdef -t policy -o 7.0 name=admin1 rule=allow - - + + 11. - + To create a node definition with nic attributes - - + + .. code-block:: perl - + mkdef -t node cn1 groups=all nicips.eth0="1.1.1.1|1.2.1.1" nicnetworks.eth0="net1|net2" nictypes.eth0="Ethernet" - - + + 12. - + To create an osimage definition and fill in attributes automatically. - - + + .. code-block:: perl - + mkdef redhat6img -u profile=compute provmethod=statelite - - + + 13. - + To create a PowerLE kvm node definition with the xCAT shipped template "ppc64lekvmguest-template". - - + + .. code-block:: perl - + mkdef -t node cn1 --template ppc64lekvmguest-template ip=1.1.1.1 mac=42:3d:0a:05:27:0b vmhost=1.1.0.1 vmnics=br0 - - + + 14. - + To create a node definition from an existing node definition "cn1" - - + + .. code-block:: perl - + mkdef -t node cn2 --template cn1 ip=1.1.1.2 mac=42:3d:0a:05:27:0c - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mkdocker.1.rst b/docs/source/guides/admin-guides/references/man1/mkdocker.1.rst index 808b1eda9..f1e2d2e47 100644 --- a/docs/source/guides/admin-guides/references/man1/mkdocker.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkdocker.1.rst @@ -40,79 +40,79 @@ OPTIONS -\ **image**\ - +\ **image**\ + The docker image name that the instance will use. + - -\ **command**\ - +\ **command**\ + The command that the instance will run based on the \ **image**\ specified. The \ **image**\ option must be specified in order to use this option. + - -\ **dockerflag**\ - +\ **dockerflag**\ + A JSON string which will be used as parameters to create a docker. Reference https://docs.docker.com/engine/reference/api/docker_remote_api_v1.22/ for more information about which parameters can be specified. - + Some useful flags are: - - - \ **AttachStdin**\ =\ **true | false**\ - + + + \ **AttachStdin**\ =\ **true | false**\ + Whether attaches to stdin. - - - - \ **AttachStdout**\ =\ **true | false**\ - + + + + \ **AttachStdout**\ =\ **true | false**\ + Whether attaches to stdout. - - - - \ **AttachStderr**\ =\ **true | false**\ - + + + + \ **AttachStderr**\ =\ **true | false**\ + Whether attaches to stderr. - - - - \ **OpenStdin**\ =\ **true | false**\ - + + + + \ **OpenStdin**\ =\ **true | false**\ + Whether opens stdin. - - - - \ **Tty**\ =\ **true | false**\ - + + + + \ **Tty**\ =\ **true | false**\ + Attach standard streams to a tty, including stdin if it is not closed. - - - - \ **ExposedPorts**\ - + + + + \ **ExposedPorts**\ + An object mapping ports to an empty object in the form of: - - + + .. code-block:: perl - + "ExposedPorts": { "/\: {}" } - - - - - \ **HostConfig: {"Binds"}**\ - + + + + + \ **HostConfig: {"Binds"}**\ + A list of volume bindings for this docker instance, the form will be: - - + + .. code-block:: perl - + "HostConfig": {"Binds":[":"]} - - - - + + + + diff --git a/docs/source/guides/admin-guides/references/man1/mkdsklsnode.1.rst b/docs/source/guides/admin-guides/references/man1/mkdsklsnode.1.rst index 35eda685e..8d7a389b7 100644 --- a/docs/source/guides/admin-guides/references/man1/mkdsklsnode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkdsklsnode.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mkdsklsnode [-h|-**\ **-help ]**\ +\ **mkdsklsnode [-h|-**\ **-help ]**\ \ **mkdsklsnode [-V|-**\ **-verbose] [-f|-**\ **-force] [-n|-**\ **-newname] [-i**\ \ *osimage_name*\ ] [\ **-l**\ \ *location*\ ] [\ **-u | -**\ **-updateSN**\ ] [\ **-k | -**\ **-skipsync**\ ] [\ **-p | -**\ **-primarySN**\ ] [\ **-b | -**\ **-backupSN**\ ] [\ **-S | -**\ **-setuphanfs**\ ] \ *noderange*\ [\ *attr=val [attr=val ...]*\ ] @@ -70,46 +70,46 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr= val pairs must be specified last on the command line. These are used to specify additional values that can be passed to the underlying NIM commands. - + Valid values: - - - \ **duplex**\ - + + + \ **duplex**\ + Specifies the duplex setting (optional). Used when defining the NIM machine. Use this setting to configure the client's network interface. This value can be full or half. The default is full. (ex. "duplex=full") - - - - \ **speed**\ - + + + + \ **speed**\ + Specifies the speed setting (optional). Used when defining the NIM machine. This is the communication speed to use when configuring the client's network interface. This value can be 10, 100, or 1000. The default is 100. (ex. "speed=100") - - - - \ **psize**\ - + + + + \ **psize**\ + Specifies the size in Megabytes of the paging space for the diskless node.(optional) Used when initializing the NIM machine. The minimum and default size is 64 MB of paging space. (ex. "psize=256") - - - - \ **sparse_paging**\ - + + + + \ **sparse_paging**\ + Specifies that the paging file should be created as an AIX sparse file, (ex. "sparse_paging=yes"). The default is "no". - - - - \ **dump_iscsi_port**\ - + + + + \ **dump_iscsi_port**\ + The tcpip port number to use to communicate dump images from the client to the dump resource server. Normally set by default. This port number is used by a dump resource server. - - - - \ **configdump**\ - + + + + \ **configdump**\ + Specifies the type dump to be collected from the client. The values are "selective", "full", and "none". If the configdump attribute is set to "full" or "selective" the client will automatically be configured to dump to an iSCSI @@ -118,81 +118,81 @@ OPTIONS and full memory dumps will be stored in subdirectory of the dump resource allocated to the client. This attribute is saved in the xCAT osimage definition. + + + - - - -\ **-b |-**\ **-backupSN**\ - +\ **-b |-**\ **-backupSN**\ + When using backup service nodes only update the backup. The default is to update both the primary and backup service nodes. + - -\ **-f |-**\ **-force**\ - +\ **-f |-**\ **-force**\ + Use the force option to reinitialize the NIM machines. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-i**\ \ *image_name*\ - +\ **-i**\ \ *image_name*\ + The name of an existing xCAT osimage definition. If this information is not provided on the command line the code checks the node definition for the value of the "provmethod" attribute. If the "-i" value is provided on the command line then that value will be used to set the "provmethod" attribute of the node definitions. + - -\ **-k|-**\ **-skipsync**\ - +\ **-k|-**\ **-skipsync**\ + Use this option to have the mkdsklsnode command skip the NIM sync_roots operation. This option should only be used if you are certain that the shared_root resource does not have to be updated from the SPOT. Normally, when the SPOT is updated, you should do a sync_roots on the shared_root resource. + - -\ **-l|-**\ **-location**\ - +\ **-l|-**\ **-location**\ + The directory location to use when creating new NIM resolv_conf resources. The default location is /install/nim. + - -\ **-n|-**\ **-newname**\ - +\ **-n|-**\ **-newname**\ + Create a new NIM machine object name for the xCAT node. Use the naming convention "_" for the new NIM machine definition. + - -\ **-p|-**\ **-primarySN**\ - +\ **-p|-**\ **-primarySN**\ + When using backup service nodes only update the primary. The default is to update both the primary and backup service nodes. + - -\ **-S|-**\ **-setuphanfs**\ - +\ **-S|-**\ **-setuphanfs**\ + Setup NFSv4 replication between the primary service nodes and backup service nodes to provide high availability NFS for the compute nodes. This option only exports the /install directory with NFSv4 replication settings, the data synchronization between the primary service nodes and backup service nodes needs to be taken care of through some mechanism. + - -\ **-u|-**\ **-updateSN**\ - +\ **-u|-**\ **-updateSN**\ + Use this option if you wish to update the osimages but do not want to define or initialize the NIM client definitions. This option is only valid when the xCAT "site" definition attribute "sharedinstall" is set to either "sns" or "all". + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + @@ -218,45 +218,45 @@ EXAMPLES 1. Initialize an xCAT node named "node01" as an AIX diskless machine. The xCAT osimage named "61spot" should be used to boot the node. - - + + .. code-block:: perl - + mkdsklsnode -i 61spot node01 - - + + 2. Initialize all AIX diskless nodes contained in the xCAT node group called "aixnodes" using the image definitions pointed to by the "provmethod" attribute of the xCAT node definitions. - - + + .. code-block:: perl - + mkdsklsnode aixnodes - - + + 3. Initialize diskless node "clstrn29" using the xCAT osimage called "61dskls". Also set the paging size to be 128M and specify the paging file be an AIX sparse file. - - + + .. code-block:: perl - + mkdsklsnode -i 61dskls clstrn29 psize=128 sparse_paging=yes - - + + 4. - + Initialize an xCAT node called "node02" as an AIX diskless node. Create a new NIM machine definition name with the osimage as an extension to the xCAT node name. - - + + .. code-block:: perl - + mkdsklsnode -n -i 61spot node02 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mkflexnode.1.rst b/docs/source/guides/admin-guides/references/man1/mkflexnode.1.rst index 159d42042..853e34221 100644 --- a/docs/source/guides/admin-guides/references/man1/mkflexnode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkflexnode.1.rst @@ -23,7 +23,7 @@ SYNOPSIS \ **mkflexnode**\ [\ **-v**\ | \ **-**\ **-version**\ ] -\ **mkflexnode**\ \ *noderange*\ +\ **mkflexnode**\ \ *noderange*\ *********** @@ -48,16 +48,16 @@ OPTIONS -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display the usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the version information. - + @@ -68,15 +68,15 @@ EXAMPLES 1. Create a flexible node base on the xCAT node blade1. - + The blade1 should belong to a complex, the \ *id*\ attribute should be set correctly and all the slots should be in \ **power off**\ state. - - + + .. code-block:: perl - + mkflexnode blade1 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mkhwconn.1.rst b/docs/source/guides/admin-guides/references/man1/mkhwconn.1.rst index c8fe55adf..87ece91f7 100644 --- a/docs/source/guides/admin-guides/references/man1/mkhwconn.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkhwconn.1.rst @@ -77,53 +77,53 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-t**\ - +\ **-t**\ + Read connection information from xCAT DB (ppc and ppcdirect tables). Use this option if you need to connect multiple CECs/Frames to multiple HMCs in a single command. + - -\ **-p**\ - +\ **-p**\ + The HMC node name. Only one HMC nodes can be specified by this flag. To setup connection for multiple HMC nodes, use flag \ **-t**\ . + - -\ **-P**\ - +\ **-P**\ + The password of HMC based CEC/Frame login user(Default user name is 'HMC'). This flag is optional. + - -\ **-T**\ - +\ **-T**\ + The tooltype is used to communicate to the CEC/Frame. The value could be \ **lpar**\ or \ **fnm**\ . The tooltype value \ **lpar**\ is for xCAT and \ **fnm**\ is for CNM. The default value is "\ **lpar**\ ". + - -\ **-**\ **-port**\ - +\ **-**\ **-port**\ + The port value specifies which special side will be used to create the connection to the CEC/Frame. The value could only be specified as "\ **0**\ " or "\ **1**\ " and the default value is "\ **0,1**\ ". If the user wants to use all ports to create the connection, he should not specify this value. If the port value is specified as "\ **0**\ ", in the vpd table, the side column should be \ **A-0**\ and \ **B-0**\ ; If the port value is specified as "\ **1**\ ", the side column should be \ **A-1**\ and \ **B-1**\ . When making hardware connection between CEC/Frame and HMC, the value is used to specify the fsp/bpa port of the cec/frame and will be organized in order of "\ **A-0,A-1,B-0,B-1**\ ". If any side does not exist, the side would simply be ignored. Generally, only one port of a fsp/bap can be connected while another port be used as backup. + - -\ **-s**\ - +\ **-s**\ + The flag -s is used to make the connection between the frame and its Service Focal Point(HMC). -s flag is not supposed to work with other functional flags. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + @@ -144,63 +144,63 @@ EXAMPLES 1. - + To setup the connection for all CEC nodes in node group cec to HMC node, according to the definition in xCAT DB: - - + + .. code-block:: perl - + mkhwconn cec -t - - + + 2. - + To setup the connection for Frame nodes in node group frame to HMC node hmc1, with password 'abc123': - - + + .. code-block:: perl - + mkhwconn frame -p hmc1 -P abc123 - - + + 3. - + To setup the connections for all CEC nodes in node group cec to hardware server, and the tooltype value is lpar: - - + + .. code-block:: perl - + mkhwconn cec -t -T lpar - - + + 4. - + To setup the connections for all cecs nodes in node group cec to hardware server, and the tooltype value is lpar, and the port value is 1: - - + + .. code-block:: perl - + mkhwconn cec -t -T lpar --port 1 - - + + 5. - + To setup the connection between the frame and it's SFP node. This command will also set the connections between the CECs within this frame and their SFP node. User need to define HMC_name in the database in advance, but no need to set the sfp attribute for these node, xCAT will set the HMC_name as ppc.sfp for these nodes. The CECs within this frame should have the same sfp attribute as the frame. - - + + .. code-block:: perl - + mkhwconn cec -s HMC_name -P HMC_passwd - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mknimimage.1.rst b/docs/source/guides/admin-guides/references/man1/mknimimage.1.rst index 5428ec80e..a8b7596e0 100644 --- a/docs/source/guides/admin-guides/references/man1/mknimimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mknimimage.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mknimimage [-h | -**\ **-help ]**\ +\ **mknimimage [-h | -**\ **-help ]**\ \ **mknimimage [-V] -u**\ \ *osimage_name [attr=val [attr=val ...]*\ ] @@ -39,13 +39,13 @@ The naming convention for the NIM SPOT resource definition is to use the same na When creating a mksysb image definition you must specify either the "-n" or the "-b" option. The "-n" option can be used to create a mksysb image from an existing NIM client machine. The "-b" option can be used to specify an existing mksysb backup file. -\ **Adding software and configuration files to the osimage.**\ +\ **Adding software and configuration files to the osimage.**\ When creating a diskless osimage definition you also have the option of automatically updating the NIM SPOT resource. You can have additional software installed or you can have configuration files added or updated. To have software installed you must provide either the names of NIM installp_bundle resources or fileset names on the command line using the "attr=val" option. You may also supply the installp flags, RPM flags, emgr flags to use when installing the software. To have configuration files updated you must provide the full path name of a "synclists" file which contains the list of actual files to update. The xCAT osimage definition that is created will contain the installp_bundle, otherpkgs, and synclists files that are provided on the command line. -\ **Updating an existing xCAT osimage**\ +\ **Updating an existing xCAT osimage**\ If you wish to update an existing diskless image after it has already been created you can use the "-u" (update) option. In this case the xCAT osimage definition will not be updated. @@ -57,7 +57,7 @@ Or, you could do a more ad hoc update by providing one or more of the "installp_ WARNING: Installing random RPM packages in a SPOT may have unpredictable consequences. The SPOT is a very restricted environment and some RPM packages may corrupt the SPOT or even hang your management system. Try to be very careful about the packages you install. When installing RPMs, if the mknimimage command hangs or if there are file systems left mounted after the command completes you may need to reboot your management node to recover. This is a limitation of the current AIX support for diskless systems -\ **Copying an xCAT osimage.**\ +\ **Copying an xCAT osimage.**\ You can use the "-i" and "-p" options to copy an existing diskless osimage. To do this you must supply the name of an existing xCAT osimage definition and the name of the new osimage you wish to create. The \ **mknimimage**\ command will do the following: @@ -71,7 +71,7 @@ You can use the "-i" and "-p" options to copy an existing diskless osimage. To - if the "-p" option is specified then the original NIM lpp_source resource will be copied to a new location and redefined to NIM. (The default would be to use the original lpp_source - to save file system space.) -\ **Additional information**\ +\ **Additional information**\ IMPORTANT: The NIM lpp_source and SPOT resources can get quite large. Always make sure that you have sufficient file system space available before running the \ **mknimimage**\ command. @@ -94,265 +94,265 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. - + Currently supported attributes: - - - \ **bosinst_data**\ - + + + \ **bosinst_data**\ + The name of a NIM bosinst_data resource. - - - - \ **dump**\ - + + + + \ **dump**\ + The name of the NIM dump resource. - - - - \ **fb_script**\ - + + + + \ **fb_script**\ + The name of a NIM fb_script resource. - - - - \ **home**\ - + + + + \ **home**\ + The name of the NIM home resource. - - - - \ **installp_bundle**\ - + + + + \ **installp_bundle**\ + One or more comma separated NIM installp_bundle resources. - - - - \ **lpp_source**\ - + + + + \ **lpp_source**\ + The name of the NIM lpp_source resource. - - - - \ **mksysb**\ - + + + + \ **mksysb**\ + The name of a NIM mksysb resource. - - - - \ **otherpkgs**\ - + + + + \ **otherpkgs**\ + One or more comma separated installp, emgr, or rpm packages. The packages must have prefixes of 'I:', 'E:', or 'R:', respectively. (ex. R:foo.rpm) - - - - \ **paging**\ - + + + + \ **paging**\ + The name of the NIM paging resource. - - - - \ **resolv_conf**\ - + + + + \ **resolv_conf**\ + The name of the NIM resolv_conf resource. - - - - \ **root**\ - + + + + \ **root**\ + The name of the NIM root resource. - - - - \ **script**\ - + + + + \ **script**\ + The name of a NIM script resource. - - - - \ **shared_home**\ - + + + + \ **shared_home**\ + The name of the NIM shared_home resource. - - - - \ **shared_root**\ - + + + + \ **shared_root**\ + A shared_root resource represents a directory that can be used as a / (root) directory by one or more diskless clients. - - - - \ **spot**\ - + + + + \ **spot**\ + The name of the NIM SPOT resource. - - - - \ **synclists**\ - + + + + \ **synclists**\ + The fully qualified name of a file containing a list of files to synchronize on the nodes. - - - - \ **tmp**\ - + + + + \ **tmp**\ + The name of the NIM tmp resource. - - - - \ **installp_flags**\ - + + + + \ **installp_flags**\ + The alternate flags to be passed along to the AIX installp command. (The default for installp_flags is "-abgQXY".) - - - - \ **rpm_flags**\ - + + + + \ **rpm_flags**\ + The alternate flags to be passed along to the AIX rpm command. (The default for rpm_flags is "-Uvh ".) The mknimimage command will check each rpm to see if it is installed. It will not be reinstalled unless you specify the appropriate rpm option, such as '--replacepkgs'. - - - - \ **emgr_flags**\ - + + + + \ **emgr_flags**\ + The alternate flags to be passed along to the AIX emgr command. (There is no default flags for the emgr command.) - - - - \ **dumpsize**\ - + + + + \ **dumpsize**\ + The maximum size for a single dump image the dump resource will accept. Space is not allocated until a client starts to dump. The default size is 50GB. The dump resource should be large enough to hold the expected AIX dump and snap data. - - - - \ **max_dumps**\ - + + + + \ **max_dumps**\ + The maximum number of archived dumps for an individual client. The default is one. - - - - \ **snapcollect**\ - + + + + \ **snapcollect**\ + Indicates that after a dump is collected then snap data should be collected. The snap data will be collected in the clients dump resource directory. Values are "yes" or "no". The default is "no". - - - - \ **nfs_vers**\ - + + + + \ **nfs_vers**\ + Value Specifies the NFS protocol version required for NFS access. - - - - \ **nfs_sec**\ - + + + + \ **nfs_sec**\ + Value Specifies the security method required for NFS access. - - - + + + Note that you may specify multiple "script", "otherpkgs", and "installp_bundle" resources by using a comma separated list. (ex. "script=ascript,bscript"). RPM names may be included in the "otherpkgs" list by using a "R:" prefix(ex. "R:whatever.rpm"). epkg (AIX interim fix package) file names may be included in the "otherpkgs" using the 'E:' prefix. (ex. "otherpkgs=E:IZ38930TL0.120304.epkg.Z"). + - -\ **-b**\ \ *mksysbfile*\ - +\ **-b**\ \ *mksysbfile*\ + Used to specify the path name of a mksysb file to use when defining a NIM mksysb resource. + - -\ **-c|-**\ **-completeosimage**\ - +\ **-c|-**\ **-completeosimage**\ + Complete the creation of the osimage definition passed in on the command line. This option will use any additional values passed in on the command line and/or it will attempt to create required resources in order to complete the definition of the xCAT osimage. For example, if the osimage definition is missing a spot or shared_root resource the command will create those resources and add them to the osimage definition. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Use the force option to re-create xCAT osimage definition. This option removes the old definition before creating the new one. It does not remove any of the NIM resource definitions named in the osimage definition. Use the \ **rmnimimage**\ command to remove the NIM resources associated with an xCAT osimage definition. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ *osimage_name*\ - +\ *osimage_name*\ + The name of the xCAT osimage definition. This will be used as the name of the xCAT osimage definition as well as the name of the NIM SPOT resource. + - -\ **-D|-**\ **-mkdumpres**\ - +\ **-D|-**\ **-mkdumpres**\ + Create a diskless dump resource. + - -\ **-i**\ \ *current_image*\ - +\ **-i**\ \ *current_image*\ + The name of an existing xCAT osimage that should be copied to make a new xCAT osimage definition. Only valid when defining a "diskless" or "dataless" type image. + - -\ **-l**\ \ *location*\ - +\ **-l**\ \ *location*\ + The directory location to use when creating new NIM resources. The default location is /install/nim. + - -\ **-m**\ \ *nimmethod*\ - +\ **-m**\ \ *nimmethod*\ + Used to specify the NIM installation method to use. The possible values are "rte" and "mksysb". The default is "rte". + - -\ **-n**\ \ *mksysbnode*\ - +\ **-n**\ \ *mksysbnode*\ + The xCAT node to use to create a mksysb image. The node must be a defined as a NIM client machine. + - -\ **-p|-**\ **-cplpp**\ - +\ **-p|-**\ **-cplpp**\ + Use this option when copying existing diskless osimages to indicate that you also wish to have the lpp_resource copied. This option is only valid when using the "-i" option. + - -\ **-r|-**\ **-sharedroot**\ - +\ **-r|-**\ **-sharedroot**\ + Use this option to specify that a NIM "shared_root" resource be created for the AIX diskless nodes. The default is to create a NIM "root" resource. This feature is only available when using AIX version 6.1.4 or beyond. See the AIX/NIM documentation for a description of the "root" and "shared_root" resources. + - -\ **-s**\ \ *image_source*\ - +\ **-s**\ \ *image_source*\ + The source of software to use when creating the new NIM lpp_source resource. This could be a source directory or a previously defined NIM lpp_source resource name. + - -\ **-t nimtype**\ - +\ **-t nimtype**\ + Used to specify the NIM machine type. The possible values are "standalone", "diskless" or "dataless". The default is "standalone". + - -\ **-u**\ - +\ **-u**\ + Used to update an AIX/NIM SPOT resource with additional software and configuration files. This option is only valid for xCAT diskless osimage objects. The SPOT resource associated with the xCAT osimage definition will be updated. This option can also be used to update the nfs_vers attribute from NFSv3 to NFSv4 for the NIM resources associated with diskful or diskless image. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + diff --git a/docs/source/guides/admin-guides/references/man1/mkvlan.1.rst b/docs/source/guides/admin-guides/references/man1/mkvlan.1.rst index 7bf761def..1221f5c16 100644 --- a/docs/source/guides/admin-guides/references/man1/mkvlan.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkvlan.1.rst @@ -147,65 +147,65 @@ The following is an example of the switches table 1. - + To make a private vlan for node1, node2 and node3 - - + + .. code-block:: perl - + mkvlan -n node1,node2,node3 - - + + The vlan will be created on eth0 for the nodes. - + 2. - + To make a private vlan for node1, node2 and node3 on eth1, - - + + .. code-block:: perl - + mkvlan -n node1,node2,node3 -i eth1 - - + + 3. - + To make a private vlan for node1, node2 with given subnet and netmask. - - + + .. code-block:: perl - + mkvlan -n node1,node2,node3 -t 10.3.2.0 -m 255.255.255.0 - - + + 4. - + To make a private vlan for KVM guests node1 and node2 - - + + .. code-block:: perl - + chtab key=usexhrm site.vlaue=1 - + mkdef node1 arch=x86_64 groups=kvm,all installnic=mac primarynic=mac mgt=kvm netboot=pxe nfsserver=10.1.0.204 os=rhels6 profile=compute provmethod=install serialport=0 serialspeed=115200 vmcpus=1 vmhost=x3650n01 vmmemory=512 vmnics=br0 vmstorage=nfs://10.1.0.203/vms - + mkdef node2 arch=x86_64 groups=kvm,all installnic=mac primarynic=mac mgt=kvm netboot=pxe nfsserver=10.1.0.204 os=rhels6 profile=compute provmethod=install serialport=0 serialspeed=115200 vmcpus=1 vmhost=x3650n01 vmmemory=512 vmnics=br0 vmstorage=nfs://10.1.0.203/vms - + mkvlan -n node1,node2 - + mkvm node1,node2 -s 20G - + rpower node1,node2 on - + rinstall node1,node2 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/mkvm.1.rst b/docs/source/guides/admin-guides/references/man1/mkvm.1.rst index 862686779..effaaa109 100644 --- a/docs/source/guides/admin-guides/references/man1/mkvm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mkvm.1.rst @@ -32,11 +32,11 @@ For PPC (with HMC) specific: ============================ -\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-i**\ \ *id*\ \ **-l**\ \ *singlenode*\ +\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-i**\ \ *id*\ \ **-l**\ \ *singlenode*\ -\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-c**\ \ *destcec*\ \ **-p**\ \ *profile*\ +\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-c**\ \ *destcec*\ \ **-p**\ \ *profile*\ -\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-**\ **-full**\ +\ **mkvm**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ \ **-**\ **-full**\ For PPC (using Direct FSP Management) specific: @@ -122,84 +122,84 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-c**\ - +\ **-c**\ + The cec (fsp) name for the destination. + - -\ **-**\ **-cpus**\ - +\ **-**\ **-cpus**\ + The cpu count which will be created for the kvm/vmware virtual machine. + - -\ **-**\ **-full**\ - +\ **-**\ **-full**\ + Request to create a new full system partition for each CEC. - + \ **vmcpus=**\ \ *value*\ \ **vmmemory=**\ \ *value*\ \ **vmphyslots=**\ \ *value*\ \ **vmothersetting=**\ \ *value*\ \ **vmnics=**\ \ *value*\ \ **vmstorage=**\ \ *value*\ [\ **-**\ **-vios**\ ] - + To specify the parameters which are used to create a partition. The \ *vmcpus*\ , \ *vmmemory*\ are necessary, and the value specified with this command have a more high priority. If the value of any of the three options is not specified, the corresponding value specified for the node object will be used. If any of the three attributes is neither specified with this command nor specified with the node object, error information will be returned. To reference to lsvm(1)|lsvm.1 for more information about 'drc_index' for \ *vmphyslots*\ . - + The option \ *vios*\ is used to specify the partition that will be created is a VIOS partition. If specified, the value for \ *vmstorage*\ shall be number which indicate the number of vSCSI server adapter will be created, and if no value specified for \ *vmphyslots*\ , all the physical slot of the power machine will be asigned to VIOS partition. If not specified, it shall be in form of \ *vios_name:server_slotid*\ to specify the vios and the virtual slot id of the vSCSI server adapter that will be connected from the Logical partition. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + If the storage already exists, remove it before creating a new virtual machine. + - -\ **-i**\ - +\ **-i**\ + Starting numeric id of the newly created partitions. + - -\ **-l**\ - +\ **-l**\ + The partition name of the source. + - -\ **-**\ **-mem**\ - +\ **-**\ **-mem**\ + The memory size which will be used for the new created kvm/vmware virtual machine. Unit is Megabyte. + - -\ **-p**\ - +\ **-p**\ + The file that contains the profiles for the source partitions. + - -\ **-s|-**\ **-size**\ - +\ **-s|-**\ **-size**\ + The size of storage which will be created for the kvm/vmware virtual machine. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + diff --git a/docs/source/guides/admin-guides/references/man1/monadd.1.rst b/docs/source/guides/admin-guides/references/man1/monadd.1.rst index 5e9f0f5cd..bb8f629e8 100644 --- a/docs/source/guides/admin-guides/references/man1/monadd.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monadd.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **monadd [-h| -**\ **-help]**\ +\ **monadd [-h| -**\ **-help]**\ -\ **monadd [-v| -**\ **-version]**\ +\ **monadd [-v| -**\ **-version]**\ -\ **monadd name [-n|-**\ **-nodestatmon] [-s|-**\ **-settings**\ \ *settings]*\ +\ **monadd name [-n|-**\ **-nodestatmon] [-s|-**\ **-settings**\ \ *settings]*\ *********** @@ -50,28 +50,28 @@ OPTIONS -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display usage message. + - -\ **-n | -**\ **-nodestatmon**\ - +\ **-n | -**\ **-nodestatmon**\ + Indicate that this monitoring plug-in will be used for feeding the node liveness status to the xCAT \ *nodelist*\ table. + - -\ **-s | -**\ **-settings**\ - +\ **-s | -**\ **-settings**\ + Specifies the plug-in specific settings. These settings will be used by the plug-in to customize certain entities for the plug-in or the third party monitoring software. e.g. -s mon_interval=10 -s toggle=1. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Command Version. - + @@ -92,52 +92,52 @@ EXAMPLES 1. - + To register gangliamon plug-in module (which interacts with Ganglia monitoring software) to monitor the xCAT cluster, enter: - - + + .. code-block:: perl - + monadd gangliamon - - + + 2. - + To register rmcmon plug-in module (which interacts with IBM's RSCT monitoring software) to monitor the xCAT cluster and have it feed the node liveness status to xCAT's \ *nodelist*\ table, enter: - - + + .. code-block:: perl - + monadd rmcmon -n - - + + This will also add the \ *configrmcnode*\ to the \ *postscripts*\ table. To view the content of the \ *postscripts*\ table, enter: - - + + .. code-block:: perl - + tabdump postscritps #node,postscripts,comments,disable "service","servicenode",, "xcatdefaults","syslog,remoteshell,configrmcnode",, - - + + 3. - + To register xcatmon plug-in module to feed the node liveness status to xCAT's \ *nodelist*\ table, enter: - - + + .. code-block:: perl - + monadd xcatmon -n -s ping-interval=2 - - + + where 2 is the number of minutes between the pings. - + diff --git a/docs/source/guides/admin-guides/references/man1/moncfg.1.rst b/docs/source/guides/admin-guides/references/man1/moncfg.1.rst index 047d2aa6e..a7ac99ccd 100644 --- a/docs/source/guides/admin-guides/references/man1/moncfg.1.rst +++ b/docs/source/guides/admin-guides/references/man1/moncfg.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **moncfg [-h| -**\ **-help]**\ +\ **moncfg [-h| -**\ **-help]**\ -\ **moncfg [-v| -**\ **-version]**\ +\ **moncfg [-v| -**\ **-version]**\ -\ **moncfg**\ \ *name*\ \ *[noderange]*\ \ **[-r|-**\ **-remote]**\ +\ **moncfg**\ \ *name*\ \ *[noderange]*\ \ **[-r|-**\ **-remote]**\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/mondecfg.1.rst b/docs/source/guides/admin-guides/references/man1/mondecfg.1.rst index c06c5b8a2..eeb0dc747 100644 --- a/docs/source/guides/admin-guides/references/man1/mondecfg.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mondecfg.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **mondecfg [-h| -**\ **-help]**\ +\ **mondecfg [-h| -**\ **-help]**\ -\ **mondecfg [-v| -**\ **-version]**\ +\ **mondecfg [-v| -**\ **-version]**\ -\ **mondecfg**\ \ *name*\ \ *[noderange]*\ \ **[-r|-**\ **-remote]**\ +\ **mondecfg**\ \ *name*\ \ *[noderange]*\ \ **[-r|-**\ **-remote]**\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/monls.1.rst b/docs/source/guides/admin-guides/references/man1/monls.1.rst index 15eda4174..f5241006d 100644 --- a/docs/source/guides/admin-guides/references/man1/monls.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monls.1.rst @@ -19,13 +19,13 @@ SYNOPSIS ******** -\ **monls [-h| -**\ **-help]**\ +\ **monls [-h| -**\ **-help]**\ -\ **monls [-v| -**\ **-version]**\ +\ **monls [-v| -**\ **-version]**\ -\ **monls**\ \ *name*\ \ **[-d|-**\ **-description]**\ +\ **monls**\ \ *name*\ \ **[-d|-**\ **-description]**\ -\ **monls [-a|-**\ **-all] [-d|-**\ **-description]**\ +\ **monls [-a|-**\ **-all] [-d|-**\ **-description]**\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/monrm.1.rst b/docs/source/guides/admin-guides/references/man1/monrm.1.rst index 8d2edc16a..27d4563b9 100644 --- a/docs/source/guides/admin-guides/references/man1/monrm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monrm.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **monrm [-h| -**\ **-help]**\ +\ **monrm [-h| -**\ **-help]**\ -\ **monrm [-v| -**\ **-version]**\ +\ **monrm [-v| -**\ **-version]**\ -\ **monrm**\ \ *name*\ +\ **monrm**\ \ *name*\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/monshow.1.rst b/docs/source/guides/admin-guides/references/man1/monshow.1.rst index 07b343994..2c8ff130c 100644 --- a/docs/source/guides/admin-guides/references/man1/monshow.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monshow.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **monshow [-h| -**\ **-help]**\ +\ **monshow [-h| -**\ **-help]**\ -\ **monshow [-v| -**\ **-version]**\ +\ **monshow [-v| -**\ **-version]**\ \ **monshow**\ \ *name*\ \ *[noderange]*\ [\ **-s**\ ] [\ **-t**\ \ *time*\ ] [\ **-a**\ \ *attributes*\ ] [\ **-w**\ \ *attr*\ < \ *operator*\ > \ *val*\ [\ **-w**\ \ *attr*\ < \ *operator*\ > \ *val*\ ] ... ][\ **-o {p|e}**\ ] diff --git a/docs/source/guides/admin-guides/references/man1/monstart.1.rst b/docs/source/guides/admin-guides/references/man1/monstart.1.rst index 3c1c3a557..1595b28b8 100644 --- a/docs/source/guides/admin-guides/references/man1/monstart.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monstart.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **monstart [-h| -**\ **-help]**\ +\ **monstart [-h| -**\ **-help]**\ -\ **monstart [-v| -**\ **-version]**\ +\ **monstart [-v| -**\ **-version]**\ \ **monstart**\ \ *name*\ \ *[noderange]*\ [\ **-r|-**\ **-remote**\ ] diff --git a/docs/source/guides/admin-guides/references/man1/monstop.1.rst b/docs/source/guides/admin-guides/references/man1/monstop.1.rst index d776f408b..4a0502ba4 100644 --- a/docs/source/guides/admin-guides/references/man1/monstop.1.rst +++ b/docs/source/guides/admin-guides/references/man1/monstop.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **monstop [-h| -**\ **-help]**\ +\ **monstop [-h| -**\ **-help]**\ -\ **monstop [-v| -**\ **-version]**\ +\ **monstop [-v| -**\ **-version]**\ \ **monstop**\ \ *name*\ [\ *noderange*\ ] [\ **-r|-**\ **-remote**\ ] diff --git a/docs/source/guides/admin-guides/references/man1/mysqlsetup.1.rst b/docs/source/guides/admin-guides/references/man1/mysqlsetup.1.rst index d604f9551..cd6566407 100644 --- a/docs/source/guides/admin-guides/references/man1/mysqlsetup.1.rst +++ b/docs/source/guides/admin-guides/references/man1/mysqlsetup.1.rst @@ -39,7 +39,7 @@ DESCRIPTION \ **mysqlsetup**\ - Sets up the MySQL or MariaDB database (linux only for MariaDB) for xCAT to use. The mysqlsetup script is run on the Management Node as root after the MySQL code or MariaDB code has been installed. Before running the init option, the MySQL server should be stopped, if it is running. The xCAT daemon, xcatd, must be running, do not stop it. No xCAT commands should be run during the init process, because we will be migrating the xCAT database to MySQL or MariaDB and restarting the xcatd daemon as well as the MySQL daemon. For full information on all the steps that will be done, read the "Configure MySQL and Migrate xCAT Data to MySQL" sections in -\ **Setting_Up_MySQL_as_the_xCAT_DB**\ +\ **Setting_Up_MySQL_as_the_xCAT_DB**\ Two passwords must be supplied for the setup, a password for the xcatadmin id and a password for the root id in the MySQL database. These will be prompted for interactively, unless the environment variables XCATMYSQLADMIN_PW and XCATMYSQLROOT_PW are set to the passwords for the xcatadmin id and root id in the database,resp. @@ -52,57 +52,57 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Displays verbose messages. + - -\ **-i|-**\ **-init**\ - +\ **-i|-**\ **-init**\ + The init option is used to setup a xCAT database on an installed MySQL or MariaDB server for xCAT to use. The mysqlsetup script will check for the installed MariaDB server rpm first and will use MariaDB if it is installed. This involves creating the xcatdb database, the xcatadmin id, allowing access to the xcatdb database by the Management Node. It customizes the my.cnf configuration file for xcat and starts the MySQL server. It also backs up the current xCAT database and restores it into the newly setup xcatdb MySQL database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the MySQL database and restarts the xcatd daemon using the database. On AIX, it additionally setup the mysql id and group and corrects the permissions in the MySQL install directories. For AIX, you should be using the MySQL rpms available from the xCAT website. For Linux, you should use the MySQL or MariaDB rpms shipped with the OS. You can chose the -f and/or the -o option, to run after the init. + - -\ **-u|-**\ **-update**\ - +\ **-u|-**\ **-update**\ + To run the update option, you must first have run the -i option and have xcat successfully running on the MySQL database. You can chose the -f and/or the -o option, to update. + - -\ **-f|-**\ **-hostfile**\ - +\ **-f|-**\ **-hostfile**\ + This option runs during update, it will take all the host from the input file (provide a full path) and give them database access to the xcatdb in MySQL for the xcatadmin id. Wildcards and ipaddresses may be used. xCAT must have been previously successfully setup to use MySQL. xcatadmin and MySQL root password are required. + - -\ **-o|-**\ **-odbc**\ - +\ **-o|-**\ **-odbc**\ + This option sets up the ODBC /etc/../odbcinst.ini, /etc/../odbc.ini and the .odbc.ini file in roots home directory will be created and initialized to run off the xcatdb MySQL database. See "Add ODBC Support" in Setting_Up_MySQL_as_the_xCAT_DB + - -\ **-L|-**\ **-LL**\ - +\ **-L|-**\ **-LL**\ + Additional database configuration specifically for the LoadLeveler product. See "Add ODBC Support" in Setting_Up_MySQL_as_the_xCAT_DB - + @@ -128,61 +128,61 @@ EXAMPLES 1. - + To setup MySQL for xCAT to run on the MySQL xcatdb database : - - + + .. code-block:: perl - + mysqlsetup -i - - + + 2. - + Add hosts from /tmp/xcat/hostlist that can access the xcatdb database in MySQL: - - + + .. code-block:: perl - + mysqlsetup -u -f /tmp/xcat/hostlist - - + + Where the file contains a host per line, for example: - - + + .. code-block:: perl - + node1 1.115.85.2 10.%.%.% nodex.cluster.net - - + + 3. - + To setup the ODBC for MySQL xcatdb database access : - - + + .. code-block:: perl - + mysqlsetup -o - - + + 4. - + To setup MySQL for xCAT and add hosts from /tmp/xcat/hostlist and setup the ODBC in Verbose mode: - - + + .. code-block:: perl - + mysqlsetup -i -f /tmp/xcat/hostlist -o -V - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst b/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst index 0beb84a00..1fd244764 100644 --- a/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **nimnodecust [-h|-**\ **-help ]**\ +\ **nimnodecust [-h|-**\ **-help ]**\ -\ **nimnodecust [-V] -s**\ \ *lpp_source_name*\ [\ **-p**\ \ *packages*\ ] [\ **-b**\ \ *installp_bundles*\ ] \ *noderange [attr=val [attr=val ...]]*\ +\ **nimnodecust [-V] -s**\ \ *lpp_source_name*\ [\ **-p**\ \ *packages*\ ] [\ **-b**\ \ *installp_bundles*\ ] \ *noderange [attr=val [attr=val ...]]*\ *********** @@ -43,7 +43,7 @@ A bundle file contains a list of package names. The RPMs must have a prefix of # RPM R:expect-5.42.1-3.aix5.1.ppc.rpm R:ping-2.4b2_to-1.aix5.3.ppc.rpm - + #installp I:openssh.base I:openssh.license @@ -68,41 +68,41 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. These are used to specify additional values that can be passed to the underlying NIM commands, ("nim -o cust..."). See the NIM documentation for valid "nim" command line options. + - -\ **-b**\ \ *installp_bundle_names*\ - +\ **-b**\ \ *installp_bundle_names*\ + A comma separated list of NIM installp_bundle names. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-p**\ \ *package_names*\ - +\ **-p**\ \ *package_names*\ + A comma-separated list of software packages to install. Packages may be RPM or installp. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + diff --git a/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst b/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst index 2370ec466..5f3511342 100644 --- a/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **nimnodeset [-h|-**\ **-help ]**\ +\ **nimnodeset [-h|-**\ **-help ]**\ -\ **nimnodeset [-V|-**\ **-verbose] [-f|-**\ **-force] [-i**\ \ *osimage_name*\ ] [\ **-l**\ \ *location*\ ] [\ **-p|-**\ **-primarySN**\ ] [\ **-b | -**\ **-backupSN**\ ] \ *noderange [attr=val [attr=val ...]]*\ +\ **nimnodeset [-V|-**\ **-verbose] [-f|-**\ **-force] [-i**\ \ *osimage_name*\ ] [\ **-l**\ \ *location*\ ] [\ **-p|-**\ **-primarySN**\ ] [\ **-b | -**\ **-backupSN**\ ] \ *noderange [attr=val [attr=val ...]]*\ *********** @@ -73,59 +73,59 @@ OPTIONS -\ *attr=val [attr=val ...]*\ - +\ *attr=val [attr=val ...]*\ + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr= val pairs must be specified last on the command line. These are used to specify additional values that can be passed to the underlying NIM commands, ("nim -o bos_inst ..."). See the NIM documentation for valid "nim" command line options. Note that you may specify multiple "script" and "installp_bundle" values by using a comma separated list. (ex. "script=ascript,bscript"). + - -\ **-b|-**\ **-backupSN**\ - +\ **-b|-**\ **-backupSN**\ + When using backup service nodes only update the backup. The default is to update both the primary and backup service nodes + - -\ **-f |-**\ **-force**\ - +\ **-f |-**\ **-force**\ + Use the force option to reinitialize the NIM machines. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-i**\ \ *image_name*\ - +\ **-i**\ \ *image_name*\ + The name of an existing xCAT osimage definition. + - -\ **-l|-**\ **-location**\ - +\ **-l|-**\ **-location**\ + The directory location to use when creating new NIM resolv_conf resources. The default location is /install/nim. + - -\ **-p|-**\ **-primarySN**\ - +\ **-p|-**\ **-primarySN**\ + When using backup service nodes only update the primary. The default is to update both the primary and backup service nodes. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + diff --git a/docs/source/guides/admin-guides/references/man1/nodeaddunmged.1.rst b/docs/source/guides/admin-guides/references/man1/nodeaddunmged.1.rst index 0578103ef..2ce52c742 100644 --- a/docs/source/guides/admin-guides/references/man1/nodeaddunmged.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodeaddunmged.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **nodeaddunmged**\ [\ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ] -\ **nodeaddunmged hostname=**\ \ *node-name*\ \ **ip=**\ \ *ip-address*\ +\ **nodeaddunmged hostname=**\ \ *node-name*\ \ **ip=**\ \ *ip-address*\ *********** @@ -37,19 +37,19 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. -\ **hostname=**\ \ *node-name*\ +\ **hostname=**\ \ *node-name*\ Sets the name of the new unmanaged node, where is the name of the node. -\ **ip=**\ \ *ip-address*\ +\ **ip=**\ \ *ip-address*\ Sets the IP address of the unmanaged node, where \ *ip-address*\ is the IP address of the new node in the form xxx.xxx.xxx.xxx diff --git a/docs/source/guides/admin-guides/references/man1/nodech.1.rst b/docs/source/guides/admin-guides/references/man1/nodech.1.rst index 5d4c89f86..22341d5b3 100644 --- a/docs/source/guides/admin-guides/references/man1/nodech.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodech.1.rst @@ -58,22 +58,22 @@ OPTIONS -\ **-d|-**\ **-delete**\ - +\ **-d|-**\ **-delete**\ + Delete the nodes' row in the specified tables. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -99,53 +99,53 @@ EXAMPLES 1. To update nodes in noderange node1-node4 to be in only group all: - - + + .. code-block:: perl - + nodech node1-node4 groups=all - - + + 2. To put all nodes with nodepos.rack value of 2 into a group called rack2: - - + + .. code-block:: perl - + nodech all nodepos.rack==2 groups,=rack2 - - + + 3. To add nodes in noderange node1-node4 to the nodetype table with os=rhel5: - - + + .. code-block:: perl - + nodech node1-node4 groups=all,rhel5 nodetype.os=rhel5 - - + + 4. To add node1-node4 to group1 in addition to the groups they are already in: - - + + .. code-block:: perl - + nodech node1-node4 groups,=group1 - - + + 5. To put node1-node4 in group2, instead of group1: - - + + .. code-block:: perl - + nodech node1-node4 groups^=group1 groups,=group2 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodechmac.1.rst b/docs/source/guides/admin-guides/references/man1/nodechmac.1.rst index 18a44c46e..84a1dce0c 100644 --- a/docs/source/guides/admin-guides/references/man1/nodechmac.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodechmac.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **nodechmac**\ [\ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ] -\ **nodechmac**\ \ *node-name*\ \ **mac=**\ \ *mac-address*\ +\ **nodechmac**\ \ *node-name*\ \ **mac=**\ \ *mac-address*\ *********** @@ -39,19 +39,19 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. -\ *node-name*\ +\ *node-name*\ Specifies the name of the node you want to update, where is the node that is updated. -\ **mac=**\ \ *mac-address*\ +\ **mac=**\ \ *mac-address*\ Sets the new MAC address for the NIC used by the provisioning node, where is the NICs new MAC address. diff --git a/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst b/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst index 77bff5084..be6b5300e 100644 --- a/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodechprofile**\ \ **[-h| -**\ **-help | -v | -**\ **-version]**\ +\ **nodechprofile**\ \ **[-h| -**\ **-help | -v | -**\ **-version]**\ \ **nodechprofile**\ \ *noderange*\ [\ **imageprofile=**\ \ *image-profile*\ ] [\ **networkprofile=**\ \ *network-profile*\ ] [\ **hardwareprofile=**\ \ *hardware-profile*\ ] @@ -47,27 +47,27 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. -\ *noderange*\ +\ *noderange*\ The nodes to be removed. -\ **imageprofile=**\ \ *image-profile*\ +\ **imageprofile=**\ \ *image-profile*\ Sets the new image profile name used by the node, where is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. -\ **networkprofile=**\ \ *network-profile*\ +\ **networkprofile=**\ \ *network-profile*\ Sets the new network profile name used by the node, where is the new network profile. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. -\ **hardwareprofile=**\ \ *hardware-profile*\ +\ **hardwareprofile=**\ \ *hardware-profile*\ Sets the new hardware profile name used by the node, where is the new hardware management profile used by the node. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. @@ -89,23 +89,23 @@ EXAMPLES 1. To change the image profile to rhels6.3_packaged for compute nodes compute-000 and compute-001, use the following command: - - + + .. code-block:: perl - + nodechprofile compute-000,compute-001 imageprofile=rhels6.3_packaged - - + + 2. To change all of the profiles for compute node compute-000, enter the following command: - - + + .. code-block:: perl - + nodechprofile compute-000 imageprofile=rhels6.3_packaged networkprofile=default_cn hardwareprofile=default_ipmi - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodediscoverdef.1.rst b/docs/source/guides/admin-guides/references/man1/nodediscoverdef.1.rst index da7d60081..2d7235f90 100644 --- a/docs/source/guides/admin-guides/references/man1/nodediscoverdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodediscoverdef.1.rst @@ -21,9 +21,9 @@ SYNOPSIS ******** -\ **nodediscoverdef**\ \ **-u**\ \ *uuid*\ \ **-n**\ \ *node*\ +\ **nodediscoverdef**\ \ **-u**\ \ *uuid*\ \ **-n**\ \ *node*\ -\ **nodediscoverdef**\ \ **-r**\ \ **-u**\ \ *uuid*\ +\ **nodediscoverdef**\ \ **-r**\ \ **-u**\ \ *uuid*\ \ **nodediscoverdef**\ \ **-r**\ \ **-t**\ {\ **seq | profile | switch | blade | manual | undef | all**\ } @@ -56,69 +56,69 @@ OPTIONS -\ **-t seq|profile|switch|blade|manual|undef|all**\ - +\ **-t seq|profile|switch|blade|manual|undef|all**\ + Specify the nodes that have been discovered by the specified discovery method: - - + + \* \ **seq**\ - Sequential discovery (started via nodediscoverstart noderange= ...). - - - + + + \* \ **profile**\ - Profile discovery (started via nodediscoverstart networkprofile= ...). - - - + + + \* \ **switch**\ - Switch-based discovery (used when the switch and switches tables are filled in). - - - + + + \* \ **blade**\ - Blade discovery (used for IBM Flex blades). - - - + + + \* \ **manual**\ - Manually discovery (used when defining node by nodediscoverdef command). - - - + + + \* \ **undef**\ - Display the nodes that were in the discovery pool, but for which xCAT has not yet received a discovery request. - - - + + + \* \ **all**\ - All discovered nodes. + + + - - - -\ **-n**\ \ *node*\ - +\ **-n**\ \ *node*\ + The xCAT node that the discovery entry will be defined to. + - -\ **-r**\ - +\ **-r**\ + Remove the discovery entries from discoverydata table. + - -\ **-u**\ \ *uuid*\ - +\ **-u**\ \ *uuid*\ + The uuid of the discovered entry. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. - + @@ -139,57 +139,57 @@ EXAMPLES 1. Define the discovery entry which uuid is 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 to node node1 - - + + .. code-block:: perl - + nodediscoverdef -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 -n node1 - - + + Output is similar to: - - + + .. code-block:: perl - + Defined [51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4] to node node1. - - + + 2. Remove the discovery entry which uuid is 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 from the discoverydata table - - + + .. code-block:: perl - + nodediscoverdef -r -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 - - + + Output is similar to: - - + + .. code-block:: perl - + Removing discovery entries finished. - - + + 3. Remove the discovery entries which discover type is \ **seq**\ from the discoverydata table - - + + .. code-block:: perl - + nodediscoverdef -r -t seq - - + + Output is similar to: - - + + .. code-block:: perl - + Removing discovery entries finished. - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodediscoverls.1.rst b/docs/source/guides/admin-guides/references/man1/nodediscoverls.1.rst index beda1bb93..8d1458b64 100644 --- a/docs/source/guides/admin-guides/references/man1/nodediscoverls.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodediscoverls.1.rst @@ -47,63 +47,63 @@ OPTIONS -\ **-t seq|profile|switch|blade|manual|undef|all**\ - +\ **-t seq|profile|switch|blade|manual|undef|all**\ + Display the nodes that have been discovered by the specified discovery method: - - + + \* \ **seq**\ - Sequential discovery (started via nodediscoverstart noderange= ...). - - - + + + \* \ **profile**\ - Profile discovery (started via nodediscoverstart networkprofile= ...). - - - + + + \* \ **switch**\ - Switch-based discovery (used when the switch and switches tables are filled in). - - - + + + \* \ **blade**\ - Blade discovery (used for IBM Flex blades). - - - + + + \* \ **manual**\ - Manually discovery (used when defining node by nodediscoverdef command). - - - + + + \* \ **undef**\ - Display the nodes that were in the discovery pool, but for which xCAT has not yet received a discovery request. - - - + + + \* \ **all**\ - All discovered nodes. + + + - - - -\ **-l**\ - +\ **-l**\ + Display more detailed information about the discovered nodes. + - -\ **-u**\ \ *uuid*\ - +\ **-u**\ \ *uuid*\ + Display the discovered node that has this uuid. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. - + @@ -124,80 +124,80 @@ EXAMPLES 1. Display the discovered nodes when sequential discovery is running: - - + + .. code-block:: perl - + nodediscoverls - - + + Output is similar to: - - + + .. code-block:: perl - + UUID NODE METHOD MTM SERIAL 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 distest1 sequential 786310X 1052EF2 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB3 distest2 sequential 786310X 1052EF3 - - + + 2. Display the nodes that were in the discovery pool, but for which xCAT has not yet received a discovery request: - - + + .. code-block:: perl - + nodediscoverls -t undef - - + + Output is similar to: - - + + .. code-block:: perl - + UUID NODE METHOD MTM SERIAL 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB0 undef undef 786310X 1052EF0 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB1 undef undef 786310X 1052EF1 - - + + 3. Display all the discovered nodes: - - + + .. code-block:: perl - + nodediscoverls -t all - - + + Output is similar to: - - + + .. code-block:: perl - + UUID NODE METHOD MTM SERIAL 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB0 undef undef 786310X 1052EF0 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB1 undef undef 786310X 1052EF1 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 distest1 sequential 786310X 1052EF2 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB3 distest2 sequential 786310X 1052EF3 - - + + 4. Display the discovered node whose uuid is \ **51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2**\ , with detailed information: - - + + .. code-block:: perl - + nodediscoverls -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 -l - - + + Output is similar to: - - + + .. code-block:: perl - + Object uuid: 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 node=distest1 method=sequential @@ -219,8 +219,8 @@ EXAMPLES switchaddr=eth0!192.168.70.120 switchdesc=eth0!IBM Flex System Fabric EN4093 10Gb Scalable Switch, flash image: version 7.2.6, boot image: version 7.2.6 switchport=eth0!INTA2 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodediscoverstart.1.rst b/docs/source/guides/admin-guides/references/man1/nodediscoverstart.1.rst index 87a280799..2171f8da9 100644 --- a/docs/source/guides/admin-guides/references/man1/nodediscoverstart.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodediscoverstart.1.rst @@ -21,12 +21,12 @@ SYNOPSIS \ **nodediscoverstart**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] -\ **Sequential Discovery Specific:**\ +\ **Sequential Discovery Specific:**\ \ **nodediscoverstart**\ \ **noderange=**\ \ *noderange*\ [\ **hostiprange=**\ \ *imageprofile*\ ] [\ **bmciprange=**\ \ *bmciprange*\ ] [\ **groups=**\ \ *groups*\ ] [\ **rack=**\ \ *rack*\ ] [\ **chassis=**\ \ *chassis*\ ] [\ **height=**\ \ *height*\ ] [\ **unit=**\ \ *unit*\ ] [\ **osimage=**\ \ *osimagename*\ >] [\ **-n | -**\ **-dns**\ ] [\ **-s | -**\ **-skipbmcsetup**\ ] [\ **-V|-**\ **-verbose**\ ] -\ **Profile Discovery Specific:**\ +\ **Profile Discovery Specific:**\ \ **nodediscoverstart**\ \ **networkprofile=**\ \ *network-profile*\ \ **imageprofile=**\ \ *image-profile*\ \ **hostnameformat=**\ \ *nost-name-format*\ [\ **hardwareprofile=**\ \ *hardware-profile*\ ] [\ **groups=**\ \ *node-groups*\ ] [\ **rack=**\ \ *rack-name*\ ] [\ **chassis=**\ \ *chassis-name*\ ] [\ **height=**\ \ *rack-server-height*\ ] [\ **unit=**\ \ *rack-server-unit-location*\ ] [\ **rank=**\ \ *rank-num*\ ] @@ -40,7 +40,7 @@ DESCRIPTION The \ **nodediscoverstart**\ command starts either the \ **Sequential Discovery**\ or \ **Profile Discovery**\ process. They can not both be running at the same time. -\ **Sequential Discovery Specific:**\ +\ **Sequential Discovery Specific:**\ This is the simplest discovery approach. You only need to specify the \ **noderange**\ , \ **hostiprange**\ and \ **bmciprange**\ that should be @@ -49,7 +49,7 @@ then you only need to specify the \ **noderange**\ to the \ **nodediscoverstart physically power on the nodes in the sequence that you want them to receive the node names and IPs, waiting a short time (e.g. 30 seconds) between each node. -\ **Profile Discovery Specific:**\ +\ **Profile Discovery Specific:**\ This is the PCM discovery approach. \ *networkprofile*\ , \ *imageprofile*\ , \ *hostnameformat*\ arguments must be specified to start the \ **Profile Discovery**\ . @@ -68,124 +68,124 @@ OPTIONS -\ **noderange=**\ \ *noderange*\ - +\ **noderange=**\ \ *noderange*\ + The set of node names that should be given to nodes that are discovered via the \ **Sequential Discovery**\ method. This argument is required to \ **Sequential Discovery**\ . Any valid xCAT \ **noderange**\ is allowed, e.g. node[01-10]. + - -\ **hostiprange=**\ \ *ip range*\ - +\ **hostiprange=**\ \ *ip range*\ + The ip range which will be assigned to the host of new discovered nodes in the \ **Sequential Discovery**\ method. The format can be: \ *start_ip*\ \ **-**\ \ *end_ip*\ or \ *noderange*\ , e.g. 192.168.0.1-192.168.0.10 or 192.168.0.[1-10]. + - -\ **bmciprange=**\ \ *ip range*\ - +\ **bmciprange=**\ \ *ip range*\ + The ip range which will be assigned to the bmc of new discovered nodes in the \ **Sequential Discovery**\ method. The format can be: \ *start_ip*\ \ **-**\ \ *end_ip*\ or \ *noderange*\ , e.g. 192.168.1.1-192.168.1.10 or 192.168.1.[1-10]. + - -\ **imageprofile=**\ \ *image-profile*\ - +\ **imageprofile=**\ \ *image-profile*\ + Sets the new image profile name used by the discovered nodes in the \ **Profile Discovery**\ method. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. + - -\ **networkprofile=**\ \ *network-profile*\ - +\ **networkprofile=**\ \ *network-profile*\ + Sets the new network profile name used by the discovered nodes in the \ **Profile Discovery**\ method. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. + - -\ **hardwareprofile=**\ \ *hardware-profile*\ - +\ **hardwareprofile=**\ \ *hardware-profile*\ + Sets the new hardware profile name used by the discovered nodes in the \ **Profile Discovery**\ method. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. + - -\ **hostnameformat=**\ \ *nost-name-format*\ - +\ **hostnameformat=**\ \ *nost-name-format*\ + Sets the node name format for all discovered nodes in the \ **Profile Discovery**\ method. The two types of formats supported are prefix#NNNappendix and prefix#RRand#NNappendix, where wildcard #NNN and #NN are replaced by a system generated number that is based on the provisioning order. Wildcard #RR represents the rack number and stays constant. - + For example, if the node name format is compute-#NN, the node name is generated as: compute-00, compute-01, ..., compute-99. If the node name format is blade#NNN-x64, the node name is generated as: blade001-x64, blade002-x64, ..., blade999-x64 - + For example, if the node name format is compute-#RR-#NN and the rack number is 2, the node name is generated as: compute-02-00, compute-02-01, ..., compute-02-99. If node name format is node-#NN-in-#RR and rack number is 1, the node name is generated as: node-00-in-01, node-01-in-01, ..., node-99-in-01 + - -\ **groups=**\ \ *node-groups*\ - +\ **groups=**\ \ *node-groups*\ + Sets the node groups that the discovered nodes should be put in for either the Sequential Discovery or Profile Discovery methods, where \ *node-group*\ is a comma-separated list of node groups. - + \ **rack=**\ \ *rack-name*\ > - + Sets the rack name where the node is located for either the Sequential Discovery or Profile Discovery methods. + - -\ **chassis=**\ \ *chassis-name*\ - +\ **chassis=**\ \ *chassis-name*\ + Sets the chassis name that the Blade server or PureFlex blade is located in, for either the Sequential Discovery or Profile Discovery methods. This option is used for the Blade server and PureFlex system only. You cannot specify this option with the rack option. + - -\ **height=**\ \ *rack-server-height*\ - +\ **height=**\ \ *rack-server-height*\ + Sets the height of a rack-mounted server in U units for either the Sequential Discovery or Profile Discovery methods. If the rack option is not specified, the default value is 1. + - -\ **unit=**\ \ *rack-server-unit-location*\ - +\ **unit=**\ \ *rack-server-unit-location*\ + Sets the start unit value for the node in the rack, for either the Sequential Discovery or Profile Discovery methods. This option is for a rack server only. If the unit option is not specified, the default value is 1 + - -\ **rank=**\ \ *rank-num*\ - +\ **rank=**\ \ *rank-num*\ + Specifies the starting rank number that is used in the node name format, for the Profile Discovery method. The rank number must be a valid integer between 0 and 254. This option must be specified with nodenameformat option. For example, if your node name format is compute-#RR-#NN. The rack's number is 2 and rank is specified as 5, the node name is generated as follows: compute-02-05, compute-02-06, ..., compute-02-99. + - -\ **osimage=**\ \ *osimagename*\ - +\ **osimage=**\ \ *osimagename*\ + Specifies the osimage name that will be associated with the new discovered node, the os provisioning will be started automatically at the end of the discovery process. + - -\ **-n|-**\ **-dns**\ - +\ **-n|-**\ **-dns**\ + Specifies to run makedns for any new discovered node. This is useful mainly for non-predefined configuration, before running the "nodediscoverstart -n", the user needs to run makedns -n to initialize the named setup on the management node. + - -\ **-s|-**\ **-skipbmcsetup**\ - +\ **-s|-**\ **-skipbmcsetup**\ + Specifies to skip the bmcsetup during the sequential discovery process, if the bmciprange is specified with nodediscoverstart command, the BMC will be setup automatically during the discovery process, if the user does not want to run bmcsetup, could specify the "-s|--skipbmcsetup" with nodediscoverstart command to skip the bmcsetup. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Enumerates the free node names and host/bmc ips that are being specified in the ranges given. Use this option with Sequential Discovery to ensure that you are specifying the ranges you intend. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. - + @@ -206,18 +206,18 @@ EXAMPLES 1. \ **Sequential Discovery**\ : To discover nodes with noderange and host/bmc ip range: - - + + .. code-block:: perl - + nodediscoverstart noderange=n[1-10] hostiprange='172.20.101.1-172.20.101.10' bmciprange='172.20.102.1-172.20.102.10' -V - - + + Output is similar to: - - + + .. code-block:: perl - + Sequential Discovery: Started: Number of free node names: 10 Number of free host ips: 10 @@ -227,18 +227,18 @@ EXAMPLES n01 172.20.101.1 172.20.102.1 n02 172.20.101.2 172.20.102.2 ... ... ... - - + + 2. \ **Profile Discovery**\ : To discover nodes using the default_cn network profile and the rhels6.3_packaged image profile, use the following command: - - + + .. code-block:: perl - + nodediscoverstart networkprofile=default_cn imageprofile=rhels6.3_packaged hostnameformat=compute#NNN - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodediscoverstatus.1.rst b/docs/source/guides/admin-guides/references/man1/nodediscoverstatus.1.rst index 610e8bef0..182800616 100644 --- a/docs/source/guides/admin-guides/references/man1/nodediscoverstatus.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodediscoverstatus.1.rst @@ -27,7 +27,7 @@ DESCRIPTION *********** -The \ **nodediscoverstatus**\ command detects if the sequential or profile node discovery process is currently running, i.e. \ **nodediscoverstart**\ +The \ **nodediscoverstatus**\ command detects if the sequential or profile node discovery process is currently running, i.e. \ **nodediscoverstart**\ has been run, but \ **nodediscoverstop**\ has not. @@ -36,11 +36,11 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. diff --git a/docs/source/guides/admin-guides/references/man1/nodediscoverstop.1.rst b/docs/source/guides/admin-guides/references/man1/nodediscoverstop.1.rst index 4f4046b0a..f95b1b43f 100644 --- a/docs/source/guides/admin-guides/references/man1/nodediscoverstop.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodediscoverstop.1.rst @@ -37,11 +37,11 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. diff --git a/docs/source/guides/admin-guides/references/man1/nodegrpch.1.rst b/docs/source/guides/admin-guides/references/man1/nodegrpch.1.rst index 522d4a769..0256f0703 100644 --- a/docs/source/guides/admin-guides/references/man1/nodegrpch.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodegrpch.1.rst @@ -55,16 +55,16 @@ OPTIONS -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -90,15 +90,15 @@ EXAMPLES 1. - + To declare all members of ipmi group to have nodehm.mgt be ipmi - - + + .. code-block:: perl - + nodegrpch ipmi nodehm.mgt=ipmi - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodeimport.1.rst b/docs/source/guides/admin-guides/references/man1/nodeimport.1.rst index bd3a82f54..ca43f6f4a 100644 --- a/docs/source/guides/admin-guides/references/man1/nodeimport.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodeimport.1.rst @@ -39,31 +39,31 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. -\ **file=**\ \ *nodeinfo-filename*\ +\ **file=**\ \ *nodeinfo-filename*\ Specifies the node information file, where is the full path and file name of the node information file. -\ **imageprofile=**\ \ *image-profile*\ +\ **imageprofile=**\ \ *image-profile*\ Sets the new image profile name used by the node, where is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name. -\ **networkprofile=**\ \ *network-profile*\ +\ **networkprofile=**\ \ *network-profile*\ Sets the new network profile name used by the node, where is the new network profile. A network profile defines the network, NIC, and routes for a node. If the "__NetworkProfile_netprofile" group already exists in the nodehm table, then "netprofile" is used as the network profile name. -\ **hardwareprofile=**\ \ *hardware-profile*\ +\ **hardwareprofile=**\ \ *hardware-profile*\ Sets the new hardware profile name used by the node, where is the new hardware management profile used by the node. If a "__HardwareProfile_hwprofile" group exists, then "hwprofile" is the hardware profile name. A hardware profile defines hardware management related information for imported nodes, including: IPMI, HMC, CEC, CMM. -\ **hostnameformat=**\ \ *host-name-format*\ +\ **hostnameformat=**\ \ *host-name-format*\ Sets the node name format for all nodes discovered, where is a supported format. The two types of formats supported are prefix#NNNappendix and prefix#RRand#NNappendix, where wildcard #NNN and #NN are replaced by a system generated number that is based on the provisioning order. Wildcard #RR represents the rack number and stays constant. @@ -71,7 +71,7 @@ For example, if the node name format is compute-#NN, the node name is generated For example, if the node name format is compute-#RR-#NN and the rack number is 2, the node name is generated as: compute-02-00, compute-02-01, ..., compute-02-99. If node name format is node-#NN-in-#RR and rack number is 1, the node name is generated as: node-00-in-01, node-01-in-01, ... , node-99-in-01 -\ **groups=**\ \ *node-groups*\ +\ **groups=**\ \ *node-groups*\ Sets the node groups that the imported node belongs to, where is a comma-separated list of node groups. @@ -107,7 +107,7 @@ To import nodes using a profile, follow the following steps: "__NetworkProfile_default_mn","static","static",,,, "__NetworkProfile_default_cn","static",,,,, "__ImageProfile_rhels6.2-x86_64-install-compute","static","static",,,, - + # lsdef -t group __NetworkProfile_default_cn Object name: __NetworkProfile_default_cn grouptype=static @@ -132,7 +132,7 @@ To import nodes using a profile, follow the following steps: mac=b8:ac:6f:37:59:24 ip=192.168.1.20 chassis=chassis01 - + # This entry defines a rack server. __hostname__: mac=b8:ac:6f:37:59:25 @@ -140,9 +140,9 @@ To import nodes using a profile, follow the following steps: rack=rack01 height=1 unit=2 - + # hostinfo end. - + Another example of a node information file, a PureFlex X/P node defined: # hostinfo begin # To define a PureFlex P/X node, chassis and slot id must be specified. @@ -152,28 +152,28 @@ To import nodes using a profile, follow the following steps: chassis=cmm01 slotid=1 # hostinfo end. - + Example of a node information file, a switch auto discovery node defined: # hostinfo begin # This entry defines a blade. __hostname__: switches=eth0!switch1!1,eth0!switch2!1!eth1 - + Example of a node information file that specifies a CEC-based rack-mounted Power node that uses direct FSP management: # Node information file begins # This entry defines a Power rack-mount node. __hostname__: mac=b8:ac:6f:37:59:28 cec=mycec - + __hostname__: mac=b8:ac:6f:37:59:28 cec=mycec lparid=2 # Node information file ends. - + Example of a node information file that specifies a PowerKVM Guest node that uses KVM management: - + # Node information file begins # This entry defines a PowerKVM Guest node. # Make sure the node 'vm01' is already created on Hypervisor diff --git a/docs/source/guides/admin-guides/references/man1/nodels.1.rst b/docs/source/guides/admin-guides/references/man1/nodels.1.rst index 2843e2bfa..395c72848 100644 --- a/docs/source/guides/admin-guides/references/man1/nodels.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodels.1.rst @@ -38,49 +38,49 @@ are specified after the noderange in the form: \ *table.column*\ . A few shor also be used as aliases to common attributes: -\ **groups**\ - +\ **groups**\ + nodelist.groups + - -\ **tags**\ - +\ **tags**\ + nodelist.groups + - -\ **mgt**\ - +\ **mgt**\ + nodehm.mgt - + nodels can also select based on table value criteria. The following operators are available: -\ **==**\ - +\ **==**\ + Select nodes where the table.column value is exactly a certain value. + - -\ **!=**\ - +\ **!=**\ + Select nodes where the table.column value is not a given specific value. + - -\ **=~**\ - +\ **=~**\ + Select nodes where the table.column value matches a given regular expression. + - -\ **!~**\ - +\ **!~**\ + Select nodes where the table.column value does not match a given regular expression. - + The \ **nodels**\ command with a specific node and one or more table.attribute parameters is a good substitute @@ -95,34 +95,34 @@ OPTIONS -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-H|-**\ **-with-fieldname**\ - +\ **-H|-**\ **-with-fieldname**\ + Force display of table name and column name context for each result + - -\ **-b|-**\ **-blame**\ - +\ **-b|-**\ **-blame**\ + For values inherited from groups, display which groups provided the inheritance + - -\ **-S**\ - +\ **-S**\ + List all the hidden nodes (FSP/BPA nodes) with other ones. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -143,153 +143,153 @@ EXAMPLES 1. - + To list all defined nodes, enter: - - + + .. code-block:: perl - + nodels - - + + Output is similar to: - - + + .. code-block:: perl - + node1 node2 node3 - - + + 2. - + To list all defined attributes in a table for a node or noderange, enter: - - + + .. code-block:: perl - + nodels rra001a noderes - - + + Output is similar to: - - + + .. code-block:: perl - + rra001a: noderes.primarynic: eth0 rra001a: noderes.xcatmaster: rra000 rra001a: noderes.installnic: eth0 rra001a: noderes.netboot: pxe rra001a: noderes.servicenode: rra000 rra001a: noderes.node: rra001a - - + + 3. - + To list nodes in node group ppc, enter: - - + + .. code-block:: perl - + nodels ppc - - + + Output is similar to: - - + + .. code-block:: perl - + ppcnode1 ppcnode2 ppcnode3 - - + + 4. - + To list the groups each node is part of: - - + + .. code-block:: perl - + nodels all groups - - + + Output is similar to: - - + + .. code-block:: perl - + node1: groups: all node2: groups: all,storage node3: groups: all,blade - - + + 5. - + To list the groups each node is part of: - - + + .. code-block:: perl - + nodels all nodehm.power - - + + Output is similar to: - - + + .. code-block:: perl - + node1: nodehm.power: blade node2: nodehm.power: ipmi node3: nodehm.power: ipmi - - + + 6. - + To list the out-of-band mgt method for blade1: - - + + .. code-block:: perl - + nodels blade1 nodehm.mgt - - + + Output is similar to: - - + + .. code-block:: perl - + blade1: blade - - + + 7. - + Listing blades managed through an AMM named 'amm1' - - + + .. code-block:: perl - + nodels all mp.mpa==amm1 - - + + Output is similar to: - - + + .. code-block:: perl - + blade1 blade10 blade11 @@ -303,25 +303,25 @@ EXAMPLES blade7 blade8 blade9 - - + + 8. - + Listing the switch.switch value for nodes in the second rack: - - + + .. code-block:: perl - + nodels all nodepos.rack==2 switch.switch - - + + Output is similar to: - - + + .. code-block:: perl - + n41: switch.switch: switch2 n42: switch.switch: switch2 n43: switch.switch: switch2 @@ -335,25 +335,25 @@ EXAMPLES n58: switch.switch: switch2 n59: switch.switch: switch2 n60: switch.switch: switch2 - - + + 9. - + Listing the blade slot number for anything managed through a device with a name beginning with amm: - - + + .. code-block:: perl - + nodels all mp.mpa=~/^amm.*/ mp.id - - + + Output looks like: - - + + .. code-block:: perl - + blade1: mp.id: 1 blade10: mp.id: 10 blade11: mp.id: 11 @@ -367,21 +367,21 @@ EXAMPLES blade7: mp.id: 7 blade8: mp.id: 8 blade9: mp.id: 9 - - + + 10. - + To list the hidden nodes that can't be seen with other flags. The hidden nodes are FSP/BPAs. - - + + .. code-block:: perl - + lsdef -S - - + + diff --git a/docs/source/guides/admin-guides/references/man1/nodepurge.1.rst b/docs/source/guides/admin-guides/references/man1/nodepurge.1.rst index 50f18ad0d..847eb6c7b 100644 --- a/docs/source/guides/admin-guides/references/man1/nodepurge.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodepurge.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **nodepurge [-h| -**\ **-help | -v | -**\ **-version]**\ +\ **nodepurge [-h| -**\ **-help | -v | -**\ **-version]**\ -\ **nodepurge**\ \ *noderange*\ +\ **nodepurge**\ \ *noderange*\ *********** @@ -39,15 +39,15 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version -\ *noderange*\ +\ *noderange*\ The nodes to be removed. diff --git a/docs/source/guides/admin-guides/references/man1/noderefresh.1.rst b/docs/source/guides/admin-guides/references/man1/noderefresh.1.rst index d7919f311..7f110d908 100644 --- a/docs/source/guides/admin-guides/references/man1/noderefresh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/noderefresh.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **noderefresh [-h| -**\ **-help | -v | -**\ **-version]**\ +\ **noderefresh [-h| -**\ **-help | -v | -**\ **-version]**\ -\ **noderefresh**\ \ *noderange*\ +\ **noderefresh**\ \ *noderange*\ *********** @@ -37,15 +37,15 @@ OPTIONS ******* -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. -\ *noderange*\ +\ *noderange*\ The nodes to be updated. diff --git a/docs/source/guides/admin-guides/references/man1/noderm.1.rst b/docs/source/guides/admin-guides/references/man1/noderm.1.rst index 222e558b0..4f5eac74a 100644 --- a/docs/source/guides/admin-guides/references/man1/noderm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/noderm.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **noderm [-h| -**\ **-help]**\ +\ **noderm [-h| -**\ **-help]**\ -\ **noderm noderange**\ +\ **noderm noderange**\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/nodestat.1.rst b/docs/source/guides/admin-guides/references/man1/nodestat.1.rst index 2c8944375..68d3f2cfa 100644 --- a/docs/source/guides/admin-guides/references/man1/nodestat.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodestat.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -25,7 +25,7 @@ Name ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -81,144 +81,144 @@ For the command specified by 'dcmd', no input is needed, the output can be a str *************** -\ **Options**\ +\ **Options**\ *************** -\ **-f | -**\ **-usefping**\ - +\ **-f | -**\ **-usefping**\ + Uses fping instead of nmap even if nmap is available. If you seem to be having a problem with false negatives, fping can be more forgiving, but slower. + - -\ **-m | -**\ **-usemon**\ - +\ **-m | -**\ **-usemon**\ + Uses the settings from the \ **monsetting**\ table to determine a list of applications that need to get status for. + - -\ **-p | -**\ **-powerstat**\ - +\ **-p | -**\ **-powerstat**\ + Gets the power status for the nodes that are 'noping'. + - -\ **-u | -**\ **-updatedb**\ - +\ **-u | -**\ **-updatedb**\ + Updates the status and appstatus columns of the nodelist table with the returned running status from the given nodes. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - - + + .. code-block:: perl - + nodestat compute - - + + Output is similar to: - - + + .. code-block:: perl - + node1 sshd node2 sshd node3 ping node4 pbs node5 noping - - + + 2. - - + + .. code-block:: perl - + nodestat compute -p - - + + Output is similar to: - - + + .. code-block:: perl - + node1 sshd node2 sshd node3 ping node4 pbs node5 noping(Shutting down) - - + + 3. - - + + .. code-block:: perl - + nodestat compute -u - - + + Output is similar to: - - + + .. code-block:: perl - + node1 sshd node2 sshd node3 ping node4 netboot node5 noping - - + + 4. - - + + .. code-block:: perl - + nodestat compute -m - - + + Output is similar to: - - + + .. code-block:: perl - + node1 ping,sshd,ll,gpfs=ok node2 ping,sshd,ll,gpfs=not ok,someapp=something is wrong node3 netboot node4 noping - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/packimage.1.rst b/docs/source/guides/admin-guides/references/man1/packimage.1.rst index d02606404..6af0c9223 100644 --- a/docs/source/guides/admin-guides/references/man1/packimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/packimage.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **packimage [-h| -**\ **-help]**\ +\ **packimage [-h| -**\ **-help]**\ -\ **packimage [-v| -**\ **-version]**\ +\ **packimage [-v| -**\ **-version]**\ -\ **packimage**\ [\ **-m | -**\ **-method**\ \ *cpio|tar*\ ] [\ **-c | -**\ **-compress**\ \ *gzip|pigz|xz*\ ] [\ **--nosyncfiles**\ ] \ *imagename*\ +\ **packimage**\ [\ **-m | -**\ **-method**\ \ *cpio|tar*\ ] [\ **-c | -**\ **-compress**\ \ *gzip|pigz|xz*\ ] [\ **-**\ **-nosyncfiles**\ ] \ *imagename*\ *********** @@ -57,7 +57,7 @@ OPTIONS \ **-c| -**\ **-compress**\ Compress Method (pigz,gzip,xz, default is pigz/gzip) -\ **--nosyncfiles**\ Bypass of syncfiles requested, will not sync files to root image directory +\ **-**\ **-nosyncfiles**\ Bypass of syncfiles requested, will not sync files to root image directory ************ diff --git a/docs/source/guides/admin-guides/references/man1/pasu.1.rst b/docs/source/guides/admin-guides/references/man1/pasu.1.rst index 519043875..e7af74980 100644 --- a/docs/source/guides/admin-guides/references/man1/pasu.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pasu.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **pasu**\ [\ **-V**\ ] [\ **-d**\ ] [\ **-l**\ \ *user*\ ] [\ **-p**\ \ *passwd*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-i**\ \ *hostname-suffix*\ ] \ *noderange*\ \ *command*\ +\ **pasu**\ [\ **-V**\ ] [\ **-d**\ ] [\ **-l**\ \ *user*\ ] [\ **-p**\ \ *passwd*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-i**\ \ *hostname-suffix*\ ] \ *noderange*\ \ *command*\ -\ **pasu**\ [\ **-V**\ ] [\ **-d**\ ] [\ **-l**\ \ *user*\ ] [\ **-p**\ \ *passwd*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-i**\ \ *hostname-suffix*\ ] \ **-b**\ \ *batchfile*\ \ *noderange*\ +\ **pasu**\ [\ **-V**\ ] [\ **-d**\ ] [\ **-l**\ \ *user*\ ] [\ **-p**\ \ *passwd*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-i**\ \ *hostname-suffix*\ ] \ **-b**\ \ *batchfile*\ \ *noderange*\ \ **pasu**\ [\ **-h**\ | \ **-**\ **-help**\ ] @@ -47,66 +47,66 @@ OPTIONS -\ **-l|-**\ **-loginname**\ \ *username*\ - +\ **-l|-**\ **-loginname**\ \ *username*\ + The username to use to connect to the IMMs. If not specified, the row in the xCAT \ **passwd**\ table with key "ipmi" will be used to get the username. + - -\ **-p|-**\ **-passwd**\ \ *passwd*\ - +\ **-p|-**\ **-passwd**\ \ *passwd*\ + The password to use to connect to the IMMs. If not specified, the row in the xCAT passwd table with key "ipmi" will be used to get the password. + - -\ **-f|-**\ **-fanout**\ - +\ **-f|-**\ **-fanout**\ + How many processes to run in parallel simultaneously. The default is 64. You can also set the XCATPSHFANOUT environment variable. + - -\ **-b|-**\ **-batch**\ -\ *batchfile*\ - +\ **-b|-**\ **-batch**\ -\ *batchfile*\ + A simple text file that contains multiple ASU commands, each on its own line. + - -\ **-d|-**\ **-donotfilter**\ - +\ **-d|-**\ **-donotfilter**\ + By default, pasu filters out (i.e. does not display) the standard initial output from ASU: - - + + .. code-block:: perl - + IBM Advanced Settings Utility version 9.30.79N Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2007-2012 All Rights Reserved Connected to IMM at IP address node2-imm - - + + If you want this output to be displayed, use this flag. + - -\ **-i|-**\ **-interface**\ \ *hostname-suffix*\ - +\ **-i|-**\ **-interface**\ \ *hostname-suffix*\ + The hostname suffix to be appended to the node names. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display verbose messages. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -127,147 +127,147 @@ EXAMPLES 1. - + To display the Com1ActiveAfterBoot setting on 2 nodes: - - + + .. code-block:: perl - + pasu node1,node2 show DevicesandIOPorts.Com1ActiveAfterBoot - - + + Output is similar to: - - + + .. code-block:: perl - + node1: DevicesandIOPorts.Com1ActiveAfterBoot=Enable node2: DevicesandIOPorts.Com1ActiveAfterBoot=Enable - - + + 2. - + To display the Com1ActiveAfterBoot setting on all compute nodes: - - + + .. code-block:: perl - + pasu compute show DevicesandIOPorts.Com1ActiveAfterBoot | xcoll - - + + Output is similar to: - - + + .. code-block:: perl - + ==================================== compute ==================================== DevicesandIOPorts.Com1ActiveAfterBoot=Enable - - + + 3. - + To set several settings on all compute nodes, create a batch file called (for example) asu-settings with contents: - - + + .. code-block:: perl - + set DevicesandIOPorts.Com1ActiveAfterBoot Enable set DevicesandIOPorts.SerialPortSharing Enable set DevicesandIOPorts.SerialPortAccessMode Dedicated set DevicesandIOPorts.RemoteConsole Enable - - + + Then run: - - + + .. code-block:: perl - + pasu -b asu-settings compute | xcoll - - + + Output is similar to: - - + + .. code-block:: perl - + ==================================== compute ==================================== Batch mode start. [set DevicesandIOPorts.Com1ActiveAfterBoot Enable] DevicesandIOPorts.Com1ActiveAfterBoot=Enable - + [set DevicesandIOPorts.SerialPortSharing Enable] DevicesandIOPorts.SerialPortSharing=Enable - + [set DevicesandIOPorts.SerialPortAccessMode Dedicated] DevicesandIOPorts.SerialPortAccessMode=Dedicated - + [set DevicesandIOPorts.RemoteConsole Enable] DevicesandIOPorts.RemoteConsole=Enable - + Beginning intermediate batch update. Waiting for command completion status. Command completed successfully. Completed intermediate batch update. Batch mode competed successfully. - - + + 4. - + To confirm that all the settings were made on all compute nodes, create a batch file called (for example) asu-show with contents: - - + + .. code-block:: perl - + show DevicesandIOPorts.Com1ActiveAfterBoot show DevicesandIOPorts.SerialPortSharing show DevicesandIOPorts.SerialPortAccessMode show DevicesandIOPorts.RemoteConsole - - + + Then run: - - + + .. code-block:: perl - + pasu -b asu-show compute | xcoll - - + + Output is similar to: - - + + .. code-block:: perl - + ==================================== compute ==================================== Batch mode start. [show DevicesandIOPorts.Com1ActiveAfterBoot] DevicesandIOPorts.Com1ActiveAfterBoot=Enable - + [show DevicesandIOPorts.SerialPortSharing] DevicesandIOPorts.SerialPortSharing=Enable - + [show DevicesandIOPorts.SerialPortAccessMode] DevicesandIOPorts.SerialPortAccessMode=Dedicated - + [show DevicesandIOPorts.RemoteConsole] DevicesandIOPorts.RemoteConsole=Enable - + Batch mode competed successfully. - - + + diff --git a/docs/source/guides/admin-guides/references/man1/pcons.1.rst b/docs/source/guides/admin-guides/references/man1/pcons.1.rst index 27cf7e628..25cd3dce7 100644 --- a/docs/source/guides/admin-guides/references/man1/pcons.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pcons.1.rst @@ -11,12 +11,12 @@ SYNOPSIS ******** -\ **pcons**\ \ *noderange*\ \ *command*\ +\ **pcons**\ \ *noderange*\ \ *command*\ -\ **pcons**\ +\ **pcons**\ [\ **-h | -**\ **-help**\ ] -\ **pcons**\ +\ **pcons**\ [\ **-v | -**\ **-version**\ ] diff --git a/docs/source/guides/admin-guides/references/man1/pgsqlsetup.1.rst b/docs/source/guides/admin-guides/references/man1/pgsqlsetup.1.rst index e291a087b..6a64febc3 100644 --- a/docs/source/guides/admin-guides/references/man1/pgsqlsetup.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pgsqlsetup.1.rst @@ -43,62 +43,62 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Displays verbose messages. + - -\ **-i|-**\ **-init**\ - +\ **-i|-**\ **-init**\ + The init option is used to setup an installed PostgreSQL database so that xCAT can use the database. This involves creating the xcat database, the xcat admin id, allowing access to the xcatdb database by the Management Node. It customizes the postgresql.conf configuration file, adds the management server to the pg_hba.conf and starts the PostgreSQL server. It also backs up the current xCAT database and restores it into the newly setup xcatdb PostgreSQL database. It creates the /etc/xcat/cfgloc file to point the xcatd daemon to the PostgreSQL database and restarts the xcatd daemon using the database. On AIX, it additionally setup the xcatadm unix id and the postgres id and group. For AIX, you should be using the PostgreSQL rpms available from the xCAT website. For Linux, you should use the PostgreSQL rpms shipped with the OS. You can chose the -o option, to run after the init. To add additional nodes to access the PostgreSQL server, setup on the Management Node, use the -a option. - + For more documentation see:Setting_Up_PostgreSQL_as_the_xCAT_DB + - -\ **-N|-**\ **-nostart**\ - +\ **-N|-**\ **-nostart**\ + This option with the -i flag will create the database, but will not backup and restore xCAT tables into the database. It will create the cfgloc file such that the next start of xcatd will try and contact the database. This can be used to setup the xCAT PostgreSQL database during or before install. + - -\ **-l|-**\ **-listen**\ \ *address*\ - +\ **-l|-**\ **-listen**\ \ *address*\ + This option is used to specify additional IP addresses on which the PostgreSQL database will listen. Without it, only localhost (on Linux) and the management node's main IP (on Linux and AIX) will be configured. This option can be specified multiple times. + - -\ **-a|-**\ **-access**\ \ *address*\ - +\ **-a|-**\ **-access**\ \ *address*\ + This option is used to specify additional IP addresses from which the additional nodes will connect to the PostgreSQL database, for example, service nodes IP addresses or MN HA primary/standby nodes physical IP addresses. Without it, only the management node will be configured for database access. This option can be specified multiple times. + - -\ **-P|-**\ **-PCM**\ - +\ **-P|-**\ **-PCM**\ + This option sets up PostgreSQL database to be used with xCAT running with PCM. + - -\ **-o|-**\ **-odbc**\ - +\ **-o|-**\ **-odbc**\ + This option sets up the ODBC /etc/../odbcinst.ini, /etc/../odbc.ini and the .odbc.ini file in roots home directory will be created and initialized to run off the xcatdb PostgreSQL database. - + @@ -108,10 +108,10 @@ ENVIRONMENT VARIABLES -\ **XCATPGPW**\ - +\ **XCATPGPW**\ + The password to be used to setup the xCAT admin id for the database. - + @@ -122,22 +122,22 @@ EXAMPLES 1. To setup PostgreSQL for xCAT to run on the PostgreSQL xcatdb database : - - + + .. code-block:: perl - + pgsqlsetup -i + + - - -2. To setup the ODBC for PostgreSQL xcatdb database access : - - +2. To setup the ODBC for PostgreSQL xcatdb database access : + + .. code-block:: perl - + pgsqlsetup -o - - + + diff --git a/docs/source/guides/admin-guides/references/man1/pping.1.rst b/docs/source/guides/admin-guides/references/man1/pping.1.rst index 20bad2a90..92e680380 100644 --- a/docs/source/guides/admin-guides/references/man1/pping.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pping.1.rst @@ -11,7 +11,7 @@ SYNOPSIS ******** -\ **pping**\ [\ **-i | -**\ **-interface**\ \ *interfaces*\ ] [\ **-f | -**\ **-use_fping**\ ] \ *noderange*\ +\ **pping**\ [\ **-i | -**\ **-interface**\ \ *interfaces*\ ] [\ **-f | -**\ **-use_fping**\ ] \ *noderange*\ \ **pping**\ [\ **-h | -**\ **-help**\ ] @@ -36,32 +36,32 @@ OPTIONS -\ **-i | -**\ **-interface**\ \ *interfaces*\ - +\ **-i | -**\ **-interface**\ \ *interfaces*\ + A comma separated list of network interface names that should be pinged instead of the interface represented by the nodename/hostname. The following name resolution convention is assumed: an interface is reachable by the hostname -. For example, the ib2 interface on node3 has a hostname of node3-ib2. - + If more than one interface is specified, each interface will be combined with the nodenames as described above and will be pinged in turn. + - -\ **-f | -**\ **-use_fping**\ - - Use \ **fping**\ instead of \ **nmap**\ +\ **-f | -**\ **-use_fping**\ + + Use \ **fping**\ instead of \ **nmap**\ + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Show usage information. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the installed version of xCAT. - + @@ -72,46 +72,46 @@ EXAMPLES 1. - - + + .. code-block:: perl - + pping all - - + + Output is similar to: - - + + .. code-block:: perl - + node1: ping node2: ping node3: noping - - + + 2. - - + + .. code-block:: perl - + pping all -i ib0,ib1 - - + + Output is similar to: - - + + .. code-block:: perl - + node1-ib0: ping node2-ib0: ping node3-ib0: noping node1-ib1: ping node2-ib1: ping node3-ib1: noping - - + + diff --git a/docs/source/guides/admin-guides/references/man1/ppping.1.rst b/docs/source/guides/admin-guides/references/man1/ppping.1.rst index 2dd33df35..c957e330d 100644 --- a/docs/source/guides/admin-guides/references/man1/ppping.1.rst +++ b/docs/source/guides/admin-guides/references/man1/ppping.1.rst @@ -11,7 +11,7 @@ SYNOPSIS ******** -\ **ppping**\ [\ **-i | -**\ **-interface**\ \ *interfaces*\ ] [\ **-d | -**\ **-debug**\ ] [\ **-V | -**\ **-verbose**\ ] [\ **-q | -**\ **-quiet**\ ] [\ **-s | -**\ **-serial**\ ] \ *noderange*\ +\ **ppping**\ [\ **-i | -**\ **-interface**\ \ *interfaces*\ ] [\ **-d | -**\ **-debug**\ ] [\ **-V | -**\ **-verbose**\ ] [\ **-q | -**\ **-quiet**\ ] [\ **-s | -**\ **-serial**\ ] \ *noderange*\ \ **ppping**\ [\ **-h | -**\ **-help**\ ] @@ -35,52 +35,52 @@ OPTIONS -\ **-s**\ - +\ **-s**\ + Ping serially instead of in parallel. + - -\ **-i | -**\ **-interface**\ \ *interfaces*\ - +\ **-i | -**\ **-interface**\ \ *interfaces*\ + A comma separated list of network interface names that should be pinged instead of the interface represented by the nodename/hostname. The following name resolution convention is assumed: an interface is reachable by the hostname -. For example, the ib2 interface on node3 has a hostname of node3-ib2. - + If more than one interface is specified, each interface will be combined with the nodenames as described above and will be pinged in turn. + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Display verbose output. The result of every ping attempt from every node will be displayed. Without this option, just a summary of the successful pings are displayed, along with all of the unsuccessful pings. + - -\ **-q | -**\ **-quiet**\ - +\ **-q | -**\ **-quiet**\ + Display minimum output: just the unsuccessful pings. This option has the effect that if all pings are successful, nothing is displayed. But it also has the performance benefit that each node does not have to send successful ping info back to the management node. + - -\ **-d | -**\ **-debug**\ - +\ **-d | -**\ **-debug**\ + Print debug information. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Show usage information. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the installed version of xCAT. - + @@ -91,40 +91,40 @@ EXAMPLES 1. - - + + .. code-block:: perl - + ppping all -q - - + + Output is similar to: - - + + .. code-block:: perl - + blade7: node2: noping blade8: node2: noping blade9: node2: noping devmaster: node2: noping node2: noping - - + + 2. - - + + .. code-block:: perl - + ppping node1,node2 -i ib0,ib1,ib2,ib3 - - + + Output is similar to: - - + + .. code-block:: perl - + node1: pinged all nodes successfully on interface ib0 node1: pinged all nodes successfully on interface ib1 node1: pinged all nodes successfully on interface ib2 @@ -133,8 +133,8 @@ EXAMPLES node2: pinged all nodes successfully on interface ib1 node2: pinged all nodes successfully on interface ib2 node2: pinged all nodes successfully on interface ib3 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/prsync.1.rst b/docs/source/guides/admin-guides/references/man1/prsync.1.rst index 55e447be7..7bee4871f 100644 --- a/docs/source/guides/admin-guides/references/man1/prsync.1.rst +++ b/docs/source/guides/admin-guides/references/man1/prsync.1.rst @@ -15,20 +15,20 @@ prsync - parallel rsync **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **prsync**\ \ *filename*\ [\ *filename*\ \ *...*\ ] \ *noderange:destinationdirectory*\ +\ **prsync**\ \ *filename*\ [\ *filename*\ \ *...*\ ] \ *noderange:destinationdirectory*\ \ **prsync**\ [\ **-o**\ \ *rsyncopts*\ ] [\ **-f**\ \ *fanout*\ ] [\ *filename*\ \ *filename*\ \ *...*\ ] [\ *directory*\ \ *directory*\ \ *...*\ ] -\ *noderange:destinationdirectory*\ +\ *noderange:destinationdirectory*\ \ **prsync**\ {\ **-h | -**\ **-help | -v | -**\ **-version**\ } ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -40,91 +40,91 @@ Note: this command does not support the xcatd client/server communication and t *************** -\ **Options**\ +\ **Options**\ *************** -\ **-o**\ \ *rsyncopts*\ - +\ **-o**\ \ *rsyncopts*\ + rsync options. See \ **rsync(1)**\ . + - -\ **-f**\ \ *fanout*\ - +\ **-f**\ \ *fanout*\ + Specifies a fanout value for the maximum number of concurrently executing remote shell processes. + - -\ *filename*\ - +\ *filename*\ + A space delimited list of files to rsync. + - -\ *directory*\ - +\ *directory*\ + A space delimited list of directories to rsync. + - -\ *noderange:destination*\ - +\ *noderange:destination*\ + A noderange(3)|noderange.3 and destination directory. The : is required. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. + - -\ **XCATPSHFANOUT**\ - +\ **XCATPSHFANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. Default is 64. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - - + + .. code-block:: perl - + cd /install; prsync -o "crz" post stage:/install - - + + 2. - - + + .. code-block:: perl - + prsync passwd group rack01:/etc - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/pscp.1.rst b/docs/source/guides/admin-guides/references/man1/pscp.1.rst index 0a98b5f2d..48d9a2af9 100644 --- a/docs/source/guides/admin-guides/references/man1/pscp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pscp.1.rst @@ -15,17 +15,17 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **pscp**\ [\ **-i**\ \ *suffix*\ ] [\ *scp options*\ \ *...*\ ] [\ **-f**\ \ *fanout*\ ] \ *filename*\ [\ *filename*\ \ *...*\ ] \ *noderange:destinationdirectory*\ +\ **pscp**\ [\ **-i**\ \ *suffix*\ ] [\ *scp options*\ \ *...*\ ] [\ **-f**\ \ *fanout*\ ] \ *filename*\ [\ *filename*\ \ *...*\ ] \ *noderange:destinationdirectory*\ \ **pscp**\ {\ **-h | -**\ **-help | -v | -**\ **-version**\ } ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -41,92 +41,92 @@ management node to the compute node via a service node. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-f**\ \ *fanout*\ - +\ **-f**\ \ *fanout*\ + Specifies a fanout value for the maximum number of concur- rently executing remote shell processes. + - -\ **-i**\ \ *suffix*\ - +\ **-i**\ \ *suffix*\ + Interfaces to be used. + - -\ *scp options*\ - - See \ **scp(1)**\ +\ *scp options*\ + + See \ **scp(1)**\ + - -\ *filename*\ - +\ *filename*\ + A space delimited list of files to copy. If \ **-r**\ is passed as an scp option, directories may be specified as well. + - -\ *noderange:destination*\ - +\ *noderange:destination*\ + A noderange(3)|noderange.3 and destination directory. The : is required. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. + - -\ **XCATPSHFANOUT**\ - +\ **XCATPSHFANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. Default is 64. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - - + + .. code-block:: perl - + pscp -r /usr/local node1,node3:/usr/local - - + + 2. - - + + .. code-block:: perl - + pscp passwd group rack01:/etc - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/psh.1.rst b/docs/source/guides/admin-guides/references/man1/psh.1.rst index dc847a489..e264a9e75 100644 --- a/docs/source/guides/admin-guides/references/man1/psh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/psh.1.rst @@ -15,17 +15,17 @@ psh - parallel remote shell **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **psh**\ [\ **-i**\ \ *interface*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-l**\ \ *user*\ ] \ *noderange*\ \ *command*\ +\ **psh**\ [\ **-i**\ \ *interface*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-l**\ \ *user*\ ] \ *noderange*\ \ *command*\ \ **psh**\ {\ **-h | -**\ **-help | -v | -**\ **-version**\ } ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -44,129 +44,129 @@ management node to the compute node via a service node. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-i**\ \ *interface*\ - +\ **-i**\ \ *interface*\ + The NIC on the node that psh should communicate with. For example, if \ *interface*\ is \ **eth1**\ , then psh will concatenate \ **-eth1**\ to the end of every node name before ssh'ing to it. This assumes those host names have been set up to resolve to the IP address of each of the eth1 NICs. + - -\ **-f**\ \ *fanout*\ - +\ **-f**\ \ *fanout*\ + Specifies a fanout value for the maximum number of concur- rently executing remote shell processes. + - -\ **-l**\ \ *user*\ - +\ **-l**\ \ *user*\ + Log into the nodes as the specified username. The default is to use the same username as you are running the psh command as. + - -\ **-n|-**\ **-nonodecheck**\ - +\ **-n|-**\ **-nonodecheck**\ + Do not send the noderange to xcatd to expand it into a list of nodes. Instead, use the noderange exactly as it is specified. In this case, the noderange must be a simple list of comma-separated hostnames of the nodes. This allows you to run \ **psh**\ even when xcatd is not running. + - -\ *noderange*\ - +\ *noderange*\ + See noderange(3)|noderange.3. + - -\ *command*\ - - Command to be run in parallel. If no command is give then \ **psh**\ +\ *command*\ + + Command to be run in parallel. If no command is give then \ **psh**\ enters interactive mode. In interactive mode a ">" prompt is displayed. Any command entered is executed in parallel to the nodes in the noderange. Use "exit" or "Ctrl-D" to end the interactive session. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. - + ************************************* -\ **Environment**\ \ **Variables**\ +\ **Environment**\ \ **Variables**\ ************************************* -\ **XCATPSHFANOUT**\ - +\ **XCATPSHFANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. Default is 64. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. Run uptime on 3 nodes: - - + + .. code-block:: perl - + psh node4-node6 uptime - - + + Output is similar to: - - + + .. code-block:: perl - + node4: Sun Aug 5 17:42:06 MDT 2001 node5: Sun Aug 5 17:42:06 MDT 2001 node6: Sun Aug 5 17:42:06 MDT 2001 - - + + 2. Run a command on some BladeCenter management modules: - - + + .. code-block:: perl - + psh amm1-amm5 'info -T mm[1]' - - + + 3. Remove the tmp files on the nodes in the 1st frame: - - + + .. code-block:: perl - + psh rack01 'rm -f /tmp/*' - - + + Notice the use of '' to forward shell expansion. This is not necessary in interactive mode. - + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/pushinitrd.1.rst b/docs/source/guides/admin-guides/references/man1/pushinitrd.1.rst index 42e359602..7b1ea8919 100644 --- a/docs/source/guides/admin-guides/references/man1/pushinitrd.1.rst +++ b/docs/source/guides/admin-guides/references/man1/pushinitrd.1.rst @@ -49,24 +49,24 @@ OPTIONS -\ **-w**\ \ *waittime*\ - +\ **-w**\ \ *waittime*\ + The number of seconds the initrd should wait before trying to communicate over the network. The default is 75. This translates into the netwait kernel parameter and is usually needed in a SoftLayer environment because it can take a while for a NIC to be active after changing state. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. - + @@ -87,15 +87,15 @@ EXAMPLES 1. - + Configure nodes for net installing in a SoftLayer environment: - - + + .. code-block:: perl - + pushinitrd - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rbootseq.1.rst b/docs/source/guides/admin-guides/references/man1/rbootseq.1.rst index 6075619ea..fece3a79f 100644 --- a/docs/source/guides/admin-guides/references/man1/rbootseq.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rbootseq.1.rst @@ -17,21 +17,21 @@ Blade specific: =============== -\ **rbootseq**\ \ *noderange*\ {\ **hd0 | hd1 | hd2 | hd3 | net | iscsi | iscsicrit | cdrom | usbflash | floppy | none | list | stat**\ }\ **,**\ \ *...*\ +\ **rbootseq**\ \ *noderange*\ {\ **hd0 | hd1 | hd2 | hd3 | net | iscsi | iscsicrit | cdrom | usbflash | floppy | none | list | stat**\ }\ **,**\ \ *...*\ HP Blade specific: ================== -\ **rbootseq**\ \ *noderange*\ {\ **hd | net1 | net2 | net3 | net4 | cdrom | usbflash | floppy | none**\ }\ **,**\ \ *...*\ +\ **rbootseq**\ \ *noderange*\ {\ **hd | net1 | net2 | net3 | net4 | cdrom | usbflash | floppy | none**\ }\ **,**\ \ *...*\ PPC (using Direct FSP Management) specific: =========================================== -\ **rbootseq**\ \ *noderange*\ \ **[hfi|net]**\ +\ **rbootseq**\ \ *noderange*\ \ **[hfi|net]**\ @@ -58,106 +58,106 @@ OPTIONS -\ **hd0 | harddisk0 | hd | harddisk**\ - +\ **hd0 | harddisk0 | hd | harddisk**\ + The first hard disk. + - -\ **hd1 | harddisk1**\ - +\ **hd1 | harddisk1**\ + The second hard disk. + - -\ **hd2 | harddisk2**\ - +\ **hd2 | harddisk2**\ + The third hard disk. + - -\ **hd3 | harddisk3**\ - +\ **hd3 | harddisk3**\ + The fourth hard disk. + - -\ **n | net | network**\ - +\ **n | net | network**\ + Boot over the ethernet network, using a PXE or BOOTP broadcast. - + \ **n | net | network | net1 | nic1**\ (HP Blade Only) - + Boot over the first ethernet network, using a PXE or BOOTP broadcast. - + \ **net2 | nic2**\ (HP Blade Only) - + Boot over the second ethernet network, using a PXE or BOOTP broadcast. - + \ **net3 | nic3**\ (HP Blade Only) - + Boot over the third ethernet network, using a PXE or BOOTP broadcast. - + \ **net3 | nic3**\ (HP Blade Only) - + Boot over the fourth ethernet network, using a PXE or BOOTP broadcast. + - -\ **hfi**\ - +\ **hfi**\ + Boot p775 nodes over the HFI network, using BOOTP broadcast. + - -\ **iscsi**\ - +\ **iscsi**\ + Boot to an iSCSI disk over the network. + - -\ **iscsicrit**\ - +\ **iscsicrit**\ + ?? + - -\ **cd | cdrom**\ - +\ **cd | cdrom**\ + The CD or DVD drive. + - -\ **usbflash | usb | flash**\ - +\ **usbflash | usb | flash**\ + A USB flash drive. + - -\ **floppy**\ - +\ **floppy**\ + The floppy drive. + - -\ **none**\ - +\ **none**\ + If it gets to this part of the sequence, do not boot. Can not be specified 1st, or before any real boot devices. + - -\ **list | stat**\ - +\ **list | stat**\ + Display the current boot sequence. - + @@ -168,16 +168,16 @@ EXAMPLES 1. - + Set blades 14-56 and 70-203 to try to boot first from the CD drive, then the floppy drive, then the network, and finally from the 1st hard disk: - - + + .. code-block:: perl - + rbootseq blade[14-56],blade[70-203] c,f,n,hd0 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rcons.1.rst b/docs/source/guides/admin-guides/references/man1/rcons.1.rst index 0a9ddc63a..e8f4ad2d7 100644 --- a/docs/source/guides/admin-guides/references/man1/rcons.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rcons.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -25,7 +25,7 @@ Name ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -39,41 +39,41 @@ To exit the console session, enter: 'ctrl-e c .' (3 characters: ctrl-e, 'c' and *************** -\ **Options**\ +\ **Options**\ *************** -\ **-f**\ - +\ **-f**\ + If another console for this node is already open in read-write mode, force that console into read-only (spy) mode, and open this console in read-write mode. If -f is not specified, this console will be put in spy mode if another console is already open in read-write mode. The -f flag can not be used with the -s flag. + - -\ **-s**\ - +\ **-s**\ + Open the console in read-only (spy) mode, in this mode all the escape sequences work, but all other keyboard input is discarded. The -s flag can not be used with the -f flag. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + ************* -\ **Files**\ +\ **Files**\ ************* @@ -84,7 +84,7 @@ method. **************** -\ **Examples**\ +\ **Examples**\ **************** @@ -96,7 +96,7 @@ method. ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/regnotif.1.rst b/docs/source/guides/admin-guides/references/man1/regnotif.1.rst index 17d38a4c5..2460784b2 100644 --- a/docs/source/guides/admin-guides/references/man1/regnotif.1.rst +++ b/docs/source/guides/admin-guides/references/man1/regnotif.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **regnotif [-h| -**\ **-help]**\ +\ **regnotif [-h| -**\ **-help]**\ -\ **regnotif [-v| -**\ **-version]**\ +\ **regnotif [-v| -**\ **-version]**\ \ **regnotif**\ \ *filename tablename[,tablename]...*\ [\ **-o | -**\ **-operation**\ \ *actions*\ ] diff --git a/docs/source/guides/admin-guides/references/man1/renergy.1.rst b/docs/source/guides/admin-guides/references/man1/renergy.1.rst index d9e5a5be4..f05bdc684 100644 --- a/docs/source/guides/admin-guides/references/man1/renergy.1.rst +++ b/docs/source/guides/admin-guides/references/man1/renergy.1.rst @@ -7,7 +7,7 @@ renergy.1 ************ -\ **NAME**\ +\ **NAME**\ ************ @@ -15,7 +15,7 @@ renergy.1 **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** @@ -23,76 +23,76 @@ renergy.1 \ **renergy**\ [\ **-v**\ | \ **-**\ **-version**\ ] -\ **Power 6 server specific :**\ +\ **Power 6 server specific :**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [savingstatus] [cappingstatus] [cappingmaxmin] [cappingvalue] [cappingsoftmin] [averageAC] [averageDC] [ambienttemp] [exhausttemp] [CPUspeed] [syssbpower] [sysIPLtime]**\ } \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **savingstatus={on | off} | cappingstatus={on | off} | cappingwatt=watt | cappingperc=percentage**\ } -\ **Power 7 server specific :**\ +\ **Power 7 server specific :**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [savingstatus] [dsavingstatus] [cappingstatus] [cappingmaxmin] [cappingvalue] [cappingsoftmin] [averageAC] [averageDC] [ambienttemp] [exhausttemp] [CPUspeed] [syssbpower] [sysIPLtime] [fsavingstatus] [ffoMin] [ffoVmin] [ffoTurbo] [ffoNorm] [ffovalue]**\ } \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **savingstatus={on | off} | dsavingstatus={on-norm | on-maxp | off} | fsavingstatus={on | off} | ffovalue=MHZ | cappingstatus={on | off} | cappingwatt=watt | cappingperc=percentage**\ } -\ **Power 8 server specific :**\ +\ **Power 8 server specific :**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [savingstatus] [dsavingstatus] [averageAC] [averageAChistory] [averageDC] [averageDChistory] [ambienttemp] [ambienttemphistory] [exhausttemp] [exhausttemphistory] [fanspeed] [fanspeedhistory] [CPUspeed] [CPUspeedhistory] [syssbpower] [sysIPLtime] [fsavingstatus] [ffoMin] [ffoVmin] [ffoTurbo] [ffoNorm] [ffovalue]**\ } -\ **renergy**\ \ *noderange*\ \ **[-V] {savingstatus={on | off} | dsavingstatus={on-norm | on-maxp | off} | fsavingstatus={on | off} | ffovalue=MHZ }**\ +\ **renergy**\ \ *noderange*\ \ **[-V] {savingstatus={on | off} | dsavingstatus={on-norm | on-maxp | off} | fsavingstatus={on | off} | ffovalue=MHZ }**\ \ *NOTE:*\ The setting operation for \ **Power 8**\ server is only supported for the server which is running in PowerVM mode. Do NOT run the setting for the server which is running in OPAL mode. -\ **BladeCenter specific :**\ +\ **BladeCenter specific :**\ -\ **For Management Modules:**\ +\ **For Management Modules:**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | pd1all | pd2all | [pd1status] [pd2status] [pd1policy] [pd2policy] [pd1powermodule1] [pd1powermodule2] [pd2powermodule1] [pd2powermodule2] [pd1avaiablepower] [pd2avaiablepower] [pd1reservedpower] [pd2reservedpower] [pd1remainpower] [pd2remainpower] [pd1inusedpower] [pd2inusedpower] [availableDC] [averageAC] [thermaloutput] [ambienttemp] [mmtemp]**\ } -\ **For a blade server nodes:**\ +\ **For a blade server nodes:**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [averageDC] [capability] [cappingvalue] [CPUspeed] [maxCPUspeed] [savingstatus] [dsavingstatus]**\ } \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **savingstatus={on | off} | dsavingstatus={on-norm | on-maxp | off}**\ } -\ **Flex specific :**\ +\ **Flex specific :**\ -\ **For Flex Management Modules:**\ +\ **For Flex Management Modules:**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [powerstatus] [powerpolicy] [powermodule] [avaiablepower] [reservedpower] [remainpower] [inusedpower] [availableDC] [averageAC] [thermaloutput] [ambienttemp] [mmtemp]**\ } -\ **For Flex node (power and x86):**\ +\ **For Flex node (power and x86):**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **all | [averageDC] [capability] [cappingvalue] [cappingmaxmin] [cappingmax] [cappingmin] [cappingGmin] [CPUspeed] [maxCPUspeed] [savingstatus] [dsavingstatus]**\ } \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **cappingstatus={on | off} | cappingwatt=watt | cappingperc=percentage | savingstatus={on | off} | dsavingstatus={on-norm | on-maxp | off}**\ } -\ **iDataPlex specific :**\ +\ **iDataPlex specific :**\ \ **renergy**\ \ *noderange*\ [\ **-V**\ ] [{\ **cappingmaxmin | cappingmax | cappingmin}] [cappingstatus] [cappingvalue] [relhistogram]**\ } \ **renergy**\ \ *noderange*\ [\ **-V**\ ] {\ **cappingstatus={on | enable | off | disable} | {cappingwatt|cappingvalue}=watt**\ } -\ **OpenPOWER server specific :**\ +\ **OpenPOWER server specific :**\ \ **renergy**\ \ *noderange*\ {\ **powerusage | temperature**\ } ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* @@ -114,7 +114,7 @@ management module node names or blade server node names. Lpar name is not acceptable here. \ **renergy**\ command can accept multiple of energy attributes to query or one of energy -attribute to set. If only the attribute name is specified, without the '=', \ **renergy**\ +attribute to set. If only the attribute name is specified, without the '=', \ **renergy**\ gets and displays the current value. Otherwise, if specifying the attribute with '=' like 'savingstatus=on', \ **renergy**\ will set the attribute savingstatus to value 'on'. @@ -128,7 +128,7 @@ server, the return value of this attribute will be 'na'. The supported attributes for each specific system p hardware type is listed as follows: -\ **8203-E4A**\ , \ **8204-E8A**\ +\ **8203-E4A**\ , \ **8204-E8A**\ Supported attributes: @@ -139,7 +139,7 @@ exhausttemp,CPUspeed,syssbpower,sysIPLtime \ **Set**\ : savingstatus,cappingstatus,cappingwatt,cappingperc -\ **9125-F2A**\ +\ **9125-F2A**\ Supported attributes: @@ -149,7 +149,7 @@ CPUspeed \ **Set**\ : savingstatus -\ **8233-E8B**\ , \ **8236-E8C**\ +\ **8233-E8B**\ , \ **8236-E8C**\ Supported attributes: @@ -161,7 +161,7 @@ ambienttemp,exhausttemp,CPUspeed,syssbpower,sysIPLtime \ **Set**\ : savingstatus,dsavingstatus,cappingstatus,cappingwatt, cappingperc -\ **9125-F2C**\ , \ **9119-FHB**\ +\ **9125-F2C**\ , \ **9119-FHB**\ Supported attributes: @@ -174,7 +174,7 @@ fsavingstatus,ffoMin,ffoVmin,ffoTurbo,ffoNorm,ffovalue \ **Set**\ : savingstatus,dsavingstatus,cappingstatus,cappingwatt, cappingperc,fsavingstatus,ffovalue -\ **Non of Above**\ +\ **Non of Above**\ For the machine type which is not in the above list, the following @@ -194,7 +194,7 @@ will get response immediately. ********************* -\ **PREREQUISITES**\ +\ **PREREQUISITES**\ ********************* @@ -214,519 +214,519 @@ so no additional plugins are needed for BladeCenter.) *************** -\ **OPTIONS**\ +\ **OPTIONS**\ *************** -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display the usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the version information. + - -\ **-V**\ - +\ **-V**\ + Verbose output. + - -\ **all**\ - +\ **all**\ + Query all energy attributes which supported by the specific type of hardware. - + For \ *Power8*\ machines, will not display the attributes for historical records. + - -\ **pd1all**\ - +\ **pd1all**\ + Query all energy attributes of the power domain 1 for blade management module node. + - -\ **pd2all**\ - +\ **pd2all**\ + Query all energy attributes of the power domain 2 for blade management module node. + - -\ **ambienttemp**\ - +\ **ambienttemp**\ + Query the current ambient temperature. (Unit is centigrade) + - -\ **ambienttemphistory**\ - +\ **ambienttemphistory**\ + Query the historical records which were generated in last one hour for \ **ambienttemp**\ . + - -\ **availableDC**\ - +\ **availableDC**\ + Query the total DC power available for the entire blade center chassis. + - -\ **averageAC**\ - +\ **averageAC**\ + Query the average power consumed (Input). (Unit is watt) - + Note: For 9125-F2A,9125-F2C server, the value of attribute averageAC is the aggregate for all of the servers in a rack. - + Note: For Blade Center, the value of attribute averageAC is the total AC power being consumed by all modules in the chassis. It also includes power consumed by the Chassis Cooling Devices for BCH chassis. + - -\ **averageAChistory**\ - +\ **averageAChistory**\ + Query the historical records which were generated in last one hour for \ **averageAC**\ . + - -\ **averageDC**\ - +\ **averageDC**\ + Query the average power consumed (Output). (Unit is watt) + - -\ **averageDChistory**\ - +\ **averageDChistory**\ + Query the historical records which were generated in last one hour for \ **averageDC**\ . + - -\ **capability**\ - +\ **capability**\ + Query the Power Capabilities of the blade server. - + staticPowerManagement: the module with the static worst case power values. - + fixedPowermanagement: the module with the static power values but ability to throttle. - + dynamicPowerManagement: the module with power meter capability, measurement enabled, but capping disabled. - + dynamicPowerMeasurement1: the module with power meter capability, measurement enabled, phase 1 only - + dynamicPowerMeasurement2: the module with power meter capability, measurement enabled, phase 2 or higher - + dynamicPowerMeasurementWithPowerCapping: the module with power meter capability, both measurement and capping enabled, phase 2 or higher + - -\ **cappingGmin**\ - +\ **cappingGmin**\ + Query the Guaranteed Minimum power capping value in watts. + - -\ **cappingmax**\ - +\ **cappingmax**\ + Query the Maximum of power capping value in watts. + - -\ **cappingmaxmin**\ - +\ **cappingmaxmin**\ + Query the Maximum and Minimum of power capping value in watts. + - -\ **cappingmin**\ - +\ **cappingmin**\ + Query the Minimum of power capping value in watts. + - -\ **cappingperc**\ =\ **percentage**\ - +\ **cappingperc**\ =\ **percentage**\ + Set the power capping value base on the percentage of the max-min of capping value which getting from \ *cappingmaxmim*\ attribute. The valid value must be from 0 to 100. + - -\ **cappingsoftmin**\ - +\ **cappingsoftmin**\ + Query the minimum value that can be assigned to power capping without guaranteed enforceability. (Unit is watt) + - -\ **cappingstatus**\ - +\ **cappingstatus**\ + Query the power capping status. The result should be 'on' or 'off'. - + \ **cappingstatus**\ ={\ **on**\ | \ **off**\ } - + Set the power capping status. The value must be 'on' or 'off'. This is the switch to turn on or turn off the power capping function. + - -\ **cappingvalue**\ - +\ **cappingvalue**\ + Query the current power capping value. (Unit is watt) + - -\ **cappingwatt**\ =\ **watt**\ - +\ **cappingwatt**\ =\ **watt**\ + Set the power capping value base on the watt unit. - + If the 'watt' > maximum of \ *cappingmaxmin*\ or 'watt' < \ *cappingsoftmin*\ , the setting operation will be failed. If the 'watt' > \ *cappingsoftmin*\ and 'watt' < minimum of \ *cappingmaxmin*\ , the value can NOT be guaranteed. + - -\ **CPUspeed**\ - +\ **CPUspeed**\ + Query the effective processor frequency. (Unit is MHz) + - -\ **CPUspeedhistory**\ - - Query the historical records which were generated in last one hour for \ **CPUspeed**\ +\ **CPUspeedhistory**\ + + Query the historical records which were generated in last one hour for \ **CPUspeed**\ + - -\ **dsavingstatus**\ - +\ **dsavingstatus**\ + Query the dynamic power saving status. The result should be 'on-norm', 'on-maxp' or 'off'. - + If turning on the dynamic power saving, the processor frequency and voltage will be dropped dynamically based on the core utilization. It supports two modes for turn on state: - + \ *on-norm*\ - means normal, the processor frequency cannot exceed the nominal value; - + \ *on-maxp*\ - means maximum performance, the processor frequency can exceed the nominal value. - + \ **dsavingstatus**\ ={\ **on-norm**\ | \ **on-maxp**\ | \ **off**\ } - + Set the dynamic power saving. The value must be 'on-norm', 'on-maxp' or 'off'. - + The dsavingstatus setting operation needs about 2 minutes to take effect. (The used time depends on the hardware type) - + The \ **dsavingstatus**\ only can be turned on when the \ **savingstatus**\ is in turn off status. + - -\ **exhausttemp**\ - +\ **exhausttemp**\ + Query the current exhaust temperature. (Unit is centigrade) + - -\ **exhausttemphistory**\ - - Query the historical records which were generated in last one hour for \ **exhausttemp**\ +\ **exhausttemphistory**\ + + Query the historical records which were generated in last one hour for \ **exhausttemp**\ + - -\ **fanspeed**\ - +\ **fanspeed**\ + Query the fan speed for all the fans which installed in this node. (Unit is RPM - Rotations Per Minute)) - + If there are multiple fans for a node, multiple lines will be output. And a fan name in bracket will be appended after \ **fanspped**\ attribute name. + - -\ **fanspeedhistory**\ - +\ **fanspeedhistory**\ + Query the historical records which were generated in last one hour for \ **fanspeed**\ . + - -\ **ffoMin**\ - +\ **ffoMin**\ + Query the minimum cpu frequency which can be set for FFO. (Fixed Frequency Override) + - -\ **ffoNorm**\ - +\ **ffoNorm**\ + Query the maximum cpu frequency which can be set for FFO. + - -\ **ffoTurbo**\ - +\ **ffoTurbo**\ + Query the advertised maximum cpu frequency (selling point). + - -\ **ffoVmin**\ - +\ **ffoVmin**\ + Query the minimum cpu frequency which can be set for dropping down the voltage to save power. That means when you drop the cpu frequency from the ffoVmin to ffoVmin, the voltage won't change, then there's no obvious power to be saved. + - -\ **ffovalue**\ - +\ **ffovalue**\ + Query the current value of FFO. + - -\ **ffovalue**\ =\ **MHZ**\ - +\ **ffovalue**\ =\ **MHZ**\ + Set the current value of FFO. The valid value of ffovalue should be between the ffoMin and ffoNorm. - + Note1: Due to the limitation of firmware, the frequency in the range 3501 MHz - 3807 MHz can NOT be set to ffovalue. This range may be changed in future. - + Note2: The setting will take effect only when the fsavingstatus is in 'on' status. But you need to set the ffovalue to a valid value before enabling the fsavingstatus. (It's a limitation of the initial firmware and will be fixed in future.) - + The ffovalue setting operation needs about 1 minute to take effect. + - -\ **fsavingstatus**\ - +\ **fsavingstatus**\ + Query the status of FFO. The result should be 'on' or 'off'. 'on' - enable; 'off' - disable. - + \ **fsavingstatus**\ ={\ **on**\ | \ **off**\ } - + Set the status of FFO. The value must be 'on' or 'off'. - - 'on' - enable. It will take effect only when the \ **ffovalue**\ + + 'on' - enable. It will take effect only when the \ **ffovalue**\ has been set to a valid value. - + 'off' -disable. It will take effect immediately. - + Note: See the Note2 of ffovalue=MHZ. + - -\ **maxCPUspeed**\ - +\ **maxCPUspeed**\ + Query the maximum processor frequency. (Unit is MHz) + - -\ **mmtemp**\ - +\ **mmtemp**\ + Query the current temperature of management module. (Unit is centigrade) + - -\ **pd1status | powerstatus**\ - +\ **pd1status | powerstatus**\ + Query the status of power domain 1 for blade management module node. - + Note: for the attribute without the leading 'pd1' which means there's only one power doamin in the chassis. + - -\ **pd1policy | powerpolicy**\ - +\ **pd1policy | powerpolicy**\ + Query the power management policy of power domain 1. + - -\ **pd1powermodule1 | powermodule**\ - +\ **pd1powermodule1 | powermodule**\ + Query the First Power Module capacity in power domain 1. + - -\ **pd1powermodule2 | powermodule**\ - +\ **pd1powermodule2 | powermodule**\ + Query the Second Power Module capacity in power domain 1. + - -\ **pd1avaiablepower | avaiablepower**\ - +\ **pd1avaiablepower | avaiablepower**\ + Query the total available power in power domain 1. + - -\ **pd1reservedpower | reservedpower**\ - +\ **pd1reservedpower | reservedpower**\ + Query the power that has been reserved for power domain 1. + - -\ **pd1remainpower | remainpower**\ - +\ **pd1remainpower | remainpower**\ + Query the remaining power available in power domain 1. + - -\ **pd1inusedpower | inusedpower**\ - +\ **pd1inusedpower | inusedpower**\ + Query the total power being used in power domain 1. + - -\ **pd2status**\ - +\ **pd2status**\ + Query the status of power domain 2 for blade management module node. + - -\ **pd2policy**\ - +\ **pd2policy**\ + Query the power management policy of power domain 2. + - -\ **pd2powermodule1**\ - +\ **pd2powermodule1**\ + Query the First Power Module capacity in power domain 2. + - -\ **pd2powermodule2**\ - +\ **pd2powermodule2**\ + Query the Second Power Module capacity in power domain 2. + - -\ **pd2avaiablepower**\ - +\ **pd2avaiablepower**\ + Query the total available power in power domain 2. + - -\ **pd2reservedpower**\ - +\ **pd2reservedpower**\ + Query the power that has been reserved for power domain 2. + - -\ **pd2remainpower**\ - +\ **pd2remainpower**\ + Query the remaining power available in power domain 2. + - -\ **pd2inusedpower**\ - +\ **pd2inusedpower**\ + Query the total power being used in power domain 2. + - -\ **relhistogram**\ - +\ **relhistogram**\ + Query histogram data for wattage information + - -\ **savingstatus**\ - +\ **savingstatus**\ + Query the static power saving status. The result should be 'on' or 'off'. 'on' - enable; 'off' - disable. - + \ **savingstatus**\ ={\ **on**\ | \ **off**\ } - + Set the static power saving. The value must be 'on' or 'off'. - + If turning on the static power saving, the processor frequency and voltage will be dropped to a fixed value to save energy. - + The savingstatus setting operation needs about 2 minutes to take effect. (The used time depends on the hardware type) - + The \ **savingstatus**\ only can be turned on when the \ **dsavingstatus**\ is in turn off status. + - -\ **sysIPLtime**\ - +\ **sysIPLtime**\ + Query the time used from FSP standby to OS standby. (Unit is Second) + - -\ **syssbpower**\ - +\ **syssbpower**\ + Query the system power consumed prior to power on. (Unit is Watt) + - -\ **thermaloutput**\ - +\ **thermaloutput**\ + Query the thermal output (load) in BTUs per hour for the blade center chassis. + - -\ **powerusage**\ - +\ **powerusage**\ + Query System Power Statistics with DCMI (Data Center Manageability Interface). + - -\ **temperature**\ - +\ **temperature**\ + Query the temperature from DCMI (Data Center Manageability Interface) Temperature sensor. Currently, only CPU temperature and baseboard temperature sensor available for OpenPOWER servers. - + ******************** -\ **RETURN VALUE**\ +\ **RETURN VALUE**\ ******************** @@ -736,24 +736,24 @@ so no additional plugins are needed for BladeCenter.) **************** -\ **EXAMPLES**\ +\ **EXAMPLES**\ **************** 1. Query all attributes which CEC1,CEC2 supported. - - + + .. code-block:: perl - + renergy CEC1,CEC2 all - - + + The output of the query operation: - - + + .. code-block:: perl - + CEC1: savingstatus: off CEC1: dsavingstatus: off CEC1: cappingstatus: off @@ -779,23 +779,23 @@ so no additional plugins are needed for BladeCenter.) CEC2: ambienttemp: 25 C CEC2: exhausttemp: 40 C CEC2: CPUspeed: 4695 MHz - - + + 2. Query the \ **fanspeed**\ attribute for Power8 CEC. - - + + .. code-block:: perl - + renergy CEC1 fanspeed - - + + The output of the query operation: - - + + .. code-block:: perl - + CEC1: fanspeed (Fan U78CB.001.WZS00MA-A1 00002101): 5947 RPM CEC1: fanspeed (Fan U78CB.001.WZS00MA-A2 00002103): 6081 RPM CEC1: fanspeed (Fan U78CB.001.WZS00MA-A3 00002105): 6108 RPM @@ -804,19 +804,19 @@ so no additional plugins are needed for BladeCenter.) CEC1: fanspeed (Fan U78CB.001.WZS00MA-A6 0000210B): 6013 RPM CEC1: fanspeed (Fan U78CB.001.WZS00MA-E1 0000210C): 4992 RPM CEC1: fanspeed (Fan U78CB.001.WZS00MA-E2 0000210D): 5016 RPM - - + + 3. Query the historical records for the \ **CPUspeed**\ attribute. (Power8 CEC) - + \ **renergy**\ CEC1 CPUspeedhistory - + The output of the query operation: - - + + .. code-block:: perl - + CEC1: CPUspeedhistory: 2027 MHZ: 20141226042900 CEC1: CPUspeedhistory: 2027 MHZ: 20141226042930 CEC1: CPUspeedhistory: 2244 MHZ: 20141226043000 @@ -828,25 +828,25 @@ so no additional plugins are needed for BladeCenter.) CEC1: CPUspeedhistory: 2393 MHZ: 20141226043300 CEC1: CPUspeedhistory: 2393 MHZ: 20141226043330 ... - - + + 4 - + Query all the attirbutes for management module node MM1. (For chassis) - - + + .. code-block:: perl - + renergy MM1 all - - + + The output of the query operation: - - + + .. code-block:: perl - + mm1: availableDC: 5880W mm1: frontpaneltmp: 18.00 Centigrade mm1: inusedAC: 2848W @@ -868,23 +868,23 @@ so no additional plugins are needed for BladeCenter.) mm1: pd2reservedpower: 2889W mm1: pd2status: 2 - Warning: Power redundancy does not exist in this power domain. mm1: thermaloutput: 9717.376000 BTU/hour - - + + 5. Query all the attirbutes for blade server node blade1. - - + + .. code-block:: perl - + renergy blade1 all - - + + The output of the query operation: - - + + .. code-block:: perl - + blade1: CPUspeed: 4204MHZ blade1: averageDC: 227W blade1: capability: dynamicPowerMeasurement2 @@ -892,87 +892,87 @@ so no additional plugins are needed for BladeCenter.) blade1: dsavingstatus: off blade1: maxCPUspeed: 4204MHZ blade1: savingstatus: off - - + + 6. Query the attributes savingstatus, cappingstatus and CPUspeed for server CEC1. - - + + .. code-block:: perl - + renergy CEC1 savingstatus cappingstatus CPUspeed - - + + The output of the query operation: - - + + .. code-block:: perl - + CEC1: savingstatus: off CEC1: cappingstatus: on CEC1: CPUspeed: 3621 MHz - - + + 7. Turn on the power saving function of CEC1. - - + + .. code-block:: perl - + renergy CEC1 savingstatus=on - - + + The output of the setting operation: - - + + .. code-block:: perl - + CEC1: Set savingstatus succeeded. CEC1: This setting may need some minutes to take effect. - - + + 8. Set the power capping value base on the percentage of the max-min capping value. Here, set it to 50%. - - + + .. code-block:: perl - + renergy CEC1 cappingperc=50 - - + + If the maximum capping value of the CEC1 is 850w, and the minimum capping value of the CEC1 is 782w, the Power Capping value will be set as ((850-782)\*50% + 782) = 816w. - + The output of the setting operation: - - + + .. code-block:: perl - + CEC1: Set cappingperc succeeded. CEC1: cappingvalue: 816 - - + + 9. Query powerusage and temperature for OpenPOWER servers. - - + + .. code-block:: perl - + renergy ops01 powerusage temperature - - + + The output will be like this: - - + + .. code-block:: perl - + ops01: Current Power : 591W ops01: Minimum Power over sampling duration : 558W ops01: Maximum Power over sampling duration : 607W @@ -982,38 +982,38 @@ max-min capping value. Here, set it to 50%. ops01: Power Measurement : Active ops01: CPU Temperature Instance 0 : +39 Centigrade ops01: Baseboard temperature Instance 0 : +28 Centigrade - - + + ****************** -\ **REFERENCES**\ +\ **REFERENCES**\ ****************** 1. For more information on 'Power System Energy Management': - + http://www-03.ibm.com/systems/power/software/energy/index.html - + 2. EnergyScale white paper for Power6: - + http://www-03.ibm.com/systems/power/hardware/whitepapers/energyscale.html - + 3. EnergyScale white paper for Power7: - + http://www-03.ibm.com/systems/power/hardware/whitepapers/energyscale7.html - + ************* -\ **FILES**\ +\ **FILES**\ ************* diff --git a/docs/source/guides/admin-guides/references/man1/replaycons.1.rst b/docs/source/guides/admin-guides/references/man1/replaycons.1.rst index aee76d34d..c4b1929b3 100644 --- a/docs/source/guides/admin-guides/references/man1/replaycons.1.rst +++ b/docs/source/guides/admin-guides/references/man1/replaycons.1.rst @@ -43,28 +43,28 @@ OPTIONS -\ *bps*\ - +\ *bps*\ + The display rate to use to play back the console output. Default is 19200. + - -\ *tail_amount*\ - +\ *tail_amount*\ + The place in the console log file to start play back, specified as the # of lines from the end. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -90,15 +90,15 @@ EXAMPLES 1. - + To replay the console for node1 at the default rate, starting 2000 lines from the end: - - + + .. code-block:: perl - + replaycons 19200 2000 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/restartxcatd.1.rst b/docs/source/guides/admin-guides/references/man1/restartxcatd.1.rst index 57c6e4fb4..a4348f73f 100644 --- a/docs/source/guides/admin-guides/references/man1/restartxcatd.1.rst +++ b/docs/source/guides/admin-guides/references/man1/restartxcatd.1.rst @@ -29,7 +29,7 @@ DESCRIPTION The \ **restartxcatd**\ command restarts the xCAT daemon (xcatd). -\ **Linux Specific**\ +\ **Linux Specific**\ It will perform the xcatd \ *fast restart*\ . The xcatd \ *fast restart*\ is a specific restart which has two advantages compares to the \ *stop*\ and then \ *start*\ . @@ -40,7 +40,7 @@ It does the same thing as 'service xcatd restart' on NON-systemd enabled Operati It's recommended to use \ **restartxcatd**\ command to restart xcatd on systemd enable system like rh7 and sles12 instead of 'service xcatd restart' or 'systemctl restart xcatd'. -\ **AIX Specific**\ +\ **AIX Specific**\ It runs 'stopsrc -s xcatd' to stop xcatd first if xcatd is active, then runs 'startsrc -s xcatd' to start xcatd. diff --git a/docs/source/guides/admin-guides/references/man1/reventlog.1.rst b/docs/source/guides/admin-guides/references/man1/reventlog.1.rst index 76a0d9a20..108ccbe9d 100644 --- a/docs/source/guides/admin-guides/references/man1/reventlog.1.rst +++ b/docs/source/guides/admin-guides/references/man1/reventlog.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -32,7 +32,7 @@ OpenPOWER OpenBMC specific : ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -42,73 +42,73 @@ logs are stored on each servers service processor. *************** -\ **Options**\ +\ **Options**\ *************** -\ *number-of-entries*\ - +\ *number-of-entries*\ + Retrieve the specified number of entries from the nodes' service processors. + - -\ **all**\ - +\ **all**\ + Retrieve all entries. + - -\ **-s**\ - +\ **-s**\ + To sort the entries from latest (always the last entry in event DB) to oldest (always the first entry in event DB). If \ **number-of-entries**\ specified, the latest \ **number-of-entries**\ events will be output in the order of latest to oldest. + - -\ **clear**\ - +\ **clear**\ + Clear event logs. - + \ **resolved=**\ {\ *id-list*\ |\ **LED**\ } - + Mark event log entries as resolved. Use comma separated list of entry ids to specify individual entries. Use \ **LED**\ to mark as resolved all event log entries that contribute to LED fault. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. List last 5 event log entries from node4 and node5 - - + + .. code-block:: perl - + reventlog node4,node5 5 - - + + Output is similar to: - - + + .. code-block:: perl - + node4: SERVPROC I 09/06/00 15:23:33 Remote Login Successful User ID = USERID[00] node4: SERVPROC I 09/06/00 15:23:32 System spn1 started a RS485 connection with us[00] node4: SERVPROC I 09/06/00 15:22:35 RS485 connection to system spn1 has ended[00] @@ -119,48 +119,48 @@ logs are stored on each servers service processor. node5: SERVPROC I 09/06/00 15:21:34 RS485 connection to system spn1 has ended[00] node5: SERVPROC I 09/06/00 15:21:30 Remote Login Successful User ID = USERID[00] node5: SERVPROC I 09/06/00 15:21:29 System spn1 started a RS485 connection with us[00] - - + + 2. Clear all event log entries from node4 and node5 - - + + .. code-block:: perl - + reventlog node4,node5 clear - - + + Output is similar to: - - + + .. code-block:: perl - + node4: clear node5: clear - - + + 3. Mark as resolved all event log entries from node4 that contribute to LED fault - - + + .. code-block:: perl - + reventlog node4 resolved=LED - - + + Output is similar to: - - + + .. code-block:: perl - + Attempting to resolve the following log entries: LED... node4: Resolved 51. node4: Resolved 52. node4: Resolved 58. - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rflash.1.rst b/docs/source/guides/admin-guides/references/man1/rflash.1.rst index 4c494b23d..90c3ed721 100644 --- a/docs/source/guides/admin-guides/references/man1/rflash.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rflash.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -43,7 +43,7 @@ NeXtScale FPC specific: ======================= -\ **rflash**\ \ *noderange*\ \ *http_directory*\ +\ **rflash**\ \ *noderange*\ \ *http_directory*\ OpenPOWER BMC specific (using IPMI): @@ -52,7 +52,7 @@ OpenPOWER BMC specific (using IPMI): \ **rflash**\ \ *noderange*\ [\ *hpm_file_path*\ | \ **-d**\ \ *data_directory*\ ] [\ **-c | -**\ **-check**\ ] [\ **-**\ **-retry=**\ \ *count*\ ] -\ **rflash**\ \ *noderange*\ \ **-**\ **-recover**\ \ *bmc_file_path*\ +\ **rflash**\ \ *noderange*\ \ **-**\ **-recover**\ \ *bmc_file_path*\ OpenPOWER OpenBMC specific : @@ -70,7 +70,7 @@ OpenPOWER OpenBMC specific : ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -181,110 +181,110 @@ This delete option will delete update image from BMC. It expects an ID as the in *************** -\ **Options**\ +\ **Options**\ *************** -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Writes the command's usage statement to standard output. + - -\ **-c|-**\ **-check**\ - +\ **-c|-**\ **-check**\ + Check the firmware version of BMC and an update file. + - -\ **-p**\ \ *directory*\ - +\ **-p**\ \ *directory*\ + Specifies the directory where the packages are located. + - -\ **-d**\ \ *data_directory*\ - +\ **-d**\ \ *data_directory*\ + PPC (without HMC, using Direct FSP Management) specific: - + Specifies the directory where the raw data from rpm packages for each CEC/Frame are located. The default directory is /tmp. The option is only used in Direct FSP/BPA Management. - + OpenPOWER BMC specific (using IPMI): - + Used for IBM Power S822LC for Big Data systems only. Specifies the directory where the \ **pUpdate**\ utility and at least one of BMC or Host update files are located. The utility and update files can be downloaded from FixCentral. - + \ **-**\ **-activate**\ {\ **concurrent**\ | \ **disruptive**\ } - + Must be specified to activate the new Licensed Internal Code. The "disruptive" option will cause the target systems to be recycled. Without this flag, LIC updates will be installed only, not activated. + - -\ **-**\ **-commit**\ - +\ **-**\ **-commit**\ + Used to commit the flash image in the temporary side of the chip to the permanent side for both managed systems and power subsystems. + - -\ **-**\ **-recover**\ - +\ **-**\ **-recover**\ + PPC (with HMC) and PPC (without HMC, using Direct FSP Management) specific: - + Used to recover the flash image in the permanent side of the chip to the temporary side for both managed systems and power subsystems. - + OpenPOWER BMC specific (using IPMI): - + Used for IBM Power S822LC for Big Data systems only. Used to recover the BMC with a BMC image downloaded from FixCentral. This option will only work if BMC is in "Brick protection" state. + - -\ **-**\ **-retry=**\ \ *count*\ - +\ **-**\ **-retry=**\ \ *count*\ + Specify number of times to retry the update if failure is detected. Default value is 2. Value of 0 can be used to indicate no retries. + - -\ **-a|-**\ **-activate**\ - +\ **-a|-**\ **-activate**\ + Activate update image. Image id or update file must be specified. + - -\ **-l|-**\ **-list**\ - +\ **-l|-**\ **-list**\ + List currently uploaded update images. "(\*)" indicates currently active image. + - -\ **-u|-**\ **-upload**\ - +\ **-u|-**\ **-upload**\ + Upload update image. Specified file must be in .tar format. + - -\ **-**\ **-delete**\ - +\ **-**\ **-delete**\ + Delete update image from BMC + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the command's version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. - + ******************* -\ **Exit Status**\ +\ **Exit Status**\ ******************* @@ -294,96 +294,96 @@ This delete option will delete update image from BMC. It expects an ID as the in **************** -\ **Examples**\ +\ **Examples**\ **************** 1. To update only the power subsystem attached to a single HMC-attached pSeries CEC(cec_name), and recycle the power subsystem and all attached managed systems when the update is complete, and the Microcode update package and associated XML file are in /tmp/fw, enter: - - + + .. code-block:: perl - + rflash cec_name -p /tmp/fw --activate disruptive - - + + 2. To update only the power subsystem attached to a single HMC-attached pSeries node, and recycle the power subsystem and all attached managed systems when the update is complete, and the Microcode update package and associated XML file are in /tmp/fw, enter: - - + + .. code-block:: perl - + rflash bpa_name -p /tmp/fw --activate disruptive - - + + 3. To commit a firmware update to permanent flash for both managed system and the related power subsystems, enter: - - + + .. code-block:: perl - + rflash cec_name --commit - - + + 4. To update the firmware on a NeXtScale FPC specify the FPC node name and the HTTP location of the file including the xCAT MN IP address and the directory on the xCAT MN containing the firmware as follows: - - + + .. code-block:: perl - + rflash fpc01 http://10.1.147.169/install/firmware/fhet17a/ibm_fw_fpc_fhet17a-2.02_anyos_noarch.rom - - + + 5. To update the firmware on OpenPOWER machine specify the node name and the file path of the HPM firmware file as follows: - - + + .. code-block:: perl - + rflash fs3 /firmware/8335_810.1543.20151021b_update.hpm - - + + Print verbose message to rflash log file (/var/log/xcat/rflash/fs3.log) when updading firmware: - - + + .. code-block:: perl - + rflash fs3 /firmware/8335_810.1543.20151021b_update.hpm -V - - + + 6. To update the firmware on IBM Power S822LC for Big Data machine specify the node name and the file path of the data directory containing pUpdate utility, both BMC and Host update files: - - + + .. code-block:: perl - + rflash briggs01 -d /root/supermicro/OP825 - - + + 7. To update the firmware on the OpenBMC machine, specify the firmare update file to upload and activate: - - + + .. code-block:: perl - + rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar - - + + **************** -\ **Location**\ +\ **Location**\ **************** -\ **/opt/xcat/bin/rflash**\ +\ **/opt/xcat/bin/rflash**\ ***** diff --git a/docs/source/guides/admin-guides/references/man1/rinv.1.rst b/docs/source/guides/admin-guides/references/man1/rinv.1.rst index 128ee6fbe..4f28900ab 100644 --- a/docs/source/guides/admin-guides/references/man1/rinv.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rinv.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -76,7 +76,7 @@ pdu specific: ============= -\ **rinv**\ \ *noderange*\ +\ **rinv**\ \ *noderange*\ zVM specific: @@ -110,7 +110,7 @@ zVM specific: ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -121,220 +121,220 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, number of CPUs, amou *************** -\ **Options**\ +\ **Options**\ *************** -\ **bus**\ - +\ **bus**\ + List all buses for each I/O slot. + - -\ **config**\ - +\ **config**\ + Retrieves number of processors, speed, total memory, and DIMM locations. + - -\ **model**\ - +\ **model**\ + Retrieves model number. + - -\ **serial**\ - +\ **serial**\ + Retrieves serial number. + - -\ **firm**\ - +\ **firm**\ + Retrieves firmware versions. + - -\ **deconfig**\ - +\ **deconfig**\ + Retrieves deconfigured resources. Deconfigured resources are hw components (cpus, memory, etc.) that have failed so the firmware has automatically turned those components off. This option is only capable of listing some of the deconfigured resources and should not be the only method used to check the hardware status. + - -\ **-x**\ - +\ **-x**\ + To output the raw information of deconfigured resources for CEC. + - -\ **asset**\ - +\ **asset**\ + Retrieves asset tag. Usually it's the MAC address of eth0. + - -\ **vpd**\ - +\ **vpd**\ + Same as specifying model, serial, deviceid, and mprom. + - -\ **diag**\ - +\ **diag**\ + Diagnostics information of firmware. + - -\ **mprom**\ - +\ **mprom**\ + Retrieves mprom firmware level. + - -\ **dimm**\ - +\ **dimm**\ + Retrieves dual in-line memory module information. + - -\ **deviceid**\ - +\ **deviceid**\ + Retrieves device identification. Usually device, manufacturing and product IDs. + - -\ **uuid**\ - +\ **uuid**\ + Retrieves the universally unique identifier. + - -\ **guid**\ - +\ **guid**\ + Retrieves the global unique identifier . + - -\ **all**\ - +\ **all**\ + All of the above. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Prints verbose output, if available. + - -\ **-t**\ - +\ **-t**\ + Set the values in the vm table to what vCenter has for the indicated nodes. + - -\ **zVM specific :**\ +\ **zVM specific :**\ -\ **-**\ **-diskpoolspace**\ - +\ **-**\ **-diskpoolspace**\ + Calculates the total size of every known storage pool. + - -\ **-**\ **-diskpool**\ \ *pool*\ \ *space*\ - +\ **-**\ **-diskpool**\ \ *pool*\ \ *space*\ + Lists the storage devices (ECKD and FBA) contained in a disk pool. Space can be: all, free, or used. + - -\ **-**\ **-fcpdevices**\ \ *state*\ \ *details*\ - +\ **-**\ **-fcpdevices**\ \ *state*\ \ *details*\ + Lists the FCP device channels that are active, free, or offline. State can be: active, free, or offline. + - -\ **-**\ **-diskpoolnames**\ - +\ **-**\ **-diskpoolnames**\ + Lists the known disk pool names. + - -\ **-**\ **-networknames**\ - +\ **-**\ **-networknames**\ + Lists the known network names. + - -\ **-**\ **-network**\ \ *name*\ - +\ **-**\ **-network**\ \ *name*\ + Shows the configuration of a given network device. + - -\ **-**\ **-ssi**\ - +\ **-**\ **-ssi**\ + Obtain the SSI and system status. + - -\ **-**\ **-smapilevel**\ - +\ **-**\ **-smapilevel**\ + Obtain the SMAPI level installed on the z/VM system. + - -\ **-**\ **-wwpns**\ \ *fcp_channel*\ - +\ **-**\ **-wwpns**\ \ *fcp_channel*\ + Query a given FCP device channel on a z/VM system and return a list of WWPNs. + - -\ **-**\ **-zfcppool**\ \ *pool*\ \ *space*\ - +\ **-**\ **-zfcppool**\ \ *pool*\ \ *space*\ + List the SCSI/FCP devices contained in a zFCP pool. Space can be: free or used. + - -\ **-**\ **-zfcppoolnames**\ - +\ **-**\ **-zfcppoolnames**\ + List the known zFCP pool names. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. To retrieve all information available from blade node4, enter: - - + + .. code-block:: perl - + rinv node5 all - - + + Output is similar to: - - + + .. code-block:: perl - + node5: Machine Type/Model 865431Z node5: Serial Number 23C5030 node5: Asset Tag 00:06:29:1F:01:1A @@ -355,23 +355,23 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, number of CPUs, amou node5: Processor Speed: 866 MHz node5: Total Memory: 512 MB node5: Memory DIMM locations: Slot(s) 3 4 - - + + 2. To output the raw information of deconfigured resources for CEC cec01, enter: - - + + .. code-block:: perl - + rinv cec01 deconfig -x - - + + Output is similar to: - - + + .. code-block:: perl - + cec01: IH @@ -380,74 +380,74 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, number of CPUs, amou 800 - - + + 3. - + To retrieve 'config' information from the HMC-managed LPAR node3, enter: - - + + .. code-block:: perl - + rinv node3 config - - + + Output is similar to: - - + + .. code-block:: perl - + node5: Machine Configuration Info node5: Number of Processors: 1 node5: Total Memory (MB): 1024 - - + + 4. - + To retrieve information about a VMware node vm1, enter: - - + + .. code-block:: perl - + rinv vm1 - - + + Output is similar to: - - + + .. code-block:: perl - + vm1: UUID/GUID: 42198f65-d579-fb26-8de7-3ae49e1790a7 vm1: CPUs: 1 vm1: Memory: 1536 MB vm1: Network adapter 1: 36:1b:c2:6e:04:02 vm1: Hard disk 1 (d0): 9000 MB @ [nfs_192.168.68.21_vol_rc1storage_vmware] vm1_3/vm1.vmdk vm1: Hard disk 2 (d4): 64000 MB @ [nfs_192.168.68.21_vol_rc1storage_vmware] vm1_3/vm1_5.vmdk - - - \ **zVM specific :**\ - + + + \ **zVM specific :**\ + 5. - + To list the defined network names available for a given node: - - + + .. code-block:: perl - + rinv pokdev61 --getnetworknames - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: LAN:QDIO SYSTEM GLAN1 pokdev61: LAN:HIPERS SYSTEM GLAN2 pokdev61: LAN:QDIO SYSTEM GLAN3 @@ -456,122 +456,122 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, number of CPUs, amou pokdev61: VSWITCH SYSTEM VSW1 pokdev61: VSWITCH SYSTEM VSW2 pokdev61: VSWITCH SYSTEM VSW3 - - + + 6. - + To list the configuration for a given network: - - + + .. code-block:: perl - + rinv pokdev61 --getnetwork GLAN1 - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: LAN SYSTEM GLAN1 Type: QDIO Connected: 1 Maxconn: INFINITE pokdev61: PERSISTENT UNRESTRICTED IP Accounting: OFF pokdev61: IPTimeout: 5 MAC Protection: Unspecified pokdev61: Isolation Status: OFF - - + + 7. - + To list the disk pool names available: - - + + .. code-block:: perl - + rinv pokdev61 --diskpoolnames - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: POOL1 pokdev61: POOL2 pokdev61: POOL3 - - + + 8. - + List the configuration for a given disk pool: - - + + .. code-block:: perl - + rinv pokdev61 --diskpool POOL1 free - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: #VolID DevType StartAddr Size pokdev61: EMC2C4 3390-09 0001 10016 pokdev61: EMC2C5 3390-09 0001 10016 - - + + 9. - + List the known zFCP pool names. - - + + .. code-block:: perl - + rinv pokdev61 --zfcppoolnames - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: zfcp1 pokdev61: zfcp2 pokdev61: zfcp3 - - + + 10. - + List the SCSI/FCP devices contained in a given zFCP pool: - - + + .. code-block:: perl - + rinv pokdev61 --zfcppool zfcp1 - - + + Output is similar to: - - + + .. code-block:: perl - + pokdev61: #status,wwpn,lun,size,range,owner,channel,tag pokdev61: used,500512345678c411,4014412100000000,2g,3B40-3B7F,ihost13,3b77, pokdev61: used,500512345678c411,4014412200000000,8192M,3B40-3B7F,ihost13,3b77,replace_root_device pokdev61: free,500512345678c411,4014412300000000,8g,3B40-3B7F,,, pokdev61: free,5005123456789411,4014412400000000,2g,3B40-3B7F,,, pokdev61: free,5005123456789411;5005123456789411,4014412600000000,2G,3B40-3B7F,,, - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst index 2b3ea96cf..c7913da80 100644 --- a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst @@ -39,65 +39,65 @@ OPTIONS -\ **-a|-**\ **-all**\ - +\ **-a|-**\ **-all**\ + Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option as the xCAT daemons will no longer work once cleared. - + To restore: - - + + 1. \ **export XCATBYPASS=1**\ and run the \ **restorexCATdb**\ command. - + or - - - + + + 2. Run \ **xcatconfig -d**\ which initializes the database the same as when xCAT was installed. + + + - - - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Use this with the \ **-**\ **-all**\ option as an extra indicator that ALL definitions are to be removed. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display a usage message. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats. + - -\ **-o**\ \ *object-names*\ - +\ **-o**\ \ *object-names*\ + A set of comma delimited object names. + - -\ **-t**\ \ *object-types*\ - +\ **-t**\ \ *object-types*\ + A set of comma delimited object types. + - -\ **-C|-**\ **-cleanup**\ - +\ **-C|-**\ **-cleanup**\ + Perform additional cleanup by running \ **nodeset offline**\ , \ **makeconservercf -d**\ and \ **makegocons -**\ **-cleanup**\ on the objects specified in the \ *noderange*\ . + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + @@ -118,35 +118,35 @@ EXAMPLES 1. To remove a range of node definitions. - - + + .. code-block:: perl - + rmdef -t node node1-node4 - - + + 2. To remove all node definitions for the nodes contained in the group bpcnodes. - - + + .. code-block:: perl - + rmdef -t node -o bpcnodes - - + + 3. To remove the group called bpcnodes. - - + + .. code-block:: perl - + rmdef -t group -o bpcnodes - - + + (This will also update the values of the "groups" attribute of the member nodes.) - + diff --git a/docs/source/guides/admin-guides/references/man1/rmdocker.1.rst b/docs/source/guides/admin-guides/references/man1/rmdocker.1.rst index b1d7849e3..db021f2a9 100644 --- a/docs/source/guides/admin-guides/references/man1/rmdocker.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmdocker.1.rst @@ -32,7 +32,7 @@ OPTIONS -\ **-f|-**\ **-force**\ +\ **-f|-**\ **-force**\ diff --git a/docs/source/guides/admin-guides/references/man1/rmdsklsnode.1.rst b/docs/source/guides/admin-guides/references/man1/rmdsklsnode.1.rst index 4fa5ccde5..b9dd2625d 100644 --- a/docs/source/guides/admin-guides/references/man1/rmdsklsnode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmdsklsnode.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **rmdsklsnode [-h | -**\ **-help ]**\ +\ **rmdsklsnode [-h | -**\ **-help ]**\ -\ **rmdsklsnode [-V|-**\ **-verbose] [-f|-**\ **-force] [-r|-**\ **-remdef] [-i**\ \ *image_name*\ ] \ **[-p|-**\ **-primarySN] [-b|-**\ **-backupSN]**\ \ *noderange*\ +\ **rmdsklsnode [-V|-**\ **-verbose] [-f|-**\ **-force] [-r|-**\ **-remdef] [-i**\ \ *image_name*\ ] \ **[-p|-**\ **-primarySN] [-b|-**\ **-backupSN]**\ \ *noderange*\ *********** @@ -37,7 +37,7 @@ If you are using xCAT service nodes the \ **rmdsklsnode**\ command will automat If the node you are trying to remove is currently running the \ **rmdsklsnode**\ command will not remove the definitions. You can use the "-f" option to shut down the node and remove the definition. -\ **Removing alternate NIM client definitions**\ +\ **Removing alternate NIM client definitions**\ If you used the "-n" option when you created the NIM client definitions with the \ **mkdsklsnode**\ command then the NIM client machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions, you must provide the name of the osimage that was used using the "-i" option. @@ -52,52 +52,52 @@ OPTIONS -\ **-f |-**\ **-force**\ - +\ **-f |-**\ **-force**\ + Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not. + - -\ **-b |-**\ **-backupSN**\ - +\ **-b |-**\ **-backupSN**\ + When using backup service nodes only update the backup. The default is to update both the primary and backup service nodes. + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-i**\ \ *image_name*\ - +\ **-i**\ \ *image_name*\ + The name of an xCAT image definition. + - -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. + - -\ **-p|-**\ **-primarySN**\ - +\ **-p|-**\ **-primarySN**\ + When using backup service nodes only update the primary. The default is to update both the primary and backup service nodes. + - -\ **-r|-**\ **-remdef**\ - +\ **-r|-**\ **-remdef**\ + Use this option to reset, deallocate, and remove NIM client definitions. This option will not attempt to shut down running nodes. This option should be used when remove alternate NIM client definitions that were created using \ **mkdsklsnode -n**\ . + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + diff --git a/docs/source/guides/admin-guides/references/man1/rmflexnode.1.rst b/docs/source/guides/admin-guides/references/man1/rmflexnode.1.rst index 5859588de..4aebb1f7a 100644 --- a/docs/source/guides/admin-guides/references/man1/rmflexnode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmflexnode.1.rst @@ -23,7 +23,7 @@ SYNOPSIS \ **rmflexnode**\ [\ **-v**\ | \ **-**\ **-version**\ ] -\ **rmflexnode**\ \ *noderange*\ +\ **rmflexnode**\ \ *noderange*\ *********** @@ -48,16 +48,16 @@ OPTIONS -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display the usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the version information. - + @@ -68,15 +68,15 @@ EXAMPLES 1 Delete a flexible node base on the xCAT node blade1. - + The blade1 should belong to a complex, the \ *id*\ attribute should be set correctly and all the slots should be in \ **power off**\ state. - - + + .. code-block:: perl - + rmflexnode blade1 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rmhwconn.1.rst b/docs/source/guides/admin-guides/references/man1/rmhwconn.1.rst index 0229cf313..225bb4627 100644 --- a/docs/source/guides/admin-guides/references/man1/rmhwconn.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmhwconn.1.rst @@ -27,21 +27,21 @@ PPC (with HMC) specific: ======================== -\ **rmhwconn**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ +\ **rmhwconn**\ [\ **-V**\ | \ **-**\ **-verbose**\ ] \ *noderange*\ PPC (without HMC, using FSPAPI) specific: ========================================= -\ **rmhwconn**\ \ *noderange*\ \ **-T**\ \ *tooltype*\ +\ **rmhwconn**\ \ *noderange*\ \ **-T**\ \ *tooltype*\ PPC (use HMC as SFP) specific: ============================== -\ **rmhwconn**\ \ **-s**\ +\ **rmhwconn**\ \ **-s**\ @@ -71,22 +71,22 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose output. + - -\ **-T**\ - +\ **-T**\ + The tooltype is used to communicate to the CEC/Frame. The value could be \ **lpar**\ or \ **fnm**\ . The tooltype value \ **lpar**\ is for xCAT and \ **fnm**\ is for CNM. - + @@ -107,39 +107,39 @@ EXAMPLES 1. - + To disconnect all CEC nodes in node group cec from their HMC nodes: - - + + .. code-block:: perl - + rmhwconn cec - - + + 2. - + To remove the connection for Frame node frame1: - - + + .. code-block:: perl - + rmhwconn frame1 - - + + 3. - + To disconnect all CEC nodes in node group cec from their related hardware serveri, using lpar tooltype: - - + + .. code-block:: perl - + rmhwconn cec -T lpar - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rmhypervisor.1.rst b/docs/source/guides/admin-guides/references/man1/rmhypervisor.1.rst index 222ccef1d..5ada8fcbb 100644 --- a/docs/source/guides/admin-guides/references/man1/rmhypervisor.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmhypervisor.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **RHEV specific :**\ +\ **RHEV specific :**\ \ **rmhypervisor**\ \ *noderange*\ [\ **-f**\ ] @@ -39,10 +39,10 @@ OPTIONS -\ **-f**\ - +\ **-f**\ + If \ **-f**\ is specified, the host will be deactivated to maintenance before the removing. - + @@ -63,13 +63,13 @@ EXAMPLES 1. To remove the host 'host1', enter: - - + + .. code-block:: perl - + rmhypervisor host1 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rmigrate.1.rst b/docs/source/guides/admin-guides/references/man1/rmigrate.1.rst index dcb4a6a2e..c76a6584e 100644 --- a/docs/source/guides/admin-guides/references/man1/rmigrate.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmigrate.1.rst @@ -15,11 +15,11 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **rmigrate**\ \ *noderange*\ \ *target_host*\ +\ **rmigrate**\ \ *noderange*\ \ *target_host*\ For zVM: ======== @@ -30,7 +30,7 @@ For zVM: ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -83,7 +83,7 @@ zVM specific: ************* -\ **Files**\ +\ **Files**\ ************* @@ -93,7 +93,7 @@ This is used to determine the current host to migrate from. **************** -\ **Examples**\ +\ **Examples**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/rmimage.1.rst b/docs/source/guides/admin-guides/references/man1/rmimage.1.rst index 637e0ade5..1d49195a4 100644 --- a/docs/source/guides/admin-guides/references/man1/rmimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **rmimage [-h | -**\ **-help]**\ +\ **rmimage [-h | -**\ **-help]**\ -\ **rmimage [-V | -**\ **-verbose]**\ \ *imagename*\ \ **[-**\ **-xcatdef]**\ +\ **rmimage [-V | -**\ **-verbose]**\ \ *imagename*\ \ **[-**\ **-xcatdef]**\ *********** @@ -32,7 +32,7 @@ DESCRIPTION Removes the Linux stateless or statelite image from the file system. The install dir is setup by using "installdir" attribute set in the site table. -If \ *imagename*\ is specified, this command uses the information in the \ *imagename*\ +If \ *imagename*\ is specified, this command uses the information in the \ *imagename*\ to calculate the image root directory; otherwise, this command uses the operating system name, architecture and profile name to calculate the image root directory. diff --git a/docs/source/guides/admin-guides/references/man1/rmkit.1.rst b/docs/source/guides/admin-guides/references/man1/rmkit.1.rst index a4aec473b..d83ca67ce 100644 --- a/docs/source/guides/admin-guides/references/man1/rmkit.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmkit.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **rmkit**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] -\ **rmkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-f | -**\ **-force**\ ] [\ **-t | -**\ **-test**\ ] \ *kitlist*\ +\ **rmkit**\ [\ **-V | -**\ **-verbose**\ ] [\ **-f | -**\ **-force**\ ] [\ **-t | -**\ **-test**\ ] \ *kitlist*\ *********** @@ -40,40 +40,40 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Remove this kit even there is any component in this kit is listed by osimage.kitcomponents. If this option is not specified, this kit will not be removed if any kit components listed in an osimage.kitcomponents + - -\ **-t|-**\ **-test**\ - +\ **-t|-**\ **-test**\ + Test if kitcomponents in this kit are used by osimage + - -\ *kitlist*\ - +\ *kitlist*\ + A comma delimited list of kits that are to be removed from the xCAT cluster. Each entry can be a kitname or kit basename. For kit basename, rmkit command will remove all the kits that have that kit basename. - + diff --git a/docs/source/guides/admin-guides/references/man1/rmkitcomp.1.rst b/docs/source/guides/admin-guides/references/man1/rmkitcomp.1.rst index 3dbd0bf13..183372691 100644 --- a/docs/source/guides/admin-guides/references/man1/rmkitcomp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmkitcomp.1.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **rmkitcomp**\ [\ **-? | -h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] -\ **rmkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-u | -**\ **-uninstall**\ ] [\ **-f | -**\ **-force**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ +\ **rmkitcomp**\ [\ **-V | -**\ **-verbose**\ ] [\ **-u | -**\ **-uninstall**\ ] [\ **-f | -**\ **-force**\ ] [\ **-**\ **-noscripts**\ ] \ **-i**\ \ *osimage*\ \ *kitcompname_list*\ *********** @@ -40,52 +40,52 @@ OPTIONS -\ **-u|-**\ **-uninstall**\ - +\ **-u|-**\ **-uninstall**\ + All the kit component meta rpms and package rpms in otherpkglist will be uninstalled during genimage for stateless image and updatenode for stateful nodes. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command version. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Remove this kit component from osimage no matter it is a dependency of other kit components. + - -\ **-**\ **-noscripts**\ - +\ **-**\ **-noscripts**\ + Do not remove kitcomponent's postbootscripts from osimage + - -\ **-i**\ \ *osimage*\ - +\ **-i**\ \ *osimage*\ + osimage name that include this kit component. + - -\ *kitcompname_list*\ - +\ *kitcompname_list*\ + A comma-delimited list of valid full kit component names or kit component basenames that are to be removed from the osimage. If a basename is specified, all kitcomponents matching that basename will be removed from the osimage. - + diff --git a/docs/source/guides/admin-guides/references/man1/rmnimimage.1.rst b/docs/source/guides/admin-guides/references/man1/rmnimimage.1.rst index 134b409af..f6b6ffe7a 100644 --- a/docs/source/guides/admin-guides/references/man1/rmnimimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmnimimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **rmnimimage [-h|-**\ **-help]**\ +\ **rmnimimage [-h|-**\ **-help]**\ -\ **rmnimimage [-V|-**\ **-verbose] [-f|-**\ **-force] [-d|-**\ **-delete] [-x|-**\ **-xcatdef] [-M|-**\ **-managementnode] [-s**\ \ *servicenoderange*\ ] \ *osimage_name*\ +\ **rmnimimage [-V|-**\ **-verbose] [-f|-**\ **-force] [-d|-**\ **-delete] [-x|-**\ **-xcatdef] [-M|-**\ **-managementnode] [-s**\ \ *servicenoderange*\ ] \ *osimage_name*\ *********** @@ -31,7 +31,7 @@ DESCRIPTION Use this xCAT command to remove the AIX resources specified in an xCAT osimage definition. -To list the contents of the xCAT osimage definition use the xCAT \ **lsdef**\ command ("lsdef -t osimage -l -o "). \ **Before running the rmnimimage command you should be absolutely certain that you really want to remove the NIM resources specified in the xCAT osimage definition!**\ +To list the contents of the xCAT osimage definition use the xCAT \ **lsdef**\ command ("lsdef -t osimage -l -o "). \ **Before running the rmnimimage command you should be absolutely certain that you really want to remove the NIM resources specified in the xCAT osimage definition!**\ The default behavior of this command is to remove all the NIM resources, except the lpp_source, on the xCAT management node in addition to the resources that were replicated on any xCAT service nodes. @@ -58,52 +58,52 @@ OPTIONS -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-d|-**\ **-delete**\ - +\ **-d|-**\ **-delete**\ + Delete any files or directories that were left after the "nim -o remove" command was run. This option will also remove the lpp_source resouce and all files contained in the lpp_source directories. When this command completes all definitions and files will be completely erased so use with caution! + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + Override the check for shared resources when removing an xCAT osimage. + - -\ **-M|-**\ **-managementnode**\ - +\ **-M|-**\ **-managementnode**\ + Remove NIM resources from the xCAT management node only. + - -\ **-s**\ \ *servicenoderange*\ - +\ **-s**\ \ *servicenoderange*\ + Remove the NIM resources on these xCAT service nodes only. Do not remove the NIM resources from the xCAT management node. + - -\ *osimage_name*\ - +\ *osimage_name*\ + The name of the xCAT osimage definition. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. This option will display the underlying NIM commands that are being called. + - -\ **-x|-**\ **-xcatdef**\ - +\ **-x|-**\ **-xcatdef**\ + Remove the xCAT osimage definition. - + diff --git a/docs/source/guides/admin-guides/references/man1/rmvlan.1.rst b/docs/source/guides/admin-guides/references/man1/rmvlan.1.rst index f5a8674c0..67b48992a 100644 --- a/docs/source/guides/admin-guides/references/man1/rmvlan.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmvlan.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **rmvlan**\ \ *vlanid*\ +\ **rmvlan**\ \ *vlanid*\ \ **rmvlan**\ [\ **-h | -**\ **-help**\ ] @@ -76,19 +76,19 @@ EXAMPLES 1. - + To remove vlan 3 - - + + .. code-block:: perl - + rmvlan 3 - - + + If the nodes are KVM guest then the do the following after the vlan is removed: rpower node1,node2 off rmvm node1,node2 - + diff --git a/docs/source/guides/admin-guides/references/man1/rmvm.1.rst b/docs/source/guides/admin-guides/references/man1/rmvm.1.rst index d1d7a5e5a..39a083ec7 100644 --- a/docs/source/guides/admin-guides/references/man1/rmvm.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmvm.1.rst @@ -19,24 +19,24 @@ SYNOPSIS ******** -\ **rmvm [-h| -**\ **-help]**\ +\ **rmvm [-h| -**\ **-help]**\ -\ **rmvm [-v| -**\ **-version]**\ +\ **rmvm [-v| -**\ **-version]**\ -\ **rmvm [-V| -**\ **-verbose]**\ \ *noderange*\ \ **[-r] [-**\ **-service]**\ +\ **rmvm [-V| -**\ **-verbose]**\ \ *noderange*\ \ **[-r] [-**\ **-service]**\ For KVM and VMware: =================== -\ **rmvm [-p] [-f]**\ \ *noderange*\ +\ **rmvm [-p] [-f]**\ \ *noderange*\ PPC (using Direct FSP Management) specific: =========================================== -\ **rmvm [-p]**\ \ *noderange*\ +\ **rmvm [-p]**\ \ *noderange*\ diff --git a/docs/source/guides/admin-guides/references/man1/rnetboot.1.rst b/docs/source/guides/admin-guides/references/man1/rnetboot.1.rst index c86ad1317..866e10306 100644 --- a/docs/source/guides/admin-guides/references/man1/rnetboot.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rnetboot.1.rst @@ -46,41 +46,41 @@ OPTIONS ******* -\ **-s**\ +\ **-s**\ Set the boot device order. Accepted boot devices are hd and net. -\ **-F**\ +\ **-F**\ Force reboot the system no matter what state the node is. By default, rnetboot will not reboot the node if node is in 'boot' state. -\ **-f**\ +\ **-f**\ Force immediate shutdown of the partition. -\ **-m**\ +\ **-m**\ Use one or multiple -m flags to specify the node attributes and the expected status for the node installation monitoring and automatic retry mechanism. The operators ==, !=, =~ and !~ are valid. This flag must be used with -t flag. Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. -\ **-r**\ +\ **-r**\ specify the number of retries that the monitoring process will perform before declaring the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag. -\ **-t**\ +\ **-t**\ Specify the timeout, in minutes, to wait for the expectedstatus specified by -m flag. This is a required flag if the -m flag is specified. -\ **-V|-**\ **-verbose**\ +\ **-V|-**\ **-verbose**\ Verbose output. -\ **-h|-**\ **-help**\ +\ **-h|-**\ **-help**\ Display usage message. -\ **-v|-**\ **-version**\ +\ **-v|-**\ **-version**\ Command Version. @@ -104,15 +104,15 @@ EXAMPLES .. code-block:: perl rnetboot 1,3 - + rnetboot 14-56,70-203 - + rnetboot 1,3,14-56,70-203 - + rnetboot all,-129-256 - + rnetboot all -s hd,net - + rnetboot all ipl=00c diff --git a/docs/source/guides/admin-guides/references/man1/rollupdate.1.rst b/docs/source/guides/admin-guides/references/man1/rollupdate.1.rst index 385666d8b..3d445eeaa 100644 --- a/docs/source/guides/admin-guides/references/man1/rollupdate.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rollupdate.1.rst @@ -48,28 +48,28 @@ OPTIONS -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Display additional progress and error messages. Output is also logged in /var/log/xcat/rollupdate.log. + - -\ **-t|-**\ **-test**\ - +\ **-t|-**\ **-test**\ + Run the rollupdate command in test mode only to verify the output files that are created. No scheduler reservation requests will be submitted. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -95,17 +95,17 @@ EXAMPLES 1. - + To run a cluster rolling update based on the information you have created in the file /u/admin/rolling_updates/update_all.stanza enter: - - + + .. code-block:: perl - + cat /u/admin/rolling_updates/update_all.stanza | rollupdate - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rpower.1.rst b/docs/source/guides/admin-guides/references/man1/rpower.1.rst index 3756d063e..71bdc73a8 100644 --- a/docs/source/guides/admin-guides/references/man1/rpower.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rpower.1.rst @@ -149,94 +149,94 @@ OPTIONS -\ **on**\ - +\ **on**\ + Turn power on. + - -\ **onstandby**\ - +\ **onstandby**\ + Turn power on to standby state + - -\ **-T**\ - +\ **-T**\ + The value could be \ **lpar**\ or \ **fnm**\ . The tooltype value \ **lpar**\ is for xCAT and \ **fnm**\ is for CNM. The default value is "\ **lpar**\ ". For cold start in the large cluster, it will save a lot of time if the admins use "\ **rpower**\ \ *noderange*\ \ **onstandby**\ \ **-T**\ \ **fnm**\ " to power on all the CECs from the management node through the \ **fnm**\ connections. + - -\ **rackstandby**\ - +\ **rackstandby**\ + Places the rack in the rack standby state. It requires that all CECs and DE be powered off before it will run. + - -\ **exit_rackstandby**\ - +\ **exit_rackstandby**\ + Exit Rack standby will be the default state that a rack goes into when power is initially applied to the rack. It simply moves the BPA from Rack standby to both bpa's in standby state. + - -\ **resetsp**\ - +\ **resetsp**\ + Reboot the service processor. If there are primary and secondary FSPs/BPAs of one cec/frame, it will reboot them almost at the same time. + - -\ **softoff**\ - +\ **softoff**\ + Attempt to request clean shutdown of OS (may not detect failures in completing command) + - -\ **off**\ - +\ **off**\ + Turn power off. + - -\ **suspend**\ - +\ **suspend**\ + Suspend the target nodes execution. - + The \ **suspend**\ action could be run together with \ **-w**\ \ **-o**\ \ **-r**\ . - + Refer to the following steps to enable the \ **suspend**\ function: - + 1. Add the 'acpid' and 'suspend'(the suspend package is not needed on RHEL) package to the .pkglist of your osimage so that the required package could be installed correctly to your target system. - + 2. Add two configuration files for the base function: - - + + .. code-block:: perl - + /etc/pm/config.d/suspend S2RAM_OPTS="--force --vbe_save --vbe_post --vbe_mode" - + /etc/acpi/events/suspend_event event=button/sleep.* action=/usr/sbin/pm-suspend - - + + 3. Add the hook files for your specific applications which need specific action before or after the suspend action. - + Refer to the 'pm-utils' package for how to create the specific hook files. + - -\ **wake**\ - +\ **wake**\ + Wake up the target nodes which is in \ **suspend**\ state. - + Don't try to run \ **wake**\ against the 'on' state node, it would cause the node gets to 'off' state. - + For some of xCAT hardware such as NeXtScale, it may need to enable S3 before using \ **wake**\ . The following steps can be used to enable S3. Reference pasu(1)|pasu.1 for "pasu" usage. - - + + .. code-block:: perl - + [root@xcatmn home]# echo "set Power.S3Enable Enable" > power-setting [root@xcatmn home]# pasu -b power-setting node01 node01: Batch mode start. @@ -248,7 +248,7 @@ OPTIONS node01: Command completed successfully. node01: Completed intermediate batch update. node01: Batch mode completed successfully. - + [root@xcatmn home]# pasu node01 show all|grep -i s3 node01: IMM.Community_HostIPAddress3.1= node01: IMM.Community_HostIPAddress3.2= @@ -256,158 +256,158 @@ OPTIONS node01: IMM.DNS_IP_Address3=0.0.0.0 node01: IMM.IPv6DNS_IP_Address3=:: node01: Power.S3Enable=Enable + + - - -\ **stat | state**\ - +\ **stat | state**\ + Print the current power state/status. + - -\ **reset**\ - +\ **reset**\ + Send a hard reset. + - -\ **boot**\ - +\ **boot**\ + If off, then power on. If on, then hard reset. This option is recommended over \ **cycle**\ . + - -\ **cycle**\ - +\ **cycle**\ + Power off, then on. + - -\ **reseat**\ - +\ **reseat**\ + For Lenovo high-density servers, simulates unplugging and replugging the node into the chassis. + - -\ **of**\ - +\ **of**\ + Boot the node to open firmware console mode. + - -\ **sms**\ - +\ **sms**\ + Boot the node to open firmware SMS menu mode. + - -\ **-m**\ \ *table.column*\ ==\ *expectedstatus*\ \ **-m**\ \ *table.column*\ =~\ *expectedstatus*\ - +\ **-m**\ \ *table.column*\ ==\ *expectedstatus*\ \ **-m**\ \ *table.column*\ =~\ *expectedstatus*\ + Use one or multiple \ **-m**\ flags to specify the node attributes and the expected status for the node installation monitoring and automatic retry mechanism. The operators ==, !=, =~ and !~ are valid. This flag must be used with -t flag. - + Note: if the "val" fields includes spaces or any other characters that will be parsed by shell, the "attrval" needs to be quoted. If the operator is "!~", the "attrval" needs to be quoted using single quote. + - -\ **-**\ **-nodeps**\ - +\ **-**\ **-nodeps**\ + Do not use dependency table (default is to use dependency table). Valid only with \ **on|off|boot|reset|cycle**\ for blade power method and \ **on|off|reset|softoff**\ for hmc/fsp power method. + - -\ **-r**\ \ *retrycount*\ - +\ **-r**\ \ *retrycount*\ + specify the number of retries that the monitoring process will perform before declaring the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag. + - -\ **-t**\ \ *timeout*\ - +\ **-t**\ \ *timeout*\ + Specify the timeout, in minutes, to wait for the expectedstatus specified by -m flag. This is a required flag if the -m flag is specified. - + Power off, then on. + - -\ **-w**\ \ *timeout*\ - +\ **-w**\ \ *timeout*\ + To set the \ *timeout*\ for the \ **suspend**\ action to wait for the success. + - -\ **-o**\ - +\ **-o**\ + To specify that the target node will be power down if \ **suspend**\ action failed. + - -\ **-r**\ - +\ **-r**\ + To specify that the target node will be reset if \ **suspend**\ action failed. + - -\ **start**\ - +\ **start**\ + To start a created docker instance. + - -\ **stop**\ - +\ **stop**\ + To stop a created docker instance. + - -\ **restart**\ - +\ **restart**\ + To restart a created docker instance. + - -\ **pause**\ - +\ **pause**\ + To pause all processes in the instance. + - -\ **unpause**\ - +\ **unpause**\ + To unpause all processes in the instance. + - -\ **bmcreboot**\ - +\ **bmcreboot**\ + To reboot BMC. + - -\ **bmcstate**\ - +\ **bmcstate**\ + To get state of the BMC. + - -\ **state**\ - +\ **state**\ + To get state of the instance. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Prints out a brief usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display the version number. - + @@ -418,40 +418,40 @@ EXAMPLES 1. To display power status of nodes4 and note5 - - + + .. code-block:: perl - + rpower node4,node5 stat - - + + Output is similar to: - - + + .. code-block:: perl - + node4: on node5: off - - + + 2. To power on node5 - - + + .. code-block:: perl - + rpower node5 on - - + + Output is similar to: - - + + .. code-block:: perl - + node5: on - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rscan.1.rst b/docs/source/guides/admin-guides/references/man1/rscan.1.rst index fa143d57a..9d6ff5082 100644 --- a/docs/source/guides/admin-guides/references/man1/rscan.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rscan.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **rscan [-h|-**\ **-help]**\ +\ **rscan [-h|-**\ **-help]**\ -\ **rscan [-v|-**\ **-version]**\ +\ **rscan [-v|-**\ **-version]**\ -\ **rscan [-V|-**\ **-verbose]**\ \ *noderange*\ \ **[-u][-w][-x|-z]**\ +\ **rscan [-V|-**\ **-verbose]**\ \ *noderange*\ \ **[-u][-w][-x|-z]**\ *********** @@ -101,7 +101,7 @@ Output is similar to: .. code-block:: perl type name id type-model serial-number address - + hmc hmc01 7310-C05 10F426A hmc01 fsp Server-9117-MMA-SN10F6F3D 9117-MMA 10F6F3D 3.3.3.197 lpar lpar3 4 9117-MMA 10F6F3D @@ -136,7 +136,7 @@ Output is similar to: fsp,all 10 - + ivm lpar01 @@ -150,7 +150,7 @@ Output is similar to: lpar,all 1 - + ivm lpar02 @@ -191,7 +191,7 @@ Output is similar to: groups=bpa,all mgt=hmc cons= - + Server-9119-590-SN02C5F9E: objtype=node type=fsp @@ -204,7 +204,7 @@ Output is similar to: groups=fsp,all mgt=hmc cons= - + lpar01: objtype=node nodetype=lpar,osi @@ -217,7 +217,7 @@ Output is similar to: groups=lpar,all mgt=hmc cons=hmc - + lpar02: objtype=node nodetype=lpar,osi diff --git a/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst b/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst index a38804cb1..f25aa0bed 100644 --- a/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst @@ -30,46 +30,46 @@ OPTIONS -\ **hd**\ - +\ **hd**\ + Boot from the hard disk. + - -\ **net**\ - +\ **net**\ + Boot over the network, using a PXE or BOOTP broadcast. + - -\ **cd**\ - +\ **cd**\ + Boot from the CD or DVD drive. + - -\ **def | default**\ - +\ **def | default**\ + Boot using the default set in BIOS. + - -\ **stat**\ - +\ **stat**\ + Display the current boot setting. + - -\ **-u**\ - +\ **-u**\ + To specify the next boot mode to be "UEFI Mode". (Not supported for OpenBMC) + - -\ **-p**\ - +\ **-p**\ + To make the specified boot device and boot mode settings persistent. - + @@ -80,47 +80,47 @@ EXAMPLES 1. - + Set nodes 1 and 3 to boot from the network on the next boot: - - + + .. code-block:: perl - + rsetboot node1,node3 net - - + + 2. - + Display the next-boot value for nodes 14-56 and 70-203: - - + + .. code-block:: perl - + rsetboot node[14-56],node[70-203] stat - - + + Or: - - + + .. code-block:: perl - + rsetboot node[14-56],node[70-203] - - + + 3. - + Restore the next-boot value for these nodes back to their default set in the BIOS: - - + + .. code-block:: perl - + rsetboot node1,node3,node[14-56],node[70-203] default - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst index 957b8848d..7655d078b 100644 --- a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst @@ -29,7 +29,7 @@ BMC/MPA specific: \ **rspconfig**\ \ *noderange*\ \ **alert**\ ={\ **on | enable | off | disable**\ } -\ **rspconfig**\ \ *noderange*\ \ **snmpdest**\ =\ *snmpmanager-IP*\ +\ **rspconfig**\ \ *noderange*\ \ **snmpdest**\ =\ *snmpmanager-IP*\ \ **rspconfig**\ \ *noderange*\ \ **community**\ ={\ **public**\ | \ *string*\ } @@ -40,7 +40,7 @@ BMC specific: \ **rspconfig**\ \ *noderange*\ {\ **ip | netmask | gateway | backupgateway | garp | vlan**\ } -\ **rspconfig**\ \ *noderange*\ \ **garp**\ =\ *time*\ +\ **rspconfig**\ \ *noderange*\ \ **garp**\ =\ *time*\ OpenBMC specific: @@ -51,41 +51,41 @@ OpenBMC specific: \ **rspconfig**\ \ *noderange*\ \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \ **autoreboot**\ +\ **rspconfig**\ \ *noderange*\ \ **autoreboot**\ -\ **rspconfig**\ \ *noderange*\ \ **autoreboot={0|1}**\ +\ **rspconfig**\ \ *noderange*\ \ **autoreboot={0|1}**\ -\ **rspconfig**\ \ *noderange*\ \ **bootmode**\ +\ **rspconfig**\ \ *noderange*\ \ **bootmode**\ -\ **rspconfig**\ \ *noderange*\ \ **bootmode={safe|regular|setup}**\ +\ **rspconfig**\ \ *noderange*\ \ **bootmode={safe|regular|setup}**\ \ **rspconfig**\ \ *noderange*\ \ **dump**\ [\ **-l | -**\ **-list**\ ] [\ **-g | -**\ **-generate**\ ] [\ **-c | -**\ **-clear**\ {\ *id*\ | \ **all**\ }] [\ **-d | -**\ **-download**\ {\ *id*\ | \ **all**\ }] -\ **rspconfig**\ \ *noderange*\ \ **gard -c|-**\ **-clear**\ +\ **rspconfig**\ \ *noderange*\ \ **gard -c|-**\ **-clear**\ -\ **rspconfig**\ \ *noderange*\ \ **ip=dhcp**\ +\ **rspconfig**\ \ *noderange*\ \ **ip=dhcp**\ -\ **rspconfig**\ \ *noderange*\ \ **hostname**\ +\ **rspconfig**\ \ *noderange*\ \ **hostname**\ \ **rspconfig**\ \ *noderange*\ \ **hostname**\ ={\* | \ *name*\ } -\ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ +\ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ \ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ ={\ *ntpservers*\ } -\ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy**\ +\ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy**\ -\ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy={always_on|restore|always_off}**\ +\ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy={always_on|restore|always_off}**\ -\ **rspconfig**\ \ *noderange*\ \ **powersupplyredundancy**\ +\ **rspconfig**\ \ *noderange*\ \ **powersupplyredundancy**\ -\ **rspconfig**\ \ *noderange*\ \ **powersupplyredundancy={disabled|enabled}**\ +\ **rspconfig**\ \ *noderange*\ \ **powersupplyredundancy={disabled|enabled}**\ -\ **rspconfig**\ \ *noderange*\ \ **sshcfg**\ +\ **rspconfig**\ \ *noderange*\ \ **sshcfg**\ -\ **rspconfig**\ \ *noderange*\ \ **timesyncmethod**\ +\ **rspconfig**\ \ *noderange*\ \ **timesyncmethod**\ -\ **rspconfig**\ \ *noderange*\ \ **timesyncmethod={manual|ntp}**\ +\ **rspconfig**\ \ *noderange*\ \ **timesyncmethod={manual|ntp}**\ MPA specific: @@ -131,9 +131,9 @@ FSP/CEC specific: \ **rspconfig**\ \ *noderange*\ \ **iocap**\ ={\ **enable | disable**\ } -\ **rspconfig**\ \ *noderange*\ \ **time**\ =\ *hh:mm:ss*\ +\ **rspconfig**\ \ *noderange*\ \ **time**\ =\ *hh:mm:ss*\ -\ **rspconfig**\ \ *noderange*\ \ **date**\ =\ *mm:dd:yyyy*\ +\ **rspconfig**\ \ *noderange*\ \ **date**\ =\ *mm:dd:yyyy*\ \ **rspconfig**\ \ *noderange*\ \ **decfg**\ ={\ **enable|disable**\ :\ *policyname,...*\ } @@ -159,7 +159,7 @@ FSP/CEC specific: \ **rspconfig**\ \ *noderange*\ \ **hostname**\ ={\* | \ *name*\ } -\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ +\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ Flex system Specific: @@ -203,7 +203,7 @@ BPA/Frame Specific: \ **rspconfig**\ \ *noderange*\ \ **hostname**\ ={\* | \ *name*\ } -\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ +\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ FSP/CEC (using Direct FSP Management) Specific: @@ -242,7 +242,7 @@ FSP/CEC (using Direct FSP Management) Specific: \ **rspconfig**\ \ *noderange*\ {\ **force_failover**\ } -\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ +\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ BPA/Frame (using Direct FSP Management) Specific: @@ -269,7 +269,7 @@ BPA/Frame (using Direct FSP Management) Specific: \ **rspconfig**\ \ *noderange*\ \ **pending_power_on_side**\ ={\ **temp | perm**\ } -\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ +\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ HMC Specific: @@ -280,7 +280,7 @@ HMC Specific: \ **rspconfig**\ \ *noderange*\ \ **sshcfg**\ ={\ **enable | disable**\ } -\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ +\ **rspconfig**\ \ *noderange*\ \ **-**\ **-resetnet**\ @@ -300,418 +300,418 @@ OPTIONS -\ **alert={on | enable | off | disable}**\ - +\ **alert={on | enable | off | disable}**\ + Turn on or off SNMP alerts. - + \ **autopower**\ ={\ *enable*\ | \ *disable*\ } - + Select the policy for auto power restart. If enabled, the system will boot automatically once power is restored after a power disturbance. + - -\ **backupgateway**\ - +\ **backupgateway**\ + Get the BMC backup gateway ip address. - + \ **community**\ ={\ **public**\ | \ *string*\ } - + Get or set the SNMP commmunity value. The default is \ **public**\ . + - -\ **date**\ =\ *mm:dd:yyy*\ - +\ **date**\ =\ *mm:dd:yyy*\ + Enter the current date. - + \ **decfg**\ ={\ **enable | disable**\ :\ *policyname,...*\ } - + Enables or disables deconfiguration policies. - + \ **frame**\ ={\ *framenumber*\ | \*} - + Set or get frame number. If no framenumber and \* specified, framenumber for the nodes will be displayed and updated in xCAAT database. If framenumber is specified, it only supports single node and the framenumber will be set for that frame. If \* is specified, it supports noderange and all the frame numbers for the noderange will be read from xCAT database and set to frames. Setting the frame number is a disruptive command which requires all CECs to be powered off prior to issuing the command. - + \ **cec_off_policy**\ ={\ **poweroff | stayon**\ } - + Set or get cec off policy after lpars are powered off. If no cec_off_policy value specified, the cec_off_policy for the nodes will be displayed. the cec_off_policy has two values: \ **poweroff**\ and \ **stayon**\ . \ **poweroff**\ means Power off when last partition powers off. \ **stayon**\ means Stay running after last partition powers off. If cec_off_policy value is specified, the cec off policy will be set for that cec. - + \ **HMC_passwd**\ ={\ *currentpasswd,newpasswd*\ } - + Change the password of the userid \ **HMC**\ for CEC/Frame. If the CEC/Frame is the factory default, the currentpasswd should NOT be specified; otherwise, the currentpasswd should be specified to the current password of the userid \ **HMC**\ for the CEC/Frame. - + \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } - + Change the password of the userid \ **admin**\ for CEC/Frame from currentpasswd to newpasswd. If the CEC/Frame is the factory default, the currentpasswd should NOT be specified; otherwise, the currentpasswd should be specified to the current password of the userid \ **admin**\ for the CEC/Frame. - + \ **general_passwd**\ ={\ *currentpasswd,newpasswd*\ } - + Change the password of the userid \ **general**\ for CEC/Frame from currentpasswd to newpasswd. If the CEC/Frame is the factory default, the currentpasswd should NOT be specified; otherwise, the currentpasswd should be specified to the current password of the userid \ **general**\ for the CEC/Frame. - + \*\ **_passwd**\ ={\ *currentpasswd,newpasswd*\ } - + Change the passwords of the userids \ **HMC**\ , \ **admin**\ and \ **general**\ for CEC/Frame from currentpasswd to newpasswd. If the CEC/Frame is the factory default, the currentpasswd should NOT be specified; otherwise, if the current passwords of the userids \ **HMC**\ , \ **admin**\ and \ **general**\ for CEC/Frame are the same one, the currentpasswd should be specified to the current password, and then the password will be changed to the newpasswd. If the CEC/Frame is NOT the factory default, and the current passwords of the userids \ **HMC**\ , \ **admin**\ and \ **general**\ for CEC/Frame are NOT the same one, this option could NOT be used, and we should change the password one by one. + - -\ **frequency**\ - +\ **frequency**\ + The NTP update frequency (in minutes). + - -\ **gard -c|-**\ **-clear**\ - +\ **gard -c|-**\ **-clear**\ + Clear gard file. [OpenBMC] + - -\ **garp**\ =\ *time*\ - +\ **garp**\ =\ *time*\ + Get or set Gratuitous ARP generation interval. The unit is number of 1/2 second. + - -\ **gateway**\ - +\ **gateway**\ + The gateway ip address. + - -\ **hostname**\ - +\ **hostname**\ + Display the CEC/BPA system names. + - -\ **BSR**\ - +\ **BSR**\ + Get Barrier Synchronization Register (BSR) allocation for a CEC. + - -\ **huge_page**\ - +\ **huge_page**\ + Query huge page information or request NUM of huge pages for CEC. If no value specified, it means query huge page information for the specified CECs, if a CEC is specified, the specified huge_page value NUM will be used as the requested number of huge pages for the CEC, if CECs are specified, it means to request the same NUM huge pages for all the specified CECs. - + \ **setup_failover**\ ={\ **enable**\ | \ **disable**\ } - + Enable or disable the service processor failover function of a CEC or display status of this function. + - -\ **force_failover**\ - +\ **force_failover**\ + Force a service processor failover from the primary service processor to the secondary service processor. - + \ **hostname**\ ={\* | \ *name*\ } - + Set CEC/BPA system names to the names in xCAT DB or the input name. - + \ **iocap**\ ={\ **enable**\ | \ **disable**\ } - + Select the policy for I/O Adapter Enlarged Capacity. This option controls the size of PCI memory space allocated to each PCI slot. + - -\ **hostname**\ - +\ **hostname**\ + Get or set hostname on the service processor. + - -\ **vlan**\ - +\ **vlan**\ + Get or set vlan ID. For get vlan ID, if vlan is not enabled, 'BMC VLAN disabled' will be outputed. For set vlan ID, the valid value are [1-4096]. + - -\ **ipsrc**\ - +\ **ipsrc**\ + Get the IP source for OpenBMC. + - -\ **ip**\ - +\ **ip**\ + The IP address. - + \ **memdecfg**\ ={\ **configure | deconfigure**\ :\ *processingunit*\ :\ *unit|bank*\ :\ *id,...*\ } - + Select whether each memory bank should be enabled or disabled. State changes take effect on the next platform boot. + - -\ **netmask**\ - +\ **netmask**\ + The subnet mask. + - -\ **powerrestorepolicy**\ - +\ **powerrestorepolicy**\ + Display or control BMC Power Restore Policy attribute setting. [OpenBMC] + - -\ **powersupplyredundancy**\ - +\ **powersupplyredundancy**\ + Display or control BMC Power Supply Redundancy attribute setting. [OpenBMC] + - -\ **autoreboot**\ - +\ **autoreboot**\ + Display or control BMC Auto Reboot attribute setting. [OpenBMC] + - -\ **bootmode**\ - +\ **bootmode**\ + Display or control BMC Boot Mode attribute setting. [OpenBMC] + - -\ **dump**\ - +\ **dump**\ + Generate/Manage BMC system dumps. If no sub-option is provided, will generate, wait, and download the dump. [OpenBMC] - - + + \ **-c**\ will clear a single specified dump, or use 'all' to clear all dumps on the BMC. - - - + + + \ **-l**\ will list all the generated dumps on the BMC. - - - + + + \ **-g**\ will generate a new dump on the BMC. Dump generation can take a few minutes. - - - + + + \ **-d**\ will download a single dump or all generated dumps from the BMC to /var/log/xcat/dump on management or service node. + + + - - - -\ **timesyncmethod**\ - +\ **timesyncmethod**\ + Set the method for time synchronization on the BMC. [OpenBMC] - + \ **network**\ ={[\ *ip*\ ],[\ *host*\ ],[\ *gateway*\ ],[\ *netmask*\ ]|\*} - + For MPA: get or set the MPA network parameters. If '\*' is specified, all parameters are read from the xCAT database. - + For FSP of Flex system P node: set the network parameters. If '\*' is specified, all parameters are read from the xCAT database. - + \ **initnetwork**\ ={[\ *ip*\ ],[\ *host*\ ],[\ *gateway*\ ],[\ *netmask*\ ]|\*} - + For MPA only. Connecting to the IP of MPA from the hosts.otherinterfaces to set the MPA network parameters. If '\*' is specified, all parameters are read from the xCAT database. - + \ **network**\ ={\ *nic*\ ,{[\ *ip*\ ],[\ *host*\ ],[\ *gateway*\ ],[\ *netmask*\ ]}|\*} - + Not only for FSP/BPA but also for IMM. Get or set the FSP/BPA/IMM network parameters. If '\*' is specified, all parameters are read from the xCAT database. If the value of \ *ip*\ is '0.0.0.0', this \ *nic*\ will be configured as a DHCP client. Otherwise this \ *nic*\ will be configured with a static IP. - + Note that IPs of FSP/BPAs will be updated with this option, user needs to put the new IPs to /etc/hosts manually or with xCAT command makehosts. For more details, see the man page of makehosts. + - -\ **nonred**\ - +\ **nonred**\ + Allows loss of redundancy. - + \ **ntp**\ ={[\ *ntpenable*\ ],[\ *ntpserver*\ ],[\ *frequency*\ ],[\ *v3*\ ]} - + Get or set the MPA Network Time Protocol (NTP) parameters. + - -\ **ntpenable**\ - +\ **ntpenable**\ + Enable or disable NTP (enable|disable). + - -\ **ntpserver**\ - +\ **ntpserver**\ + Get or set NTP server IP address or name. + - -\ **ntpservers**\ - +\ **ntpservers**\ + Get or set NTP servers name. [OpenBMC] - + \ **pd1**\ ={\ **nonred | redwoperf | redwperf**\ } - + Power Domain 1 - determines how an MPA responds to a loss of redundant power. - + \ **pd2**\ ={\ **nonred | redwoperf | redwperf**\ } - + Power Domain 2 - determines how an MPA responds to a loss of redundant power. - + \ **procdecfg**\ ={\ **configure|deconfigure**\ :\ *processingunit*\ :\ *id,...*\ } - + Selects whether each processor should be enabled or disabled. State changes take effect on the next platform boot. + - -\ **redwoperf**\ - +\ **redwoperf**\ + Prevents components from turning on that will cause loss of power redundancy. + - -\ **redwperf**\ - +\ **redwperf**\ + Power throttles components to maintain power redundancy and prevents components from turning on that will cause loss of power redundancy. - + \ **snmpcfg**\ ={\ **enable | disable**\ } - + Enable or disable SNMP on MPA. + - -\ **snmpdest**\ =\ *snmpmanager-IP*\ - +\ **snmpdest**\ =\ *snmpmanager-IP*\ + Get or set where the SNMP alerts should be sent to. - + \ **solcfg**\ ={\ **enable | disable**\ } - + Enable or disable the sol on MPA (or CMM) and blade servers belongs to it. + - -\ **spdump**\ - +\ **spdump**\ + Performs a service processor dump. - + \ **sshcfg**\ ={\ **enable | disable**\ } - + Enable or disable SSH on MPA. + - -\ **sshcfg**\ - +\ **sshcfg**\ + Copy SSH keys. - + \ **swnet**\ ={[\ *ip*\ ],[\ *gateway*\ ],[\ *netmask*\ ]} - + Set the Switch network parameters. + - -\ **sysdump**\ - +\ **sysdump**\ + Performs a system dump. + - -\ **sysname**\ - +\ **sysname**\ + Query or set sysname for CEC or Frame. If no value specified, means to query sysname of the specified nodes. If '\*' specified, it means to set sysname for the specified nodes, and the sysname values would get from xCAT datebase. If a string is specified, it means to use the string as sysname value to set for the specified node. - + \ **pending_power_on_side**\ ={\ **temp|perm**\ } - + List or set pending power on side for CEC or Frame. If no pending_power_on_side value specified, the pending power on side for the CECs or frames will be displayed. If specified, the pending_power_on_side value will be set to CEC's FSPs or Frame's BPAs. The value 'temp' means T-side or temporary side. The value 'perm' means P-side or permanent side. + - -\ **time**\ =\ *hh:mm:ss*\ - +\ **time**\ =\ *hh:mm:ss*\ + Enter the current time in UTC (Coordinated Universal Time) format. - + \ **textid**\ ={\ *\\*|textid*\ } - + Set the blade or MPA textid. When using '\*', the textid used is the node name specified on the command-line. Note that when specifying an actual textid, only a single node can be specified in the noderange. - + \ **USERID**\ ={\ *newpasswd*\ } \ **updateBMC**\ ={\ **y|n**\ } - + Change the password of the userid \ **USERID**\ for CMM in Flex system cluster. The option \ *updateBMC*\ can be used to specify whether updating the password of BMCs that connected to the specified CMM. The value is 'y' by default which means whenever updating the password of CMM, the password of BMCs will be also updated. Note that there will be several seconds needed before this command complete. - + If value "\*" is specified for USERID and the object node is \ *Flex System X node*\ , the password used to access the BMC of the System X node through IPMI will be updated as the same password of the userid \ **USERID**\ of the CMM in the same cluster. + - -\ **-**\ **-resetnet**\ - +\ **-**\ **-resetnet**\ + Reset the network interfaces of the specified nodes. + - -\ **v3**\ - +\ **v3**\ + Enable or disable v3 authentication (enable|disable). + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Prints out a brief usage message. + - -\ **-v**\ | \ **-**\ **-version**\ - +\ **-v**\ | \ **-**\ **-version**\ + Display the version number. - + @@ -722,181 +722,181 @@ EXAMPLES 1. To setup new ssh keys on the Management Module mm: - - + + .. code-block:: perl - + rspconfig mm snmpcfg=enable sshcfg=enable - - + + 2. To turn on SNMP alerts for node5: - - + + .. code-block:: perl - + rspconfig node5 alert=on - - + + Output is similar to: - - + + .. code-block:: perl - + node5: Alerts: enabled - - + + 3. To display the destination setting for SNMP alerts for node4: - - + + .. code-block:: perl - + rspconfig node4 snmpdest - - + + Output is similar to: - - + + .. code-block:: perl - + node4: BMC SNMP Destination 1: 9.114.47.227 - - + + 4. - + To display the frame number for frame 9A00-10000001 - - + + .. code-block:: perl - + rspconfig> 9A00-10000001 frame - - + + Output is similar to: - - + + .. code-block:: perl - + 9A00-10000001: 1 - - + + 5. To set the frame number for frame 9A00-10000001 - - + + .. code-block:: perl - + rspconfig 9A00-10000001 frame=2 - - + + Output is similar to: - - + + .. code-block:: perl - + 9A00-10000001: SUCCESS - - + + 6. To set the frame numbers for frame 9A00-10000001 and 9A00-10000002 - - + + .. code-block:: perl - + rspconfig 9A00-10000001,9A00-10000002 frame=* - - + + Output is similar to: - - + + .. code-block:: perl - + 9A00-10000001: SUCCESS 9A00-10000002: SUCCESS - - + + 7. To display the MPA network parameters for mm01: - - + + .. code-block:: perl - + rspconfig mm01 network - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: MM IP: 192.168.1.47 mm01: MM Hostname: MM001125C31F28 mm01: Gateway: 192.168.1.254 mm01: Subnet Mask: 255.255.255.224 - - + + 8. To change the MPA network parameters with the values in the xCAT database for mm01: - - + + .. code-block:: perl - + rspconfig mm01 network=* - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: MM IP: 192.168.1.47 mm01: MM Hostname: mm01 mm01: Gateway: 192.168.1.254 mm01: Subnet Mask: 255.255.255.224 - - + + 9. To change only the gateway parameter for the MPA network mm01: - - + + .. code-block:: perl - + rspconfig mm01 network=,,192.168.1.1, - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: Gateway: 192.168.1.1 - - + + 10. To display the FSP network parameters for fsp01: - - + + .. code-block:: perl - + rspconfig> fsp01 network - - + + Output is similar to: - - + + .. code-block:: perl - + fsp01: eth0: IP Type: Dynamic @@ -904,237 +904,237 @@ EXAMPLES Hostname: Gateway: Netmask: 255.255.255.0 - + eth1: IP Type: Dynamic IP Address: 192.168.200.51 Hostname: fsp01 Gateway: Netmask: 255.255.255.0 - - + + 11. To change the FSP network parameters with the values in command line for eth0 on fsp01: - - + + .. code-block:: perl - + rspconfig fsp01 network=eth0,192.168.1.200,fsp01,,255.255.255.0 - - + + Output is similar to: - - + + .. code-block:: perl - + fsp01: Success to set IP address,hostname,netmask - - + + 12. To change the FSP network parameters with the values in the xCAT database for eth0 on fsp01: - - + + .. code-block:: perl - + rspconfig fsp01 network=eth0,* - - + + Output is similar to: - - + + .. code-block:: perl - + fsp01: Success to set IP address,hostname,gateway,netmask - - + + 13. To configure eth0 on fsp01 to get dynamic IP address from DHCP server: - - + + .. code-block:: perl - + rspconfig fsp01 network=eth0,0.0.0.0 - - + + Output is similar to: - - + + .. code-block:: perl - + fsp01: Success to set IP type to dynamic. - - + + 14. To get the current power redundancy mode for power domain 1 on mm01: - - + + .. code-block:: perl - + rspconfig mm01 pd1 - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: Redundant without performance impact - - + + 15. To change the current power redundancy mode for power domain 1 on mm01 to non-redundant: - - + + .. code-block:: perl - + rspconfig mm01 pd1=nonred - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: nonred - - + + 16. To enable NTP with an NTP server address of 192.168.1.1, an update frequency of 90 minutes, and with v3 authentication enabled on mm01: - - + + .. code-block:: perl - + rspconfig mm01 ntp=enable,192.168.1.1,90,enable - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: NTP: disabled mm01: NTP Server: 192.168.1.1 mm01: NTP: 90 (minutes) mm01: NTP: enabled - - + + 17. To disable NTP v3 authentication only on mm01: - - + + .. code-block:: perl - + rspconfig mm01 ntp=,,,disable - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: NTP v3: disabled - - + + 18. To disable Predictive Failure and L2 Failure deconfiguration policies on mm01: - - + + .. code-block:: perl - + rspconfig mm01 decfg=disable:predictive,L3 - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: Success - - + + 19. To deconfigure processors 4 and 5 of Processing Unit 0 on mm01: - - + + .. code-block:: perl - + rspconfig mm01 procedecfg=deconfigure:0:4,5 - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: Success - - + + 20. To check if CEC sysname set correct on mm01: - - + + .. code-block:: perl - + rspconfig mm01 sysname - + mm01: mm01 - + rspconfig mm01 sysname=cec01 - + mm01: Success - + rspconfig mm01 sysname - + mm01: cec01 - - + + 21. To check and change the pending_power_on_side value of cec01's fsps: - - + + .. code-block:: perl - + rspconfig cec01 pending_power_on_side - + cec01: Pending Power On Side Primary: temp cec01: Pending Power On Side Secondary: temp - + rspconfig cec01 pending_power_on_side=perm - + cec01: Success - + rspconfig cec01 pending_power_on_side - + cec01: Pending Power On Side Primary: perm cec01: Pending Power On Side Secondary: perm - - + + 22. To show the BSR allocation for cec01: - - + + .. code-block:: perl - + rspconfig cec01 BSR - - + + Output is similar to: - - + + .. code-block:: perl - + cec01: Barrier Synchronization Register (BSR) cec01: Number of BSR arrays: 256 cec01: Bytes per BSR array : 4096 @@ -1148,23 +1148,23 @@ EXAMPLES cec01: lpar06 : 32 cec01: lpar07 : 32 cec01: lpar08 : 32 - - + + 23. To query the huge page information for CEC1, enter: - - + + .. code-block:: perl - + rspconfig CEC1 huge_page - - + + Output is similar to: - - + + .. code-block:: perl - + CEC1: Huge Page Memory CEC1: Available huge page memory(in pages): 0 CEC1: Configurable huge page memory(in pages): 12 @@ -1180,199 +1180,199 @@ EXAMPLES CEC1: lpar21 : 0 CEC1: lpar25 : 0 CEC1: lpar29 : 0 - - + + 24. To request 10 huge pages for CEC1, enter: - - + + .. code-block:: perl - + rspconfig CEC1 huge_page=10 - - + + Output is similar to: - - + + .. code-block:: perl - + CEC1: Success - - + + 25. To disable service processor failover for cec01, in order to complete this command, the user should power off cec01 first: - - + + .. code-block:: perl - + rspconfig cec01 setup_failover - + cec01: Failover status: Enabled - + rpower cec01 off - + rspconfig cec01 setup_failover=disable - + cec01: Success - + rspconfig cec01 setup_failover - + cec01: Failover status: Disabled - - + + 26. To force service processor failover for cec01: - - + + .. code-block:: perl - + lshwconn cec01 - + cec01: 192.168.1.1: LINE DOWN cec01: 192.168.2.1: sp=primary,ipadd=192.168.2.1,alt_ipadd=unavailable,state=LINE UP cec01: 192.168.1.2: sp=secondary,ipadd=192.168.1.2,alt_ipadd=unavailable,state=LINE UP cec01: 192.168.2.2: LINE DOWN - + rspconfig cec01 force_failover - + cec01: Success. - + lshwconn> cec01 - + cec01: 192.168.1.1: sp=secondary,ipadd=192.168.1.1,alt_ipadd=unavailable,state=LINE UP cec01: 192.168.2.1: LINE DOWN cec01: 192.168.1.2: LINE DOWN cec01: 192.168.2.2: sp=primary,ipadd=192.168.2.2,alt_ipadd=unavailable,state=LINE UP - - + + 27. - + To deconfigure memory bank 9 and 10 of Processing Unit 0 on mm01: - - + + .. code-block:: perl - + rspconfig mm01 memdecfg=deconfigure:bank:0:9,10 - - + + Output is similar to: - - + + .. code-block:: perl - + mm01: Success - - + + 28. - + To reset the network interface of the specified nodes: - - + + .. code-block:: perl - + rspconfig --resetnet - - + + Output is similar to: - - + + .. code-block:: perl - + Start to reset network.. - + Reset network failed nodes: - + Reset network succeed nodes: Server-8233-E8B-SN1000ECP-A,Server-9119-FHA-SN0275995-B,Server-9119-FHA-SN0275995-A, - + Reset network finished. - - + + 29. To update the existing admin password on fsp: - - + + .. code-block:: perl - + rspconfig fsp admin_passwd=admin,abc123 - - + + Output is similar to: - - + + .. code-block:: perl - + fsp: Success - - + + 30. To set the initial password for user HMC on fsp: - - + + .. code-block:: perl - + rspconfig fsp HMC_passwd=,abc123 - - + + Output is similar to: - - + + .. code-block:: perl - + fsp: Success - - + + 31. To list BMC dumps available for download: - - + + .. code-block:: perl - + rspconfig p9euh02 dump -l - - + + Output is similar to: - - + + .. code-block:: perl - + p9euh02: [1] Generated: 09/06/2017 14:31:49, Size: 4528 p9euh02: [2] Generated: 09/06/2017 14:31:55, Size: 4516 p9euh02: [3] Generated: 09/06/2017 14:32:01, Size: 4236 p9euh02: [4] Generated: 09/06/2017 14:32:07, Size: 4248 p9euh02: [5] Generated: 09/06/2017 14:32:11, Size: 4268 - - + + 32. To generate and download BMC dump: - - + + .. code-block:: perl - + rspconfig p9euh02 dump - - + + Output is similar to: - - + + .. code-block:: perl - + Capturing BMC Diagnostic information, this will take some time... p9euh02: Dump requested. Target ID is 6, waiting for BMC to generate... p9euh02: Dump 6 generated. Downloading to /var/log/xcat/dump/20171211-0951_p9euh02_dump_6.tar.xz - - + + diff --git a/docs/source/guides/admin-guides/references/man1/rspreset.1.rst b/docs/source/guides/admin-guides/references/man1/rspreset.1.rst index 6d6fe60c4..a73320790 100644 --- a/docs/source/guides/admin-guides/references/man1/rspreset.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspreset.1.rst @@ -15,17 +15,17 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **rspreset**\ \ *noderange*\ +\ **rspreset**\ \ *noderange*\ \ **rspreset**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -36,45 +36,45 @@ the blade's on board service processor will be reset. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - + Reset the service processor that controls node5: - - + + .. code-block:: perl - + rspreset node5 - - + + **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/rvitals.1.rst b/docs/source/guides/admin-guides/references/man1/rvitals.1.rst index ee6ab3d18..862f224ae 100644 --- a/docs/source/guides/admin-guides/references/man1/rvitals.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rvitals.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -72,7 +72,7 @@ OpenPOWER (OpenBMC) specific: ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -81,126 +81,126 @@ Processor for a single or range of nodes and groups. *************** -\ **Options**\ +\ **Options**\ *************** -\ **cputemp**\ - +\ **cputemp**\ + Retrieves CPU temperatures. + - -\ **disktemp**\ - +\ **disktemp**\ + Retrieves HD back plane temperatures. + - -\ **ambtemp**\ - +\ **ambtemp**\ + Retrieves ambient temperatures. + - -\ **temp**\ - +\ **temp**\ + Retrieves all temperatures. + - -\ **voltage**\ - +\ **voltage**\ + Retrieves power supply and VRM voltage readings. + - -\ **fanspeed**\ - +\ **fanspeed**\ + Retrieves fan speeds. + - -\ **lcds**\ - +\ **lcds**\ + Retrieves LCDs status. + - -\ **rackenv**\ - +\ **rackenv**\ + Retrieves rack environmentals. + - -\ **leds**\ - +\ **leds**\ + Retrieves LEDs status. + - -\ **chassis**\ - +\ **chassis**\ + Retrieves chassis status. + - -\ **altitude**\ - +\ **altitude**\ + Retrieves altitude related attributes. + - -\ **power**\ - +\ **power**\ + Retrieves power status. + - -\ **powertime**\ - +\ **powertime**\ + Retrieves total power uptime. This value only increases, unless the Service Processor flash gets updated. This option is not valid for x86 architecture systems. + - -\ **reboot**\ - +\ **reboot**\ + Retrieves total number of reboots. This value only increases, unless the Service Processor flash gets updated. This option is not valid for x86 architecture systems. + - -\ **state**\ - +\ **state**\ + Retrieves the system state. + - -\ **all**\ - +\ **all**\ + All of the above. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + **************** -\ **Examples**\ +\ **Examples**\ **************** @@ -240,7 +240,7 @@ Output is similar to: **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/snmove.1.rst b/docs/source/guides/admin-guides/references/man1/snmove.1.rst index 53abb0129..f797e30d4 100644 --- a/docs/source/guides/admin-guides/references/man1/snmove.1.rst +++ b/docs/source/guides/admin-guides/references/man1/snmove.1.rst @@ -88,65 +88,65 @@ OPTIONS -\ **-d|-**\ **-dest**\ - +\ **-d|-**\ **-dest**\ + Specifies the hostname of the new destination service node as known by (facing) the management node. + - -\ **-D|-**\ **-destn**\ - +\ **-D|-**\ **-destn**\ + Specifies the hostname of the destination service node as known by (facing) the nodes. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-i|-**\ **-ignorenodes**\ - +\ **-i|-**\ **-ignorenodes**\ + No modifications will be made on the nodes. If not specified, several xCAT postscripts will be run on the nodes to complete the switch to the new service node. + - -\ **-l|-**\ **-liteonly**\ - +\ **-l|-**\ **-liteonly**\ + Use this option to ONLY synchronize any AIX statelite files from the primary server to the backup server for the nodes. It will not do the actual moving of the nodes to the backup servers. + - -\ **-P|-**\ **-postscripts**\ - +\ **-P|-**\ **-postscripts**\ + Specifies a list of extra postscripts to be run on the nodes after the nodes are moved over to the new service node. If \ **all**\ is specified, all the postscripts defined in the postscripts table will be run for the nodes. The specified postscripts must be stored under /install/postscripts directory. + - -\ **-s|-**\ **-source**\ - +\ **-s|-**\ **-source**\ + Specifies the hostname of the current (source) service node sa known by (facing) the management node. + - -\ **-S|-**\ **-sourcen**\ - +\ **-S|-**\ **-sourcen**\ + Specifies the hostname of the current service node adapter as known by (facing) the nodes. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. - + @@ -157,99 +157,99 @@ EXAMPLES 1. - + Move the nodes contained in group "group1" to the service node named "xcatsn02". - - + + .. code-block:: perl - + snmove group1 -d xcatsn02 -D xcatsn02-eth1 - - + + 2. - + Move all the nodes that use service node xcatsn01 to service node xcatsn02. - - + + .. code-block:: perl - + snmove -s xcatsn01 -S xcatsn01-eth1 -d xcatsn02 -D xcatsn02-eth1 - - + + 3. - + Move any nodes that have sn1 as their primary server to the backup service node set in the xCAT node definition. - - + + .. code-block:: perl - + snmove -s sn1 - - + + 4. - + Move all the nodes in the xCAT group named "nodegroup1" to their backup SNs. - - + + .. code-block:: perl - + snmove nodegroup1 - - + + 5. - + Move all the nodes in xCAT group "sngroup1" to the service node named "xcatsn2". - - + + .. code-block:: perl - + snmove sngroup1 -d xcatsn2 - - + + 6. - + Move all the nodes in xCAT group "sngroup1" to the SN named "xcatsn2" and run extra postscripts. - - + + .. code-block:: perl - + snmove sngroup1 -d xcatsn2 -P test1 - - + + 7. - + Move all the nodes in xCAT group "sngroup1" to the SN named "xcatsn2" and do not run anything on the nodes. - - + + .. code-block:: perl - + snmove sngroup1 -d xcatsn2 -i - - + + 8. - + Synchronize any AIX statelite files from the primary server for compute03 to the backup server. This will not actually move the node to it's backup service node. - - + + .. code-block:: perl - + snmove compute03 -l -V - - + + diff --git a/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst b/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst index 62e76a07b..158c5f4cf 100644 --- a/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst +++ b/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst @@ -53,28 +53,28 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-c**\ - +\ **-c**\ + \ *current_node*\ -- the defective non-compute node. + - -\ **-f**\ - +\ **-f**\ + \ *fip_node*\ -- a compute node which will be swapped as the non-compute node. + - -\ **-o**\ - +\ **-o**\ + one way. Only move the \ *current_node*\ definition to the \ *fip_node*\ 's hardware resource, and not move the fip_node definition to the \ *current_node*\ . And then the \ *current_node*\ will use the \ *fip_node*\ 's hardware resource, and the \ *fip_node*\ definition is not changed. if the two nodes are in the same CEC, the I/O adapter from the original \ *current_node*\ will be assigned to the \ *fip_node*\ . - + @@ -95,33 +95,33 @@ EXAMPLES 1. To swap the service node attributes and IO assignments between sn1 and compute2 which are in the same cec, all the attributes in the ppc table and nodepos table of the two node will be swapped, and the I/O adapters from the defective node (the original sn1) will be assigned to the available node (the original compute2). After the swapping, the sn1 will use the compute2's hardware resource and the I/O adapters from the original sn1. - - + + .. code-block:: perl - + swapnodes -c sn1 -f compute2 - - + + 2. To swap the service node attributes and IO assignments between sn1 and compute2 which are NOT in the same cec, all the attributes in the ppc table and nodepos table of the two node will be swapped. After the swapping, the sn1 will use the compute2's hardware resource. - - + + .. code-block:: perl - + swapnodes -c sn1 -f compute2 - - + + 3. Only to move the service node (sn1) definition to the compute node (compute2)'s hardware resource, and not move the compute2 definition to the sn1. After the swapping, the sn1 will use the compute2's hardware resource, and the compute2 definition is not changed. - - + + .. code-block:: perl - + swapnodes -c sn1 -f compute2 -o - - + + diff --git a/docs/source/guides/admin-guides/references/man1/switchblade.1.rst b/docs/source/guides/admin-guides/references/man1/switchblade.1.rst index 6421009aa..3d9ebad71 100644 --- a/docs/source/guides/admin-guides/references/man1/switchblade.1.rst +++ b/docs/source/guides/admin-guides/references/man1/switchblade.1.rst @@ -35,35 +35,35 @@ OPTIONS -\ **list | stat**\ - +\ **list | stat**\ + Display which blade the media tray and KVM are currently assigned to. + - -\ **media | mt**\ - +\ **media | mt**\ + Assign the media tray to the specified blade. + - -\ **kvm | video**\ - +\ **kvm | video**\ + Assign the KVM (video display) to the specified blade. + - -\ **both**\ - +\ **both**\ + Assign both the media tray and the KVM to the specified blade. + - -\ *slot_num*\ - +\ *slot_num*\ + The slot # of the blade that the resources should be assigned to. If not specified, it will use the slot # of the node specified. - + @@ -74,23 +74,23 @@ EXAMPLES 1. - + Switch the media tray to be assigned to the blade in slot 4 (assume it is node4): - - + + .. code-block:: perl - + switchblade node4 media - - + + Output will be like: - - + + .. code-block:: perl - + Media Tray slot: 4 - - + + diff --git a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst index 2d67ecfae..2472d8d51 100644 --- a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst @@ -11,9 +11,9 @@ SYNOPSIS ******** -\ **switchdiscover [-h| -**\ **-help]**\ +\ **switchdiscover [-h| -**\ **-help]**\ -\ **switchdiscover [-v| -**\ **-version]**\ +\ **switchdiscover [-v| -**\ **-version]**\ \ **switchdiscover**\ [\ *noderange*\ | \ **-**\ **-range**\ \ *ip_ranges*\ ] \ **[-V] [-w][-r|-x|-z][-s**\ \ *scan_methods*\ ] [\ **-**\ **-setup**\ ] [\ **-c**\ \ *community*\ ] @@ -40,8 +40,8 @@ OPTIONS -\ *noderange*\ - +\ *noderange*\ + The switches which the user want to discover. If the user specify the noderange, switchdiscover will just return the switches in the node range. Which means it will @@ -50,78 +50,78 @@ OPTIONS specified in noderange should be defined in database in advance. The ips of the switches will be defined in /etc/hosts file. This command will fill the switch attributes for the switches defined. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-**\ **-range**\ - +\ **-**\ **-range**\ + Specify one or more IP ranges. Each can be an ip address (10.1.2.3) or an ip range (10.1.2.0/24). If the range is huge, for example, 192.168.1.1/8, the switch discover may take a very long time to scan. So the range should be exactly specified. - + For nmap and snmp scan method, it accepts multiple formats. For example: 192.168.1.1/24, 40-41.1-2.3-4.1-100. - + If the range is not specified, the command scans all the subnets that the active network interfaces (eth0, eth1) are on where this command is issued. + - -\ **-r**\ - +\ **-r**\ + Display Raw responses. + - -\ **-s**\ - +\ **-s**\ + It is a comma separated list of methods for switch discovery. The possible switch scan methods are: lldp, nmap or snmp. The default is nmap. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V**\ - +\ **-V**\ + Verbose output. + - -\ **-w**\ - +\ **-w**\ + Writes output to xCAT database. + - -\ **-x**\ - +\ **-x**\ + XML formatted output. + - -\ **-z**\ - +\ **-z**\ + Stanza formatted output. + - -\ **-**\ **-setup**\ - +\ **-**\ **-setup**\ + Process switch-based switch discovery. Update discovered switch's ip address, hostname and enable snmpv3 configuration based on the predefined switch. + - -\ **-c**\ - +\ **-c**\ + User defined community string for snmp scan. - + @@ -142,45 +142,45 @@ EXAMPLES 1. To discover the switches on some subnets: - - + + .. code-block:: perl - + switchdiscover --range 10.2.3.0/24,192.168.3.0/24,11.5.6.7 - - + + 2. To do the switch discovery and save them to the xCAT database: - - + + .. code-block:: perl - + switchdiscover --range 10.2.3.4/24 -w - - + + It is recommended to run \ **makehosts**\ after the switches are saved in the DB. - + 3. To use lldp method to discover the switches: - - + + .. code-block:: perl - + switchdiscover -s lldp - - + + 4. To process switch-based switch discovery, the core switch has to be configured and top-of-rack (edge) switch has to be predefine into xCAT databse with attribute \ **switch**\ and \ **switchport**\ to core switch: - - + + .. code-block:: perl - + switchdiscover --range 192.168.5.150-170 -s snmp --setup - - + + diff --git a/docs/source/guides/admin-guides/references/man1/tabgrep.1.rst b/docs/source/guides/admin-guides/references/man1/tabgrep.1.rst index 7b4b1b427..7670799be 100644 --- a/docs/source/guides/admin-guides/references/man1/tabgrep.1.rst +++ b/docs/source/guides/admin-guides/references/man1/tabgrep.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **tabgrep**\ \ *nodename*\ +\ **tabgrep**\ \ *nodename*\ \ **tabgrep**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ ] @@ -40,10 +40,10 @@ OPTIONS -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -69,20 +69,20 @@ EXAMPLES 1. - + To display the tables that contain blade1: - - + + .. code-block:: perl - + tabgrep blade1 - - + + The output would be similar to: - - + + .. code-block:: perl - + nodelist nodehm mp @@ -91,8 +91,8 @@ EXAMPLES mac noderes nodetype - - + + diff --git a/docs/source/guides/admin-guides/references/man1/unregnotif.1.rst b/docs/source/guides/admin-guides/references/man1/unregnotif.1.rst index 52e735e61..a61c02d17 100644 --- a/docs/source/guides/admin-guides/references/man1/unregnotif.1.rst +++ b/docs/source/guides/admin-guides/references/man1/unregnotif.1.rst @@ -19,11 +19,11 @@ SYNOPSIS ******** -\ **unregnotif [-h| -**\ **-help]**\ +\ **unregnotif [-h| -**\ **-help]**\ -\ **unregnotif [-v| -**\ **-version]**\ +\ **unregnotif [-v| -**\ **-version]**\ -\ **unregnotif**\ \ *filename*\ +\ **unregnotif**\ \ *filename*\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/updateSNimage.1.rst b/docs/source/guides/admin-guides/references/man1/updateSNimage.1.rst index 560c0b973..cb3d0e024 100644 --- a/docs/source/guides/admin-guides/references/man1/updateSNimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/updateSNimage.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **updateSNimage [-h | -**\ **-help ]**\ +\ **updateSNimage [-h | -**\ **-help ]**\ -\ **updateSNimage [-v | -**\ **-version]**\ +\ **updateSNimage [-v | -**\ **-version]**\ \ **updateSNimage**\ [\ **-n**\ \ *node*\ ] [\ **-p**\ \ *path*\ ] diff --git a/docs/source/guides/admin-guides/references/man1/updatenode.1.rst b/docs/source/guides/admin-guides/references/man1/updatenode.1.rst index cffcf7c41..48ed01138 100644 --- a/docs/source/guides/admin-guides/references/man1/updatenode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/updatenode.1.rst @@ -143,7 +143,7 @@ To install/update the packages, run: updatenode -S -\ **For Linux systems:**\ +\ **For Linux systems:**\ It this is equivalent to running the following command: @@ -165,7 +165,7 @@ To preserve the existing repositories, you can run the following command instead updatenode noderange -P "ospkgs --keeprepo,otherpkgs" -\ **For AIX systems:**\ +\ **For AIX systems:**\ Note: The updatenode command is used to update AIX diskful nodes only. For updating diskless AIX nodes refer to the xCAT for AIX update documentation and use the xCAT mknimimage command. For information on updating software on AIX cluster: @@ -266,7 +266,7 @@ xcatd's of management node and service node. -\ *Set up the SSH keys*\ +\ *Set up the SSH keys*\ A password for the user who is running this command is needed to setup the ssh keys. This user must have the same uid and gid as @@ -280,7 +280,7 @@ The non-root users public ssh keys and root's public ssh keys will be put in the authorized_keys\* files under the non-root users .ssh directory on the node(s ). -\ *Handle the hierarchical scenario*\ +\ *Handle the hierarchical scenario*\ When update security files for the node which is served by a service node, the service node will be updated automatically first, and then the target @@ -310,40 +310,40 @@ PARAMETERS -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited xCAT node names and/or group names. See the xCAT "noderange" man page for details on additional supported formats. + - -\ *script1,script2...*\ - +\ *script1,script2...*\ + A comma-separated list of script names. The scripts must be executable and copied to the /install/postscripts directory. Each script can take zero or more parameters. If parameters are specified, the whole list needs to be quoted by double quotes. For example: - - + + .. code-block:: perl - + "script1 p1 p2,script2" - - + + [\ *attr=val*\ [\ *attr=val...*\ ]] - + Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. The currently supported attributes are: "installp_bundle", "otherpkgs", "installp_flags", "emgr_flags" and "rpm_flags". These attributes are only valid for AIX software maintenance support. - + @@ -353,34 +353,34 @@ OPTIONS -\ **-**\ **-fanout**\ =\ *fanout_value*\ - +\ **-**\ **-fanout**\ =\ *fanout_value*\ + Specifies a fanout value for the maximum number of concurrently executing remote shell processes. Serial execution can be specified by indicating a fanout value of \ **1**\ . If \ **-**\ **-fanout**\ is not specified, a default fanout value of \ **64**\ is used. + - -\ **-A|-**\ **-updateallsw**\ - +\ **-A|-**\ **-updateallsw**\ + Install or update all software contained in the source directory. (AIX only) + - -\ **-c|cmdlineonly**\ - +\ **-c|cmdlineonly**\ + Specifies that the updatenode command should only use software maintenance information provided on the command line. This flag is only valid when using AIX software maintenance support. + - -\ **-d**\ \ *alt_source_dir*\ - +\ **-d**\ \ *alt_source_dir*\ + Used to specify a source directory other than the standard lpp_source directory specified in the xCAT osimage definition. (AIX only) + - -\ **-F|-**\ **-sync**\ - +\ **-F|-**\ **-sync**\ + Specifies that file synchronization should be performed on the nodes. rsync/scp and ssh must be installed and configured on the nodes. @@ -388,11 +388,11 @@ OPTIONS For NFS-based statelite installations to sync files, you should use the read-only option for files/directories listed in litefile table with source location specified in the litetree table. + - -\ **-f|-**\ **-snsync**\ - +\ **-f|-**\ **-snsync**\ + Specifies that file synchronization should be performed to the service nodes that service the nodes in the noderange. This updates the service @@ -409,98 +409,98 @@ OPTIONS For statelite installations to sync files, you should use the read-only option for files/directories listed in litefile table with source location specified in the litetree table. - + [\ **-r | -**\ **-node-rcp**\ [\ *full_path_to_remote_copy_command*\ ]] - + Specifies the full path of the remote copy command used for syncing files to node targets, such as "/usr/bin/rsync" or "/usr/bin/scp". If not specified, rsync will be used by default. - + Notice: The synclist for "-r /usr/bin/scp" has some differences with "-r /usr/bin/rsync": - - 1) the ``EXECUTE`` clause is not supported in "-r /usr/bin/scp" - - 2) if the destination directory specified in synclist is an existing file on target node, "updatenode -r /usr/bin/scp" will fail with ``scp: : Not a directory`` - - 3) if the destination file specified in synclist is an existing directory on target node, "updatenode -r /usr/bin/scp" will fail with ``scp: : Is a directory`` + + 1) the \`\`EXECUTE\`\` clause is not supported in "-r /usr/bin/scp" + + 2) if the destination directory specified in synclist is an existing file on target node, "updatenode -r /usr/bin/scp" will fail with \`\`scp: : Not a directory\`\` + + 3) if the destination file specified in synclist is an existing directory on target node, "updatenode -r /usr/bin/scp" will fail with \`\`scp: : Is a directory\`\` + - -\ **-g|-**\ **-genmypost**\ - +\ **-g|-**\ **-genmypost**\ + Will generate a new mypostscript file for the nodes in the noderange, if site precreatemypostscripts is 1 or YES. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-k|-**\ **-security**\ - +\ **-k|-**\ **-security**\ + Update the ssh keys and host keys for the service nodes and compute nodes; Update the ca and credentials to the service nodes. Never run this command to the Management Node, it will take down xcatd. You must be running updatenode as root to use the -k flag. + - -\ **-l | -**\ **-user**\ \ *user_ID*\ - +\ **-l | -**\ **-user**\ \ *user_ID*\ + Specifies a non-root user name to use for remote command execution. This option is only available when running postscripts (-P) for AIX and Linux and updating software (-S) for Linux only. The non-root userid must be previously defined as an xCAT user. The userid sudo setup will have to be done by the admin on the node. This is not supported in a hierarchical cluster, that is the node is serviced by a service node. See the document Granting_Users_xCAT_privileges for required xcat/sudo setup. + - -\ **-P|-**\ **-scripts**\ - +\ **-P|-**\ **-scripts**\ + Specifies that postscripts and postbootscripts should be run on the nodes. updatenode -P syncfiles is not supported. The syncfiles postscript can only be run during install. You should use updatenode -F instead. + - -\ **-S|-**\ **-sw**\ - +\ **-S|-**\ **-sw**\ + Specifies that node software should be updated. In Sysclone environment, specifies pushing the delta changes to target nodes. + - -\ **-n|-**\ **-noverify**\ - +\ **-n|-**\ **-noverify**\ + Specifies that node network availability verification will be skipped. + - -\ **-s|-**\ **-sn**\ - +\ **-s|-**\ **-sn**\ + Set the server information stored on the nodes in /opt/xcat/xcatinfo on Linux. + - -\ **-t**\ \ *timeout*\ - +\ **-t**\ \ *timeout*\ + Specifies a timeout in seconds the command will wait for the remote targets to complete. If timeout is not specified it will wait indefinitely. updatenode -k is the exception that has a timeout of 10 seconds, unless overridden by this flag. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + @@ -521,82 +521,82 @@ EXAMPLES 1. To perform all updatenode features for the Linux nodes in the group "compute": - - + + .. code-block:: perl - + updatenode compute - - + + The command will: run any scripts listed in the nodes "postscripts and postbootscripts" attribute, install or update any software indicated in the /install/custom/install//profile.otherpkgs.pkglist (refer to the \ **To install or update software part**\ ), synchronize any files indicated by the synclist files specified in the osimage "synclists" attribute. - + 2. To run postscripts,postbootscripts and file synchronization only on the node "clstrn01": - - + + .. code-block:: perl - + updatenode clstrn01 -F -P - - + + 3. Running updatenode -P with the syncfiles postscript is not supported. You should use updatenode -F instead. - + Do not run: - - + + .. code-block:: perl - + updatenode clstrno1 -P syncfiles - - + + Run: - - + + .. code-block:: perl - + updatenode clstrn01 -F - - + + 4. To run the postscripts and postbootscripts indicated in the postscripts and postbootscripts attributes on the node "clstrn01": - - + + .. code-block:: perl - + updatenode clstrn01 -P - - + + 5. To run the postscripts script1 and script2 on the node "clstrn01": - - + + .. code-block:: perl - + cp script1,script2 /install/postscripts - + updatenode clstrn01 -P "script1 p1 p2,script2" - - + + Since flag '-P' can be omitted when only script names are specified, the following command is equivalent: - - + + .. code-block:: perl - + updatenode clstrn01 "script1 p1 p2,script2" - - + + p1 p2 are parameters for script1. - + 6. To synchronize the files on the node "clstrn01": Prepare the synclist file. @@ -604,191 +604,191 @@ For AIX, set the full path of synclist in the osimage table synclists attribute. For Linux, put the synclist file into the location: /install/custom///...synclist Then: - - + + .. code-block:: perl - + updatenode clstrn01 -F - - + + 7. To perform the software update on the Linux node "clstrn01": Copy the extra rpm into the /install/post/otherpkgs///\* and add the rpm names into the /install/custom/install//profile.otherpkgs.pkglist . Then: - - + + .. code-block:: perl - + updatenode clstrn01 -S - - + + 8. To update the AIX node named "xcatn11" using the "installp_bundle" and/or "otherpkgs" attribute values stored in the xCAT database. Use the default installp, rpm and emgr flags. - - + + .. code-block:: perl - + updatenode xcatn11 -V -S - - + + Note: The xCAT "xcatn11" node definition points to an xCAT osimage definition which contains the "installp_bundle" and "otherpkgs" attributes as well as the name of the NIM lpp_source resource. - + 9. To update the AIX node "xcatn11" by installing the "bos.cpr" fileset using the "-agQXY" installp flags. Also display the output of the installp command. - - + + .. code-block:: perl - + updatenode xcatn11 -V -S otherpkgs="I:bos.cpr" installp_flags="-agQXY" - - + + Note: The 'I:' prefix is optional but recommended for installp packages. - + 10. To uninstall the "bos.cpr" fileset that was installed in the previous example. - - + + .. code-block:: perl - + updatenode xcatn11 -V -S otherpkgs="I:bos.cpr" installp_flags="-u" - - + + 11. To update the AIX nodes "xcatn11" and "xcatn12" with the "gpfs.base" fileset and the "rsync" rpm using the installp flags "-agQXY" and the rpm flags "-i --nodeps". - - + + .. code-block:: perl - + updatenode xcatn11,xcatn12 -V -S otherpkgs="I:gpfs.base,R:rsync-2.6.2-1.aix5.1.ppc.rpm" installp_flags="-agQXY" rpm_flags="-i --nodeps" - - + + Note: Using the "-V" flag with multiple nodes may result in a large amount of output. - + 12. To uninstall the rsync rpm that was installed in the previous example. - - + + .. code-block:: perl - + updatenode xcatn11 -V -S otherpkgs="R:rsync-2.6.2-1" rpm_flags="-e" - - + + 13. Update the AIX node "node01" using the software specified in the NIM "sslbnd" and "sshbnd" installp_bundle resources and the "-agQXY" installp flags. - - + + .. code-block:: perl - + updatenode node01 -V -S installp_bundle="sslbnd,sshbnd" installp_flags="-agQXY" - - + + 14. To get a preview of what would happen if you tried to install the "rsct.base" fileset on AIX node "node42". (You must use the "-V" option to get the full output from the installp command.) - - + + .. code-block:: perl - + updatenode node42 -V -S otherpkgs="I:rsct.base" installp_flags="-apXY" - - + + 15. To check what rpm packages are installed on the AIX node "node09". (You must use the "-c" flag so updatenode does not get a list of packages from the database.) - - + + .. code-block:: perl - + updatenode node09 -V -c -S rpm_flags="-qa" - - + + 16. To install all software updates contained in the /images directory. - - + + .. code-block:: perl - + updatenode node27 -V -S -A -d /images - - + + Note: Make sure the directory is exportable and that the permissions are set correctly for all the files. (Including the .toc file in the case of installp filesets.) - + 17. Install the interim fix package located in the /efixes directory. - - + + .. code-block:: perl - + updatenode node29 -V -S -d /efixes otherpkgs=E:IZ38930TL0.120304.epkg.Z - - + + 18. To uninstall the interim fix that was installed in the previous example. - - + + .. code-block:: perl - + updatenode xcatsn11 -V -S -c emgr_flags="-r -L IZ38930TL0" - - + + 19. To update the security keys for the node "node01" - - + + .. code-block:: perl - + updatenode node01 -k - - + + 20. To update the service nodes with the files to be synchronized to node group compute: - - + + .. code-block:: perl - + updatenode compute -f - - + + 21. To run updatenode with the non-root userid "user1" that has been setup as an xCAT userid with sudo on node1 to run as root, do the following: See Granting_Users_xCAT_privileges for required sudo setup. - - + + .. code-block:: perl - + updatenode node1 -l user1 -P syslog - - + + 22. In Sysclone environment, after capturing the delta changes from golden client to management node, to run updatenode to push these delta changes to target nodes. - - + + .. code-block:: perl - + updatenode target-node -S - - + + diff --git a/docs/source/guides/admin-guides/references/man1/wcons.1.rst b/docs/source/guides/admin-guides/references/man1/wcons.1.rst index 2ca612b93..4ff69d007 100644 --- a/docs/source/guides/admin-guides/references/man1/wcons.1.rst +++ b/docs/source/guides/admin-guides/references/man1/wcons.1.rst @@ -15,17 +15,17 @@ wcons - windowed remote console **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **wcons**\ [\ **-t | -**\ **-tile**\ =\ *n*\ ] [\ *xterm-options*\ ] \ *noderange*\ +\ **wcons**\ [\ **-t | -**\ **-tile**\ =\ *n*\ ] [\ *xterm-options*\ ] \ *noderange*\ \ **wcons**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -36,45 +36,45 @@ range or nodes or groups. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-t | -**\ **-tile**\ =\ *n*\ - +\ **-t | -**\ **-tile**\ =\ *n*\ + Tile \ **wcons**\ windows from top left to bottom right. If \ *n*\ is spec- ified then tile \ *n*\ across. If \ *n*\ is not specified then tile to edge of screen. If tiled \ **wcons**\ windows reach bottom right, then the windows start at top left overlaying existing \ **wcons**\ windows. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. + - -\ *xterm options*\ - +\ *xterm options*\ + See xterm(1). Any options other than those listed above are passed directly to xterm. \ **Note:**\ when given multiple nodes, wcons will - override \ **-title**\ and tries to figure out optimal \ **-geometry**\ + override \ **-title**\ and tries to figure out optimal \ **-geometry**\ options for the xterms (however, \ **-geometry**\ can still be specified). - + ************* -\ **Files**\ +\ **Files**\ ************* @@ -84,21 +84,21 @@ method. **************** -\ **Examples**\ +\ **Examples**\ **************** -\ **wcons**\ \ *node1-node5*\ +\ **wcons**\ \ *node1-node5*\ -\ **wcons**\ \ **-**\ **-tile**\ \ **-**\ **-font**\ =\ *nil2*\ \ *all*\ +\ **wcons**\ \ **-**\ **-tile**\ \ **-**\ **-font**\ =\ *nil2*\ \ *all*\ -\ **wcons**\ \ **-t**\ \ *4*\ \ *node1-node16*\ +\ **wcons**\ \ **-t**\ \ *4*\ \ *node1-node16*\ -\ **wcons**\ \ **-f**\ \ *vs*\ \ **-t**\ \ *4*\ \ *node1-node4*\ +\ **wcons**\ \ **-f**\ \ *vs*\ \ **-t**\ \ *4*\ \ *node1-node4*\ ************ -\ **Bugs**\ +\ **Bugs**\ ************ @@ -109,7 +109,7 @@ window manager let me know. ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/wkill.1.rst b/docs/source/guides/admin-guides/references/man1/wkill.1.rst index b40658bcc..8d4cd02c7 100644 --- a/docs/source/guides/admin-guides/references/man1/wkill.1.rst +++ b/docs/source/guides/admin-guides/references/man1/wkill.1.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -25,7 +25,7 @@ Name ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -40,26 +40,26 @@ wcons windows on your $DISPLAY will be killed. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + **************** -\ **Examples**\ +\ **Examples**\ **************** @@ -71,7 +71,7 @@ wcons windows on your $DISPLAY will be killed. ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man1/wvid.1.rst b/docs/source/guides/admin-guides/references/man1/wvid.1.rst index 10447f06d..5a1c178ad 100644 --- a/docs/source/guides/admin-guides/references/man1/wvid.1.rst +++ b/docs/source/guides/admin-guides/references/man1/wvid.1.rst @@ -7,7 +7,7 @@ wvid.1 ************ -\ **Name**\ +\ **Name**\ ************ @@ -15,15 +15,15 @@ wvid - windowed remote video console for nodes **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **wvid**\ \ *noderange*\ +\ **wvid**\ \ *noderange*\ ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -35,7 +35,7 @@ The \ **nodehm.cons**\ attribute of the node determines the method used to open *************** -\ **Options**\ +\ **Options**\ *************** @@ -43,26 +43,26 @@ No options are supported at this time. **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - + To open video consoles for the 1st 2 nodes: - - + + .. code-block:: perl - + wvid node1,node2 - - + + **************** -\ **See Also**\ +\ **See Also**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/xCATWorld.1.rst b/docs/source/guides/admin-guides/references/man1/xCATWorld.1.rst index c29437dc1..f444a86fc 100644 --- a/docs/source/guides/admin-guides/references/man1/xCATWorld.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xCATWorld.1.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **xCATWorld**\ \ *noderange*\ +\ **xCATWorld**\ \ *noderange*\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/xcat2nim.1.rst b/docs/source/guides/admin-guides/references/man1/xcat2nim.1.rst index f855ea2cc..9069b27de 100644 --- a/docs/source/guides/admin-guides/references/man1/xcat2nim.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcat2nim.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **xcat2nim [-h|-**\ **-help]**\ +\ **xcat2nim [-h|-**\ **-help]**\ -\ **xcat2nim [-V|-**\ **-verbose] [-u|-**\ **-update] [-l|-**\ **-list] [-r|-**\ **-remove] [-f|-**\ **-force] [-t object-types] [-o**\ \ *object-names*\ ] \ **[-a|-**\ **-allobjects] [-p|-**\ **-primarySN] [-b|-**\ **-backupSN]**\ \ *[noderange] [attr=val [attr=val...]]*\ +\ **xcat2nim [-V|-**\ **-verbose] [-u|-**\ **-update] [-l|-**\ **-list] [-r|-**\ **-remove] [-f|-**\ **-force] [-t object-types] [-o**\ \ *object-names*\ ] \ **[-a|-**\ **-allobjects] [-p|-**\ **-primarySN] [-b|-**\ **-backupSN]**\ \ *[noderange] [attr=val [attr=val...]]*\ *********** diff --git a/docs/source/guides/admin-guides/references/man1/xcatchroot.1.rst b/docs/source/guides/admin-guides/references/man1/xcatchroot.1.rst index 8d7b03e0e..c6507141f 100644 --- a/docs/source/guides/admin-guides/references/man1/xcatchroot.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcatchroot.1.rst @@ -19,9 +19,9 @@ SYNOPSIS ******** -\ **xcatchroot -h**\ +\ **xcatchroot -h**\ -\ **xcatchroot [-V] -i**\ \ *osimage_name cmd_string*\ +\ **xcatchroot [-V] -i**\ \ *osimage_name cmd_string*\ *********** @@ -33,7 +33,7 @@ For AIX diskless images this command will modify the AIX SPOT resource using the chroot command. You must include the name of an xCAT osimage definition and the command that you wish to have run in the spot. -\ **WARNING:**\ +\ **WARNING:**\ Be very careful when using this command!!! Make sure you are @@ -89,29 +89,29 @@ OPTIONS -\ *cmd_string*\ - +\ *cmd_string*\ + The command you wish to have run in the chroot environment. (Use a quoted string.) + - -\ **-h |-**\ **-help**\ - +\ **-h |-**\ **-help**\ + Display usage message. + - -\ **-i**\ \ *osimage_name*\ - +\ **-i**\ \ *osimage_name*\ + The name of the xCAT osimage definition. + - -\ **-V |-**\ **-verbose**\ - +\ **-V |-**\ **-verbose**\ + Verbose mode. - + diff --git a/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst b/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst index 3c7bf5394..8276fcbb8 100644 --- a/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst @@ -54,22 +54,22 @@ OPTIONS -\ **-?|-h**\ - +\ **-?|-h**\ + Display usage message. - + - + Specifies the command list file with full-path. xCAT supports an example command file: /opt/xcat/share/xcat/tools/autotest/perfcmds.lst - + - + Total number of fake nodes will be defined during the testing. - + @@ -128,33 +128,33 @@ ENVIRONMENT VARIABLE The xcatperftest command supports be customized by some environment variables. -\ **FAKE_NODE_PREFIX**\ +\ **FAKE_NODE_PREFIX**\ Optional, the prefix of the fake compute node name. By default, the value is 'fake' -\ **FAKE_NODE_GROUP**\ +\ **FAKE_NODE_GROUP**\ # Optional, the group name of all the fake compute nodes. By default, the value is 'perftest' -\ **FAKE_NETWORK_PRO**\ +\ **FAKE_NETWORK_PRO**\ Mandatory, the Provision network for all the fake compute nodes. By default, the value is '192.168'. It must be a string like 'A.B', and be matched with \`tabdump networks\` -\ **FAKE_NETWORK_BMC**\ +\ **FAKE_NETWORK_BMC**\ Mandatory, the BMC network for all the fake compute nodes. By default, the value is '192.168'. Note: It could not be the same subnet as 'FAKE_NETWORK_PRO' It must be a string like 'A.B' and no need to be defined in 'networks' table. -\ **PERF_NODETEMPL**\ +\ **PERF_NODETEMPL**\ Optional, The node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch. -\ **PERF_DRYRUN**\ +\ **PERF_DRYRUN**\ Optional, Indicate no real commands will be executed if the environment variable is set. -\ **PERF_NOCREATE**\ +\ **PERF_NOCREATE**\ Optional, Indicate no new fake nodes will be created if the environment variable is set. @@ -166,39 +166,39 @@ EXAMPLES 1. - + To run the performance testing for the commands defined in /tmp/cmd.lst on 5000 fake nodes: - - + + .. code-block:: perl - + xcatperftest 5000 /tmp/cmd.lst - - + + 2. - + To generate an xCAT node object stanz file for 10000 nodes in subnet 10.100.0.0: - - + + .. code-block:: perl - + FAKE_NETWORK_PRO=10.100 FAKE_NETWORK_BMC=10.200 xcatperftest 10000 - - + + 3. - + To run the performance testing for the commands defined in /opt/xcat/share/xcat/tools/autotest/perfcmds.lst on 5000 existing fake nodes: - - + + .. code-block:: perl - + PERF_NOCREATE=y xcatperftest 5000 /opt/xcat/share/xcat/tools/autotest/perfcmds.lst - - + + diff --git a/docs/source/guides/admin-guides/references/man1/xcattest.1.rst b/docs/source/guides/admin-guides/references/man1/xcattest.1.rst index fbc86963b..ba6727629 100644 --- a/docs/source/guides/admin-guides/references/man1/xcattest.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcattest.1.rst @@ -54,46 +54,46 @@ OPTIONS -\ **-?|-h**\ - +\ **-?|-h**\ + Display usage message. + - -\ **-f**\ \ *configure file*\ - +\ **-f**\ \ *configure file*\ + Specifies the configuration file with full-path. xCAT supports an example config file: /opt/xcat/share/xcat/tools/autotest/linux.conf.template + - -\ **-b**\ \ *case bundle list*\ - +\ **-b**\ \ *case bundle list*\ + Comma separated list of test cases bundle files, each test cases bundle can contain multiple lines and each line for one test case name. The bundle files should be listed in: /opt/xcat/share/xcat/tools/autotest/bundle. + - -\ **-t**\ \ *cases list*\ - +\ **-t**\ \ *cases list*\ + Comma separated list of test cases that will be run. + - -\ **-c**\ \ *cmd list*\ - +\ **-c**\ \ *cmd list*\ + Comma separated list of commands which will be tested, i.e., all the test cases under the command sub directory will be run. + - -\ **-l**\ - +\ **-l**\ + Display the test cases names specified by the flag -b, -t or -c. + - -\ **-s**\ - +\ **-s**\ + Display the bundle files and command with value: bundle or command. - + @@ -146,50 +146,50 @@ EXAMPLES 1. - + To run all test cases related command rpower: - - + + .. code-block:: perl - + xcattest -f /tmp/config -c rpower - - + + 2. - + To run customized bundle with /tmp/config file: - - + + .. code-block:: perl - + xcattest -c lsdef -l > /opt/xcat/share/xcat/tools/autotest/bundle/custom.bundle Modify custom.bundle xcattest -f /tmp/config -b custom.bundle - - + + 3. - + To run specified test cases with /tmp/config file: - - + + .. code-block:: perl - + xcattest -f /tmp/config -t lsdef_t_o_l_z - - + + 4. - + To add a new case to test chvm. In the example, we assume that the min_mem should not be equal to 16 in the lpar profile of computenode. The case name is chvm_custom. It create a test lpar named testnode firstly, that change the min_mem of the lpar to 16 using chvm, then check if min_mem have changed correctly. At last, the testnode be remove to ensure no garbage produced in the cases. - - + + .. code-block:: perl - + add a new test case file in /opt/xcat/share/xcat/tools/autotest/chvm edit filename start:chvm_custom @@ -207,8 +207,8 @@ EXAMPLES cmd:rmvm testnode cmd:rm -f /tmp/autotest.profile end - - + + diff --git a/docs/source/guides/admin-guides/references/man1/xcoll.1.rst b/docs/source/guides/admin-guides/references/man1/xcoll.1.rst index ef49f4b13..678d76ac2 100644 --- a/docs/source/guides/admin-guides/references/man1/xcoll.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcoll.1.rst @@ -7,7 +7,7 @@ xcoll.1 ************ -\ **NAME**\ +\ **NAME**\ ************ @@ -15,7 +15,7 @@ xcoll.1 **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** @@ -23,11 +23,11 @@ xcoll.1 ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* -The \ **xcoll**\ command formats and consolidates output from the \ **psh,rinv**\ command. The \ **xcoll**\ +The \ **xcoll**\ command formats and consolidates output from the \ **psh,rinv**\ command. The \ **xcoll**\ command takes, as input, lines in the following format: groupname: line of output from remote command, will use group name, if defined @@ -47,7 +47,7 @@ is identical: lines from psh for node1 with hostnames stripped off . . - + ==================================== node2 or nodegroup name ==================================== @@ -56,7 +56,7 @@ is identical: lines from psh for node2 with hostnames stripped off . . - + ==================================== node3, node4 or nodegroup name ==================================== @@ -69,44 +69,44 @@ is identical: *************** -\ **OPTIONS**\ +\ **OPTIONS**\ *************** -\ **-c**\ - +\ **-c**\ + Display a total nodecount for each set of output. + - -\ **-n**\ - +\ **-n**\ + Display output as nodenames instead of groupnames. - + **************** -\ **EXAMPLES**\ +\ **EXAMPLES**\ **************** 1. To display the results of a command issued on several nodes, in the format used in the Description, enter: - - + + .. code-block:: perl - + psh node1,node2,node3 cat /etc/passwd | xcoll - - + + **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/xdcp.1.rst b/docs/source/guides/admin-guides/references/man1/xdcp.1.rst index 4584d26c8..d9acda7c2 100644 --- a/docs/source/guides/admin-guides/references/man1/xdcp.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xdcp.1.rst @@ -7,7 +7,7 @@ xdcp.1 ************ -\ **NAME**\ +\ **NAME**\ ************ @@ -15,11 +15,11 @@ xdcp.1 **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** -\ **xdcp**\ \ *noderange*\ [[\ **-B**\ | \ **-**\ **-bypass**\ ] [\ **-f**\ \ *fanout*\ ] [\ **-L**\ ] [\ **-l**\ \ *userID*\ ] [\ **-o**\ \ *node_options*\ ] [\ **-p**\ ] [\ **-P**\ ] [\ **-r**\ \ *node_remote_shell*\ ] [\ **-R**\ ] [\ **-t**\ \ *timeout*\ ] [\ **-T**\ ] [\ **-v**\ ] [\ **-q**\ ] [\ **-X**\ \ *env_list*\ ] \ *sourcefile.... targetpath*\ +\ **xdcp**\ \ *noderange*\ [[\ **-B**\ | \ **-**\ **-bypass**\ ] [\ **-f**\ \ *fanout*\ ] [\ **-L**\ ] [\ **-l**\ \ *userID*\ ] [\ **-o**\ \ *node_options*\ ] [\ **-p**\ ] [\ **-P**\ ] [\ **-r**\ \ *node_remote_shell*\ ] [\ **-R**\ ] [\ **-t**\ \ *timeout*\ ] [\ **-T**\ ] [\ **-v**\ ] [\ **-q**\ ] [\ **-X**\ \ *env_list*\ ] \ *sourcefile.... targetpath*\ \ **xdcp**\ \ *noderange*\ [\ **-F**\ \ *rsync input file*\ ] @@ -31,7 +31,7 @@ xdcp.1 ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* @@ -85,22 +85,22 @@ standard output or standard error is displayed. *************** -\ **OPTIONS**\ +\ **OPTIONS**\ *************** -\ *sourcefile...*\ - +\ *sourcefile...*\ + Specifies the complete path for the file to be copied to or from the target. Multiple files can be specified. When used with the -R flag, only a single directory can be specified. When used with the -P flag, only a single file can be specified. + - -\ *targetpath*\ - +\ *targetpath*\ + If one source_file file, then it specifies the file to copy the source_file file to on the target. If multiple source_file files, it specifies the directory to copy the source_file files to on the target. @@ -109,90 +109,90 @@ standard output or standard error is displayed. under target_path and the remote target name is appended to the copied source_file name in the target_path directory. Note: the targetpath directory must exist. + - -\ **-B | -**\ **-bypass**\ - +\ **-B | -**\ **-bypass**\ + Runs in bypass mode, use if the xcatd daemon is hung. + - -\ **-f | -**\ **-fanout**\ \ *fanout_value*\ - +\ **-f | -**\ **-fanout**\ \ *fanout_value*\ + Specifies a fanout value for the maximum number of concur- rently executing remote shell processes. Serial execution can be specified by indicating a fanout value of \ **1**\ . If \ **-f**\ is not specified, a default fanout value of \ **64**\ is used. + - -\ **-F | -**\ **-File**\ \ *rsync input file*\ - +\ **-F | -**\ **-File**\ \ *rsync input file*\ + Specifies the path to the file that will be used to build the \ **rsync**\ command. The format of the input file is as follows, each line contains: - - + + .. code-block:: perl - + ... -> < path to destination file/directory> - - + + or - - + + .. code-block:: perl - + -> - - + + or - - + + .. code-block:: perl - + -> - - + + For example: - - + + .. code-block:: perl - + /etc/password /etc/hosts -> /etc - + /tmp/file2 -> /tmp/file2 - + /tmp/file2 -> /tmp/ - + /tmp/filex -> /tmp/source/filey - + /etc/* -> /etc/ - - + + \ **Running postscripts after files are sync'd to the nodes**\ : - + After you define the files to rsync, you can add an \ **EXECUTE:**\ clause in the synclist file. The \ **EXECUTE:**\ clause will list all the postscripts that you would like to run after the files are sync'd to the node. The postscript file must be of the form \ **filename.post**\ , where the is the is the from , reside in the same directory as \ **filename**\ , and be executable. - If the file \ **filename**\ is rsync'd to the node, then the \ **filename.post**\ + If the file \ **filename**\ is rsync'd to the node, then the \ **filename.post**\ will automatically be run on the node. If the file \ **filename**\ is not updated on the node, the \ **filename.post**\ will not be run. - + Putting the \ **filename.post**\ in the file list to rsync to the node is required for hierarchical clusters. It is optional for non-hierarchical clusters. - + Another option is the \ **EXECUTEALWAYS:**\ clause in the synclist file. The \ **EXECUTEALWAYS:**\ will list all the postscripts that you would like to run after the files are sync'd to the nodes. These scripts will run whether or not any files are sync'd to the nodes. The scripts have no special format, but must contain the fully qualified path. - + The scripts must be also added to the file list to rsync to the node for hierarchical clusters. It is optional for non-hierarchical clusters. - + For example, your rsynclist file may look like this: - - + + .. code-block:: perl - + /tmp/share/file2 -> /tmp/file2 /tmp/share/file2.post -> /tmp/file2.post /tmp/share/file3 -> /tmp/filex @@ -204,18 +204,18 @@ standard output or standard error is displayed. /tmp/share/file3.post EXECUTEALWAYS: /tmp/myscript - - + + If /tmp/file2 and /tmp/file3 update /tmp/file2 and /tmp/filex on the node, then the postscripts /tmp/file2.post and /tmp/file3.post are automatically run on the node. /tmp/myscript will always be run on the node. - + Another option is the \ **APPEND:**\ clause in the synclist file. The \ **APPEND:**\ clause is used to append the contents of the input file to an existing file on the node. The file to append \ **must**\ already exist on the node and not be part of the synclist that contains the \ **APPEND:**\ clause. - + For example, your rsynclist file may look like this: - - + + .. code-block:: perl - + /tmp/share/file2 -> /tmp/file2 /tmp/share/file2.post -> /tmp/file2.post /tmp/share/file3 -> /tmp/filex @@ -230,12 +230,12 @@ standard output or standard error is displayed. APPEND: /etc/myappenddir/appendfile -> /etc/mysetup/setup /etc/myappenddir/appendfile2 -> /etc/mysetup/setup2 - - + + When you use the append script, the file (left) of the arrow is appended to the file right of the arrow. In this example, /etc/myappenddir/appendfile is appended to /etc/mysetup/setup file, which must already exist on the node. The /opt/xcat/share/xcat/scripts/xdcpappend.sh is used to accomplish this. - + Another option is the \ **MERGE:**\ clause in the synclist file. The \ **MERGE:**\ clause is used to append the contents of the input file to /etc/passwd, /etc/group, or /etc/shadow on a Linux node. It is only supported for those files and only on Linux. You must not use both the APPEND and MERGE funcion for these three files. The processing could end up not creating the file you desire. The MERGE function is the preferred method, becuase APPEND only adds to the file. MERGE will add to the file but also insure there are no duplicate entries. - + For example, your rsynclist file may look like this: /tmp/share/file2 -> /tmp/file2 /tmp/share/file2.post -> /tmp/file2.post @@ -252,44 +252,44 @@ standard output or standard error is displayed. /custom/mypasswd -> /etc/passwd /custom/mygroups -> /etc/group /custom/myshadow -> /etc/shadow - + Note: no order can be assumed by the order that the EXECUTE,EXECUTEALWAYS and APPEND clause fall in the synclist file. - + For more information on syncing files to node, read Sync-ing_Config_Files_to_Nodes - + On Linux rsync always uses ssh remoteshell. On AIX, ssh or rsh is used depending on the site.useSSHonAIX attribute. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Displays usage information. + - -\ **-i | -**\ **-rootimg**\ \ *install image*\ - +\ **-i | -**\ **-rootimg**\ \ *install image*\ + Specifies the path to the install image on the local Linux node. + - -\ **-o | -**\ **-node-options**\ \ *node_options*\ - +\ **-o | -**\ **-node-options**\ \ *node_options*\ + Specifies options to pass to the remote shell command for node targets. The options must be specified within double quotation marks ("") to distinguish them from \ **xdsh**\ options. + - -\ **-p | -**\ **-preserve**\ - +\ **-p | -**\ **-preserve**\ + Preserves the source file characteristics as implemented by the configured remote copy command. + - -\ **-P | -**\ **-pull**\ - +\ **-P | -**\ **-pull**\ + Pulls (copies) the files from the targets and places them in the target_path directory on the local host. The target_path must be a directory. Files pulled from remote machines have @@ -300,47 +300,47 @@ standard output or standard error is displayed. Hierarchy is not automatically support yet. You must first pull the file to the Service Node and then pull the file to the Management node. + - -\ **-q | -**\ **-show-config**\ - +\ **-q | -**\ **-show-config**\ + Displays the current environment settings for all DSH Utilities commands. This includes the values of all environment variables and settings for all currently installed and valid contexts. Each setting is prefixed with \ *context*\ : to identify the source context of the setting. + - -\ **-r | -**\ **-node-rcp**\ \ *node_remote_copy*\ - +\ **-r | -**\ **-node-rcp**\ \ *node_remote_copy*\ + Specifies the full path of the remote copy command used for remote command execution on node targets. + - -\ **-R | -**\ **-recursive**\ \ *recursive*\ - +\ **-R | -**\ **-recursive**\ \ *recursive*\ + Recursively copies files from a local directory to the remote targets, or when specified with the \ **-P**\ flag, recursively pulls (copies) files from a remote directory to the local host. A single source directory can be specified using the source_file parameter. + - -\ **-s**\ \ *synch service nodes*\ - +\ **-s**\ \ *synch service nodes*\ + Will only sync the files listed in the synclist (\ **-F**\ ), to the service nodes for the input compute node list. The files will be placed in the directory defined by the site.SNsyncfiledir attribute, or the default /var/xcat/syncfiles directory. + - -\ **-t | -**\ **-timeout**\ \ *timeout*\ - +\ **-t | -**\ **-timeout**\ \ *timeout*\ + Specifies the time, in seconds, to wait for output from any currently executing remote targets. If no output is available from any target in the specified \ *timeout*\ , @@ -350,112 +350,112 @@ standard output or standard error is displayed. all remote targets. When specified with the \ **-i**\ flag, the user is prompted for an additional timeout interval to wait for output. + - -\ **-T | -**\ **-trace**\ - +\ **-T | -**\ **-trace**\ + Enables trace mode. The \ **xdcp**\ command prints diagnostic messages to standard output during execution to each target. + - -\ **-v | -**\ **-verify**\ - +\ **-v | -**\ **-verify**\ + Verifies each target before executing any remote commands on the target. If a target is not responding, execution of remote commands for the target is canceled. + - -\ **-V | -**\ **-version**\ - +\ **-V | -**\ **-version**\ + Displays the \ **xdcp**\ command version information. - + ************************************* -\ **Environment**\ \ **Variables**\ +\ **Environment**\ \ **Variables**\ ************************************* -\ **DSH_ENVIRONMENT**\ - +\ **DSH_ENVIRONMENT**\ + Specifies a file that contains environment variable definitions to export to the target before executing the remote command. This variable is overridden by the \ **-E**\ flag. + - -\ **DSH_FANOUT**\ - +\ **DSH_FANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. + - -\ **DSH_NODE_OPTS**\ - +\ **DSH_NODE_OPTS**\ + Specifies the options to use for the remote shell command with node targets only. This variable is overridden by the \ **-o**\ flag. + - -\ **DSH_NODE_RCP**\ - +\ **DSH_NODE_RCP**\ + Specifies the full path of the remote copy command to use to copy local scripts and local environment configuration files to node targets. + - -\ **DSH_NODE_RSH**\ - +\ **DSH_NODE_RSH**\ + Specifies the full path of the remote shell to use for remote command execution on node targets. This variable is overridden by the \ **-r**\ flag. + - -\ **DSH_NODEGROUP_PATH**\ - +\ **DSH_NODEGROUP_PATH**\ + Specifies a colon-separated list of directories that contain node group files for the \ **DSH**\ context. When the \ **-a**\ flag is specified in the \ **DSH**\ context, a list of unique node names is collected from all node group files in the path. + - -\ **DSH_PATH**\ - +\ **DSH_PATH**\ + Sets the command path to use on the targets. If \ **DSH_PATH**\ is not set, the default path defined in the profile of the remote \ *user_ID*\ is used. + - -\ **DSH_SYNTAX**\ - +\ **DSH_SYNTAX**\ + Specifies the shell syntax to use on remote targets; \ **ksh**\ or \ **csh**\ . If not specified, the \ **ksh**\ syntax is assumed. This variable is overridden by the \ **-S**\ flag. + - -\ **DSH_TIMEOUT**\ - +\ **DSH_TIMEOUT**\ + Specifies the time, in seconds, to wait for output from - each remote target. This variable is overridden by the \ **-t**\ + each remote target. This variable is overridden by the \ **-t**\ flag. - + ******************* -\ **Exit Status**\ +\ **Exit Status**\ ******************* @@ -473,7 +473,7 @@ successfully, the xdcp command exit value is greater than 0. **************** -\ **Security**\ +\ **Security**\ **************** @@ -491,235 +491,235 @@ userdefined. **************** -\ **Examples**\ +\ **Examples**\ **************** 1. To copy the /etc/hosts file from all nodes in the cluster to the /tmp/hosts.dir directory on the local host, enter: - - + + .. code-block:: perl - + xdcp all -P /etc/hosts /tmp/hosts.dir - - + + A suffix specifying the name of the target is appended to each file name. The contents of the /tmp/hosts.dir directory are similar to: - - + + .. code-block:: perl - + hosts._node1 hosts._node4 hosts._node7 hosts._node2 hosts._node5 hosts._node8 hosts._node3 hosts._node6 - - + + 2. To copy the directory /var/log/testlogdir from all targets in NodeGroup1 with a fanout of 12, and save each directory on the local host as /var/log._target, enter: - - + + .. code-block:: perl - + xdcp NodeGroup1 -f 12 -RP /var/log/testlogdir /var/log - - + + 3. To copy /localnode/smallfile and /tmp/bigfile to /tmp on node1 using rsync and input -t flag to rsync, enter: - - + + .. code-block:: perl - + xdcp node1 -r /usr/bin/rsync -o "-t" /localnode/smallfile /tmp/bigfile /tmp - - + + 4. To copy the /etc/hosts file from the local host to all the nodes in the cluster, enter: - - + + .. code-block:: perl - + xdcp all /etc/hosts /etc/hosts - - + + 5. To copy all the files in /tmp/testdir from the local host to all the nodes in the cluster, enter: - - + + .. code-block:: perl - + xdcp all /tmp/testdir/* /tmp/testdir - - + + 6. To copy all the files in /tmp/testdir and it's subdirectories from the local host to node1 in the cluster, enter: - - + + .. code-block:: perl - + xdcp node1 -R /tmp/testdir /tmp/testdir - - + + 7. To copy the /etc/hosts file from node1 and node2 to the /tmp/hosts.dir directory on the local host, enter: - - + + .. code-block:: perl - + xdcp node1,node2 -P /etc/hosts /tmp/hosts.dir - - + + 8. To rsync the /etc/hosts file to your compute nodes: - + Create a rsync file /tmp/myrsync, with this line: - + /etc/hosts -> /etc/hosts - + or - + /etc/hosts -> /etc/ (last / is required) - + Run: - - + + .. code-block:: perl - + xdcp compute -F /tmp/myrsync - - + + 9. - + To rsync all the files in /home/mikev to the compute nodes: - + Create a rsync file /tmp/myrsync, with this line: - + /home/mikev/\* -> /home/mikev/ (last / is required) - + Run: - - + + .. code-block:: perl - + xdcp compute -F /tmp/myrsync - - + + 10. To rsync to the compute nodes, using service nodes, the command will first rsync the files to the /var/xcat/syncfiles directory on the service nodes and then rsync the files from that directory to the compute nodes. The /var/xcat/syncfiles default directory on the service nodes, can be changed by putting a directory value in the site table SNsyncfiledir attribute. - + Create a rsync file /tmp/myrsync, with this line: - + /etc/hosts /etc/passwd -> /etc - + or - + /etc/hosts /etc/passwd -> /etc/ - + Run: - - + + .. code-block:: perl - + xdcp compute -F /tmp/myrsync - - + + to update the Compute Nodes - + 11. To rsync to the service nodes in preparation for rsyncing the compute nodes during an install from the service node. - + Create a rsync file /tmp/myrsync, with this line: - + /etc/hosts /etc/passwd -> /etc - + Run: - - + + .. code-block:: perl - + xdcp compute -s -F /tmp/myrsync - - + + to sync the service node for compute - + 12. To rsync the /etc/file1 and file2 to your compute nodes and rename to filex and filey: - + Create a rsync file /tmp/myrsync, with these line: - + /etc/file1 -> /etc/filex - + /etc/file2 -> /etc/filey - + Run: - - + + .. code-block:: perl - + xdcp compute -F /tmp/myrsync - - + + to update the Compute Nodes - + 13. To rsync files in the Linux image at /install/netboot/fedora9/x86_64/compute/rootimg on the MN: - + Create a rsync file /tmp/myrsync, with this line: - + /etc/hosts /etc/passwd -> /etc - + Run: - - + + .. code-block:: perl - + xdcp -i /install/netboot/fedora9/x86_64/compute/rootimg -F /tmp/myrsync - - + + 14. To define the Management Node in the database so you can use xdcp, run - - + + .. code-block:: perl - + xcatconfig -m - - + + ************* -\ **Files**\ +\ **Files**\ ************* **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/xdsh.1.rst b/docs/source/guides/admin-guides/references/man1/xdsh.1.rst index 03f6db8f2..ebc6ff7f9 100644 --- a/docs/source/guides/admin-guides/references/man1/xdsh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xdsh.1.rst @@ -7,7 +7,7 @@ xdsh.1 ************ -\ **NAME**\ +\ **NAME**\ ************ @@ -15,19 +15,19 @@ xdsh.1 **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** \ **xdsh**\ \ *noderange*\ [\ **-B**\ | \ **-**\ **-bypass**\ ] [\ **-**\ **-devicetype**\ \ *type_of_device*\ ] [\ **-e**\ ] [\ **-E**\ \ *environment_file*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-L**\ ] [\ **-l**\ \ *userID*\ ] [\ **-m**\ ] [\ **-o**\ \ *node_options*\ ] [\ **-Q**\ ] [\ **-r**\ \ *node_remote_shell*\ ] [\ **-s**\ ] [\ **-S**\ {\ **csh | ksh**\ }] [\ **-t**\ \ *timeout*\ ] -[\ **-T**\ ] [\ **-v**\ ] [\ **-X**\ \ *env_list*\ ] [\ **-z**\ ] [\ **-**\ **-sudo**\ ] \ *command_list*\ +[\ **-T**\ ] [\ **-v**\ ] [\ **-X**\ \ *env_list*\ ] [\ **-z**\ ] [\ **-**\ **-sudo**\ ] \ *command_list*\ \ **xdsh**\ \ *noderange*\ [\ **-K**\ ] -\ **xdsh**\ \ *noderange*\ [\ **-K**\ ] [\ **-l**\ \ *userID*\ ] \ **-**\ **-devicetype**\ \ *type_of_device*\ +\ **xdsh**\ \ *noderange*\ [\ **-K**\ ] [\ **-l**\ \ *userID*\ ] \ **-**\ **-devicetype**\ \ *type_of_device*\ -\ **xdsh**\ [\ **-i**\ \ *image path | nim image name*\ ] \ *command_list*\ +\ **xdsh**\ [\ **-i**\ \ *image path | nim image name*\ ] \ *command_list*\ \ **xdsh**\ \ *noderange*\ [\ **-c**\ ] @@ -35,7 +35,7 @@ xdsh.1 ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* @@ -116,7 +116,7 @@ The file should be executable and contain one environment variable per line. \ **COMMAND**\ \ **EXECUTION**\ : The maximum number of concurrent remote shell command processes (the -fanout) can be specified with the \ **-f**\ flag or with the \ **DSH_FANOUT**\ +fanout) can be specified with the \ **-f**\ flag or with the \ **DSH_FANOUT**\ environment variable. The fanout is only restricted by the number of remote shell commands that can be run in parallel. You can experiment with the \ **DSH_FANOUT**\ value on your management server to see if higher values are @@ -177,87 +177,87 @@ the commands executing on the remote targets. Signal 19 (CONT), Signal 17 (STOP), and Signal 18 (TSTP) default to \ **xdsh**\ ; the \ **xdsh**\ command responds normally to these signals, but the signals do not have an effect on remotely executing commands. Other -signals are caught by \ **xdsh**\ and have their default effects on the \ **xdsh**\ +signals are caught by \ **xdsh**\ and have their default effects on the \ **xdsh**\ command; all current child processes, through propagation to remotely running commands, are terminated (SIGTERM). *************** -\ **OPTIONS**\ +\ **OPTIONS**\ *************** -\ **-B | -**\ **-bypass**\ - +\ **-B | -**\ **-bypass**\ + Runs in bypass mode, use if the xcatd daemon is hung. + - -\ **-c | -**\ **-cleanup**\ - +\ **-c | -**\ **-cleanup**\ + This flag will have xdsh remove all files from the subdirectories of the the directory on the servicenodes, where xdcp stages the copy to the compute nodes as defined in the site table SNsyncfiledir and nodesyncfiledir attribute, when the target is a service node. - + It can also be used to remove the nodesyncfiledir directory on the compute nodes, which keeps the backup copies of files for the xdcp APPEND function support, if a compute node is the target. + - -\ **-e | -**\ **-execute**\ - +\ **-e | -**\ **-execute**\ + Indicates that \ *command_list*\ specifies a local script filename and arguments to be executed on the remote targets. The script file is copied to the remote targets and then remotely executed with the given arguments. The \ **DSH_NODE_RCP**\ environment variables specify the remote copy command to use to copy the script file to node targets. + - -\ **-E | -**\ **-environment**\ \ *environment_file*\ - +\ **-E | -**\ **-environment**\ \ *environment_file*\ + Specifies that the \ *environment_file*\ contains environment variable definitions to export to the target before executing the \ *command_list*\ . + - -\ **-**\ **-devicetype**\ \ *type_of_device*\ - +\ **-**\ **-devicetype**\ \ *type_of_device*\ + Specify a user-defined device type that references the location of relevant device configuration file. The devicetype value must correspond to a valid device configuration file. xCAT ships some default configuration files for Ethernet switches and and IB switches under \ */opt/xcat/share/xcat/devicetype*\ directory. If you want to overwrite - any of the configuration files, copy them to \ */var/opt/xcat/*\ + any of the configuration files, copy them to \ */var/opt/xcat/*\ directory and cutomize. For example, \ *base/IBSwitch/Qlogic/config*\ is the configuration file location if devicetype is specified as IBSwitch::Qlogic. xCAT will first search config file using \ */var/opt/xcat/*\ as the base. If not found, it will search for it using \ */opt/xcat/share/xcat/devicetype/*\ as the base. + - -\ **-f | -**\ **-fanout**\ \ *fanout_value*\ - +\ **-f | -**\ **-fanout**\ \ *fanout_value*\ + Specifies a fanout value for the maximum number of concurrently executing remote shell processes. Serial execution can be specified by indicating a fanout value of \ **1**\ . If \ **-f**\ is not specified, a default fanout value of \ **64**\ is used. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Displays usage information. + - -\ **-i | -**\ **-rootimg**\ \ *install image*\ - +\ **-i | -**\ **-rootimg**\ \ *install image*\ + For Linux, Specifies the path to the install image on the local node. For AIX, specifies the name of the osimage on the local node. Run lsnim for valid names. @@ -265,19 +265,19 @@ running commands, are terminated (SIGTERM). install image. No other xdsh flags, environment variables apply with this input. A noderange is not accepted. Only runs on the local host, normally the Management Node. The command you run must not prompt for input, the prompt will not be returned to you, and it will appear that \ **xdsh**\ hangs. + + + +\ **-K | -**\ **-ssh-setup**\ -\ **-K | -**\ **-ssh-setup**\ - - - -\ **-K | -**\ **-ssh-setup**\ \ **-l | -**\ **-user**\ \ *user_ID*\ \ **-**\ **-devicetype**\ \ *type_of_device*\ - +\ **-K | -**\ **-ssh-setup**\ \ **-l | -**\ **-user**\ \ *user_ID*\ \ **-**\ **-devicetype**\ \ *type_of_device*\ + Set up the SSH keys for the user running the command to the specified node list. The userid must have the same uid, gid and password as the userid on the node where the keys will be setup. - + If the current user is root, roots public ssh keys will be put in the authorized_keys\* files under roots .ssh directory on the node(s). If the current user is non-root, the user must be in the policy table and have credential to run the xdsh command. @@ -287,78 +287,78 @@ running commands, are terminated (SIGTERM). device should be defined as a node and nodetype should be defined as switch before connecting. The \ **xdsh -K**\ command must be run from the Management Node. + - -\ **-l | -**\ **-user**\ \ *user_ID*\ - +\ **-l | -**\ **-user**\ \ *user_ID*\ + Specifies a remote user name to use for remote command execution. + - -\ **-L | -**\ **-no-locale**\ - +\ **-L | -**\ **-no-locale**\ + Specifies to not export the locale definitions of the local host to the remote targets. Local host locale definitions are exported by default to each remote target. + - -\ **-m | -**\ **-monitor**\ - +\ **-m | -**\ **-monitor**\ + Monitors remote shell execution by displaying status messages during execution on each target. + - -\ **-o | -**\ **-node-options**\ \ *node_options*\ - +\ **-o | -**\ **-node-options**\ \ *node_options*\ + Specifies options to pass to the remote shell command for node targets. The options must be specified within double quotation marks ("") to distinguish them from \ **xdsh**\ options. + - -\ **-q | -**\ **-show-config**\ - +\ **-q | -**\ **-show-config**\ + Displays the current environment settings for all DSH Utilities commands. This includes the values of all environment variables and settings for all currently installed and valid contexts. Each setting is prefixed with \ *context*\ : to identify the source context of the setting. + - -\ **-Q | -**\ **-silent**\ - +\ **-Q | -**\ **-silent**\ + Specifies silent mode. No target output is written to standard output or standard error. Monitoring messages are written to standard output. + - -\ **-r | -**\ **-node-rsh**\ \ *node_remote_shell*\ - +\ **-r | -**\ **-node-rsh**\ \ *node_remote_shell*\ + Specifies the path of the remote shell command used for remote command execution on node targets. + - -\ **-s | -**\ **-stream**\ - +\ **-s | -**\ **-stream**\ + Specifies that output is returned as it becomes available - from each target, instead of waiting for the \ *command_list*\ + from each target, instead of waiting for the \ *command_list*\ to be completed on a target before returning output. - + \ **-S | -**\ **-syntax**\ {\ **csh | ksh**\ } - + Specifies the shell syntax to be used on the remote target. If not specified, the \ **ksh**\ syntax is used. + - -\ **-**\ **-sudo**\ - +\ **-**\ **-sudo**\ + Adding the \ **-**\ **-sudo**\ flag to the xdsh command will have xdsh run sudo before running the command. This is particular useful when using the \ **-e**\ option. This is required when you input \ **-l**\ with a non-root user id and want that id @@ -370,47 +370,47 @@ running commands, are terminated (SIGTERM). You must disabl ssh tty requirements by commenting out or removing this line in the /etc/sudoes file "#Defaults requiretty". See the document Granting_Users_xCAT_privileges for sudo setup requirements. This is not supported in a hierarical cluster, that is the nodes are serviced by servicenodes. + - -\ **-t | -**\ **-timeout**\ \ *timeout*\ - +\ **-t | -**\ **-timeout**\ \ *timeout*\ + Specifies the time, in seconds, to wait for output from any currently executing remote targets. If no output is - available from any target in the specified \ *timeout*\ , \ **xdsh**\ + available from any target in the specified \ *timeout*\ , \ **xdsh**\ displays an error and terminates execution for the remote targets that failed to respond. If \ *timeout*\ is not specified, \ **xdsh**\ waits indefinitely to continue processing output from all remote targets. The exception is the \ **-K**\ flag which defaults to 10 seconds. + - -\ **-T | -**\ **-trace**\ - +\ **-T | -**\ **-trace**\ + Enables trace mode. The \ **xdsh**\ command prints diagnostic messages to standard output during execution to each target. + - -\ **-v | -**\ **-verify**\ - +\ **-v | -**\ **-verify**\ + Verifies each target before executing any remote commands on the target. If a target is not responding, execution of remote commands for the target is canceled. When specified with the \ **-i**\ flag, the user is prompted to retry the verification request. + - -\ **-V | -**\ **-version**\ - +\ **-V | -**\ **-version**\ + Displays the \ **xdsh**\ command version information. + - -\ **-X**\ \ *env_list*\ - +\ **-X**\ \ *env_list*\ + Ignore \ **xdsh**\ environment variables. This option can take an argument which is a comma separated list of environment variable names that should \ **NOT**\ be ignored. If there is no @@ -419,16 +419,16 @@ running commands, are terminated (SIGTERM). This option is useful when running \ **xdsh**\ from within other scripts when you don't want the user's environment affecting the behavior of xdsh. + - -\ **-z | -**\ **-exit-status**\ - +\ **-z | -**\ **-exit-status**\ + Displays the exit status for the last remotely executed non-asynchronous command on each target. If the command issued on the remote node is run in the background, the exit status is not displayed. - + Exit values for each remote shell execution are displayed in messages from the \ **xdsh**\ command, if the remote shell exit values are non-zero. A non-zero return code from a remote shell indicates that @@ -436,7 +436,7 @@ running commands, are terminated (SIGTERM). unrelated to the exit code of the remotely issued command. If a remote shell encounters an error, execution of the remote command on that target is bypassed. - + The \ **xdsh**\ command exit code is \ **0**\ if the command executed without errors and all remote shell commands finished with exit codes of \ **0**\ . If internal \ **xdsh**\ errors occur or the remote shell commands do not @@ -445,101 +445,101 @@ running commands, are terminated (SIGTERM). an unsuccessful remote command execution. If the remotely issued command is run in the background, the exit code of the remotely issued command is \ **0**\ . - + ************************************* -\ **Environment**\ \ **Variables**\ +\ **Environment**\ \ **Variables**\ ************************************* -\ **DEVICETYPE**\ - +\ **DEVICETYPE**\ + Specify a user-defined device type. See \ **-**\ **-devicetype**\ flag. + - -\ **DSH_ENVIRONMENT**\ - +\ **DSH_ENVIRONMENT**\ + Specifies a file that contains environment variable definitions to export to the target before executing the remote command. This variable is overridden by the \ **-E**\ flag. + - -\ **DSH_FANOUT**\ - +\ **DSH_FANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. + - -\ **DSH_NODE_OPTS**\ - +\ **DSH_NODE_OPTS**\ + Specifies the options to use for the remote shell command with node targets only. This variable is overridden by the \ **-o**\ flag. + - -\ **DSH_NODE_RCP**\ - +\ **DSH_NODE_RCP**\ + Specifies the full path of the remote copy command to use to copy local scripts and local environment configuration files to node targets. + - -\ **DSH_NODE_RSH**\ - +\ **DSH_NODE_RSH**\ + Specifies the full path of the remote shell to use for remote command execution on node targets. This variable is overridden by the \ **-r**\ flag. + - -\ **DSH_PATH**\ - +\ **DSH_PATH**\ + Sets the command path to use on the targets. If \ **DSH_PATH**\ is not set, the default path defined in the profile of the remote \ *user_ID*\ is used. + - -\ **DSH_REMOTE_PASSWORD**\ - +\ **DSH_REMOTE_PASSWORD**\ + If \ **DSH_REMOTE_PASSWORD**\ is set to the password of the userid (usually root) that will ssh to the node, then when you use the \ **-K**\ flag, you will not be prompted for a password. + - -\ **DSH_SYNTAX**\ - +\ **DSH_SYNTAX**\ + Specifies the shell syntax to use on remote targets; \ **ksh**\ or \ **csh**\ . If not specified, the \ **ksh**\ syntax is assumed. This variable is overridden by the \ **-S**\ flag. + - -\ **DSH_TIMEOUT**\ - +\ **DSH_TIMEOUT**\ + Specifies the time, in seconds, to wait for output from each remote target. This variable is overridden by the \ **-t**\ flag. + - -\ **DSH_VERIFY**\ - +\ **DSH_VERIFY**\ + Verifies each target before executing any remote commands on the target. If a target is not responding, execution of remote commands for the target is canceled. This variable is overridden by the \ **-v**\ flag. - + ********************************** -\ **Compatibility with AIX dsh**\ +\ **Compatibility with AIX dsh**\ ********************************** @@ -550,7 +550,7 @@ xCAT database that can be used by \ **dsh**\ . See \ **man groupfiles4dsh**\ . **************** -\ **SECURITY**\ +\ **SECURITY**\ **************** @@ -568,7 +568,7 @@ userdefined. ******************* -\ **EXIT STATUS**\ +\ **EXIT STATUS**\ ******************* @@ -576,178 +576,178 @@ The \ **xdsh**\ command exit code is 0 if the command executed without errors a **************** -\ **EXAMPLES**\ +\ **EXAMPLES**\ **************** 1. To set up the SSH keys for root on node1, run as root: - - + + .. code-block:: perl - + xdsh node1 -K - - + + 2. To run the \ **ps -ef**\ command on node targets \ **node1**\ and \ **node2**\ , enter: - - + + .. code-block:: perl - + xdsh node1,node2 "ps -ef" - - + + 3. To run the \ **ps**\ command on node targets \ **node1**\ and run the remote command with the -v and -t flag, enter: - - + + .. code-block:: perl - + xdsh node1,node2 -o "-v -t" ps + + - - -4. To execute the commands contained in \ **myfile**\ in the \ **XCAT**\ +4. To execute the commands contained in \ **myfile**\ in the \ **XCAT**\ context on several node targets, with a fanout of \ **1**\ , enter: - - + + .. code-block:: perl - + xdsh node1,node2 -f 1 -e myfile - - + + 5. To run the ps command on node1 and ignore all the dsh environment variable except the DSH_NODE_OPTS, enter: - - + + .. code-block:: perl - + xdsh node1 -X `DSH_NODE_OPTS' ps - - + + 6. To run on Linux, the xdsh command "rpm -qa | grep xCAT" on the service node fedora9 diskless image, enter: - - + + .. code-block:: perl - + xdsh -i /install/netboot/fedora9/x86_64/service/rootimg "rpm -qa | grep xCAT" - - + + 7. To run on AIX, the xdsh command "lslpp -l | grep bos" on the NIM 611dskls spot, enter: - - + + .. code-block:: perl - + xdsh -i 611dskls "/usr/bin/lslpp -l | grep bos" - - + + 8. To cleanup the servicenode directory that stages the copy of files to the nodes, enter: - - + + .. code-block:: perl - + xdsh servicenoderange -c - - + + 9. - + To define the QLogic IB switch as a node and to set up the SSH keys for IB switch \ **qswitch**\ with device configuration file \ **/var/opt/xcat/IBSwitch/Qlogic/config**\ and user name \ **username**\ , enter - - + + .. code-block:: perl - + chdef -t node -o qswitch groups=all nodetype=switch - + xdsh qswitch -K -l username --devicetype IBSwitch::Qlogic - - + + 10. To define the Management Node in the database so you can use \ **xdsh**\ , enter - - + + .. code-block:: perl - + xcatconfig -m - - + + 11. To define the Mellanox switch as a node and run a command to show the ssh keys. \ **mswitch**\ with and user name \ **username**\ , enter - - + + .. code-block:: perl - + chdef -t node -o mswitch groups=all nodetype=switch - + xdsh mswitch -l admin --devicetype IBSwitch::Mellanox 'enable;configure terminal;show ssh server host-keys' - - + + 12. - + To define a BNT Ethernet switch as a node and run a command to create a new vlan with vlan id 3 on the switch. - - + + .. code-block:: perl - + chdef myswitch groups=all - + tabch switch=myswitch switches.sshusername=admin switches.sshpassword=passw0rd switches.protocol=[ssh|telnet] - - + + where \ *admin*\ and \ *passw0rd*\ are the SSH user name and password for the switch. - + If it is for Telnet, add \ *tn:*\ in front of the user name: \ *tn:admin*\ . - - + + .. code-block:: perl - + dsh myswitch --devicetype EthSwitch::BNT 'enable;configure terminal;vlan 3;end;show vlan' - - + + 13. - + To run \ **xdsh**\ with the non-root userid "user1" that has been setup as an xCAT userid and with sudo on node1 and node2 to run as root, do the following, see xCAT doc on Granting_Users_xCAT_privileges: - - + + .. code-block:: perl - + xdsh node1,node2 --sudo -l user1 "cat /etc/passwd" - - + + ************* -\ **Files**\ +\ **Files**\ ************* **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/xdshbak.1.rst b/docs/source/guides/admin-guides/references/man1/xdshbak.1.rst index 3ebac0d2d..aa9e3a74e 100644 --- a/docs/source/guides/admin-guides/references/man1/xdshbak.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xdshbak.1.rst @@ -15,7 +15,7 @@ NAME **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** @@ -27,7 +27,7 @@ DESCRIPTION *********** -The \ **xdshbak**\ command formats output from the \ **xdsh**\ command. The \ **xdshbak**\ +The \ **xdshbak**\ command formats output from the \ **xdsh**\ command. The \ **xdshbak**\ command takes, as input, lines in the following format: @@ -73,7 +73,7 @@ When output is displayed from more than one node in collapsed form, the host names are displayed alphabetically. When output is not collapsed, output is displayed sorted alphabetically by host name. -If the \ **-q**\ quiet flag is not set then \ **xdshbak**\ +If the \ **-q**\ quiet flag is not set then \ **xdshbak**\ command writes "." for each 1000 lines of output processed (to show progress), since it won't display the output until it has processed all of it. @@ -112,87 +112,87 @@ OPTIONS -\ **-b**\ - +\ **-b**\ + Strip the host prefix from the beginning of the lines. This only works with the \ **-x**\ option. + - -\ **-c**\ - +\ **-c**\ + If the output from multiple nodes is identical it will be collapsed and displayed only once. + - -\ **-x**\ - +\ **-x**\ + Omit the extra header lines that xdshbak normally displays for each node. This provides more compact output, but xdshbak still sorts the output by node name for easier viewing. This option should not be used with \ **-c**\ . + - -\ **-h**\ - +\ **-h**\ + Displays usage information. + - -\ **-q**\ - +\ **-q**\ + Quiet mode, do not display "." for each 1000 lines of output. - + **************** -\ **EXAMPLES**\ +\ **EXAMPLES**\ **************** 1. To display the results of a command issued on several nodes, in the format used in the Description, enter: - - + + .. code-block:: perl - + xdsh node1,node2,node3 cat /etc/passwd | xdshbak - - + + 2. - + To display the results of a command issued on several nodes with identical output displayed only once, enter: - - + + .. code-block:: perl - + xdsh host1,host2,host3 pwd | xdshbak -c - - + + 3. To display the results of a command issued on several nodes with compact output and be sorted alphabetically by host name, enter: - - + + .. code-block:: perl - + xdsh host1,host2,host3 date | xdshbak -x - - + + **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man1/xdshcoll.1.rst b/docs/source/guides/admin-guides/references/man1/xdshcoll.1.rst index d70cfe2a8..0e1b13487 100644 --- a/docs/source/guides/admin-guides/references/man1/xdshcoll.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xdshcoll.1.rst @@ -7,7 +7,7 @@ xdshcoll.1 ************ -\ **NAME**\ +\ **NAME**\ ************ @@ -15,19 +15,19 @@ xdshcoll.1 **************** -\ **SYNOPSIS**\ +\ **SYNOPSIS**\ **************** -\ **xdshcoll**\ +\ **xdshcoll**\ ******************* -\ **DESCRIPTION**\ +\ **DESCRIPTION**\ ******************* -The \ **xdshcoll**\ command formats and consolidates output from the \ **xdsh,sinv**\ command. The \ **xdshcoll**\ +The \ **xdshcoll**\ command formats and consolidates output from the \ **xdsh,sinv**\ command. The \ **xdshcoll**\ command takes, as input, lines in the following format: host_name: line of output from remote command @@ -47,7 +47,7 @@ is identical: lines from xdsh for node1 with hostnames stripped off . . - + ==================================== node2 ==================================== @@ -56,7 +56,7 @@ is identical: lines from xdsh for node2 with hostnames stripped off . . - + ==================================== node3, node4 ==================================== @@ -69,25 +69,25 @@ is identical: **************** -\ **EXAMPLES**\ +\ **EXAMPLES**\ **************** 1. To display the results of a command issued on several nodes, in the format used in the Description, enter: - - + + .. code-block:: perl - + xdsh node1,node2,node3 cat /etc/passwd> | Bvalue ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -180,7 +180,7 @@ no group range match will be attempted. All node and group names are validated against the nodelist table. Invalid names are ignored and return nothing. -\ **xCAT Node Name Format**\ +\ **xCAT Node Name Format**\ ============================= @@ -237,134 +237,134 @@ Example of \ **xCAT Node Name Format**\ node/group names: **************** -\ **Examples**\ +\ **Examples**\ **************** 1. - + Generates a list of all nodes (assuming all is a group) listed in the \ **nodelist**\ table less node5 through node10: - - + + .. code-block:: perl - + all,-node5-node10 - - + + 2. - + Generates a list of nodes 1 through 10 less nodes 3,4,5. Note that node4 is listed twice, first in the range and then at the end. Because exclusion has precedence node4 will be excluded. - - + + .. code-block:: perl - + node1-node10,-node3-node5,node4 - - + + 3. - + Generates a list of nodes 1 through 10 less nodes 3 and 5. - - + + .. code-block:: perl - + node1-node10,-node3,-node5 - - + + 4. - + Generates a list of all (assuming \`all' is a group) nodes in the \ **nodelist**\ table less 17 through 32. - - + + .. code-block:: perl - + -node17-node32,all - - + + 5. - + Generates a list of nodes 1 through 128, and user nodes 1 through 4. - - + + .. code-block:: perl - + node1-node128,user1-user4 - - + + 6. - + Generates a list of all nodes (assuming \`all' is a group), less nodes in groups rack1 through rack3 (assuming groups rack1, rack2, and rack3 are defined), less nodes 100 through 200, less nodes in the storage group. Note that node150 is listed but is excluded. - - + + .. code-block:: perl - + all,-rack1-rack3,-node100-node200,node150,-storage - - + + 7. - + Generates a list of nodes matching the regex \ *node[23].\\**\ . That is all nodes that start with node2 or node3 and end in anything or nothing. E.g. node2, node3, node20, node30, node21234 all match. - - + + .. code-block:: perl - + /node[23].* - - + + 8. - + Generates a list of nodes which have the value hmc in the nodehm.cons attribute. - - + + .. code-block:: perl - + nodehm.cons==hmc - + nodehm.cons=~hmc - - + + 9. - + Generate a list of nodes in the 1st two frames: - - + + .. code-block:: perl - + f[1-2]n[1-42] - - + + ************ -\ **Bugs**\ +\ **Bugs**\ ************ @@ -374,7 +374,7 @@ and \`~' may have to be escaped from the shell. **************** -\ **SEE ALSO**\ +\ **SEE ALSO**\ **************** diff --git a/docs/source/guides/admin-guides/references/man5/auditlog.5.rst b/docs/source/guides/admin-guides/references/man5/auditlog.5.rst index b16ed7ad6..a89b681aa 100644 --- a/docs/source/guides/admin-guides/references/man5/auditlog.5.rst +++ b/docs/source/guides/admin-guides/references/man5/auditlog.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **auditlog Attributes:**\ \ *recid*\ , \ *audittime*\ , \ *userid*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *noderange*\ , \ *args*\ , \ *status*\ , \ *comments*\ , \ *disable*\ +\ **auditlog Attributes:**\ \ *recid*\ , \ *audittime*\ , \ *userid*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *noderange*\ , \ *args*\ , \ *status*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,70 +36,70 @@ auditlog Attributes: -\ **recid**\ - +\ **recid**\ + The record id. + - -\ **audittime**\ - +\ **audittime**\ + The timestamp for the audit entry. + - -\ **userid**\ - +\ **userid**\ + The user running the command. + - -\ **clientname**\ - +\ **clientname**\ + The client machine, where the command originated. + - -\ **clienttype**\ - +\ **clienttype**\ + Type of command: cli, java, webui, other. + - -\ **command**\ - +\ **command**\ + Command executed. See auditskipcmds site table attribute to control which commands get logged. + - -\ **noderange**\ - +\ **noderange**\ + The noderange on which the command was run. + - -\ **args**\ - +\ **args**\ + The command argument list. + - -\ **status**\ - +\ **status**\ + Allowed or Denied. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Do not use. tabprune will not work if set to yes or 1 - + @@ -108,5 +108,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/bootparams.5.rst b/docs/source/guides/admin-guides/references/man5/bootparams.5.rst index f984191a8..13f261616 100644 --- a/docs/source/guides/admin-guides/references/man5/bootparams.5.rst +++ b/docs/source/guides/admin-guides/references/man5/bootparams.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **bootparams Attributes:**\ \ *node*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *addkcmdline*\ , \ *dhcpstatements*\ , \ *adddhcpstatements*\ , \ *comments*\ , \ *disable*\ +\ **bootparams Attributes:**\ \ *node*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *addkcmdline*\ , \ *dhcpstatements*\ , \ *adddhcpstatements*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,58 +36,58 @@ bootparams Attributes: -\ **node**\ - +\ **node**\ + The node or group name + - -\ **kernel**\ - +\ **kernel**\ + The kernel that network boot actions should currently acquire and use. Note this could be a chained boot loader such as memdisk or a non-linux boot loader + - -\ **initrd**\ - +\ **initrd**\ + The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel) + - -\ **kcmdline**\ - +\ **kcmdline**\ + Arguments to be passed to the kernel + - -\ **addkcmdline**\ - +\ **addkcmdline**\ + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ") + - -\ **dhcpstatements**\ - +\ **dhcpstatements**\ + xCAT manipulated custom dhcp statements (not intended for user manipulation) + - -\ **adddhcpstatements**\ - +\ **adddhcpstatements**\ + Custom dhcp statements for administrator use (not implemneted yet) + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -96,5 +96,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/boottarget.5.rst b/docs/source/guides/admin-guides/references/man5/boottarget.5.rst index b93468c43..ff34f5b4a 100644 --- a/docs/source/guides/admin-guides/references/man5/boottarget.5.rst +++ b/docs/source/guides/admin-guides/references/man5/boottarget.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **boottarget Attributes:**\ \ *bprofile*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *comments*\ , \ *disable*\ +\ **boottarget Attributes:**\ \ *bprofile*\ , \ *kernel*\ , \ *initrd*\ , \ *kcmdline*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ boottarget Attributes: -\ **bprofile**\ - +\ **bprofile**\ + All nodes with a nodetype.profile value equal to this value and nodetype.os set to "boottarget", will use the associated kernel, initrd, and kcmdline. + - -\ **kernel**\ - +\ **kernel**\ + The kernel that network boot actions should currently acquire and use. Note this could be a chained boot loader such as memdisk or a non-linux boot loader + - -\ **initrd**\ - +\ **initrd**\ + The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel) + - -\ **kcmdline**\ - +\ **kcmdline**\ + Arguments to be passed to the kernel + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/cfgmgt.5.rst b/docs/source/guides/admin-guides/references/man5/cfgmgt.5.rst index b659a1ac4..58d9c3f7a 100644 --- a/docs/source/guides/admin-guides/references/man5/cfgmgt.5.rst +++ b/docs/source/guides/admin-guides/references/man5/cfgmgt.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **cfgmgt Attributes:**\ \ *node*\ , \ *cfgmgr*\ , \ *cfgserver*\ , \ *roles*\ , \ *comments*\ , \ *disable*\ +\ **cfgmgt Attributes:**\ \ *node*\ , \ *cfgmgr*\ , \ *cfgserver*\ , \ *roles*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ cfgmgt Attributes: -\ **node**\ - +\ **node**\ + The node being managed by the cfgmgr service + - -\ **cfgmgr**\ - +\ **cfgmgr**\ + The name of the configuration manager service. Currently 'chef' and 'puppet' are supported services. + - -\ **cfgserver**\ - +\ **cfgserver**\ + The xCAT node name of the chef server or puppet master + - -\ **roles**\ - +\ **roles**\ + The roles associated with this node as recognized by the cfgmgr for the software that is to be installed and configured. These role names map to chef recipes or puppet manifest classes that should be used for this node. For example, chef OpenStack cookbooks have roles such as mysql-master,keystone, glance, nova-controller, nova-conductor, cinder-all. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/chain.5.rst b/docs/source/guides/admin-guides/references/man5/chain.5.rst index dd2e5b869..37ac50f22 100644 --- a/docs/source/guides/admin-guides/references/man5/chain.5.rst +++ b/docs/source/guides/admin-guides/references/man5/chain.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **chain Attributes:**\ \ *node*\ , \ *currstate*\ , \ *currchain*\ , \ *chain*\ , \ *ondiscover*\ , \ *comments*\ , \ *disable*\ +\ **chain Attributes:**\ \ *node*\ , \ *currstate*\ , \ *currchain*\ , \ *chain*\ , \ *ondiscover*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ chain Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **currstate**\ - +\ **currstate**\ + The current or next chain step to be executed on this node by xCAT-genesis. Set by xCAT during node discovery or as a result of nodeset. + - -\ **currchain**\ - +\ **currchain**\ + The chain steps still left to do for this node. This attribute will be automatically adjusted by xCAT while xCAT-genesis is running on the node (either during node discovery or a special operation like firmware update). During node discovery, this attribute is initialized from the chain attribute and updated as the chain steps are executed. + - -\ **chain**\ - +\ **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=, runimage=, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=shell. + - -\ **ondiscover**\ - +\ **ondiscover**\ + This attribute is currently not used by xCAT. The "nodediscover" operation is always done during node discovery. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/deps.5.rst b/docs/source/guides/admin-guides/references/man5/deps.5.rst index 7058824d6..1da97c43c 100644 --- a/docs/source/guides/admin-guides/references/man5/deps.5.rst +++ b/docs/source/guides/admin-guides/references/man5/deps.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **deps Attributes:**\ \ *node*\ , \ *nodedep*\ , \ *msdelay*\ , \ *cmd*\ , \ *comments*\ , \ *disable*\ +\ **deps Attributes:**\ \ *node*\ , \ *nodedep*\ , \ *msdelay*\ , \ *cmd*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ deps Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **nodedep**\ - +\ **nodedep**\ + Comma-separated list of nodes or node groups it is dependent on. + - -\ **msdelay**\ - +\ **msdelay**\ + How long to wait between operating on the dependent nodes and the primary nodes. + - -\ **cmd**\ - +\ **cmd**\ + Comma-separated list of which operation this dependency applies to. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/discoverydata.5.rst b/docs/source/guides/admin-guides/references/man5/discoverydata.5.rst index 014c3c685..b187e5b5f 100644 --- a/docs/source/guides/admin-guides/references/man5/discoverydata.5.rst +++ b/docs/source/guides/admin-guides/references/man5/discoverydata.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **discoverydata Attributes:**\ \ *uuid*\ , \ *node*\ , \ *method*\ , \ *discoverytime*\ , \ *arch*\ , \ *cpucount*\ , \ *cputype*\ , \ *memory*\ , \ *mtm*\ , \ *serial*\ , \ *nicdriver*\ , \ *nicipv4*\ , \ *nichwaddr*\ , \ *nicpci*\ , \ *nicloc*\ , \ *niconboard*\ , \ *nicfirm*\ , \ *switchname*\ , \ *switchaddr*\ , \ *switchdesc*\ , \ *switchport*\ , \ *otherdata*\ , \ *comments*\ , \ *disable*\ +\ **discoverydata Attributes:**\ \ *uuid*\ , \ *node*\ , \ *method*\ , \ *discoverytime*\ , \ *arch*\ , \ *cpucount*\ , \ *cputype*\ , \ *memory*\ , \ *mtm*\ , \ *serial*\ , \ *nicdriver*\ , \ *nicipv4*\ , \ *nichwaddr*\ , \ *nicpci*\ , \ *nicloc*\ , \ *niconboard*\ , \ *nicfirm*\ , \ *switchname*\ , \ *switchaddr*\ , \ *switchdesc*\ , \ *switchport*\ , \ *otherdata*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,148 +36,148 @@ discoverydata Attributes: -\ **uuid**\ - +\ **uuid**\ + The uuid of the node which send out the discovery request. + - -\ **node**\ - +\ **node**\ + The node name which assigned to the discovered node. + - -\ **method**\ - +\ **method**\ + The method which handled the discovery request. The method could be one of: switch, blade, profile, sequential. + - -\ **discoverytime**\ - +\ **discoverytime**\ + The last time that xCAT received the discovery message. + - -\ **arch**\ - +\ **arch**\ + The architecture of the discovered node. e.g. x86_64. + - -\ **cpucount**\ - +\ **cpucount**\ + The number of cores multiply by threads core supported for the discovered node. e.g. 192. + - -\ **cputype**\ - +\ **cputype**\ + The cpu type of the discovered node. e.g. Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz + - -\ **memory**\ - +\ **memory**\ + The memory size of the discovered node. e.g. 198460852 + - -\ **mtm**\ - +\ **mtm**\ + The machine type model of the discovered node. e.g. 786310X + - -\ **serial**\ - +\ **serial**\ + The serial number of the discovered node. e.g. 1052EFB + - -\ **nicdriver**\ - +\ **nicdriver**\ + The driver of the nic. The value should be comma separated . e.g. eth0!be2net,eth1!be2net + - -\ **nicipv4**\ - +\ **nicipv4**\ + The ipv4 address of the nic. The value should be comma separated . e.g. eth0!10.0.0.212/8 + - -\ **nichwaddr**\ - +\ **nichwaddr**\ + The hardware address of the nic. The should will be comma separated . e.g. eth0!34:40:B5:BE:DB:B0,eth1!34:40:B5:BE:DB:B4 + - -\ **nicpci**\ - +\ **nicpci**\ + The pic device of the nic. The value should be comma separated . e.g. eth0!0000:0c:00.0,eth1!0000:0c:00.1 + - -\ **nicloc**\ - +\ **nicloc**\ + The location of the nic. The value should be comma separated . e.g. eth0!Onboard Ethernet 1,eth1!Onboard Ethernet 2 + - -\ **niconboard**\ - +\ **niconboard**\ + The onboard info of the nic. The value should be comma separated . e.g. eth0!1,eth1!2 + - -\ **nicfirm**\ - +\ **nicfirm**\ + The firmware description of the nic. The value should be comma separated . e.g. eth0!ServerEngines BE3 Controller,eth1!ServerEngines BE3 Controller + - -\ **switchname**\ - +\ **switchname**\ + The switch name which the nic connected to. The value should be comma separated . e.g. eth0!c909f06sw01 + - -\ **switchaddr**\ - +\ **switchaddr**\ + The address of the switch which the nic connected to. The value should be comma separated . e.g. eth0!192.168.70.120 + - -\ **switchdesc**\ - +\ **switchdesc**\ + The description of the switch which the nic connected to. The value should be comma separated . e.g. eth0!IBM Flex System Fabric EN4093 10Gb Scalable Switch, flash image: version 7.2.6, boot image: version 7.2.6 + - -\ **switchport**\ - +\ **switchport**\ + The port of the switch that the nic connected to. The value should be comma separated . e.g. eth0!INTA2 + - -\ **otherdata**\ - +\ **otherdata**\ + The left data which is not parsed to specific attributes (The complete message comes from genesis) + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -186,5 +186,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/domain.5.rst b/docs/source/guides/admin-guides/references/man5/domain.5.rst index 724d6d4da..73cc78ebb 100644 --- a/docs/source/guides/admin-guides/references/man5/domain.5.rst +++ b/docs/source/guides/admin-guides/references/man5/domain.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **domain Attributes:**\ \ *node*\ , \ *ou*\ , \ *authdomain*\ , \ *adminuser*\ , \ *adminpassword*\ , \ *type*\ , \ *comments*\ , \ *disable*\ +\ **domain Attributes:**\ \ *node*\ , \ *ou*\ , \ *authdomain*\ , \ *adminuser*\ , \ *adminpassword*\ , \ *type*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,52 +36,52 @@ domain Attributes: -\ **node**\ - +\ **node**\ + The node or group the entry applies to + - -\ **ou**\ - +\ **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 + - -\ **authdomain**\ - +\ **authdomain**\ + If a node should participate in an AD domain or Kerberos realm distinct from domain indicated in site, this field can be used to specify that + - -\ **adminuser**\ - +\ **adminuser**\ + Allow a node specific indication of Administrative user. Most will want to just use passwd table to indicate this once rather than by node. + - -\ **adminpassword**\ - +\ **adminpassword**\ + Allow a node specific indication of Administrative user password for the domain. Most will want to ignore this in favor of passwd table. + - -\ **type**\ - +\ **type**\ + Type, if any, of authentication domain to manipulate. The only recognized value at the moment is activedirectory. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -90,5 +90,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/eventlog.5.rst b/docs/source/guides/admin-guides/references/man5/eventlog.5.rst index bc82fc48e..f75afb9de 100644 --- a/docs/source/guides/admin-guides/references/man5/eventlog.5.rst +++ b/docs/source/guides/admin-guides/references/man5/eventlog.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **eventlog Attributes:**\ \ *recid*\ , \ *eventtime*\ , \ *eventtype*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *application*\ , \ *component*\ , \ *id*\ , \ *severity*\ , \ *message*\ , \ *rawdata*\ , \ *comments*\ , \ *disable*\ +\ **eventlog Attributes:**\ \ *recid*\ , \ *eventtime*\ , \ *eventtype*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *application*\ , \ *component*\ , \ *id*\ , \ *severity*\ , \ *message*\ , \ *rawdata*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,88 +36,88 @@ eventlog Attributes: -\ **recid**\ - +\ **recid**\ + The record id. + - -\ **eventtime**\ - +\ **eventtime**\ + The timestamp for the event. + - -\ **eventtype**\ - +\ **eventtype**\ + The type of the event. + - -\ **monitor**\ - +\ **monitor**\ + The name of the monitor that monitors this event. + - -\ **monnode**\ - +\ **monnode**\ + The node that monitors this event. + - -\ **node**\ - +\ **node**\ + The node where the event occurred. + - -\ **application**\ - +\ **application**\ + The application that reports the event. + - -\ **component**\ - +\ **component**\ + The component where the event occurred. + - -\ **id**\ - +\ **id**\ + The location or the resource name where the event occurred. + - -\ **severity**\ - +\ **severity**\ + The severity of the event. Valid values are: informational, warning, critical. + - -\ **message**\ - +\ **message**\ + The full description of the event. + - -\ **rawdata**\ - +\ **rawdata**\ + The data that associated with the event. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Do not use. tabprune will not work if set to yes or 1 - + @@ -126,5 +126,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/firmware.5.rst b/docs/source/guides/admin-guides/references/man5/firmware.5.rst index 358c49dc0..3b41f261f 100644 --- a/docs/source/guides/admin-guides/references/man5/firmware.5.rst +++ b/docs/source/guides/admin-guides/references/man5/firmware.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **firmware Attributes:**\ \ *node*\ , \ *cfgfile*\ , \ *comments*\ , \ *disable*\ +\ **firmware Attributes:**\ \ *node*\ , \ *cfgfile*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,28 +36,28 @@ firmware Attributes: -\ **node**\ - +\ **node**\ + The node id. + - -\ **cfgfile**\ - +\ **cfgfile**\ + The file to use. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -66,5 +66,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/hosts.5.rst b/docs/source/guides/admin-guides/references/man5/hosts.5.rst index d18fbd6da..2771c52d9 100644 --- a/docs/source/guides/admin-guides/references/man5/hosts.5.rst +++ b/docs/source/guides/admin-guides/references/man5/hosts.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **hosts Attributes:**\ \ *node*\ , \ *ip*\ , \ *hostnames*\ , \ *otherinterfaces*\ , \ *comments*\ , \ *disable*\ +\ **hosts Attributes:**\ \ *node*\ , \ *ip*\ , \ *hostnames*\ , \ *otherinterfaces*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ hosts Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **ip**\ - +\ **ip**\ + The IP address of the node. This is only used in makehosts. The rest of xCAT uses system name resolution to resolve node names to IP addresses. + - -\ **hostnames**\ - +\ **hostnames**\ + Hostname aliases added to /etc/hosts for this node. Comma or blank separated list. + - -\ **otherinterfaces**\ - +\ **otherinterfaces**\ + Other IP addresses to add for this node. Format: -:,:,... + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/hwinv.5.rst b/docs/source/guides/admin-guides/references/man5/hwinv.5.rst index b74b094d9..626fee9c2 100644 --- a/docs/source/guides/admin-guides/references/man5/hwinv.5.rst +++ b/docs/source/guides/admin-guides/references/man5/hwinv.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **hwinv Attributes:**\ \ *node*\ , \ *cputype*\ , \ *cpucount*\ , \ *memory*\ , \ *disksize*\ , \ *comments*\ , \ *disable*\ +\ **hwinv Attributes:**\ \ *node*\ , \ *cputype*\ , \ *cpucount*\ , \ *memory*\ , \ *disksize*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ hwinv Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **cputype**\ - +\ **cputype**\ + The cpu model name for the node. + - -\ **cpucount**\ - +\ **cpucount**\ + The number of cpus for the node. + - -\ **memory**\ - +\ **memory**\ + The size of the memory for the node in MB. + - -\ **disksize**\ - +\ **disksize**\ + The size of the disks for the node in GB. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/hypervisor.5.rst b/docs/source/guides/admin-guides/references/man5/hypervisor.5.rst index 2c9886af6..c3f9e3a4c 100644 --- a/docs/source/guides/admin-guides/references/man5/hypervisor.5.rst +++ b/docs/source/guides/admin-guides/references/man5/hypervisor.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **hypervisor Attributes:**\ \ *node*\ , \ *type*\ , \ *mgr*\ , \ *interface*\ , \ *netmap*\ , \ *defaultnet*\ , \ *cluster*\ , \ *datacenter*\ , \ *preferdirect*\ , \ *comments*\ , \ *disable*\ +\ **hypervisor Attributes:**\ \ *node*\ , \ *type*\ , \ *mgr*\ , \ *interface*\ , \ *netmap*\ , \ *defaultnet*\ , \ *cluster*\ , \ *datacenter*\ , \ *preferdirect*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,65 +36,65 @@ hypervisor Attributes: -\ **node**\ - +\ **node**\ + The node or static group name + - -\ **type**\ - +\ **type**\ + The plugin associated with hypervisor specific commands such as revacuate + - -\ **mgr**\ - +\ **mgr**\ + The virtualization specific manager of this hypervisor when applicable + - -\ **interface**\ - +\ **interface**\ + The definition of interfaces for the hypervisor. The format is [networkname:interfacename:bootprotocol:IP:netmask:gateway] that split with | for each interface + - -\ **netmap**\ - +\ **netmap**\ + Optional mapping of useful names to relevant physical ports. For example, 10ge=vmnic_16.0&vmnic_16.1,ge=vmnic1 would be requesting two virtual switches to be created, one called 10ge with vmnic_16.0 and vmnic_16.1 bonded, and another simply connected to vmnic1. Use of this allows abstracting guests from network differences amongst hypervisors + - -\ **defaultnet**\ - +\ **defaultnet**\ + Optionally specify a default network entity for guests to join to if they do not specify. + - -\ **cluster**\ - +\ **cluster**\ + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + - -\ **datacenter**\ - +\ **datacenter**\ + Optionally specify a datacenter for the hypervisor to exist in (only applicable to VMWare) + - -\ **preferdirect**\ - +\ **preferdirect**\ + If a mgr is declared for a hypervisor, xCAT will default to using the mgr for all operations. If this is field is set to yes or 1, xCAT will prefer to directly communicate with the hypervisor if possible + + + +\ **comments**\ -\ **comments**\ - - - -\ **disable**\ +\ **disable**\ @@ -104,5 +104,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/ipmi.5.rst b/docs/source/guides/admin-guides/references/man5/ipmi.5.rst index 0d45e562d..1912e186c 100644 --- a/docs/source/guides/admin-guides/references/man5/ipmi.5.rst +++ b/docs/source/guides/admin-guides/references/man5/ipmi.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **ipmi Attributes:**\ \ *node*\ , \ *bmc*\ , \ *bmcport*\ , \ *taggedvlan*\ , \ *bmcid*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ +\ **ipmi Attributes:**\ \ *node*\ , \ *bmc*\ , \ *bmcport*\ , \ *taggedvlan*\ , \ *bmcid*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,98 +36,98 @@ ipmi Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **bmc**\ - +\ **bmc**\ + The hostname of the BMC adapter. + - -\ **bmcport**\ - +\ **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. - - + + .. code-block:: perl - + The following special cases exist for IBM System x servers: - + For x3755 M3 systems, 0 means use the dedicated port, 1 means shared, blank is to not assign. - + For certain systems which have a mezzaine or ML2 adapter, there is a second value to include: - - + + For x3750 M4 (Model 8722): - - + + 0 2 1st 1Gbps interface for LOM - + 0 0 1st 10Gbps interface for LOM - + 0 3 2nd 1Gbps interface for LOM - + 0 1 2nd 10Gbps interface for LOM - - + + For x3750 M4 (Model 8752), x3850/3950 X6, dx360 M4, x3550 M4, and x3650 M4: - - + + 0 Shared (1st onboard interface) - + 1 Dedicated - + 2 0 First interface on ML2 or mezzanine adapter - + 2 1 Second interface on ML2 or mezzanine adapter - + 2 2 Third interface on ML2 or mezzanine adapter - + 2 3 Fourth interface on ML2 or mezzanine adapter + + - - -\ **taggedvlan**\ - +\ **taggedvlan**\ + bmcsetup script will configure the network interface of the BMC to be tagged to the VLAN specified. + - -\ **bmcid**\ - +\ **bmcid**\ + Unique identified data used by discovery processes to distinguish known BMCs from unrecognized BMCs + - -\ **username**\ - +\ **username**\ + The BMC userid. If not specified, the key=ipmi row in the passwd table is used as the default. + - -\ **password**\ - +\ **password**\ + The BMC password. If not specified, the key=ipmi row in the passwd table is used as the default. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -136,5 +136,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/iscsi.5.rst b/docs/source/guides/admin-guides/references/man5/iscsi.5.rst index 6371674ee..48a91d893 100644 --- a/docs/source/guides/admin-guides/references/man5/iscsi.5.rst +++ b/docs/source/guides/admin-guides/references/man5/iscsi.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **iscsi Attributes:**\ \ *node*\ , \ *server*\ , \ *target*\ , \ *lun*\ , \ *iname*\ , \ *file*\ , \ *userid*\ , \ *passwd*\ , \ *kernel*\ , \ *kcmdline*\ , \ *initrd*\ , \ *comments*\ , \ *disable*\ +\ **iscsi Attributes:**\ \ *node*\ , \ *server*\ , \ *target*\ , \ *lun*\ , \ *iname*\ , \ *file*\ , \ *userid*\ , \ *passwd*\ , \ *kernel*\ , \ *kcmdline*\ , \ *initrd*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,82 +36,82 @@ iscsi Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **server**\ - +\ **server**\ + The server containing the iscsi boot device for this node. + - -\ **target**\ - +\ **target**\ + The iscsi disk used for the boot device for this node. Filled in by xCAT. + - -\ **lun**\ - +\ **lun**\ + LUN of boot device. Per RFC-4173, this is presumed to be 0 if unset. tgtd often requires this to be 1 + - -\ **iname**\ - +\ **iname**\ + Initiator name. Currently unused. + - -\ **file**\ - +\ **file**\ + The path on the server of the OS image the node should boot from. + - -\ **userid**\ - +\ **userid**\ + The userid of the iscsi server containing the boot device for this node. + - -\ **passwd**\ - +\ **passwd**\ + The password for the iscsi server containing the boot device for this node. + - -\ **kernel**\ - +\ **kernel**\ + The path of the linux kernel to boot from. + - -\ **kcmdline**\ - +\ **kcmdline**\ + The kernel command line to use with iSCSI for this node. + - -\ **initrd**\ - +\ **initrd**\ + The initial ramdisk to use when network booting this node. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -120,5 +120,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/kit.5.rst b/docs/source/guides/admin-guides/references/man5/kit.5.rst index 3ffd4f226..af76b1134 100644 --- a/docs/source/guides/admin-guides/references/man5/kit.5.rst +++ b/docs/source/guides/admin-guides/references/man5/kit.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kit Attributes:**\ \ *kitname*\ , \ *basename*\ , \ *description*\ , \ *version*\ , \ *release*\ , \ *ostype*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *comments*\ , \ *disable*\ +\ **kit Attributes:**\ \ *kitname*\ , \ *basename*\ , \ *description*\ , \ *version*\ , \ *release*\ , \ *ostype*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,70 +36,70 @@ kit Attributes: -\ **kitname**\ - +\ **kitname**\ + The unique generated kit name, when kit is added to the cluster. + - -\ **basename**\ - +\ **basename**\ + The kit base name + - -\ **description**\ - +\ **description**\ + The Kit description. + - -\ **version**\ - +\ **version**\ + The kit version + - -\ **release**\ - +\ **release**\ + The kit release + - -\ **ostype**\ - +\ **ostype**\ + The kit OS type. Linux or AIX. + - -\ **isinternal**\ - +\ **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**\ - +\ **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**\ - +\ **kitdir**\ + The path to Kit Installation directory on the Mgt Node. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -108,5 +108,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/kitcomponent.5.rst b/docs/source/guides/admin-guides/references/man5/kitcomponent.5.rst index cd52254e8..ac48fa7a0 100644 --- a/docs/source/guides/admin-guides/references/man5/kitcomponent.5.rst +++ b/docs/source/guides/admin-guides/references/man5/kitcomponent.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kitcomponent Attributes:**\ \ *kitcompname*\ , \ *description*\ , \ *kitname*\ , \ *kitreponame*\ , \ *basename*\ , \ *version*\ , \ *release*\ , \ *serverroles*\ , \ *kitpkgdeps*\ , \ *prerequisite*\ , \ *driverpacks*\ , \ *kitcompdeps*\ , \ *postbootscripts*\ , \ *genimage_postinstall*\ , \ *exlist*\ , \ *comments*\ , \ *disable*\ +\ **kitcomponent Attributes:**\ \ *kitcompname*\ , \ *description*\ , \ *kitname*\ , \ *kitreponame*\ , \ *basename*\ , \ *version*\ , \ *release*\ , \ *serverroles*\ , \ *kitpkgdeps*\ , \ *prerequisite*\ , \ *driverpacks*\ , \ *kitcompdeps*\ , \ *postbootscripts*\ , \ *genimage_postinstall*\ , \ *exlist*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,106 +36,106 @@ kitcomponent Attributes: -\ **kitcompname**\ - +\ **kitcompname**\ + The unique Kit Component name. It is auto-generated when the parent Kit is added to the cluster. + - -\ **description**\ - +\ **description**\ + The Kit component description. + - -\ **kitname**\ - +\ **kitname**\ + The Kit name which this Kit Component belongs to. + - -\ **kitreponame**\ - +\ **kitreponame**\ + The Kit Package Repository name which this Kit Component belongs to. + - -\ **basename**\ - +\ **basename**\ + Kit Component basename. + - -\ **version**\ - +\ **version**\ + Kit Component version. + - -\ **release**\ - +\ **release**\ + Kit Component release. + - -\ **serverroles**\ - +\ **serverroles**\ + The types of servers that this Kit Component can install on. Valid types are: mgtnode, servicenode, compute + - -\ **kitpkgdeps**\ - +\ **kitpkgdeps**\ + Comma-separated list of packages that this kit component depends on. + - -\ **prerequisite**\ - +\ **prerequisite**\ + Prerequisite for this kit component, the prerequisite includes ospkgdeps,preinstall,preupgrade,preuninstall scripts + - -\ **driverpacks**\ - +\ **driverpacks**\ + Comma-separated List of driver package names. These must be full names like: pkg1-1.0-1.x86_64.rpm. + - -\ **kitcompdeps**\ - +\ **kitcompdeps**\ + Comma-separated list of kit components that this kit component depends on. + - -\ **postbootscripts**\ - +\ **postbootscripts**\ + Comma-separated list of postbootscripts that will run during the node boot. + - -\ **genimage_postinstall**\ - +\ **genimage_postinstall**\ + Comma-separated list of postinstall scripts that will run during the genimage. + - -\ **exlist**\ - +\ **exlist**\ + Exclude list file containing the files/directories to exclude when building a diskless image. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -144,5 +144,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/kitrepo.5.rst b/docs/source/guides/admin-guides/references/man5/kitrepo.5.rst index 5a47317db..da260bccb 100644 --- a/docs/source/guides/admin-guides/references/man5/kitrepo.5.rst +++ b/docs/source/guides/admin-guides/references/man5/kitrepo.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kitrepo Attributes:**\ \ *kitreponame*\ , \ *kitname*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ , \ *osarch*\ , \ *compat_osbasenames*\ , \ *kitrepodir*\ , \ *comments*\ , \ *disable*\ +\ **kitrepo Attributes:**\ \ *kitreponame*\ , \ *kitname*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ , \ *osarch*\ , \ *compat_osbasenames*\ , \ *kitrepodir*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,64 +36,64 @@ kitrepo Attributes: -\ **kitreponame**\ - +\ **kitreponame**\ + The unique generated kit repo package name, when kit is added to the cluster. + - -\ **kitname**\ - +\ **kitname**\ + The Kit name which this Kit Package Repository belongs to. + - -\ **osbasename**\ - +\ **osbasename**\ + The OS distro name which this repository is based on. + - -\ **osmajorversion**\ - +\ **osmajorversion**\ + The OS distro major version which this repository is based on. + - -\ **osminorversion**\ - +\ **osminorversion**\ + The OS distro minor version which this repository is based on. If this attribute is not set, it means that this repo applies to all minor versions. + - -\ **osarch**\ - +\ **osarch**\ + The OS distro arch which this repository is based on. + - -\ **compat_osbasenames**\ - +\ **compat_osbasenames**\ + List of compatible OS base names. + - -\ **kitrepodir**\ - +\ **kitrepodir**\ + The path to Kit Repository directory on the Mgt Node. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -102,5 +102,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst b/docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst index d9a70a8c3..7ac2d011a 100644 --- a/docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst +++ b/docs/source/guides/admin-guides/references/man5/kvm_masterdata.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kvm_masterdata Attributes:**\ \ *name*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ +\ **kvm_masterdata Attributes:**\ \ *name*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,26 +36,26 @@ kvm_masterdata Attributes: -\ **name**\ - +\ **name**\ + The name of the relevant master + - -\ **xml**\ - +\ **xml**\ + The XML description to be customized for clones of this master + + + +\ **comments**\ -\ **comments**\ - - - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -64,5 +64,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst b/docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst index b564c9979..c2286a413 100644 --- a/docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst +++ b/docs/source/guides/admin-guides/references/man5/kvm_nodedata.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kvm_nodedata Attributes:**\ \ *node*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ +\ **kvm_nodedata Attributes:**\ \ *node*\ , \ *xml*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,28 +36,28 @@ kvm_nodedata Attributes: -\ **node**\ - +\ **node**\ + The node corresponding to the virtual machine + - -\ **xml**\ - +\ **xml**\ + The XML description generated by xCAT, fleshed out by libvirt, and stored for reuse + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -66,5 +66,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/linuximage.5.rst b/docs/source/guides/admin-guides/references/man5/linuximage.5.rst index f5c879187..c39c9ff3d 100644 --- a/docs/source/guides/admin-guides/references/man5/linuximage.5.rst +++ b/docs/source/guides/admin-guides/references/man5/linuximage.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **linuximage Attributes:**\ \ *imagename*\ , \ *template*\ , \ *boottarget*\ , \ *addkcmdline*\ , \ *pkglist*\ , \ *pkgdir*\ , \ *otherpkglist*\ , \ *otherpkgdir*\ , \ *exlist*\ , \ *postinstall*\ , \ *rootimgdir*\ , \ *kerneldir*\ , \ *nodebootif*\ , \ *otherifce*\ , \ *netdrivers*\ , \ *kernelver*\ , \ *krpmver*\ , \ *permission*\ , \ *dump*\ , \ *crashkernelsize*\ , \ *partitionfile*\ , \ *driverupdatesrc*\ , \ *comments*\ , \ *disable*\ +\ **linuximage Attributes:**\ \ *imagename*\ , \ *template*\ , \ *boottarget*\ , \ *addkcmdline*\ , \ *pkglist*\ , \ *pkgdir*\ , \ *otherpkglist*\ , \ *otherpkgdir*\ , \ *exlist*\ , \ *postinstall*\ , \ *rootimgdir*\ , \ *kerneldir*\ , \ *nodebootif*\ , \ *otherifce*\ , \ *netdrivers*\ , \ *kernelver*\ , \ *krpmver*\ , \ *permission*\ , \ *dump*\ , \ *crashkernelsize*\ , \ *partitionfile*\ , \ *driverupdatesrc*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,67 +36,67 @@ linuximage Attributes: -\ **imagename**\ - +\ **imagename**\ + The name of this xCAT OS image definition. + - -\ **template**\ - +\ **template**\ + The fully qualified name of the template file that will be used to create the OS installer configuration file for stateful installations (e.g. kickstart for RedHat, autoyast for SLES). + - -\ **boottarget**\ - +\ **boottarget**\ + The name of the boottarget definition. When this attribute is set, xCAT will use the kernel, initrd and kernel params defined in the boottarget definition instead of the default. + - -\ **addkcmdline**\ - +\ **addkcmdline**\ + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" "). This attribute is ignored if linuximage.boottarget is set. + - -\ **pkglist**\ - +\ **pkglist**\ + The fully qualified name of the file that stores the distro packages list that will be included in the image. Make sure that if the pkgs in the pkglist have dependency pkgs, the dependency pkgs should be found in one of the pkgdir + - -\ **pkgdir**\ - +\ **pkgdir**\ + The name of the directory where the distro packages are stored. It could be set to multiple paths. The multiple paths must be separated by ",". The first path in the value of osimage.pkgdir must be the OS base pkg dir path, such as pkgdir=/install/rhels6.2/x86_64,/install/updates . In the os base pkg path, there are default repository data. And in the other pkg path(s), the users should make sure there are repository data. If not, use "createrepo" command to create them. For ubuntu, multiple mirrors can be specified in the pkgdir attribute, the mirrors must be prefixed by the protocol(http/ssh) and delimited with "," between each other. + - -\ **otherpkglist**\ - +\ **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 to multiple paths. The multiple paths must be separated by ",". + - -\ **otherpkgdir**\ - +\ **otherpkgdir**\ + The base directory and urls of internet repos from which the non-distro packages are retrived. Only 1 local directory is supported at present. The entries should be delimited with comma ",". Currently, the internet repos are only supported on Ubuntu and Redhat. + - -\ **exlist**\ - +\ **exlist**\ + The fully qualified name of the file that stores the file names and directory names that will be excluded from the image during packimage command. It is used for diskless image only. + - -\ **postinstall**\ - +\ **postinstall**\ + Supported in diskless image only. The fully qualified name of the scripts and the user-specified arguments running in non-chroot mode after the package installation but before initrd generation during genimage. If multiple scripts are specified, they should be seperated with comma ",". The arguments passed to each postinstall script include 4 implicit arguments(,,,) and the user-specified arguments. A set of osimage attributes are exported as the environment variables to be used in the postinstall scripts: - - + + .. code-block:: perl - + IMG_ARCH(The architecture of the osimage, such as "ppc64le","x86_64"), IMG_NAME(The name of the osimage, such as "rhels7.3-ppc64le-netboot-compute"), IMG_OSVER(The os release of the osimage, such as "rhels7.3","sles11.4"), @@ -107,72 +107,72 @@ linuximage Attributes: IMG_OTHERPKGLIST(the "otherpkglist" attribute of the osimage), IMG_OTHERPKGDIR(the "otherpkgdir" attribute of the osimage), IMG_ROOTIMGDIR(the "rootimgdir" attribute of the osimage) + + - - -\ **rootimgdir**\ - +\ **rootimgdir**\ + The directory name where the image is stored. It is generally used for diskless image. it also can be used in sysclone environment to specify where the image captured from golden client is stored. in sysclone environment, rootimgdir is generally assigned to some default value by xcat, but you can specify your own store directory. just one thing need to be noticed, wherever you save the image, the name of last level directory must be the name of image. for example, if your image name is testimage and you want to save this image under home directoy, rootimgdir should be assigned to value /home/testimage/ + - -\ **kerneldir**\ - +\ **kerneldir**\ + The directory name where the 3rd-party kernel is stored. It is used for diskless image only. + - -\ **nodebootif**\ - +\ **nodebootif**\ + The network interface the stateless/statelite node will boot over (e.g. eth0) + - -\ **otherifce**\ - +\ **otherifce**\ + Other network interfaces (e.g. eth1) in the image that should be configured via DHCP + - -\ **netdrivers**\ - +\ **netdrivers**\ + The ethernet device drivers of the nodes which will use this linux image, at least the device driver for the nodes' installnic should be included + - -\ **kernelver**\ - +\ **kernelver**\ + The version of linux kernel used in the linux image. If the kernel version is not set, the default kernel in rootimgdir will be used + - -\ **krpmver**\ - +\ **krpmver**\ + The rpm version of kernel packages (for SLES only). If it is not set, the default rpm version of kernel packages will be used. + - -\ **permission**\ - +\ **permission**\ + The mount permission of /.statelite directory is used, its default value is 755 + - -\ **dump**\ - +\ **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. + - -\ **crashkernelsize**\ - +\ **crashkernelsize**\ + the size that assigned to the kdump kernel. If the kernel size is not set, 256M will be the default value. + - -\ **partitionfile**\ - +\ **partitionfile**\ + Only available for diskful osimages and statelite osimages(localdisk enabled). The full path of the partition file or the script to generate the partition file. The valid value includes: "": For diskful osimages, the partition file contains the partition definition that will be inserted directly into the template file for os installation. The syntax and format of the partition file should confirm to the corresponding OS installer of the Linux distributions(e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). For statelite osimages, when the localdisk is enabled, the partition file with specific syntax and format includes the partition scheme of the local disk, please refer to the statelite documentation for details. "s:": a shell script to generate the partition file "/tmp/partitionfile" inside the installer before the installation start. @@ -180,25 +180,25 @@ linuximage Attributes: "s:d:": only available for ubuntu osimages, a script to generate the disk name file "/tmp/xcat.install_disk" inside the debian installer. This script is run in the "pressed/early_command" section. "c:": only availbe for ubuntu osimages, contains the additional pressed entries in "d-i ..." form. This can be used to specify some additional preseed options to support RAID or LVM in Ubuntu. "s:c:": only available for ubuntu osimages, runs in pressed/early_command and set the preseed values with "debconf-set". The multiple values should be delimited with comma "," + - -\ **driverupdatesrc**\ - +\ **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_source_file. The tab keyword can be: dud (for Driver update disk) and rpm (for driver rpm). If missing the tab, the rpm format is the default. e.g. dud:/install/dud/dd.img,rpm:/install/rpm/d.rpm + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -207,5 +207,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/litefile.5.rst b/docs/source/guides/admin-guides/references/man5/litefile.5.rst index e3c131f0a..220627f91 100644 --- a/docs/source/guides/admin-guides/references/man5/litefile.5.rst +++ b/docs/source/guides/admin-guides/references/man5/litefile.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **litefile Attributes:**\ \ *image*\ , \ *file*\ , \ *options*\ , \ *comments*\ , \ *disable*\ +\ **litefile Attributes:**\ \ *image*\ , \ *file*\ , \ *options*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,56 +36,56 @@ litefile Attributes: -\ **image**\ - +\ **image**\ + The name of the image (as specified in the osimage table) that will use these options on this dir/file. You can also specify an image group name that is listed in the osimage.groups attribute of some osimages. 'ALL' means use this row for all images. + - -\ **file**\ - +\ **file**\ + The full pathname of the file. e.g: /etc/hosts. If the path is a directory, then it should be terminated with a '/'. + - -\ **options**\ - +\ **options**\ + Options for the file: - - + + .. code-block:: perl - + tmpfs - It is the default option if you leave the options column blank. It provides a file or directory for the node to use when booting, its permission will be the same as the original version on the server. In most cases, it is read-write; however, on the next statelite boot, the original version of the file or directory on the server will be used, it means it is non-persistent. This option can be performed on files and directories.. - - rw - Same as above. Its name "rw" does NOT mean it always be read-write, even in most cases it is read-write. Do not confuse it with the "rw" permission in the file system. - - persistent - It provides a mounted file or directory that is copied to the xCAT persistent location and then over-mounted on the local file or directory. Anything written to that file or directory is preserved. It means, if the file/directory does not exist at first, it will be copied to the persistent location. Next time the file/directory in the persistent location will be used. The file/directory will be persistent across reboots. Its permission will be the same as the original one in the statelite location. It requires the statelite table to be filled out with a spot for persistent statelite. This option can be performed on files and directories. - + + rw - Same as above. Its name "rw" does NOT mean it always be read-write, even in most cases it is read-write. Do not confuse it with the "rw" permission in the file system. + + persistent - It provides a mounted file or directory that is copied to the xCAT persistent location and then over-mounted on the local file or directory. Anything written to that file or directory is preserved. It means, if the file/directory does not exist at first, it will be copied to the persistent location. Next time the file/directory in the persistent location will be used. The file/directory will be persistent across reboots. Its permission will be the same as the original one in the statelite location. It requires the statelite table to be filled out with a spot for persistent statelite. This option can be performed on files and directories. + con - The contents of the pathname are concatenated to the contents of the existing file. For this directive the searching in the litetree hierarchy does not stop when the first match is found. All files found in the hierarchy will be concatenated to the file when found. The permission of the file will be "-rw-r--r--", which means it is read-write for the root user, but readonly for the others. It is non-persistent, when the node reboots, all changes to the file will be lost. It can only be performed on files. Do not use it for one directory. - + ro - The file/directory will be overmounted read-only on the local file/directory. It will be located in the directory hierarchy specified in the litetree table. Changes made to this file or directory on the server will be immediately seen in this file/directory on the node. This option requires that the file/directory to be mounted must be available in one of the entries in the litetree table. This option can be performed on files and directories. - - link - It provides one file/directory for the node to use when booting, it is copied from the server, and will be placed in tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to one file/directory in tmpfs. And the permission of the symbolic link is "lrwxrwxrwx", which is not the real permission of the file/directory on the node. So for some application sensitive to file permissions, it will be one issue to use "link" as its option, for example, "/root/.ssh/", which is used for SSH, should NOT use "link" as its option. It is non-persistent, when the node is rebooted, all changes to the file/directory will be lost. This option can be performed on files and directories. - - link,con - It works similar to the "con" option. All the files found in the litetree hierarchy will be concatenated to the file when found. The final file will be put to the tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to the file/directory in tmpfs. It is non-persistent, when the node is rebooted, all changes to the file will be lost. The option can only be performed on files. - + + link - It provides one file/directory for the node to use when booting, it is copied from the server, and will be placed in tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to one file/directory in tmpfs. And the permission of the symbolic link is "lrwxrwxrwx", which is not the real permission of the file/directory on the node. So for some application sensitive to file permissions, it will be one issue to use "link" as its option, for example, "/root/.ssh/", which is used for SSH, should NOT use "link" as its option. It is non-persistent, when the node is rebooted, all changes to the file/directory will be lost. This option can be performed on files and directories. + + link,con - It works similar to the "con" option. All the files found in the litetree hierarchy will be concatenated to the file when found. The final file will be put to the tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to the file/directory in tmpfs. It is non-persistent, when the node is rebooted, all changes to the file will be lost. The option can only be performed on files. + link,persistent - It provides a mounted file or directory that is copied to the xCAT persistent location and then over-mounted to the tmpfs on the booted node, and finally the symbolic link in the local file system will be linked to the over-mounted tmpfs file/directory on the booted node. The file/directory will be persistent across reboots. The permission of the file/directory where the symbolic link points to will be the same as the original one in the statelite location. It requires the statelite table to be filled out with a spot for persistent statelite. The option can be performed on files and directories. - + link,ro - The file is readonly, and will be placed in tmpfs on the booted node. In the local file system of the booted node, it is one symbolic link to the tmpfs. It is non-persistent, when the node is rebooted, all changes to the file/directory will be lost. This option requires that the file/directory to be mounted must be available in one of the entries in the litetree table. The option can be performed on files and directories. + + - - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -94,5 +94,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/litetree.5.rst b/docs/source/guides/admin-guides/references/man5/litetree.5.rst index 473af0218..50d1eaa6f 100644 --- a/docs/source/guides/admin-guides/references/man5/litetree.5.rst +++ b/docs/source/guides/admin-guides/references/man5/litetree.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **litetree Attributes:**\ \ *priority*\ , \ *image*\ , \ *directory*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ +\ **litetree Attributes:**\ \ *priority*\ , \ *image*\ , \ *directory*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ litetree Attributes: -\ **priority**\ - +\ **priority**\ + This number controls what order the directories are searched. Directories are searched from smallest priority number to largest. + - -\ **image**\ - +\ **image**\ + The name of the image (as specified in the osimage table) that will use this directory. You can also specify an image group name that is listed in the osimage.groups attribute of some osimages. 'ALL' means use this row for all images. + - -\ **directory**\ - +\ **directory**\ + The location (hostname:path) of a directory that contains files specified in the litefile table. Variables are allowed. E.g: $noderes.nfsserver://xcatmasternode/install/$node/#CMD=uname-r#/ + - -\ **mntopts**\ - +\ **mntopts**\ + A comma-separated list of options to use when mounting the litetree directory. (Ex. 'soft') The default is to do a 'hard' mount. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/mac.5.rst b/docs/source/guides/admin-guides/references/man5/mac.5.rst index 4221756cc..993fdd0cf 100644 --- a/docs/source/guides/admin-guides/references/man5/mac.5.rst +++ b/docs/source/guides/admin-guides/references/man5/mac.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mac Attributes:**\ \ *node*\ , \ *interface*\ , \ *mac*\ , \ *comments*\ , \ *disable*\ +\ **mac Attributes:**\ \ *node*\ , \ *interface*\ , \ *mac*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ mac Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **interface**\ - +\ **interface**\ + The adapter interface name that will be used to install and manage the node. E.g. eth0 (for linux) or en0 (for AIX).) + - -\ **mac**\ - +\ **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. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/mic.5.rst b/docs/source/guides/admin-guides/references/man5/mic.5.rst index 07e543a4d..896113110 100644 --- a/docs/source/guides/admin-guides/references/man5/mic.5.rst +++ b/docs/source/guides/admin-guides/references/man5/mic.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mic Attributes:**\ \ *node*\ , \ *host*\ , \ *id*\ , \ *nodetype*\ , \ *bridge*\ , \ *onboot*\ , \ *vlog*\ , \ *powermgt*\ , \ *comments*\ , \ *disable*\ +\ **mic Attributes:**\ \ *node*\ , \ *host*\ , \ *id*\ , \ *nodetype*\ , \ *bridge*\ , \ *onboot*\ , \ *vlog*\ , \ *powermgt*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,64 +36,64 @@ mic Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **host**\ - +\ **host**\ + The host node which the mic card installed on. + - -\ **id**\ - +\ **id**\ + The device id of the mic node. + - -\ **nodetype**\ - +\ **nodetype**\ + The hardware type of the mic node. Generally, it is mic. + - -\ **bridge**\ - +\ **bridge**\ + The virtual bridge on the host node which the mic connected to. + - -\ **onboot**\ - +\ **onboot**\ + Set mic to autoboot when mpss start. Valid values: yes|no. Default is yes. + - -\ **vlog**\ - +\ **vlog**\ + Set the Verbose Log to console. Valid values: yes|no. Default is no. + - -\ **powermgt**\ - +\ **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. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Do not use. tabprune will not work if set to yes or 1 - + @@ -102,5 +102,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/monitoring.5.rst b/docs/source/guides/admin-guides/references/man5/monitoring.5.rst index 52d3079aa..6ea1f73d3 100644 --- a/docs/source/guides/admin-guides/references/man5/monitoring.5.rst +++ b/docs/source/guides/admin-guides/references/man5/monitoring.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **monitoring Attributes:**\ \ *name*\ , \ *nodestatmon*\ , \ *comments*\ , \ *disable*\ +\ **monitoring Attributes:**\ \ *name*\ , \ *nodestatmon*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,28 +36,28 @@ monitoring Attributes: -\ **name**\ - +\ **name**\ + The name of the monitoring plug-in module. The plug-in must be put in /lib/perl/xCAT_monitoring/. See the man page for monstart for details. + - -\ **nodestatmon**\ - +\ **nodestatmon**\ + Specifies if the monitoring plug-in is used to feed the node status to the xCAT cluster. Any one of the following values indicates "yes": y, Y, yes, Yes, YES, 1. Any other value or blank (default), indicates "no". + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -66,5 +66,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/monsetting.5.rst b/docs/source/guides/admin-guides/references/man5/monsetting.5.rst index ebe081dc3..d14541ee0 100644 --- a/docs/source/guides/admin-guides/references/man5/monsetting.5.rst +++ b/docs/source/guides/admin-guides/references/man5/monsetting.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **monsetting Attributes:**\ \ *name*\ , \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ +\ **monsetting Attributes:**\ \ *name*\ , \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ monsetting Attributes: -\ **name**\ - +\ **name**\ + The name of the monitoring plug-in module. The plug-in must be put in /lib/perl/xCAT_monitoring/. See the man page for monstart for details. + - -\ **key**\ - +\ **key**\ + Specifies the name of the attribute. The valid values are specified by each monitoring plug-in. Use "monls name -d" to get a list of valid keys. + - -\ **value**\ - +\ **value**\ + Specifies the value of the attribute. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/mp.5.rst b/docs/source/guides/admin-guides/references/man5/mp.5.rst index ff110772d..ee046aee4 100644 --- a/docs/source/guides/admin-guides/references/man5/mp.5.rst +++ b/docs/source/guides/admin-guides/references/man5/mp.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mp Attributes:**\ \ *node*\ , \ *mpa*\ , \ *id*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ +\ **mp Attributes:**\ \ *node*\ , \ *mpa*\ , \ *id*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ mp Attributes: -\ **node**\ - +\ **node**\ + The blade node name or group name. + - -\ **mpa**\ - +\ **mpa**\ + The management module used to control this blade. + - -\ **id**\ - +\ **id**\ + The slot number of this blade in the BladeCenter chassis. + - -\ **nodetype**\ - +\ **nodetype**\ + The hardware type for mp node. Valid values: mm,cmm, blade. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/mpa.5.rst b/docs/source/guides/admin-guides/references/man5/mpa.5.rst index 71d846ac6..4b03e9d12 100644 --- a/docs/source/guides/admin-guides/references/man5/mpa.5.rst +++ b/docs/source/guides/admin-guides/references/man5/mpa.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mpa Attributes:**\ \ *mpa*\ , \ *username*\ , \ *password*\ , \ *displayname*\ , \ *slots*\ , \ *urlpath*\ , \ *comments*\ , \ *disable*\ +\ **mpa Attributes:**\ \ *mpa*\ , \ *username*\ , \ *password*\ , \ *displayname*\ , \ *slots*\ , \ *urlpath*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,60 +36,60 @@ mpa Attributes: -\ **mpa**\ - +\ **mpa**\ + Hostname of the management module. + - -\ **username**\ - +\ **username**\ + Userid to use to access the management module. + - -\ **password**\ - +\ **password**\ + Password to use to access the management module. If not specified, the key=blade row in the passwd table is used as the default. + - -\ **displayname**\ - +\ **displayname**\ + Alternative name for BladeCenter chassis. Only used by PCM. + - -\ **slots**\ - +\ **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 + + - - -\ **urlpath**\ - +\ **urlpath**\ + URL path for the Chassis web interface. The full URL is built as follows: / + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -98,5 +98,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/networks.5.rst b/docs/source/guides/admin-guides/references/man5/networks.5.rst index 14358db0e..c71afb5f2 100644 --- a/docs/source/guides/admin-guides/references/man5/networks.5.rst +++ b/docs/source/guides/admin-guides/references/man5/networks.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **networks Attributes:**\ \ *netname*\ , \ *net*\ , \ *mask*\ , \ *mgtifname*\ , \ *gateway*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nameservers*\ , \ *ntpservers*\ , \ *logservers*\ , \ *dynamicrange*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *nodehostname*\ , \ *ddnsdomain*\ , \ *vlanid*\ , \ *domain*\ , \ *mtu*\ , \ *comments*\ , \ *disable*\ +\ **networks Attributes:**\ \ *netname*\ , \ *net*\ , \ *mask*\ , \ *mgtifname*\ , \ *gateway*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nameservers*\ , \ *ntpservers*\ , \ *logservers*\ , \ *dynamicrange*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *nodehostname*\ , \ *ddnsdomain*\ , \ *vlanid*\ , \ *domain*\ , \ *mtu*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,122 +36,122 @@ networks Attributes: -\ **netname**\ - +\ **netname**\ + Name used to identify this network definition. + - -\ **net**\ - +\ **net**\ + The network address. + - -\ **mask**\ - +\ **mask**\ + The network mask. + - -\ **mgtifname**\ - +\ **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. + - -\ **gateway**\ - +\ **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. + - -\ **dhcpserver**\ - +\ **dhcpserver**\ + The DHCP server that is servicing this network. Required to be explicitly set for pooled service node operation. + - -\ **tftpserver**\ - +\ **tftpserver**\ + The TFTP server that is servicing this network. If not set, the DHCP server is assumed. + - -\ **nameservers**\ - +\ **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. + - -\ **ntpservers**\ - +\ **ntpservers**\ + The ntp servers for this network. Used in creating the DHCP network definition. Assumed to be the DHCP server if not set. + - -\ **logservers**\ - +\ **logservers**\ + The log servers for this network. Used in creating the DHCP network definition. Assumed to be the DHCP server if not set. + - -\ **dynamicrange**\ - +\ **dynamicrange**\ + The IP address range used by DHCP to assign dynamic IP addresses for requests on this network. This should not overlap with entities expected to be configured with static host declarations, i.e. anything ever expected to be a node with an address registered in the mac table. + - -\ **staticrange**\ - +\ **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**\ -\ **staticrangeincrement**\ - - - -\ **nodehostname**\ - +\ **nodehostname**\ + A regular expression used to specify node name to network-specific hostname. i.e. "/\z/-secondary/" would mean that the hostname of "n1" would be n1-secondary on this network. By default, the nodename is assumed to equal the hostname, followed by nodename-interfacename. + - -\ **ddnsdomain**\ - +\ **ddnsdomain**\ + A domain to be combined with nodename to construct FQDN for DDNS updates induced by DHCP. This is not passed down to the client as "domain" + - -\ **vlanid**\ - +\ **vlanid**\ + The vlan ID if this network is within a vlan. + - -\ **domain**\ - +\ **domain**\ + The DNS domain name (ex. cluster.com). + - -\ **mtu**\ - +\ **mtu**\ + The default MTU for the network, If multiple networks are applied to the same nic on the SN and/or CN, the MTU shall be the same for those networks. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -160,5 +160,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nics.5.rst b/docs/source/guides/admin-guides/references/man5/nics.5.rst index cf264ff18..3ef6f1716 100644 --- a/docs/source/guides/admin-guides/references/man5/nics.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nics.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nics Attributes:**\ \ *node*\ , \ *nicips*\ , \ *nichostnamesuffixes*\ , \ *nichostnameprefixes*\ , \ *nictypes*\ , \ *niccustomscripts*\ , \ *nicnetworks*\ , \ *nicaliases*\ , \ *nicextraparams*\ , \ *nicdevices*\ , \ *nicsadapter*\ , \ *comments*\ , \ *disable*\ +\ **nics Attributes:**\ \ *node*\ , \ *nicips*\ , \ *nichostnamesuffixes*\ , \ *nichostnameprefixes*\ , \ *nictypes*\ , \ *niccustomscripts*\ , \ *nicnetworks*\ , \ *nicaliases*\ , \ *nicextraparams*\ , \ *nicdevices*\ , \ *nicsadapter*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,42 +36,42 @@ nics Attributes: -\ **node**\ - +\ **node**\ + The node or group name. + - -\ **nicips**\ - +\ **nicips**\ + Comma-separated list of IP addresses per NIC. To specify one ip address per NIC: !,!,..., 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. + - -\ **nichostnamesuffixes**\ - +\ **nichostnamesuffixes**\ + Comma-separated list of hostname suffixes per NIC. If only one ip address is associated with each NIC: !,!,..., for example, eth0!-eth0,ib0!-ib0 If multiple ip addresses are associated 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. - - + + .. code-block:: perl - + 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 + + - - -\ **nichostnameprefixes**\ - +\ **nichostnameprefixes**\ + Comma-separated list of hostname prefixes per NIC. If only one ip address is associated with each NIC: !,!,..., for example, eth0!eth0-,ib0!ib- @@ -79,74 +79,74 @@ nics Attributes: !|,!|,..., 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) and minus sign (-). When you are specifying "nichostnameprefixes" or "nicaliases" make sure the resulting hostnames will conform to this naming convention + - -\ **nictypes**\ - +\ **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. + - -\ **niccustomscripts**\ - +\ **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 . + - -\ **nicnetworks**\ - +\ **nicnetworks**\ + Comma-separated list of networks connected to each NIC. 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. + - -\ **nicaliases**\ - +\ **nicaliases**\ + Comma-separated list of hostname aliases for each NIC. Format: eth0!,eth1!| For multiple aliases per nic use a space-separated list. For example: eth0!moe larry curly,eth1!tom|jerry + - -\ **nicextraparams**\ - +\ **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: !,!, 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. + - -\ **nicdevices**\ - +\ **nicdevices**\ + Comma-separated list of NIC device per NIC, multiple ethernet devices can be bonded as bond device, these ethernet devices are separated by | . !|,!, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices. as the sub attributes. + - -\ **nicsadapter**\ - +\ **nicsadapter**\ + Comma-separated list of NIC information collected by getadapter. !,!, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -155,5 +155,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nimimage.5.rst b/docs/source/guides/admin-guides/references/man5/nimimage.5.rst index 0829eb5f2..575f05328 100644 --- a/docs/source/guides/admin-guides/references/man5/nimimage.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nimimage.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nimimage Attributes:**\ \ *imagename*\ , \ *nimtype*\ , \ *lpp_source*\ , \ *spot*\ , \ *root*\ , \ *dump*\ , \ *paging*\ , \ *resolv_conf*\ , \ *tmp*\ , \ *home*\ , \ *shared_home*\ , \ *res_group*\ , \ *nimmethod*\ , \ *script*\ , \ *bosinst_data*\ , \ *installp_bundle*\ , \ *mksysb*\ , \ *fb_script*\ , \ *shared_root*\ , \ *otherpkgs*\ , \ *image_data*\ , \ *configdump*\ , \ *comments*\ , \ *disable*\ +\ **nimimage Attributes:**\ \ *imagename*\ , \ *nimtype*\ , \ *lpp_source*\ , \ *spot*\ , \ *root*\ , \ *dump*\ , \ *paging*\ , \ *resolv_conf*\ , \ *tmp*\ , \ *home*\ , \ *shared_home*\ , \ *res_group*\ , \ *nimmethod*\ , \ *script*\ , \ *bosinst_data*\ , \ *installp_bundle*\ , \ *mksysb*\ , \ *fb_script*\ , \ *shared_root*\ , \ *otherpkgs*\ , \ *image_data*\ , \ *configdump*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,148 +36,148 @@ nimimage Attributes: -\ **imagename**\ - +\ **imagename**\ + User provided name of this xCAT OS image definition. + - -\ **nimtype**\ - +\ **nimtype**\ + The NIM client type- standalone, diskless, or dataless. + - -\ **lpp_source**\ - +\ **lpp_source**\ + The name of the NIM lpp_source resource. + - -\ **spot**\ - +\ **spot**\ + The name of the NIM SPOT resource. + - -\ **root**\ - +\ **root**\ + The name of the NIM root resource. + - -\ **dump**\ - +\ **dump**\ + The name of the NIM dump resource. + - -\ **paging**\ - +\ **paging**\ + The name of the NIM paging resource. + - -\ **resolv_conf**\ - +\ **resolv_conf**\ + The name of the NIM resolv_conf resource. + - -\ **tmp**\ - +\ **tmp**\ + The name of the NIM tmp resource. + - -\ **home**\ - +\ **home**\ + The name of the NIM home resource. + - -\ **shared_home**\ - +\ **shared_home**\ + The name of the NIM shared_home resource. + - -\ **res_group**\ - +\ **res_group**\ + The name of a NIM resource group. + - -\ **nimmethod**\ - +\ **nimmethod**\ + The NIM install method to use, (ex. rte, mksysb). + - -\ **script**\ - +\ **script**\ + The name of a NIM script resource. + - -\ **bosinst_data**\ - +\ **bosinst_data**\ + The name of a NIM bosinst_data resource. + - -\ **installp_bundle**\ - +\ **installp_bundle**\ + One or more comma separated NIM installp_bundle resources. + - -\ **mksysb**\ - +\ **mksysb**\ + The name of a NIM mksysb resource. + - -\ **fb_script**\ - +\ **fb_script**\ + The name of a NIM fb_script resource. + - -\ **shared_root**\ - +\ **shared_root**\ + A shared_root resource represents a directory that can be used as a / (root) directory by one or more diskless clients. + - -\ **otherpkgs**\ - +\ **otherpkgs**\ + One or more comma separated installp or rpm packages. The rpm packages must have a prefix of 'R:', (ex. R:foo.rpm) + - -\ **image_data**\ - +\ **image_data**\ + The name of a NIM image_data resource. + - -\ **configdump**\ - +\ **configdump**\ + Specifies the type of system dump to be collected. The values are selective, full, and none. The default is selective. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -186,5 +186,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nodegroup.5.rst b/docs/source/guides/admin-guides/references/man5/nodegroup.5.rst index e255d03fd..8d6d32ade 100644 --- a/docs/source/guides/admin-guides/references/man5/nodegroup.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nodegroup.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodegroup Attributes:**\ \ *groupname*\ , \ *grouptype*\ , \ *members*\ , \ *membergroups*\ , \ *wherevals*\ , \ *comments*\ , \ *disable*\ +\ **nodegroup Attributes:**\ \ *groupname*\ , \ *grouptype*\ , \ *members*\ , \ *membergroups*\ , \ *wherevals*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ nodegroup Attributes: -\ **groupname**\ - +\ **groupname**\ + Name of the group. + - -\ **grouptype**\ - +\ **grouptype**\ + The only current valid value is dynamic. We will be looking at having the object def commands working with static group definitions in the nodelist table. + - -\ **members**\ - +\ **members**\ + The value of the attribute is not used, but the attribute is necessary as a place holder for the object def commands. (The membership for static groups is stored in the nodelist table.) + - -\ **membergroups**\ - +\ **membergroups**\ + This attribute stores a comma-separated list of nodegroups that this nodegroup refers to. This attribute is only used by PCM. + - -\ **wherevals**\ - +\ **wherevals**\ + A list of "attr\*val" pairs that can be used to determine the members of a dynamic group, the delimiter is "::" and the operator \* can be ==, =~, != or !~. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nodehm.5.rst b/docs/source/guides/admin-guides/references/man5/nodehm.5.rst index 879bf699e..aa12ce4b2 100644 --- a/docs/source/guides/admin-guides/references/man5/nodehm.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nodehm.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodehm Attributes:**\ \ *node*\ , \ *power*\ , \ *mgt*\ , \ *cons*\ , \ *termserver*\ , \ *termport*\ , \ *conserver*\ , \ *serialport*\ , \ *serialspeed*\ , \ *serialflow*\ , \ *getmac*\ , \ *cmdmapping*\ , \ *consoleondemand*\ , \ *consoleenabled*\ , \ *comments*\ , \ *disable*\ +\ **nodehm Attributes:**\ \ *node*\ , \ *power*\ , \ *mgt*\ , \ *cons*\ , \ *termserver*\ , \ *termport*\ , \ *conserver*\ , \ *serialport*\ , \ *serialspeed*\ , \ *serialflow*\ , \ *getmac*\ , \ *cmdmapping*\ , \ *consoleondemand*\ , \ *consoleenabled*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,100 +36,100 @@ nodehm Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **power**\ - +\ **power**\ + The method to use to control the power of the node. If not set, the mgt attribute will be used. Valid values: ipmi, blade, hmc, ivm, fsp, kvm, esx, rhevm. If "ipmi", xCAT will search for this node in the ipmi table for more info. If "blade", xCAT will search for this node in the mp table. If "hmc", "ivm", or "fsp", xCAT will search for this node in the ppc table. + - -\ **mgt**\ - +\ **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. + - -\ **cons**\ - +\ **cons**\ + The console method. If nodehm.serialport is set, this will default to the nodehm.mgt setting, otherwise it defaults to unused. Valid values: cyclades, mrv, or the values valid for the mgt attribute. + - -\ **termserver**\ - +\ **termserver**\ + The hostname of the terminal server. + - -\ **termport**\ - +\ **termport**\ + The port number on the terminal server that this node is connected to. + - -\ **conserver**\ - +\ **conserver**\ + The hostname of the machine where the conserver daemon is running. If not set, the default is the xCAT management node. + - -\ **serialport**\ - +\ **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**\ - +\ **serialspeed**\ + The speed of the serial port for this node. For SOL this is typically 19200. + - -\ **serialflow**\ - +\ **serialflow**\ + The flow control value of the serial port for this node. For SOL this is typically 'hard'. + - -\ **getmac**\ - +\ **getmac**\ + The method to use to get MAC address of the node with the getmac command. If not set, the mgt attribute will be used. Valid values: same as values for mgmt attribute. + - -\ **cmdmapping**\ - +\ **cmdmapping**\ + The fully qualified name of the file that stores the mapping between PCM hardware management commands and xCAT/third-party hardware management commands for a particular type of hardware device. Only used by PCM. + - -\ **consoleondemand**\ - +\ **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. + - -\ **consoleenabled**\ - +\ **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. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -138,5 +138,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nodelist.5.rst b/docs/source/guides/admin-guides/references/man5/nodelist.5.rst index bbefb44bd..7dbe45086 100644 --- a/docs/source/guides/admin-guides/references/man5/nodelist.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nodelist.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodelist Attributes:**\ \ *node*\ , \ *groups*\ , \ *status*\ , \ *statustime*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *primarysn*\ , \ *hidden*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *zonename*\ , \ *comments*\ , \ *disable*\ +\ **nodelist Attributes:**\ \ *node*\ , \ *groups*\ , \ *status*\ , \ *statustime*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *primarysn*\ , \ *hidden*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *zonename*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,82 +36,82 @@ nodelist Attributes: -\ **node**\ - +\ **node**\ + The hostname of a node in the cluster. + - -\ **groups**\ - +\ **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. + - -\ **status**\ - +\ **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 sequences are: For installation: defined->[discovering]->[configuring]->[standingby]->installing->booting->[postbooting]->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->[postbooting]->booted->[alive], For booting: [alive/unreachable]->booting->[postbooting]->booted->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series discovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. 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**\ - +\ **statustime**\ + The data and time when the status was updated. + - -\ **appstatus**\ - +\ **appstatus**\ + A comma-delimited list of application status. For example: 'sshd=up,ftp=down,ll=down' + - -\ **appstatustime**\ - +\ **appstatustime**\ + The date and time when appstatus was updated. + - -\ **primarysn**\ - +\ **primarysn**\ + Not used currently. The primary servicenode, used by this node. + - -\ **hidden**\ - +\ **hidden**\ + Used to hide fsp and bpa definitions, 1 means not show them when running lsdef and nodels + - -\ **updatestatus**\ - +\ **updatestatus**\ + The current node update status. Valid states are synced, out-of-sync,syncing,failed. + - -\ **updatestatustime**\ - +\ **updatestatustime**\ + The date and time when the updatestatus was updated. + - -\ **zonename**\ - +\ **zonename**\ + The name of the zone to which the node is currently assigned. If undefined, then it is not assigned to any zone. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -120,5 +120,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nodepos.5.rst b/docs/source/guides/admin-guides/references/man5/nodepos.5.rst index 2c9969c81..8a603d7ce 100644 --- a/docs/source/guides/admin-guides/references/man5/nodepos.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nodepos.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodepos Attributes:**\ \ *node*\ , \ *rack*\ , \ *u*\ , \ *chassis*\ , \ *slot*\ , \ *room*\ , \ *height*\ , \ *comments*\ , \ *disable*\ +\ **nodepos Attributes:**\ \ *node*\ , \ *rack*\ , \ *u*\ , \ *chassis*\ , \ *slot*\ , \ *room*\ , \ *height*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,58 +36,58 @@ nodepos Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **rack**\ - +\ **rack**\ + The frame the node is in. + - -\ **u**\ - +\ **u**\ + The vertical position of the node in the frame + - -\ **chassis**\ - +\ **chassis**\ + The BladeCenter chassis the blade is in. + - -\ **slot**\ - +\ **slot**\ + The slot number of the blade in the chassis. For PCM, a comma-separated list of slot numbers is stored + - -\ **room**\ - +\ **room**\ + The room where the node is located. + - -\ **height**\ - +\ **height**\ + The server height in U(s). + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -96,5 +96,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/noderes.5.rst b/docs/source/guides/admin-guides/references/man5/noderes.5.rst index 2381e4e81..98bc13b24 100644 --- a/docs/source/guides/admin-guides/references/man5/noderes.5.rst +++ b/docs/source/guides/admin-guides/references/man5/noderes.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **noderes Attributes:**\ \ *node*\ , \ *servicenode*\ , \ *netboot*\ , \ *tftpserver*\ , \ *tftpdir*\ , \ *nfsserver*\ , \ *monserver*\ , \ *nfsdir*\ , \ *installnic*\ , \ *primarynic*\ , \ *discoverynics*\ , \ *cmdinterface*\ , \ *xcatmaster*\ , \ *current_osimage*\ , \ *next_osimage*\ , \ *nimserver*\ , \ *routenames*\ , \ *nameservers*\ , \ *proxydhcp*\ , \ *syslog*\ , \ *comments*\ , \ *disable*\ +\ **noderes Attributes:**\ \ *node*\ , \ *servicenode*\ , \ *netboot*\ , \ *tftpserver*\ , \ *tftpdir*\ , \ *nfsserver*\ , \ *monserver*\ , \ *nfsdir*\ , \ *installnic*\ , \ *primarynic*\ , \ *discoverynics*\ , \ *cmdinterface*\ , \ *xcatmaster*\ , \ *current_osimage*\ , \ *next_osimage*\ , \ *nimserver*\ , \ *routenames*\ , \ *nameservers*\ , \ *proxydhcp*\ , \ *syslog*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,147 +36,147 @@ noderes Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **servicenode**\ - +\ **servicenode**\ + A comma separated list of node names (as known by the management node) that provides most services for this node. The first service node on the list that is accessible will be used. The 2nd node on the list is generally considered to be the backup service node for this node when running commands like snmove. + - -\ **netboot**\ - +\ **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.3 yaboot ppc64 >=rhels7, >=sles11.4 grub2,grub2-http,grub2-tftp ppc64le NonVirtualize ALL petitboot ppc64le PowerKVM Guest ALL grub2,grub2-http,grub2-tftp + + - - -\ **tftpserver**\ - +\ **tftpserver**\ + The TFTP server for this node (as known by this node). If not set, it defaults to networks.tftpserver. + - -\ **tftpdir**\ - +\ **tftpdir**\ + The directory that roots this nodes contents from a tftp and related perspective. Used for NAS offload by using different mountpoints. + - -\ **nfsserver**\ - +\ **nfsserver**\ + The NFS or HTTP server for this node (as known by this node). + - -\ **monserver**\ - +\ **monserver**\ + The monitoring aggregation point for this node. The format is "x,y" where x is the ip address as known by the management node and y is the ip address as known by the node. + - -\ **nfsdir**\ - +\ **nfsdir**\ + The path that should be mounted from the NFS server. + - -\ **installnic**\ - +\ **installnic**\ + The network adapter on the node that will be used for OS deployment, the installnic can be set to the network adapter name or the mac address or the keyword "mac" which means that the network interface specified by the mac address in the mac table will be used. If not set, primarynic will be used. If primarynic is not set too, the keyword "mac" will be used as default. + - -\ **primarynic**\ - +\ **primarynic**\ + This attribute will be deprecated. All the used network interface will be determined by installnic. The network adapter on the node that will be used for xCAT management, the primarynic can be set to the network adapter name or the mac address or the keyword "mac" which means that the network interface specified by the mac address in the mac table will be used. Default is eth0. + - -\ **discoverynics**\ - +\ **discoverynics**\ + If specified, force discovery to occur on specific network adapters only, regardless of detected connectivity. Syntax can be simply "eth2,eth3" to restrict discovery to whatever happens to come up as eth2 and eth3, or by driver name such as "bnx2:0,bnx2:1" to specify the first two adapters managed by the bnx2 driver + - -\ **cmdinterface**\ - +\ **cmdinterface**\ + Not currently used. + - -\ **xcatmaster**\ - +\ **xcatmaster**\ + The hostname of the xCAT service node (as known by this node). This acts as the default value for nfsserver and tftpserver, if they are not set. If xcatmaster is not set, the node will use whoever responds to its boot request as its master. For the directed bootp case for POWER, it will use the management node if xcatmaster is not set. + - -\ **current_osimage**\ - +\ **current_osimage**\ + Not currently used. The name of the osimage data object that represents the OS image currently deployed on this node. + - -\ **next_osimage**\ - +\ **next_osimage**\ + Not currently used. The name of the osimage data object that represents the OS image that will be installed on the node the next time it is deployed. + - -\ **nimserver**\ - +\ **nimserver**\ + Not used for now. The NIM server for this node (as known by this node). + - -\ **routenames**\ - +\ **routenames**\ + A comma separated list of route names that refer to rows in the routes table. These are the routes that should be defined on this node when it is deployed. + - -\ **nameservers**\ - +\ **nameservers**\ + An optional node/group specific override for name server list. Most people want to stick to site or network defined nameserver configuration. + - -\ **proxydhcp**\ - +\ **proxydhcp**\ + To specify whether the node supports proxydhcp protocol. Valid values: yes or 1, no or 0. Default value is yes. + - -\ **syslog**\ - +\ **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 + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -185,5 +185,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/nodetype.5.rst b/docs/source/guides/admin-guides/references/man5/nodetype.5.rst index 820914581..7d75e070c 100644 --- a/docs/source/guides/admin-guides/references/man5/nodetype.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nodetype.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **nodetype Attributes:**\ \ *node*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *provmethod*\ , \ *supportedarchs*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ +\ **nodetype Attributes:**\ \ *node*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *provmethod*\ , \ *supportedarchs*\ , \ *nodetype*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,58 +36,58 @@ nodetype Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **os**\ - +\ **os**\ + The operating system deployed on this node. Valid values: AIX, rhels\*,rhelc\*, rhas\*,centos\*,SL\*, fedora\*, sles\* (where \* is the version #). As a special case, if this is set to "boottarget", then it will use the initrd/kernel/parameters specified in the row in the boottarget table in which boottarget.bprofile equals nodetype.profile. + - -\ **arch**\ - +\ **arch**\ + The hardware architecture of this node. Valid values: x86_64, ppc64, x86, ia64. + - -\ **profile**\ - +\ **profile**\ + The string to use to locate a kickstart or autoyast template to use for OS deployment of this node. If the provmethod attribute is set to an osimage name, that takes precedence, and profile need not be defined. Otherwise, the os, profile, and arch are used to search for the files in /install/custom first, and then in /opt/xcat/share/xcat. + - -\ **provmethod**\ - +\ **provmethod**\ + The provisioning method for node deployment. The valid values are install, netboot, statelite or an os image name from the osimage table. If an image name is specified, the osimage definition stored in the osimage table and the linuximage table (for Linux) or nimimage table (for AIX) are used to locate the files for templates, pkglists, syncfiles, etc. On Linux, if install, netboot or statelite is specified, the os, profile, and arch are used to search for the files in /install/custom first, and then in /opt/xcat/share/xcat. + - -\ **supportedarchs**\ - +\ **supportedarchs**\ + Comma delimited list of architectures this node can execute. + - -\ **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. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -96,5 +96,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/notification.5.rst b/docs/source/guides/admin-guides/references/man5/notification.5.rst index 795536bb9..bd5027a74 100644 --- a/docs/source/guides/admin-guides/references/man5/notification.5.rst +++ b/docs/source/guides/admin-guides/references/man5/notification.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **notification Attributes:**\ \ *filename*\ , \ *tables*\ , \ *tableops*\ , \ *comments*\ , \ *disable*\ +\ **notification Attributes:**\ \ *filename*\ , \ *tables*\ , \ *tableops*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ notification Attributes: -\ **filename**\ - +\ **filename**\ + The path name of a file that implements the callback routine when the monitored table changes. Can be a perl module or a command. See the regnotif man page for details. + - -\ **tables**\ - +\ **tables**\ + Comma-separated list of xCAT database tables to monitor. + - -\ **tableops**\ - +\ **tableops**\ + Specifies the table operation to monitor for. Valid values: "d" (rows deleted), "a" (rows added), "u" (rows updated). + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/openbmc.5.rst b/docs/source/guides/admin-guides/references/man5/openbmc.5.rst index 88dae91e3..11bbee003 100644 --- a/docs/source/guides/admin-guides/references/man5/openbmc.5.rst +++ b/docs/source/guides/admin-guides/references/man5/openbmc.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **openbmc Attributes:**\ \ *node*\ , \ *bmc*\ , \ *consport*\ , \ *taggedvlan*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ +\ **openbmc Attributes:**\ \ *node*\ , \ *bmc*\ , \ *consport*\ , \ *taggedvlan*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,52 +36,52 @@ openbmc Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **bmc**\ - +\ **bmc**\ + The hostname of the BMC adapter. + - -\ **consport**\ - +\ **consport**\ + The console port for OpenBMC. + - -\ **taggedvlan**\ - +\ **taggedvlan**\ + bmcsetup script will configure the network interface of the BMC to be tagged to the VLAN specified. + - -\ **username**\ - +\ **username**\ + The BMC userid. + - -\ **password**\ - +\ **password**\ + The BMC password. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -90,5 +90,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/osdistro.5.rst b/docs/source/guides/admin-guides/references/man5/osdistro.5.rst index 07045a5b2..8be247605 100644 --- a/docs/source/guides/admin-guides/references/man5/osdistro.5.rst +++ b/docs/source/guides/admin-guides/references/man5/osdistro.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **osdistro Attributes:**\ \ *osdistroname*\ , \ *basename*\ , \ *majorversion*\ , \ *minorversion*\ , \ *arch*\ , \ *type*\ , \ *dirpaths*\ , \ *comments*\ , \ *disable*\ +\ **osdistro Attributes:**\ \ *osdistroname*\ , \ *basename*\ , \ *majorversion*\ , \ *minorversion*\ , \ *arch*\ , \ *type*\ , \ *dirpaths*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,58 +36,58 @@ osdistro Attributes: -\ **osdistroname**\ - +\ **osdistroname**\ + Unique name (e.g. rhels6.2-x86_64) + - -\ **basename**\ - +\ **basename**\ + The OS base name (e.g. rhels) + - -\ **majorversion**\ - +\ **majorversion**\ + The OS distro major version.(e.g. 6) + - -\ **minorversion**\ - +\ **minorversion**\ + The OS distro minor version. (e.g. 2) + - -\ **arch**\ - +\ **arch**\ + The OS distro arch (e.g. x86_64) + - -\ **type**\ - +\ **type**\ + Linux or AIX + - -\ **dirpaths**\ - +\ **dirpaths**\ + Directory paths where OS distro is store. There could be multiple paths if OS distro has more than one ISO image. (e.g. /install/rhels6.2/x86_64,...) + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -96,5 +96,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/osdistroupdate.5.rst b/docs/source/guides/admin-guides/references/man5/osdistroupdate.5.rst index 99c05a153..2d74cbd9c 100644 --- a/docs/source/guides/admin-guides/references/man5/osdistroupdate.5.rst +++ b/docs/source/guides/admin-guides/references/man5/osdistroupdate.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **osdistroupdate Attributes:**\ \ *osupdatename*\ , \ *osdistroname*\ , \ *dirpath*\ , \ *downloadtime*\ , \ *comments*\ , \ *disable*\ +\ **osdistroupdate Attributes:**\ \ *osupdatename*\ , \ *osdistroname*\ , \ *dirpath*\ , \ *downloadtime*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ osdistroupdate Attributes: -\ **osupdatename**\ - +\ **osupdatename**\ + Name of OS update. (e.g. rhn-update1) + - -\ **osdistroname**\ - +\ **osdistroname**\ + The OS distro name to update. (e.g. rhels) + - -\ **dirpath**\ - +\ **dirpath**\ + Path to where OS distro update is stored. (e.g. /install/osdistroupdates/rhels6.2-x86_64-20120716-update) + - -\ **downloadtime**\ - +\ **downloadtime**\ + The timestamp when OS distro update was downloaded.. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/osimage.5.rst b/docs/source/guides/admin-guides/references/man5/osimage.5.rst index 4be9e16ee..2c74f3a31 100644 --- a/docs/source/guides/admin-guides/references/man5/osimage.5.rst +++ b/docs/source/guides/admin-guides/references/man5/osimage.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **osimage Attributes:**\ \ *imagename*\ , \ *groups*\ , \ *profile*\ , \ *imagetype*\ , \ *description*\ , \ *provmethod*\ , \ *rootfstype*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *cfmdir*\ , \ *osname*\ , \ *osvers*\ , \ *osarch*\ , \ *synclists*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *serverrole*\ , \ *isdeletable*\ , \ *kitcomponents*\ , \ *comments*\ , \ *disable*\ +\ **osimage Attributes:**\ \ *imagename*\ , \ *groups*\ , \ *profile*\ , \ *imagetype*\ , \ *description*\ , \ *provmethod*\ , \ *rootfstype*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *cfmdir*\ , \ *osname*\ , \ *osvers*\ , \ *osarch*\ , \ *synclists*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *serverrole*\ , \ *isdeletable*\ , \ *kitcomponents*\ , \ *environvar*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,130 +36,136 @@ osimage Attributes: -\ **imagename**\ - +\ **imagename**\ + The name of this xCAT OS image definition. + - -\ **groups**\ - +\ **groups**\ + A comma-delimited list of image groups of which this image is a member. Image groups can be used in the litefile and litetree table instead of a single image name. Group names are arbitrary. + - -\ **profile**\ - +\ **profile**\ + The node usage category. For example compute, service. + - -\ **imagetype**\ - +\ **imagetype**\ + The type of operating system image this definition represents (linux,AIX). + - -\ **description**\ - +\ **description**\ + OS Image Description + - -\ **provmethod**\ - +\ **provmethod**\ + The provisioning method for node deployment. The valid values are install, netboot,statelite,boottarget,dualboot,sysclone. If boottarget is set, you must set linuximage.boottarget to the name of the boottarget definition. It is not used by AIX. + - -\ **rootfstype**\ - +\ **rootfstype**\ + The filesystem type for the rootfs is used when the provmethod is statelite. The valid values are nfs or ramdisk. The default value is nfs + - -\ **osdistroname**\ - +\ **osdistroname**\ + The name of the OS distro definition. This attribute can be used to specify which OS distro to use, instead of using the osname,osvers,and osarch attributes. For \*kit commands, the attribute will be used to read the osdistro table for the osname, osvers, and osarch attributes. If defined, the osname, osvers, and osarch attributes defined in the osimage table will be ignored. + - -\ **osupdatename**\ - +\ **osupdatename**\ + A comma-separated list of OS distro updates to apply to this osimage. + - -\ **cfmdir**\ - +\ **cfmdir**\ + CFM directory name for PCM. Set to /install/osimages//cfmdir by PCM. + - -\ **osname**\ - +\ **osname**\ + Operating system name- AIX or Linux. + - -\ **osvers**\ - +\ **osvers**\ + The Linux operating system deployed on this node. Valid values: rhels\*,rhelc\*, rhas\*,centos\*,SL\*, fedora\*, sles\* (where \* is the version #). + - -\ **osarch**\ - +\ **osarch**\ + The hardware architecture of this node. Valid values: x86_64, ppc64, x86, ia64. + - -\ **synclists**\ - +\ **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. + - -\ **postscripts**\ - +\ **postscripts**\ + Comma separated list of scripts that should be run on this image after diskful 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. + - -\ **postbootscripts**\ - +\ **postbootscripts**\ + Comma separated list of scripts that should be run on this after diskful installation or diskless boot. On AIX these scripts are run during the processing of /etc/inittab. On Linux they are run at the init.d time. xCAT automatically adds the scripts in the xcatdefaults.postbootscripts attribute to run first in the list. See the site table runbootscripts attribute. + - -\ **serverrole**\ - +\ **serverrole**\ + The role of the server created by this osimage. Default roles: mgtnode, servicenode, compute, login, storage, utility. + - -\ **isdeletable**\ - +\ **isdeletable**\ + A flag to indicate whether this image profile can be deleted. This attribute is only used by PCM. + - -\ **kitcomponents**\ - +\ **kitcomponents**\ + List of Kit Component IDs assigned to this OS Image definition. + +\ **environvar**\ + + Comma delimited environment variables for the osimage + -\ **comments**\ +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -168,5 +174,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/passwd.5.rst b/docs/source/guides/admin-guides/references/man5/passwd.5.rst index f36b52c44..4123a9258 100644 --- a/docs/source/guides/admin-guides/references/man5/passwd.5.rst +++ b/docs/source/guides/admin-guides/references/man5/passwd.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **passwd Attributes:**\ \ *key*\ , \ *username*\ , \ *password*\ , \ *cryptmethod*\ , \ *authdomain*\ , \ *comments*\ , \ *disable*\ +\ **passwd Attributes:**\ \ *key*\ , \ *username*\ , \ *password*\ , \ *cryptmethod*\ , \ *authdomain*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ passwd Attributes: -\ **key**\ - +\ **key**\ + The type of component this user/pw is for. Valid values: blade (management module), ipmi (BMC), system (nodes), omapi (DHCP), hmc, ivm, cec, frame, switch. + - -\ **username**\ - +\ **username**\ + The default userid for this type of component + - -\ **password**\ - +\ **password**\ + The default password for this type of component. On Linux, a crypted form could be provided. Hashes starting with $1$, $5$ and $6$ (md5, sha256 and sha512 respectively) are supported. + - -\ **cryptmethod**\ - +\ **cryptmethod**\ + Indicates the method to use to encrypt the password attribute. On AIX systems, if a value is provided for this attribute it indicates that the password attribute is encrypted. If the cryptmethod value is not set it indicates the password is a simple string value. On Linux systems, the cryptmethod can be set to md5, sha256 or sha512. If not set, sha256 will be used as default to encrypt plain-text passwords. + - -\ **authdomain**\ - +\ **authdomain**\ + The domain in which this entry has meaning, e.g. specifying different domain administrators per active directory domain + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/pdu.5.rst b/docs/source/guides/admin-guides/references/man5/pdu.5.rst index e2293b772..c94edf9fe 100644 --- a/docs/source/guides/admin-guides/references/man5/pdu.5.rst +++ b/docs/source/guides/admin-guides/references/man5/pdu.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *pdutype*\ , \ *outlet*\ , \ *username*\ , \ *password*\ , \ *snmpversion*\ , \ *community*\ , \ *snmpuser*\ , \ *authtype*\ , \ *authkey*\ , \ *privtype*\ , \ *privkey*\ , \ *seclevel*\ , \ *comments*\ , \ *disable*\ +\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *pdutype*\ , \ *outlet*\ , \ *username*\ , \ *password*\ , \ *snmpversion*\ , \ *community*\ , \ *snmpuser*\ , \ *authtype*\ , \ *authkey*\ , \ *privtype*\ , \ *privkey*\ , \ *seclevel*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,100 +36,100 @@ pdu Attributes: -\ **node**\ - +\ **node**\ + The hostname/address of the pdu to which the settings apply + - -\ **nodetype**\ - +\ **nodetype**\ + The node type should be pdu + - -\ **pdutype**\ - +\ **pdutype**\ + The type of pdu + - -\ **outlet**\ - +\ **outlet**\ + The pdu outlet count + - -\ **username**\ - +\ **username**\ + The remote login user name + - -\ **password**\ - +\ **password**\ + The remote login password + - -\ **snmpversion**\ - +\ **snmpversion**\ + The version to use to communicate with switch. SNMPv1 is assumed by default. + - -\ **community**\ - +\ **community**\ + The community string to use for SNMPv1/v2 + - -\ **snmpuser**\ - +\ **snmpuser**\ + The username to use for SNMPv3 communication, ignored for SNMPv1 + - -\ **authtype**\ - +\ **authtype**\ + The authentication protocol(MD5|SHA) to use for SNMPv3. + - -\ **authkey**\ - +\ **authkey**\ + The authentication passphrase for SNMPv3 + - -\ **privtype**\ - +\ **privtype**\ + The privacy protocol(AES|DES) to use for SNMPv3. + - -\ **privkey**\ - +\ **privkey**\ + The privacy passphrase to use for SNMPv3. + - -\ **seclevel**\ - +\ **seclevel**\ + The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -138,5 +138,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/pduoutlet.5.rst b/docs/source/guides/admin-guides/references/man5/pduoutlet.5.rst index 5d2f72bd4..cbed931c1 100644 --- a/docs/source/guides/admin-guides/references/man5/pduoutlet.5.rst +++ b/docs/source/guides/admin-guides/references/man5/pduoutlet.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **pduoutlet Attributes:**\ \ *node*\ , \ *pdu*\ , \ *comments*\ , \ *disable*\ +\ **pduoutlet Attributes:**\ \ *node*\ , \ *pdu*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,28 +36,28 @@ pduoutlet Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **pdu**\ - +\ **pdu**\ + a comma-separated list of outlet number for each PDU, ex: pdu1:outlet1,pdu2:outlet1 + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -66,5 +66,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/performance.5.rst b/docs/source/guides/admin-guides/references/man5/performance.5.rst index c1e8afe31..1af503424 100644 --- a/docs/source/guides/admin-guides/references/man5/performance.5.rst +++ b/docs/source/guides/admin-guides/references/man5/performance.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **performance Attributes:**\ \ *timestamp*\ , \ *node*\ , \ *attrname*\ , \ *attrvalue*\ , \ *comments*\ , \ *disable*\ +\ **performance Attributes:**\ \ *timestamp*\ , \ *node*\ , \ *attrname*\ , \ *attrvalue*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ performance Attributes: -\ **timestamp**\ - +\ **timestamp**\ + The time at which the metric was captured. + - -\ **node**\ - +\ **node**\ + The node name. + - -\ **attrname**\ - +\ **attrname**\ + The metric name. + - -\ **attrvalue**\ - +\ **attrvalue**\ + The metric value. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/policy.5.rst b/docs/source/guides/admin-guides/references/man5/policy.5.rst index f2a5357ad..7b41a78db 100644 --- a/docs/source/guides/admin-guides/references/man5/policy.5.rst +++ b/docs/source/guides/admin-guides/references/man5/policy.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **policy Attributes:**\ \ *priority*\ , \ *name*\ , \ *host*\ , \ *commands*\ , \ *noderange*\ , \ *parameters*\ , \ *time*\ , \ *rule*\ , \ *comments*\ , \ *disable*\ +\ **policy Attributes:**\ \ *priority*\ , \ *name*\ , \ *host*\ , \ *commands*\ , \ *noderange*\ , \ *parameters*\ , \ *time*\ , \ *rule*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,64 +36,64 @@ policy Attributes: -\ **priority**\ - +\ **priority**\ + The priority value for this rule. This value is used to identify this policy data object (i.e. this rule) The table is sorted on this field with the lower the number the higher the priority. For example 1.0 is higher priority than 4.1 is higher than 4.9. + - -\ **name**\ - +\ **name**\ + The username that is allowed to perform the commands specified by this rule. Default is "\*" (all users). + - -\ **host**\ - +\ **host**\ + The host from which users may issue the commands specified by this rule. Default is "\*" (all hosts). Only all or one host is supported + - -\ **commands**\ - +\ **commands**\ + The list of commands that this rule applies to. Default is "\*" (all commands). + - -\ **noderange**\ - +\ **noderange**\ + The Noderange that this rule applies to. Default is "\*" (all nodes). Not supported with the \*def commands. + - -\ **parameters**\ - +\ **parameters**\ + A regular expression that matches the command parameters (everything except the noderange) that this rule applies to. Default is "\*" (all parameters). Not supported with the \*def commands. + - -\ **time**\ - +\ **time**\ + Time ranges that this command may be executed in. This is not supported. + - -\ **rule**\ - +\ **rule**\ + Specifies how this rule should be applied. Valid values are: allow, trusted. Allow will allow the user to run the commands. Any other value will deny the user access to the commands. Trusted means that once this client has been authenticated via the certificate, all other information that is sent (e.g. the username) is believed without question. This authorization should only be given to the xcatd on the management node at this time. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -102,5 +102,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/postscripts.5.rst b/docs/source/guides/admin-guides/references/man5/postscripts.5.rst index c91b3d21e..6bac116b9 100644 --- a/docs/source/guides/admin-guides/references/man5/postscripts.5.rst +++ b/docs/source/guides/admin-guides/references/man5/postscripts.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **postscripts Attributes:**\ \ *node*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *comments*\ , \ *disable*\ +\ **postscripts Attributes:**\ \ *node*\ , \ *postscripts*\ , \ *postbootscripts*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ postscripts Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **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 + - -\ **postbootscripts**\ - +\ **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 + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/ppc.5.rst b/docs/source/guides/admin-guides/references/man5/ppc.5.rst index 2dbcf6872..3e6fed8cd 100644 --- a/docs/source/guides/admin-guides/references/man5/ppc.5.rst +++ b/docs/source/guides/admin-guides/references/man5/ppc.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **ppc Attributes:**\ \ *node*\ , \ *hcp*\ , \ *id*\ , \ *pprofile*\ , \ *parent*\ , \ *nodetype*\ , \ *supernode*\ , \ *sfp*\ , \ *comments*\ , \ *disable*\ +\ **ppc Attributes:**\ \ *node*\ , \ *hcp*\ , \ *id*\ , \ *pprofile*\ , \ *parent*\ , \ *nodetype*\ , \ *supernode*\ , \ *sfp*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,64 +36,64 @@ ppc Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **hcp**\ - +\ **hcp**\ + The hardware control point for this node (HMC, IVM, Frame or CEC). Do not need to set for BPAs and FSPs. + - -\ **id**\ - +\ **id**\ + For LPARs: the LPAR numeric id; for CECs: the cage number; for Frames: the frame number. + - -\ **pprofile**\ - +\ **pprofile**\ + The LPAR profile that will be used the next time the LPAR is powered on with rpower. For DFM, the pprofile attribute should be set to blank + - -\ **parent**\ - +\ **parent**\ + For LPARs: the CEC; for FSPs: the CEC; for CEC: the frame (if one exists); for BPA: the frame; for frame: the building block number (which consists 1 or more service nodes and compute/storage nodes that are serviced by them - optional). + - -\ **nodetype**\ - +\ **nodetype**\ + The hardware type of the node. Only can be one of fsp, bpa, cec, frame, ivm, hmc and lpar + - -\ **supernode**\ - +\ **supernode**\ + Indicates the connectivity of this CEC in the HFI network. A comma separated list of 2 ids. The first one is the supernode number the CEC is part of. The second one is the logical location number (0-3) of this CEC within the supernode. + - -\ **sfp**\ - +\ **sfp**\ + The Service Focal Point of this Frame. This is the name of the HMC that is responsible for collecting hardware service events for this frame and all of the CECs within this frame. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -102,5 +102,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/ppcdirect.5.rst b/docs/source/guides/admin-guides/references/man5/ppcdirect.5.rst index db01defb7..dd1002955 100644 --- a/docs/source/guides/admin-guides/references/man5/ppcdirect.5.rst +++ b/docs/source/guides/admin-guides/references/man5/ppcdirect.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **ppcdirect Attributes:**\ \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ +\ **ppcdirect Attributes:**\ \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ ppcdirect Attributes: -\ **hcp**\ - +\ **hcp**\ + Hostname of the FSPs/BPAs(for ASMI) and CECs/Frames(for DFM). + - -\ **username**\ - +\ **username**\ + Userid of the FSP/BPA(for ASMI) and CEC/Frame(for DFM). If not filled in, xCAT will look in the passwd table for key=fsp. If not in the passwd table, the default used is admin. + - -\ **password**\ - +\ **password**\ + Password of the FSP/BPA(for ASMI) and CEC/Frame(for DFM). If not filled in, xCAT will look in the passwd table for key=fsp. If not in the passwd table, the default used is admin. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/ppchcp.5.rst b/docs/source/guides/admin-guides/references/man5/ppchcp.5.rst index 6b4ffa611..80b3d3601 100644 --- a/docs/source/guides/admin-guides/references/man5/ppchcp.5.rst +++ b/docs/source/guides/admin-guides/references/man5/ppchcp.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **ppchcp Attributes:**\ \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ +\ **ppchcp Attributes:**\ \ *hcp*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ ppchcp Attributes: -\ **hcp**\ - +\ **hcp**\ + Hostname of the HMC or IVM. + - -\ **username**\ - +\ **username**\ + Userid of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is hscroot for HMCs and padmin for IVMs. + - -\ **password**\ - +\ **password**\ + Password of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is abc123 for HMCs and padmin for IVMs. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/prescripts.5.rst b/docs/source/guides/admin-guides/references/man5/prescripts.5.rst index 4a865211f..13f42e25c 100644 --- a/docs/source/guides/admin-guides/references/man5/prescripts.5.rst +++ b/docs/source/guides/admin-guides/references/man5/prescripts.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **prescripts Attributes:**\ \ *node*\ , \ *begin*\ , \ *end*\ , \ *comments*\ , \ *disable*\ +\ **prescripts Attributes:**\ \ *node*\ , \ *begin*\ , \ *end*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,21 +36,21 @@ prescripts Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **begin**\ - +\ **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. + - 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. + 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. @@ -59,32 +59,32 @@ prescripts Attributes: 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: + The following two environment variables will be passed to each script: NODES a coma separated list of node names that need to run the script for ACTION current nodeset action. If '#xCAT setting:MAX_INSTANCE=number' is specified in the script, the script will get invoked for each node in parallel, but no more than number of instances will be invoked at at a time. If it is not specified, the script will be invoked once for all the nodes. + - -\ **end**\ - +\ **end**\ + The scripts to be run at the end of the nodeset(Linux), nimnodeset(AIX),or mkdsklsnode(AIX) command. The format is the same as the 'begin' column. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -93,5 +93,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/prodkey.5.rst b/docs/source/guides/admin-guides/references/man5/prodkey.5.rst index e7e97f354..540cbfcce 100644 --- a/docs/source/guides/admin-guides/references/man5/prodkey.5.rst +++ b/docs/source/guides/admin-guides/references/man5/prodkey.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **prodkey Attributes:**\ \ *node*\ , \ *product*\ , \ *key*\ , \ *comments*\ , \ *disable*\ +\ **prodkey Attributes:**\ \ *node*\ , \ *product*\ , \ *key*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,34 +36,34 @@ prodkey Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **product**\ - +\ **product**\ + A string to identify the product (for OSes, the osname would be used, i.e. wink28 + - -\ **key**\ - +\ **key**\ + The product key relevant to the aforementioned node/group and product combination + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -72,5 +72,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/rack.5.rst b/docs/source/guides/admin-guides/references/man5/rack.5.rst index 9d4767e9a..0784121a2 100644 --- a/docs/source/guides/admin-guides/references/man5/rack.5.rst +++ b/docs/source/guides/admin-guides/references/man5/rack.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **rack Attributes:**\ \ *rackname*\ , \ *displayname*\ , \ *num*\ , \ *height*\ , \ *room*\ , \ *comments*\ , \ *disable*\ +\ **rack Attributes:**\ \ *rackname*\ , \ *displayname*\ , \ *num*\ , \ *height*\ , \ *room*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ rack Attributes: -\ **rackname**\ - +\ **rackname**\ + The rack name. + - -\ **displayname**\ - +\ **displayname**\ + Alternative name for rack. Only used by PCM. + - -\ **num**\ - +\ **num**\ + The rack number. + - -\ **height**\ - +\ **height**\ + Number of units which can be stored in the rack. + - -\ **room**\ - +\ **room**\ + The room in which the rack is located. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/routes.5.rst b/docs/source/guides/admin-guides/references/man5/routes.5.rst index 8484ebc57..b84fa965a 100644 --- a/docs/source/guides/admin-guides/references/man5/routes.5.rst +++ b/docs/source/guides/admin-guides/references/man5/routes.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **routes Attributes:**\ \ *routename*\ , \ *net*\ , \ *mask*\ , \ *gateway*\ , \ *ifname*\ , \ *comments*\ , \ *disable*\ +\ **routes Attributes:**\ \ *routename*\ , \ *net*\ , \ *mask*\ , \ *gateway*\ , \ *ifname*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ routes Attributes: -\ **routename**\ - +\ **routename**\ + Name used to identify this route. + - -\ **net**\ - +\ **net**\ + The network address. + - -\ **mask**\ - +\ **mask**\ + The network mask. + - -\ **gateway**\ - +\ **gateway**\ + The gateway that routes the ip traffic from the mn to the nodes. It is usually a service node. + - -\ **ifname**\ - +\ **ifname**\ + The interface name that facing the gateway. It is optional for IPv4 routes, but it is required for IPv6 routes. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/servicenode.5.rst b/docs/source/guides/admin-guides/references/man5/servicenode.5.rst index a79bc2105..a13cb606c 100644 --- a/docs/source/guides/admin-guides/references/man5/servicenode.5.rst +++ b/docs/source/guides/admin-guides/references/man5/servicenode.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **servicenode Attributes:**\ \ *node*\ , \ *nameserver*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nfsserver*\ , \ *conserver*\ , \ *monserver*\ , \ *ldapserver*\ , \ *ntpserver*\ , \ *ftpserver*\ , \ *nimserver*\ , \ *ipforward*\ , \ *dhcpinterfaces*\ , \ *proxydhcp*\ , \ *comments*\ , \ *disable*\ +\ **servicenode Attributes:**\ \ *node*\ , \ *nameserver*\ , \ *dhcpserver*\ , \ *tftpserver*\ , \ *nfsserver*\ , \ *conserver*\ , \ *monserver*\ , \ *ldapserver*\ , \ *ntpserver*\ , \ *ftpserver*\ , \ *nimserver*\ , \ *ipforward*\ , \ *dhcpinterfaces*\ , \ *proxydhcp*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,100 +36,100 @@ servicenode Attributes: -\ **node**\ - +\ **node**\ + The hostname of the service node as known by the Management Node. + - -\ **nameserver**\ - +\ **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. + - -\ **dhcpserver**\ - +\ **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. + - -\ **tftpserver**\ - +\ **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. + - -\ **nfsserver**\ - +\ **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. + - -\ **conserver**\ - +\ **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. + - -\ **monserver**\ - +\ **monserver**\ + Is this a monitoring event collection point? Valid values: 1 or 0. If 0, it does not change the current state of the service. + - -\ **ldapserver**\ - +\ **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. + - -\ **ntpserver**\ - +\ **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. + - -\ **ftpserver**\ - +\ **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 + - -\ **nimserver**\ - +\ **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. + - -\ **ipforward**\ - +\ **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. + - -\ **dhcpinterfaces**\ - +\ **dhcpinterfaces**\ + The network interfaces DHCP server should listen on for the target node. This attribute can be used for management node and service nodes. If defined, it will override the values defined in site.dhcpinterfaces. This is a comma separated list of device names. !remote! indicates a non-local network for relay DHCP. For example: !remote!,eth0,eth1 + - -\ **proxydhcp**\ - +\ **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. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -138,5 +138,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/site.5.rst b/docs/source/guides/admin-guides/references/man5/site.5.rst index 47c00f259..af8cc6d31 100644 --- a/docs/source/guides/admin-guides/references/man5/site.5.rst +++ b/docs/source/guides/admin-guides/references/man5/site.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **site Attributes:**\ \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ +\ **site Attributes:**\ \ *key*\ , \ *value*\ , \ *comments*\ , \ *disable*\ *********** @@ -27,9 +27,9 @@ DESCRIPTION *********** -Global settings for the whole cluster. This table is different from the -other tables in that each attribute is just named in the key column, rather -than having a separate column for each attribute. The following is a list of +Global settings for the whole cluster. This table is different from the +other tables in that each attribute is just named in the key column, rather +than having a separate column for each attribute. The following is a list of attributes currently used by xCAT organized into categories. @@ -39,23 +39,23 @@ site Attributes: -\ **key**\ - +\ **key**\ + Attribute Name: Description - - + + .. code-block:: perl - + ------------ AIX ATTRIBUTES ------------ nimprime : The name of NIM server, if not set default is the AIX MN. If Linux MN, then must be set for support of mixed cluster (TBD). - + useSSHonAIX: (yes/1 or no/0). Default is yes. The support for rsh/rcp is deprecated. useNFSv4onAIX: (yes/1 or no/0). If yes, NFSv4 will be used with NIM. If no, NFSv3 will be used with NIM. Default is no. - + ----------------- DATABASE ATTRIBUTES ----------------- @@ -67,78 +67,78 @@ site Attributes: 'ALL' means all cmds will be skipped. If attribute is null, all commands will be written. clienttype:web would skip all commands from the web client - For example: tabdump,nodels,clienttype:web + For example: tabdump,nodels,clienttype:web will not log tabdump, nodels or any web client commands. databaseloc: Directory where we create the db instance directory. Default is /var/lib. Only DB2 is currently supported. Do not use the directory in the site.installloc or installdir attribute. This attribute must not be changed once db2sqlsetup script has been run and DB2 has been setup. - + excludenodes: A set of comma separated nodes and/or groups that would automatically be subtracted from any noderange, it can be used for excluding some failed nodes for any xCAT commands. See the 'noderange' manpage for details on supported formats. - + nodestatus: If set to 'n', the nodelist.status column will not be updated during the node deployment, node discovery and power operations. The default is to update. - + skiptables: Comma separated list of tables to be skipped by dumpxCATdb - - skipvalidatelog: If set to 1, then getcredentials and getpostscripts calls will not + + skipvalidatelog: If set to 1, then getcredentials and getpostscripts calls will not be logged in syslog. - + ------------- DHCP ATTRIBUTES ------------- dhcpinterfaces: The network interfaces DHCP should listen on. If it is the same for all nodes, use a comma-separated list of the NICs. To specify different NICs - for different nodes, use the format: "xcatmn|eth1,eth2;service|bond0", - where xcatmn is the name of the management node, DHCP should listen on - the eth1 and eth2 interfaces. All the nodes in group 'service' should + for different nodes, use the format: "xcatmn|eth1,eth2;service|bond0", + where xcatmn is the name of the management node, DHCP should listen on + the eth1 and eth2 interfaces. All the nodes in group 'service' should listen on the 'bond0' interface. - + To disable the genesis kernel from being sent to specific interfaces, a ':noboot' option can be appended to the interface name. For example, if the management node has two interfaces, eth1 and eth2, disable genesis from being sent to eth1 using: "eth1:noboot,eth2". - + dhcpsetup: If set to 'n', it will skip the dhcp setup process in the nodeset cmd. - + dhcplease: The lease time for the dhcp client. The default value is 43200. - + disjointdhcps: If set to '1', the .leases file on a service node only contains the nodes it manages. And when 'sharedtftp' is disabled, nodeset handles boot loader configuration on a service node only for the nodes it manages. The default value is '0'. It means include all the nodes in the subnet. - + pruneservices: Whether to enable service pruning when noderm is run (i.e. removing DHCP entries when noderm is executed) - + managedaddressmode: The mode of networking configuration during node provision. - If set to 'static', the network configuration will be configured + If set to 'static', the network configuration will be configured in static mode based on the node and network definition on MN. If set to 'dhcp', the network will be configured with dhcp protocol. The default is 'dhcp'. - + ------------ DNS ATTRIBUTES ------------ dnshandler: Name of plugin that handles DNS setup for makedns. - + domain: The DNS domain name used for the cluster. - + forwarders: The DNS servers at your site that can provide names outside of the cluster. The makedns command will configure the DNS on the management node to forward requests it does not know to these servers. Note that the DNS servers on the - service nodes will ignore this value and always be configured to forward + service nodes will ignore this value and always be configured to forward to the management node. - - emptyzonesenable: (yes or no). This is to set empty-zones-enable value in named.conf options section. - + + emptyzonesenable: (yes or no). This is to set empty-zones-enable value in named.conf options section. + master: The hostname of the xCAT management node, as known by the nodes. - + nameservers: A comma delimited list of DNS servers that each node in the cluster should use. This value will end up in the nameserver settings of the /etc/resolv.conf on each node. It is common (but not required) to set @@ -148,172 +148,172 @@ site Attributes: "" to mean the DNS server for each node should be the node that is managing it (either its service node or the management node). - + externaldns: To specify that external dns is used. If externaldns is set to any value - then, makedns command will not start the local nameserver on xCAT MN. + then, makedns command will not start the local nameserver on xCAT MN. Default is to start the local nameserver. - + dnsupdaters: The value are ',' separated string which will be added to the zone config section. This is an interface for user to add configuration entries to the zone sections in named.conf. - + dnsinterfaces: The network interfaces DNS should listen on. If it is the same for all - nodes, use a simple comma-separated list of NICs. To specify different - NICs for different nodes, use the format: "xcatmn|eth1,eth2;service|bond0", + nodes, use a simple comma-separated list of NICs. To specify different + NICs for different nodes, use the format: "xcatmn|eth1,eth2;service|bond0", where xcatmn is the name of the management node, and DNS should listen on - the eth1 and eth2 interfaces. All the nods in group 'service' should + the eth1 and eth2 interfaces. All the nods in group 'service' should listen on the 'bond0' interface. - + NOTE: If using this attribute to block certain interfaces, make sure the IP maps to your hostname of xCAT MN is not blocked since xCAT needs to use this IP to communicate with the local NDS server on MN. - + ------------------------- HARDWARE CONTROL ATTRIBUTES ------------------------- blademaxp: The maximum number of concurrent processes for blade hardware control. - + ea_primary_hmc: The hostname of the HMC that the Integrated Switch Network Management Event Analysis should send hardware serviceable events to for processing and potentially sending to IBM. - + ea_backup_hmc: The hostname of the HMC that the Integrated Switch Network Management Event Analysis should send hardware serviceable events to if the primary HMC is down. - + enableASMI: (yes/1 or no/0). If yes, ASMI method will be used after fsp-api. If no, when fsp-api is used, ASMI method will not be used. Default is no. - + fsptimeout: The timeout, in milliseconds, to use when communicating with FSPs. - + hwctrldispatch: Whether or not to send hw control operations to the service node of the target nodes. Default is 'y'.(At present, this attribute is only used for IBM Flex System) - + ipmidispatch: Whether or not to send ipmi hw control operations to the service node of the target compute nodes. Default is 'y'. - + ipmimaxp: The max # of processes for ipmi hw ctrl. The default is 64. Currently, this is only used for HP hw control. - + ipmiretries: The # of retries to use when communicating with BMCs. Default is 3. - + ipmisdrcache: If set to 'no', then the xCAT IPMI support will not cache locally the target node's SDR cache to improve performance. - + ipmitimeout: The timeout to use when communicating with BMCs. Default is 2. This attribute is currently not used. - + maxssh: The max # of SSH connections at any one time to the hw ctrl point for PPC This parameter doesn't take effect on the rpower command. It takes effects on other PPC hardware control command getmacs/rnetboot/rbootseq and so on. Default is 8. - + syspowerinterval: For SystemP CECs, this is the number of seconds the rpower command will wait between performing the action for each CEC. For SystemX IPMI servers, this is the number of seconds the rpower command will wait between powering on nodes at a time. This - value is used to control the power on speed in large clusters. + value is used to control the power on speed in large clusters. Default is 0. - + syspowermaxnodes: The number of servers to power on at one time before waiting 'syspowerinterval' seconds to continue on to the next set of nodes. If the noderange given to rpower includes nodes served by different service nodes, it will try to spread each set of nodes across the service nodes evenly. Currently only used for IPMI servers and must be set if 'syspowerinterval' is set. - + powerinterval: The number of seconds the rpower command to LPARs will wait between performing the action for each LPAR. LPARs of different HCPs (HMCs or FSPs) are done in parallel. This is used to limit the cluster boot up speed in large clusters. Default is 0. This is currently only used for system p hardware. - + ppcmaxp: The max # of processes for PPC hw ctrl. If there are more than ppcmaxp hcps, this parameter will take effect. It will control the max number of processes for PPC hardware control commands. Default is 64. - + ppcretry: The max # of PPC hw connection attempts to HMC before failing. - It only takes effect on the hardware control commands through HMC. + It only takes effect on the hardware control commands through HMC. Default is 3. - + ppctimeout: The timeout, in milliseconds, to use when communicating with PPC hw through HMC. It only takes effect on the hardware control commands through HMC. Default is 0. - + snmpc: The snmp community string that xcat should use when communicating with the switches. - + --------------------------- INSTALL/DEPLOYMENT ATTRIBUTES --------------------------- cleanupxcatpost: (yes/1 or no/0). Set to 'yes' or '1' to clean up the /xcatpost directory on the stateless and statelite nodes after the postscripts are run. Default is no. - + db2installloc: The location which the service nodes should mount for the db2 code to install. Format is hostname:/path. If hostname is omitted, it defaults to the management node. Default is /mntdb2. - + defserialflow: The default serial flow - currently only used by the mknb command. - + defserialport: The default serial port - currently only used by mknb. - + defserialspeed: The default serial speed - currently only used by mknb. - + disablenodesetwarning: Allow the legacy xCAT non-osimage style nodeset to execute. - + genmacprefix: When generating mac addresses automatically, use this manufacturing prefix (e.g. 00:11:aa) - + genpasswords: Automatically generate random passwords for BMCs when configuring them. - + installdir: The local directory name used to hold the node deployment packages. - - installloc: The location from which the service nodes should mount the + + installloc: The location from which the service nodes should mount the deployment packages in the format hostname:/path. If hostname is omitted, it defaults to the management node. The path must match the path in the installdir attribute. - + iscsidir: The path to put the iscsi disks in on the mgmt node. - + mnroutenames: The name of the routes to be setup on the management node. It is a comma separated list of route names that are defined in the routes table. - + runbootscripts: If set to 'yes' the scripts listed in the postbootscripts attribute in the osimage and postscripts tables will be run during each reboot of stateful (diskful) nodes. This attribute has no effect on stateless and statelite nodes. Run the following - command after you change the value of this attribute: + command after you change the value of this attribute: 'updatenode -P setuppostbootscripts' - - precreatemypostscripts: (yes/1 or no/0). Default is no. If yes, it will + + precreatemypostscripts: (yes/1 or no/0). Default is no. If yes, it will instruct xCAT at nodeset and updatenode time to query the db once for all of the nodes passed into the cmd and create the mypostscript file for each node, and put them in a directory of tftpdir(such as: /tftpboot) If no, it will not generate the mypostscript file in the tftpdir. - + secureroot: If set to 1, xCAT will use secure mode to transfer root password hash during the installation. Default is 0. - + setinstallnic: Set the network configuration for installnic to be static. - + sharedtftp: Set to 0 or no, xCAT should not assume the directory in tftpdir is mounted on all on Service Nodes. Default is 1/yes. If value is set to a hostname, the directory in tftpdir will be mounted from that hostname on the SN - + sharedinstall: Indicates if a shared file system will be used for installation - resources. Possible values are: 'no', 'sns', or 'all'. 'no' + resources. Possible values are: 'no', 'sns', or 'all'. 'no' means a shared file system is not being used. 'sns' means a shared filesystem is being used across all service nodes. 'all' means that the management as well as the service nodes are all using a common shared filesystem. The default is 'no'. - + xcatconfdir: Where xCAT config data is (default /etc/xcat). - + xcatdebugmode: the xCAT debug level. xCAT provides a batch of techniques to help user debug problems while using xCAT, especially on OS provision, such as collecting logs of the whole installation process and accessing @@ -325,109 +325,109 @@ site Attributes: '2': enable expert debug mode For the details on 'basic debug mode' and 'expert debug mode', refer to xCAT documentation. - + -------------------- REMOTESHELL ATTRIBUTES -------------------- nodesyncfiledir: The directory on the node, where xdcp will rsync the files - + SNsyncfiledir: The directory on the Service Node, where xdcp will rsync the files from the MN that will eventually be rsync'd to the compute nodes. - + sshbetweennodes: Comma separated list of groups of compute nodes to enable passwordless root ssh to the nodes during install or running 'xdsh -K'. The default is ALLGROUPS. Set to NOGROUPS to disable. - + Service Nodes are not affected by this attribute as they are always configured with passwordless root access. If using the zone table, this attribute in not used. - + ----------------- SERVICES ATTRIBUTES ----------------- consoleondemand: When set to 'yes', conserver connects and creates the console output only when the user opens the console. Default is 'no' on Linux, 'yes' on AIX. - + httpport: The port number that the booting/installing nodes should contact the http server on the MN/SN on. It is your responsibility to configure the http server to listen on that port - xCAT will not do that. - - nmapoptions: Additional options for the nmap command. nmap is used in pping, - nodestat, xdsh -v and updatenode commands. Sometimes additional + + nmapoptions: Additional options for the nmap command. nmap is used in pping, + nodestat, xdsh -v and updatenode commands. Sometimes additional performance tuning may be needed for nmap due to network traffic. For example, if the network response time is too slow, nmap may not - give stable output. You can increase the timeout value by specifying - '--min-rtt-timeout 1s'. xCAT will append the options defined here to + give stable output. You can increase the timeout value by specifying + '--min-rtt-timeout 1s'. xCAT will append the options defined here to the nmap command. - + ntpservers: A comma delimited list of NTP servers for the service node and the compute node to sync with. The keyword means that the node's NTP server is the node that is managing it (either its service node or the management node). - + extntpservers: A comma delimited list of external NTP servers for the xCAT management node to sync with. If it is empty, the NTP server will use the management node's own hardware clock to calculate the system date and time - + svloglocal: If set to 1, syslog on the service node will not get forwarded to the management node. - + timezone: (e.g. America/New_York) - + tftpdir: The tftp directory path. Default is /tftpboot - - tftpflags: The flags that used to start tftpd. Default is '-v -l -s /tftpboot + + tftpflags: The flags that used to start tftpd. Default is '-v -l -s /tftpboot -m /etc/tftpmapfile4xcat.conf' if tftplfags is not set - + useNmapfromMN: When set to yes, nodestat command should obtain the node status using nmap (if available) from the management node instead of the service node. This will improve the performance in a flat network. - + vsftp: Default is 'n'. If set to 'y', xcatd on the management node will automatically start vsftpd. (vsftpd must be installed by the admin). This setting does not apply to service nodes. For service nodes, set servicenode.ftpserver=1. - - FQDNfirst: Fully Qualified Domain Name first. If set to 1/yes/enable, the /etc/hosts - entries generated by 'makehosts' will put the FQDN before the PQDN(Partially + + FQDNfirst: Fully Qualified Domain Name first. If set to 1/yes/enable, the /etc/hosts + entries generated by 'makehosts' will put the FQDN before the PQDN(Partially Qualified Domain Name). Otherwise, the original behavior will be performed. - + hierarchicalattrs: Table attributes(e.g. postscripts, postbootscripts) that will be included hierarchically. Attribute values for all the node's groups will be applied to the node in the groups' order except the repeat one. - dbtracelevel: The trace level for the database access log. To activate this setting, please. + dbtracelevel: The trace level for the database access log. To activate this setting, please. restart xcatd or send HUP signal to the 'xcatd: DB Access' process, Like: . - ps -ef | grep 'xcatd: DB Access' | grep -v grep | awk '{print $2}' | xargs kill -HUP - Currrent support values: - 0: disable the trace log for db - 1: trace the calls of database subroutines - 2: Besides the log from level 1, trace the event to build the cache for the table - 3: Besides the log from level 2, trace the event with cache hit - 4: Besides the log from level 3, trace the SQL statement for the db access - With this configuration, xcat will send the log to syslog very frequently, some of the - log may be lost if imjournal is enabled by rsyslog. + ps -ef | grep 'xcatd: DB Access' | grep -v grep | awk '{print $2}' | xargs kill -HUP + Currrent support values: + 0: disable the trace log for db + 1: trace the calls of database subroutines + 2: Besides the log from level 1, trace the event to build the cache for the table + 3: Besides the log from level 2, trace the event with cache hit + 4: Besides the log from level 3, trace the SQL statement for the db access + With this configuration, xcat will send the log to syslog very frequently, some of the + log may be lost if imjournal is enabled by rsyslog. Please see https://github.com/xcat2/xcat-core/issues/3910 for the detail. - + ----------------------- VIRTUALIZATION ATTRIBUTES ----------------------- usexhrm: Have xCAT execute the xHRM script when booting up KVM guests to configure the virtual network bridge. - + vcenterautojoin: When set to no, the VMWare plugin will not attempt to auto remove and add hypervisors while trying to perform operations. If users or tasks outside of xCAT perform the joining this assures xCAT will not interfere. - + vmwarereconfigonpower: When set to no, the VMWare plugin will make no effort to push vm.cpus/vm.memory updates from xCAT to VMWare. - + persistkvmguests: Keep the kvm definition on the kvm hypervisor when you power off - the kvm guest node. This is useful for you to manually change the + the kvm guest node. This is useful for you to manually change the kvm xml definition file in virsh for debugging. Set anything means enable. - + -------------------- XCAT DAEMON ATTRIBUTES -------------------- @@ -443,43 +443,43 @@ site Attributes: xcatd, and retry. The default is no. See the following document for details: Hints_and_Tips_for_Large_Scale_Clusters - + xcatmaxconnections: Number of concurrent xCAT protocol requests before requests begin queueing. This applies to both client command requests and node requests, e.g. to get postscripts. Default is 64. - + xcatmaxbatchconnections: Number of concurrent xCAT connections allowed from the nodes. Value must be less than xcatmaxconnections. Default is 50. - + xcatdport: The port used by the xcatd daemon for client/server communication. - + xcatiport: The port used by xcatd to receive install status updates from nodes. - + xcatlport: The port used by xcatd command log writer process to collect command output. - + xcatsslversion: The ssl version by xcatd. Default is SSLv3. - + xcatsslciphers: The ssl cipher by xcatd. Default is 3DES. + + - - -\ **value**\ - +\ **value**\ + The value of the attribute specified in the "key" column. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -488,5 +488,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/statelite.5.rst b/docs/source/guides/admin-guides/references/man5/statelite.5.rst index ee7fc3860..3b9f6e1b0 100644 --- a/docs/source/guides/admin-guides/references/man5/statelite.5.rst +++ b/docs/source/guides/admin-guides/references/man5/statelite.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **statelite Attributes:**\ \ *node*\ , \ *image*\ , \ *statemnt*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ +\ **statelite Attributes:**\ \ *node*\ , \ *image*\ , \ *statemnt*\ , \ *mntopts*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ statelite Attributes: -\ **node**\ - +\ **node**\ + The name of the node or group that will use this location. + - -\ **image**\ - +\ **image**\ + Reserved for future development, not used. + - -\ **statemnt**\ - +\ **statemnt**\ + The persistent read/write area where a node's persistent files will be written to, e.g: 10.0.0.1/state/. The node name will be automatically added to the pathname, so 10.0.0.1:/state, will become 10.0.0.1:/state/. + - -\ **mntopts**\ - +\ **mntopts**\ + A comma-separated list of options to use when mounting the persistent directory. (Ex. 'soft') The default is to do a 'hard' mount. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/storage.5.rst b/docs/source/guides/admin-guides/references/man5/storage.5.rst index b0f6d4b17..dd48879bb 100644 --- a/docs/source/guides/admin-guides/references/man5/storage.5.rst +++ b/docs/source/guides/admin-guides/references/man5/storage.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **storage Attributes:**\ \ *node*\ , \ *osvolume*\ , \ *size*\ , \ *state*\ , \ *storagepool*\ , \ *hypervisor*\ , \ *fcprange*\ , \ *volumetag*\ , \ *type*\ , \ *controller*\ , \ *comments*\ , \ *disable*\ +\ **storage Attributes:**\ \ *node*\ , \ *osvolume*\ , \ *size*\ , \ *state*\ , \ *storagepool*\ , \ *hypervisor*\ , \ *fcprange*\ , \ *volumetag*\ , \ *type*\ , \ *controller*\ , \ *comments*\ , \ *disable*\ *********** @@ -34,86 +34,86 @@ storage Attributes: -\ **node**\ - +\ **node**\ + The node name + - -\ **osvolume**\ - +\ **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) + + - - -\ **size**\ - +\ **size**\ + Size of the volume. Examples include: 10G, 1024M. + - -\ **state**\ - +\ **state**\ + State of the volume. The valid values are: free, used, and allocated + - -\ **storagepool**\ - +\ **storagepool**\ + Name of storage pool where the volume is assigned. + - -\ **hypervisor**\ - +\ **hypervisor**\ + Name of the hypervisor where the volume is configured. + - -\ **fcprange**\ - +\ **fcprange**\ + A range of acceptable fibre channels that the volume can use. Examples include: 3B00-3C00;4B00-4C00. + - -\ **volumetag**\ - +\ **volumetag**\ + A specific tag used to identify the volume in the autoyast or kickstart template. + - -\ **type**\ - +\ **type**\ + The plugin used to drive storage configuration (e.g. svc) + - -\ **controller**\ - +\ **controller**\ + The management address to attach/detach new volumes. In the scenario involving multiple controllers, this data must be passed as argument rather than by table value + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -122,5 +122,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/switch.5.rst b/docs/source/guides/admin-guides/references/man5/switch.5.rst index 28ff4499a..9e6d9c099 100644 --- a/docs/source/guides/admin-guides/references/man5/switch.5.rst +++ b/docs/source/guides/admin-guides/references/man5/switch.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **switch Attributes:**\ \ *node*\ , \ *switch*\ , \ *port*\ , \ *vlan*\ , \ *interface*\ , \ *comments*\ , \ *disable*\ +\ **switch Attributes:**\ \ *node*\ , \ *switch*\ , \ *port*\ , \ *vlan*\ , \ *interface*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ switch Attributes: -\ **node**\ - +\ **node**\ + The node name or group name. + - -\ **switch**\ - +\ **switch**\ + The switch hostname. + - -\ **port**\ - +\ **port**\ + The port number in the switch that this node is connected to. On a simple 1U switch, an administrator can generally enter the number as printed next to the ports, and xCAT will understand switch representation differences. On stacked switches or switches with line cards, administrators should usually use the CLI representation (i.e. 2/0/1 or 5/8). One notable exception is stacked SMC 8848M switches, in which you must add 56 for the proceeding switch, then the port number. For example, port 3 on the second switch in an SMC8848M stack would be 59 + - -\ **vlan**\ - +\ **vlan**\ + The ID for the tagged vlan that is created on this port using mkvlan and chvlan commands. + - -\ **interface**\ - +\ **interface**\ + The interface name from the node perspective. For example, eth0. For the primary nic, it can be empty, the word "primary" or "primary:ethx" where ethx is the interface name. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/switches.5.rst b/docs/source/guides/admin-guides/references/man5/switches.5.rst index 37f7b677f..86b4ec0f7 100644 --- a/docs/source/guides/admin-guides/references/man5/switches.5.rst +++ b/docs/source/guides/admin-guides/references/man5/switches.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **switches Attributes:**\ \ *switch*\ , \ *snmpversion*\ , \ *username*\ , \ *password*\ , \ *privacy*\ , \ *auth*\ , \ *linkports*\ , \ *sshusername*\ , \ *sshpassword*\ , \ *protocol*\ , \ *switchtype*\ , \ *comments*\ , \ *disable*\ +\ **switches Attributes:**\ \ *switch*\ , \ *snmpversion*\ , \ *username*\ , \ *password*\ , \ *privacy*\ , \ *auth*\ , \ *linkports*\ , \ *sshusername*\ , \ *sshpassword*\ , \ *protocol*\ , \ *switchtype*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,77 +36,77 @@ switches Attributes: -\ **switch**\ - +\ **switch**\ + The hostname/address of the switch to which the settings apply + - -\ **snmpversion**\ - +\ **snmpversion**\ + The version to use to communicate with switch. SNMPv1 is assumed by default. + - -\ **username**\ - +\ **username**\ + The username to use for SNMPv3 communication, ignored for SNMPv1 + - -\ **password**\ - +\ **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. + - -\ **privacy**\ - +\ **privacy**\ + The privacy protocol to use for v3. xCAT will use authNoPriv if this is unspecified. DES is recommended to use if v3 enabled, as it is the most readily available. + - -\ **auth**\ - +\ **auth**\ + The authentication protocol to use for SNMPv3. SHA is assumed if v3 enabled and this is unspecified + - -\ **linkports**\ - +\ **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. + - -\ **sshusername**\ - +\ **sshusername**\ + 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. + - -\ **sshpassword**\ - +\ **sshpassword**\ + 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. + - -\ **protocol**\ - +\ **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. + - -\ **switchtype**\ - +\ **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. + + + +\ **comments**\ -\ **comments**\ - - - -\ **disable**\ +\ **disable**\ @@ -116,5 +116,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/taskstate.5.rst b/docs/source/guides/admin-guides/references/man5/taskstate.5.rst index 2860e5573..1d7fc2e4f 100644 --- a/docs/source/guides/admin-guides/references/man5/taskstate.5.rst +++ b/docs/source/guides/admin-guides/references/man5/taskstate.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **taskstate Attributes:**\ \ *node*\ , \ *command*\ , \ *state*\ , \ *pid*\ , \ *reserve*\ , \ *disable*\ +\ **taskstate Attributes:**\ \ *node*\ , \ *command*\ , \ *state*\ , \ *pid*\ , \ *reserve*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ taskstate Attributes: -\ **node**\ - +\ **node**\ + The node name. + - -\ **command**\ - +\ **command**\ + Current command is running + - -\ **state**\ - +\ **state**\ + The task state(callback, running) for the node. + - -\ **pid**\ - +\ **pid**\ + The process id of the request process. + - -\ **reserve**\ - +\ **reserve**\ + used to lock the node + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/token.5.rst b/docs/source/guides/admin-guides/references/man5/token.5.rst index 0351e5c41..5089aa16b 100644 --- a/docs/source/guides/admin-guides/references/man5/token.5.rst +++ b/docs/source/guides/admin-guides/references/man5/token.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **token Attributes:**\ \ *tokenid*\ , \ *username*\ , \ *expire*\ , \ *created*\ , \ *access*\ , \ *comments*\ , \ *disable*\ +\ **token Attributes:**\ \ *tokenid*\ , \ *username*\ , \ *expire*\ , \ *created*\ , \ *access*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ token Attributes: -\ **tokenid**\ - +\ **tokenid**\ + It is a UUID as an unified identify for the user. + - -\ **username**\ - +\ **username**\ + The user name. + - -\ **expire**\ - +\ **expire**\ + The expire time for this token. + - -\ **created**\ - +\ **created**\ + Creation time for this token. + - -\ **access**\ - +\ **access**\ + Last access time for this token. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/virtsd.5.rst b/docs/source/guides/admin-guides/references/man5/virtsd.5.rst index 410b81968..9ff5547de 100644 --- a/docs/source/guides/admin-guides/references/man5/virtsd.5.rst +++ b/docs/source/guides/admin-guides/references/man5/virtsd.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **virtsd Attributes:**\ \ *node*\ , \ *sdtype*\ , \ *stype*\ , \ *location*\ , \ *host*\ , \ *cluster*\ , \ *datacenter*\ , \ *comments*\ , \ *disable*\ +\ **virtsd Attributes:**\ \ *node*\ , \ *sdtype*\ , \ *stype*\ , \ *location*\ , \ *host*\ , \ *cluster*\ , \ *datacenter*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,53 +36,53 @@ virtsd Attributes: -\ **node**\ - +\ **node**\ + The name of the storage domain + - -\ **sdtype**\ - +\ **sdtype**\ + The type of storage domain. Valid values: data, iso, export + - -\ **stype**\ - +\ **stype**\ + The type of storge. Valid values: nfs, fcp, iscsi, localfs + - -\ **location**\ - +\ **location**\ + The path of the storage + - -\ **host**\ - +\ **host**\ + For rhev, a hypervisor host needs to be specified to manage the storage domain as SPM (Storage Pool Manager). But the SPM role will be failed over to another host when this host down. + - -\ **cluster**\ - +\ **cluster**\ + A cluster of hosts + - -\ **datacenter**\ - +\ **datacenter**\ + A collection for all host, vm that will shared the same storages, networks. + + + +\ **comments**\ -\ **comments**\ - - - -\ **disable**\ +\ **disable**\ @@ -92,5 +92,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/vm.5.rst b/docs/source/guides/admin-guides/references/man5/vm.5.rst index 167ade986..2c34af76a 100644 --- a/docs/source/guides/admin-guides/references/man5/vm.5.rst +++ b/docs/source/guides/admin-guides/references/man5/vm.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **vm Attributes:**\ \ *node*\ , \ *mgr*\ , \ *host*\ , \ *migrationdest*\ , \ *storage*\ , \ *storagemodel*\ , \ *storagecache*\ , \ *storageformat*\ , \ *cfgstore*\ , \ *memory*\ , \ *cpus*\ , \ *nics*\ , \ *nicmodel*\ , \ *bootorder*\ , \ *clockoffset*\ , \ *virtflags*\ , \ *master*\ , \ *vncport*\ , \ *textconsole*\ , \ *powerstate*\ , \ *beacon*\ , \ *datacenter*\ , \ *cluster*\ , \ *guestostype*\ , \ *othersettings*\ , \ *physlots*\ , \ *vidmodel*\ , \ *vidproto*\ , \ *vidpassword*\ , \ *comments*\ , \ *disable*\ +\ **vm Attributes:**\ \ *node*\ , \ *mgr*\ , \ *host*\ , \ *migrationdest*\ , \ *storage*\ , \ *storagemodel*\ , \ *storagecache*\ , \ *storageformat*\ , \ *cfgstore*\ , \ *memory*\ , \ *cpus*\ , \ *nics*\ , \ *nicmodel*\ , \ *bootorder*\ , \ *clockoffset*\ , \ *virtflags*\ , \ *master*\ , \ *vncport*\ , \ *textconsole*\ , \ *powerstate*\ , \ *beacon*\ , \ *datacenter*\ , \ *cluster*\ , \ *guestostype*\ , \ *othersettings*\ , \ *physlots*\ , \ *vidmodel*\ , \ *vidproto*\ , \ *vidpassword*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,98 +36,98 @@ vm Attributes: -\ **node**\ - +\ **node**\ + The node or static group name + - -\ **mgr**\ - +\ **mgr**\ + The function manager for the virtual machine + - -\ **host**\ - +\ **host**\ + The system that currently hosts the VM + - -\ **migrationdest**\ - +\ **migrationdest**\ + A noderange representing candidate destinations for migration (i.e. similar systems, same SAN, or other criteria that xCAT can use + - -\ **storage**\ - +\ **storage**\ + A list of storage files or devices to be used. i.e. dir:///cluster/vm/ or nfs:///path/to/folder/ + - -\ **storagemodel**\ - +\ **storagemodel**\ + Model of storage devices to provide to guest + - -\ **storagecache**\ - +\ **storagecache**\ + Select caching scheme to employ. E.g. KVM understands 'none', 'writethrough' and 'writeback' + - -\ **storageformat**\ - +\ **storageformat**\ + Select disk format to use by default (e.g. raw versus qcow2) + - -\ **cfgstore**\ - +\ **cfgstore**\ + Optional location for persistent storage separate of emulated hard drives for virtualization solutions that require persistent store to place configuration data + - -\ **memory**\ - +\ **memory**\ + Megabytes of memory the VM currently should be set to. + - -\ **cpus**\ - +\ **cpus**\ + Number of CPUs the node should see. + - -\ **nics**\ - +\ **nics**\ + Network configuration parameters. Of the general form [physnet:]interface,.. Generally, interface describes the vlan entity (default for native, tagged for tagged, vl[number] for a specific vlan. physnet is a virtual switch name or port description that is used for some virtualization technologies to construct virtual switches. hypervisor.netmap can map names to hypervisor specific layouts, or the descriptions described there may be used directly here where possible. + - -\ **nicmodel**\ - +\ **nicmodel**\ + Model of NICs that will be provided to VMs (i.e. e1000, rtl8139, virtio, etc) + - -\ **bootorder**\ - +\ **bootorder**\ + Boot sequence (i.e. net,hd) + - -\ **clockoffset**\ - +\ **clockoffset**\ + Whether to have guest RTC synced to "localtime" or "utc" If not populated, xCAT will guess based on the nodetype.os contents. + - -\ **virtflags**\ - +\ **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] @@ -138,92 +138,92 @@ vm Attributes: qemu-img allows use of qcow2 to generate virtualization layer copy-on-write reflink uses a generic filesystem facility to clone the files on your behalf, but requires filesystem support such as btrfs placement_affinity=[migratable|user_migratable|pinned] + - -\ **master**\ - +\ **master**\ + The name of a master image, if any, this virtual machine is linked to. This is generally set by clonevm and indicates the deletion of a master that would invalidate the storage of this virtual machine + - -\ **vncport**\ - +\ **vncport**\ + Tracks the current VNC display port (currently not meant to be set + - -\ **textconsole**\ - +\ **textconsole**\ + Tracks the Psuedo-TTY that maps to the serial port or console of a VM + - -\ **powerstate**\ - +\ **powerstate**\ + This flag is used by xCAT to track the last known power state of the VM. + - -\ **beacon**\ - +\ **beacon**\ + This flag is used by xCAT to track the state of the identify LED with respect to the VM. + - -\ **datacenter**\ - +\ **datacenter**\ + Optionally specify a datacenter for the VM to exist in (only applicable to VMWare) + - -\ **cluster**\ - +\ **cluster**\ + Specify to the underlying virtualization infrastructure a cluster membership for the hypervisor. + - -\ **guestostype**\ - +\ **guestostype**\ + This allows administrator to specify an identifier for OS to pass through to virtualization stack. Normally this should be ignored as xCAT will translate from nodetype.os rather than requiring this field be used + - -\ **othersettings**\ - +\ **othersettings**\ + This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. 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'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0', the value for PCI device format also can be like:'devpassthrough:0001:01:00.1', the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. + - -\ **physlots**\ - +\ **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'. + - -\ **vidmodel**\ - +\ **vidmodel**\ + Model of video adapter to provide to guest. For example, qxl in KVM + - -\ **vidproto**\ - +\ **vidproto**\ + Request a specific protocol for remote video access be set up. For example, spice in KVM. + - -\ **vidpassword**\ - +\ **vidpassword**\ + Password to use instead of temporary random tokens for VNC and SPICE access + + + +\ **comments**\ -\ **comments**\ - - - -\ **disable**\ +\ **disable**\ @@ -233,5 +233,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/vmmaster.5.rst b/docs/source/guides/admin-guides/references/man5/vmmaster.5.rst index e974898a8..cdceff5db 100644 --- a/docs/source/guides/admin-guides/references/man5/vmmaster.5.rst +++ b/docs/source/guides/admin-guides/references/man5/vmmaster.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **vmmaster Attributes:**\ \ *name*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *storage*\ , \ *storagemodel*\ , \ *nics*\ , \ *vintage*\ , \ *originator*\ , \ *virttype*\ , \ *specializeparameters*\ , \ *comments*\ , \ *disable*\ +\ **vmmaster Attributes:**\ \ *name*\ , \ *os*\ , \ *arch*\ , \ *profile*\ , \ *storage*\ , \ *storagemodel*\ , \ *nics*\ , \ *vintage*\ , \ *originator*\ , \ *virttype*\ , \ *specializeparameters*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,77 +36,77 @@ vmmaster Attributes: -\ **name**\ - +\ **name**\ + The name of a master + - -\ **os**\ - +\ **os**\ + The value of nodetype.os at the time the master was captured + - -\ **arch**\ - +\ **arch**\ + The value of nodetype.arch at the time of capture + - -\ **profile**\ - +\ **profile**\ + The value of nodetype.profile at time of capture + - -\ **storage**\ - +\ **storage**\ + The storage location of bulk master information + - -\ **storagemodel**\ - +\ **storagemodel**\ + The default storage style to use when modifying a vm cloned from this master + - -\ **nics**\ - +\ **nics**\ + The nic configuration and relationship to vlans/bonds/etc + - -\ **vintage**\ - +\ **vintage**\ + When this image was created + - -\ **originator**\ - +\ **originator**\ + The user who created the image + - -\ **virttype**\ - +\ **virttype**\ + The type of virtualization this image pertains to (e.g. vmware, kvm, etc) + - -\ **specializeparameters**\ - +\ **specializeparameters**\ + Implementation specific arguments, currently only "autoLogonCount=- 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 + - -\ **asset**\ - +\ **asset**\ + A field for administrators to use to correlate inventory numbers they may have to accommodate + - -\ **uuid**\ - +\ **uuid**\ + The UUID applicable to the node + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -90,5 +90,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/websrv.5.rst b/docs/source/guides/admin-guides/references/man5/websrv.5.rst index 1146aaa7f..437e45619 100644 --- a/docs/source/guides/admin-guides/references/man5/websrv.5.rst +++ b/docs/source/guides/admin-guides/references/man5/websrv.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **websrv Attributes:**\ \ *node*\ , \ *port*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ +\ **websrv Attributes:**\ \ *node*\ , \ *port*\ , \ *username*\ , \ *password*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ websrv Attributes: -\ **node**\ - +\ **node**\ + The web service hostname. + - -\ **port**\ - +\ **port**\ + The port of the web service. + - -\ **username**\ - +\ **username**\ + Userid to use to access the web service. + - -\ **password**\ - +\ **password**\ + Password to use to access the web service. + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/winimage.5.rst b/docs/source/guides/admin-guides/references/man5/winimage.5.rst index cc0c1c8ae..073521acf 100644 --- a/docs/source/guides/admin-guides/references/man5/winimage.5.rst +++ b/docs/source/guides/admin-guides/references/man5/winimage.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **winimage Attributes:**\ \ *imagename*\ , \ *template*\ , \ *installto*\ , \ *partitionfile*\ , \ *winpepath*\ , \ *comments*\ , \ *disable*\ +\ **winimage Attributes:**\ \ *imagename*\ , \ *template*\ , \ *installto*\ , \ *partitionfile*\ , \ *winpepath*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,46 +36,46 @@ winimage Attributes: -\ **imagename**\ - +\ **imagename**\ + The name of this xCAT OS image definition. + - -\ **template**\ - +\ **template**\ + The fully qualified name of the template file that is used to create the windows unattend.xml file for diskful installation. + - -\ **installto**\ - +\ **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 + - -\ **partitionfile**\ - +\ **partitionfile**\ + The path of partition configuration file. Since the partition configuration for bios boot mode and uefi boot mode are different, this configuration file can include both configurations if you need to support both bios and uefi mode. Either way, you must specify the boot mode in the configuration. Example of partition configuration file: [BIOS]xxxxxxx[UEFI]yyyyyyy. To simplify the setting, you also can set installto in partitionfile with section like [INSTALLTO]0:1 + - -\ **winpepath**\ - +\ **winpepath**\ + The path of winpe which will be used to boot this image. If the real path is /tftpboot/winboot/winpe1/, the value for winpepath should be set to winboot/winpe1 + - -\ **comments**\ - +\ **comments**\ + Any user-written notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -84,5 +84,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/xcatdb.5.rst b/docs/source/guides/admin-guides/references/man5/xcatdb.5.rst index 414872f75..df1aac666 100644 --- a/docs/source/guides/admin-guides/references/man5/xcatdb.5.rst +++ b/docs/source/guides/admin-guides/references/man5/xcatdb.5.rst @@ -115,18 +115,18 @@ node names are cmm01, cmm02, etc., then you might have an mp table like: Before you panic, let me explain each column: -\ **blade**\ - +\ **blade**\ + This is a group name. In this example, we are assuming that all of your blades belong to this group. Each time the xCAT software accesses the \ **mp**\ table to get the management module and slot number of a specific blade (e.g. \ **node20**\ ), this row will match (because \ **node20**\ is in the \ **blade**\ group). Once this row is matched for \ **node20**\ , then the processing described in the following items will take place. + - -\ **|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|**\ - +\ **|\D+(\d+)|cmm(sprintf('%02d',($1-1)/14+1))|**\ + This is a perl substitution pattern that will produce the value for the second column of the table (the management module hostname). The text \ **\D+(\d+)**\ between the 1st two vertical bars is a regular expression that matches the node @@ -141,17 +141,17 @@ Before you panic, let me explain each column: zero, if necessary, to always make the number two digits. Lastly the string \ **cmm**\ is added to the beginning, making the resulting string \ **cmm02**\ , which will be used as the hostname of the management module. + - -\ **|\D+(\d+)|(($1-1)%14+1)|**\ - +\ **|\D+(\d+)|(($1-1)%14+1)|**\ + This item is similar to the one above. This substituion pattern will produce the value for the 3rd column (the chassis slot number for this blade). Because this row was the match for \ **node20**\ , the parentheses within the 1st set of vertical bars will set $1 to 20. Since % means modulo division, the expression \ **($1-1)%14+1**\ will evaluate to \ **6**\ . - + See http://www.perl.com/doc/manual/html/pod/perlre.html for information on perl regular expressions. @@ -173,34 +173,34 @@ Regular Expression Helper Functions xCAT provides several functions that can simplify regular expressions. -\ **a2idx**\ - +\ **a2idx**\ + ASCII Character to Index + - -\ **a2zidx**\ - +\ **a2zidx**\ + ASCII Character to 0-Index + - -\ **dim2idx**\ - +\ **dim2idx**\ + Dimensions to Index + - -\ **skip**\ - +\ **skip**\ + Skip indices + - -\ **ipadd**\ - +\ **ipadd**\ + Add to an IP address - + http://xcat-docs.readthedocs.org/en/latest/guides/admin-guides/basic_concepts/xcat_db/regexp_db.html#regular-expression-helper-functions @@ -235,35 +235,35 @@ In plain English, an object name is in \ **xCAT Object Name Format**\ if starti \* - + one or more alpha characters of any case and any number of "-" in any combination - + \* - + followed by one or more numbers - + \* - + then optionally followed by one alpha character of any case or "-" - + \* - + followed by any combination of case mixed alphanumerics and "-" + - -\ **Object Types**\ +\ **Object Types**\ ==================== -To run man for any of the object definitions below, use section 7. For example: \ **man 7 node**\ +To run man for any of the object definitions below, use section 7. For example: \ **man 7 node**\ The object types are: @@ -370,366 +370,366 @@ TABLES To manipulate the tables directly, use \ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **nodeadd(8)**\ , \ **nodech(1)**\ . -To run man for any of the table descriptions below, use section 5. For example: \ **man 5 nodehm**\ +To run man for any of the table descriptions below, use section 5. For example: \ **man 5 nodehm**\ The tables are: auditlog(5)|auditlog.5 - + Audit Data log. - + bootparams(5)|bootparams.5 - + Current boot settings to be sent to systems attempting network boot for deployment, stateless, or other reasons. Mostly automatically manipulated by xCAT. - + boottarget(5)|boottarget.5 - + Specify non-standard initrd, kernel, and parameters that should be used for a given profile. - + cfgmgt(5)|cfgmgt.5 - + Configuration management data for nodes used by non-xCAT osimage management services to install and configure software on a node. - + chain(5)|chain.5 - + Controls what operations are done (and it what order) when a node is discovered and deployed. - + deps(5)|deps.5 - + Describes dependencies some nodes have on others. This can be used, e.g., by rpower -d to power nodes on or off in the correct order. - + discoverydata(5)|discoverydata.5 - + Discovery data which sent from genesis. - + domain(5)|domain.5 - + Mapping of nodes to domain attributes - + eventlog(5)|eventlog.5 - + Stores the events occurred. - + firmware(5)|firmware.5 - + Maps node to firmware values to be used for setup at node discovery or later - + hosts(5)|hosts.5 - + IP addresses and hostnames of nodes. This info is optional and is only used to populate /etc/hosts and DNS via makehosts and makedns. Using regular expressions in this table can be a quick way to populate /etc/hosts. - + hwinv(5)|hwinv.5 - + The hareware inventory for the node. - + hypervisor(5)|hypervisor.5 - + Hypervisor parameters - + ipmi(5)|ipmi.5 - + Settings for nodes that are controlled by an on-board BMC via IPMI. - + iscsi(5)|iscsi.5 - + Contains settings that control how to boot a node from an iSCSI target - + kit(5)|kit.5 - + This table stores all kits added to the xCAT cluster. - + kitcomponent(5)|kitcomponent.5 - + This table stores all kit components added to the xCAT cluster. - + kitrepo(5)|kitrepo.5 - + This table stores all kits added to the xCAT cluster. - + kvm_masterdata(5)|kvm_masterdata.5 - + Persistent store for KVM plugin for masters - + kvm_nodedata(5)|kvm_nodedata.5 - + Persistent store for KVM plugin, not intended for manual modification. - + linuximage(5)|linuximage.5 - + Information about a Linux operating system image that can be used to deploy cluster nodes. - + litefile(5)|litefile.5 - + The litefile table specifies the directories and files on the statelite nodes that should be readwrite, persistent, or readonly overlay. All other files in the statelite nodes come from the readonly statelite image. - + litetree(5)|litetree.5 - + Directory hierarchy to traverse to get the initial contents of node files. The files that are specified in the litefile table are searched for in the directories specified in this table. - + mac(5)|mac.5 - + The MAC address of the node's install adapter. Normally this table is populated by getmacs or node discovery, but you can also add entries to it manually. - + mic(5)|mic.5 - + The host, slot id and configuration of the mic (Many Integrated Core). - + monitoring(5)|monitoring.5 - + Controls what external monitoring tools xCAT sets up and uses. Entries should be added and removed from this table using the provided xCAT commands monstart and monstop. - + monsetting(5)|monsetting.5 - + Specifies the monitoring plug-in specific settings. These settings will be used by the monitoring plug-in to customize the behavior such as event filter, sample interval, responses etc. Entries should be added, removed or modified by chtab command. Entries can also be added or modified by the monstart command when a monitoring plug-in is brought up. - + mp(5)|mp.5 - + Contains the hardware control info specific to blades. This table also refers to the mpa table, which contains info about each Management Module. - + mpa(5)|mpa.5 - + Contains info about each Management Module and how to access it. - + networks(5)|networks.5 - + Describes the networks in the cluster and info necessary to set up nodes on that network. - + nics(5)|nics.5 - + Stores NIC details. - + nimimage(5)|nimimage.5 - + All the info that specifies a particular AIX operating system image that can be used to deploy AIX nodes. - + nodegroup(5)|nodegroup.5 - + Contains group definitions, whose membership is dynamic depending on characteristics of the node. - + nodehm(5)|nodehm.5 - + Settings that control how each node's hardware is managed. Typically, an additional table that is specific to the hardware type of the node contains additional info. E.g. the ipmi, mp, and ppc tables. - + nodelist(5)|nodelist.5 - + The list of all the nodes in the cluster, including each node's current status and what groups it is in. - + nodepos(5)|nodepos.5 - + Contains info about the physical location of each node. Currently, this info is not used by xCAT, and therefore can be in whatevery format you want. It will likely be used in xCAT in the future. - + noderes(5)|noderes.5 - + Resources and settings to use when installing nodes. - + nodetype(5)|nodetype.5 - + A few hardware and software characteristics of the nodes. - + notification(5)|notification.5 - + Contains registrations to be notified when a table in the xCAT database changes. Users can add entries to have additional software notified of changes. Add and remove entries using the provided xCAT commands regnotif and unregnotif. - + openbmc(5)|openbmc.5 - + Setting for nodes that are controlled by an on-board OpenBMC. - + osdistro(5)|osdistro.5 - + Information about all the OS distros in the xCAT cluster - + osdistroupdate(5)|osdistroupdate.5 - + Information about the OS distro updates in the xCAT cluster - + osimage(5)|osimage.5 - + Basic information about an operating system image that can be used to deploy cluster nodes. - + passwd(5)|passwd.5 - + Contains default userids and passwords for xCAT to access cluster components. In most cases, xCAT will also actually set the userid/password in the relevant component when it is being configured or installed. Userids/passwords for specific cluster components can be overidden in other tables, e.g. mpa, ipmi, ppchcp, etc. - + pdu(5)|pdu.5 - + Parameters to use when interrogating pdus - + pduoutlet(5)|pduoutlet.5 - + Contains list of outlet numbers on the pdu each node is connected to. - + performance(5)|performance.5 - + Describes the system performance every interval unit of time. - + policy(5)|policy.5 - + The policy table in the xCAT database controls who has authority to run specific xCAT operations. It is basically the Access Control List (ACL) for xCAT. It is sorted on the priority field before evaluating. - + postscripts(5)|postscripts.5 - + The scripts that should be run on each node after installation or diskless boot. - + ppc(5)|ppc.5 - + List of system p hardware: HMCs, IVMs, FSPs, BPCs, CECs, Frames. - + ppcdirect(5)|ppcdirect.5 - + Info necessary to use FSPs/BPAs to control system p CECs/Frames. - + ppchcp(5)|ppchcp.5 - + Info necessary to use HMCs and IVMs as hardware control points for LPARs. - + prescripts(5)|prescripts.5 - + The scripts that will be run at the beginning and the end of the nodeset(Linux), nimnodeset(AIX) or mkdsklsnode(AIX) command. - + prodkey(5)|prodkey.5 - + Specify product keys for products that require them - + rack(5)|rack.5 - + Rack information. - + routes(5)|routes.5 - + Describes the additional routes needed to be setup in the os routing table. These routes usually are used to connect the management node to the compute node using the service node as gateway. - + servicenode(5)|servicenode.5 - + List of all Service Nodes and services that will be set up on the Service Node. - + site(5)|site.5 - - Global settings for the whole cluster. This table is different from the - other tables in that each attribute is just named in the key column, rather - than having a separate column for each attribute. The following is a list of + + Global settings for the whole cluster. This table is different from the + other tables in that each attribute is just named in the key column, rather + than having a separate column for each attribute. The following is a list of attributes currently used by xCAT organized into categories. - + statelite(5)|statelite.5 - + The location on an NFS server where a nodes persistent files are stored. Any file marked persistent in the litefile table will be stored in the location specified in this table for that node. - + storage(5)|storage.5 @@ -737,81 +737,81 @@ storage(5)|storage.5 switch(5)|switch.5 - + Contains what switch port numbers each node is connected to. - + switches(5)|switches.5 - + Parameters to use when interrogating switches - + taskstate(5)|taskstate.5 - + The task state for the node. - + token(5)|token.5 - + The token of users for authentication. - + virtsd(5)|virtsd.5 - + The parameters which used to create the Storage Domain - + vm(5)|vm.5 - + Virtualization parameters - + vmmaster(5)|vmmaster.5 - + Inventory of virtualization images for use with clonevm. Manual intervention in this table is not intended. - + vpd(5)|vpd.5 - + The Machine type, Model, and Serial numbers of each node. - + websrv(5)|websrv.5 - + Web service parameters - + winimage(5)|winimage.5 - + Information about a Windows operating system image that can be used to deploy cluster nodes. - + zone(5)|zone.5 - + Defines a cluster zone for nodes that share root ssh key access to each other. - + zvm(5)|zvm.5 - + List of z/VM virtual servers. - + zvmivp(5)|zvmivp.5 - + List of z/VM Installation Verification Procedures (IVPs) to be periodically run. - + @@ -820,5 +820,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **lsdef(1)**\ , \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **rmdef(1)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ , \ **lsdef(1)**\ , \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man5/xcatstanzafile.5.rst b/docs/source/guides/admin-guides/references/man5/xcatstanzafile.5.rst index 7618912c9..b8cb9d33e 100644 --- a/docs/source/guides/admin-guides/references/man5/xcatstanzafile.5.rst +++ b/docs/source/guides/admin-guides/references/man5/xcatstanzafile.5.rst @@ -23,75 +23,75 @@ A stanza file contains information that can be used to create xCAT data object d \* - + An object stanza header consists of the object name followed by a colon, (":"). - + \* - + Attribute lines must take the form of Attribute=Value. - + \* - + Attribute name might include the character dot ("."), like passwd.HMC and nicips.eth0. - + \* - + Only one stanza can exist for each object name. - + \* - + All stanzas except for default stanzas must have a value set for "objtype". - + \* - + Comments beginning with the "#" pound sign may be added to the file. A comment must be on a separate line. - + \* - + When parsing the file, tab characters and spaces are ignored. - + \* - + Each line of the file can have no more than one header or attribute definition. - + \* - + If the header name is "default-:" the attribute values in the stanza are considered default values for subsequent definitions in the file that are the same object type. - + \* - + Default stanzas can be specified multiple times and at any point in a stanza file. The values apply to all definitions following the default stanzas in a file. The default values are cumulative; a default attribute value will remain set until it is explicitly unset or changed. - + \* - + To turn off a default value, use another default stanza to set the attribute to have no value using a blank space. - + \* - + When a specific value for an attribute is provided in the stanza, it takes priority over any default value that had been set. - + The format of a stanza file should look similar to the following. @@ -103,13 +103,13 @@ The format of a stanza file should look similar to the following. attr=val attr=val . . . - + : objtype= attr=val attr=val . . . - + : objtype= attr=val @@ -125,47 +125,47 @@ EXAMPLES 1) - + Sample stanza file: - - + + .. code-block:: perl - + mysite: objtype=site rsh=/bin/rsh rcp=/bin/rcp installdir=/xcatinstall domain=ppd.pok.ibm.com - + MSnet01: objtype=network gateway=1.2.3.4 netmask=255.255.255.0 nameserver=5.6.7.8 - + default-node: next_osimage=aix61 network=MSnet01 groups=all,compute - + node01: objtype=node MAC=A2E26002C003 xcatmaster=MS02.ppd.pok.com nfsserver=IS227.ppd.pok.com - + node02: objtype=node MAC=A2E26002B004 xcatmaster=MS01.ppd.pok.com nfsserver=IS127.ppd.pok.com - + grp01: objtype=group members=node1,node2,node3 - - + + diff --git a/docs/source/guides/admin-guides/references/man5/zone.5.rst b/docs/source/guides/admin-guides/references/man5/zone.5.rst index 878c949be..b4183e642 100644 --- a/docs/source/guides/admin-guides/references/man5/zone.5.rst +++ b/docs/source/guides/admin-guides/references/man5/zone.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **zone Attributes:**\ \ *zonename*\ , \ *sshkeydir*\ , \ *sshbetweennodes*\ , \ *defaultzone*\ , \ *comments*\ , \ *disable*\ +\ **zone Attributes:**\ \ *zonename*\ , \ *sshkeydir*\ , \ *sshbetweennodes*\ , \ *defaultzone*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,40 +36,40 @@ zone Attributes: -\ **zonename**\ - +\ **zonename**\ + The name of the zone. + - -\ **sshkeydir**\ - +\ **sshkeydir**\ + Directory containing the shared root ssh RSA keys. + - -\ **sshbetweennodes**\ - +\ **sshbetweennodes**\ + Indicates whether passwordless ssh will be setup between the nodes of this zone. Values are yes/1 or no/0. Default is yes. + - -\ **defaultzone**\ - +\ **defaultzone**\ + If nodes are not assigned to any other zone, they will default to this zone. If value is set to yes or 1. + - -\ **comments**\ - +\ **comments**\ + Any user-provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. - + @@ -78,5 +78,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/zvm.5.rst b/docs/source/guides/admin-guides/references/man5/zvm.5.rst index 9e7c8d2fb..249977d9b 100644 --- a/docs/source/guides/admin-guides/references/man5/zvm.5.rst +++ b/docs/source/guides/admin-guides/references/man5/zvm.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **zvm Attributes:**\ \ *node*\ , \ *hcp*\ , \ *userid*\ , \ *nodetype*\ , \ *parent*\ , \ *comments*\ , \ *disable*\ , \ *discovered*\ , \ *status*\ +\ **zvm Attributes:**\ \ *node*\ , \ *hcp*\ , \ *userid*\ , \ *nodetype*\ , \ *parent*\ , \ *comments*\ , \ *disable*\ , \ *discovered*\ , \ *status*\ *********** @@ -36,58 +36,58 @@ zvm Attributes: -\ **node**\ - +\ **node**\ + The node name. + - -\ **hcp**\ - +\ **hcp**\ + The hardware control point for this node. + - -\ **userid**\ - +\ **userid**\ + The z/VM userID of this node. + - -\ **nodetype**\ - +\ **nodetype**\ + The node type. Valid values: cec (Central Electronic Complex), lpar (logical partition), zvm (z/VM host operating system), and vm (virtual machine). + - -\ **parent**\ - +\ **parent**\ + The parent node. For LPAR, this specifies the CEC. For z/VM, this specifies the LPAR. For VM, this specifies the z/VM host operating system. + - -\ **comments**\ - +\ **comments**\ + Any user provided notes. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to comment out this row. + - -\ **discovered**\ - +\ **discovered**\ + Set to '1' to indicate this node was discovered. + - -\ **status**\ - +\ **status**\ + The processing status. Key value pairs (key=value) indicating status of the node. Multiple pairs are separated by semi-colons. Keys include: CLONING, CLONE_ONLY. - + @@ -96,5 +96,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man5/zvmivp.5.rst b/docs/source/guides/admin-guides/references/man5/zvmivp.5.rst index b41bd902c..04e5714ba 100644 --- a/docs/source/guides/admin-guides/references/man5/zvmivp.5.rst +++ b/docs/source/guides/admin-guides/references/man5/zvmivp.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **zvmivp Attributes:**\ \ *id*\ , \ *ip*\ , \ *schedule*\ , \ *last_run*\ , \ *type_of_run*\ , \ *access_user*\ , \ *orch_parms*\ , \ *prep_parms*\ , \ *main_ivp_parms*\ , \ *comments*\ , \ *disable*\ +\ **zvmivp Attributes:**\ \ *id*\ , \ *ip*\ , \ *schedule*\ , \ *last_run*\ , \ *type_of_run*\ , \ *access_user*\ , \ *orch_parms*\ , \ *prep_parms*\ , \ *main_ivp_parms*\ , \ *comments*\ , \ *disable*\ *********** @@ -36,70 +36,70 @@ zvmivp Attributes: -\ **id**\ - +\ **id**\ + Unique identifier associated with the IVP run, e.g. 1. + - -\ **ip**\ - +\ **ip**\ + IP address of the target system, either the IP of the OpenStack compute node or the xCAT management node. + - -\ **schedule**\ - +\ **schedule**\ + The hours (0-24) that the IVP should be run. Multiple hours are separated by a blank. + - -\ **last_run**\ - +\ **last_run**\ + The last time the IVP was run specified as a set of 3 blank delimeted words: year, Julian date, and hour (in 24 hour format). + - -\ **type_of_run**\ - +\ **type_of_run**\ + The type of run requested, 'fullivp' or 'basicivp'. + - -\ **access_user**\ - +\ **access_user**\ + User on the OpenStack node that is used to: push the IVP preparation script to the OpenStack system, drive the preparation script to validate the OpenStack configuration files, and return the created driver script to the xCAT MN system for the next part of the IVP. This user should be able to access the OpenStack configuration files that are scanned by the IVP. + - -\ **orch_parms**\ - +\ **orch_parms**\ + Parameters to pass to the IVP orchestrator script, verifynode. + - -\ **prep_parms**\ - +\ **prep_parms**\ + Parameters to pass to the phase 1 IVP preparation script. + - -\ **main_ivp_parms**\ - +\ **main_ivp_parms**\ + Parameters to pass to the main IVP script. + - -\ **comments**\ - +\ **comments**\ + Any user provided notes or description of the run. + - -\ **disable**\ - +\ **disable**\ + Set to 'yes' or '1' to disable this IVP run. - + @@ -108,5 +108,5 @@ SEE ALSO ******** -\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ +\ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ diff --git a/docs/source/guides/admin-guides/references/man7/auditlog.7.rst b/docs/source/guides/admin-guides/references/man7/auditlog.7.rst index 833d7a18f..e6e270384 100644 --- a/docs/source/guides/admin-guides/references/man7/auditlog.7.rst +++ b/docs/source/guides/admin-guides/references/man7/auditlog.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **auditlog Attributes:**\ \ *args*\ , \ *audittime*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *comments*\ , \ *disable*\ , \ *noderange*\ , \ *recid*\ , \ *status*\ , \ *userid*\ +\ **auditlog Attributes:**\ \ *args*\ , \ *audittime*\ , \ *clientname*\ , \ *clienttype*\ , \ *command*\ , \ *comments*\ , \ *disable*\ , \ *noderange*\ , \ *recid*\ , \ *status*\ , \ *userid*\ *********** @@ -40,69 +40,69 @@ 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. See auditskipcmds site table attribute to control which commands get logged. - + \ **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. - + @@ -111,5 +111,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 3895b5ff4..be767a2fc 100644 --- a/docs/source/guides/admin-guides/references/man7/boottarget.7.rst +++ b/docs/source/guides/admin-guides/references/man7/boottarget.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **boottarget Attributes:**\ \ *bprofile*\ , \ *comments*\ , \ *initrd*\ , \ *kcmdline*\ , \ *kernel*\ +\ **boottarget Attributes:**\ \ *bprofile*\ , \ *comments*\ , \ *initrd*\ , \ *kcmdline*\ , \ *kernel*\ *********** @@ -40,33 +40,33 @@ boottarget Attributes: \ **bprofile**\ (boottarget.bprofile) - + All nodes with a nodetype.profile value equal to this value and nodetype.os set to "boottarget", will use the associated kernel, initrd, and kcmdline. - + \ **comments**\ (boottarget.comments) - + Any user-written notes. - + \ **initrd**\ (boottarget.initrd) - + The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel) - + \ **kcmdline**\ (boottarget.kcmdline) - + Arguments to be passed to the kernel - + \ **kernel**\ (boottarget.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 - + @@ -75,5 +75,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 2a97b9988..ff31cbe01 100644 --- a/docs/source/guides/admin-guides/references/man7/eventlog.7.rst +++ b/docs/source/guides/admin-guides/references/man7/eventlog.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **eventlog Attributes:**\ \ *application*\ , \ *comments*\ , \ *component*\ , \ *disable*\ , \ *eventtime*\ , \ *eventtype*\ , \ *id*\ , \ *message*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *rawdata*\ , \ *recid*\ , \ *severity*\ +\ **eventlog Attributes:**\ \ *application*\ , \ *comments*\ , \ *component*\ , \ *disable*\ , \ *eventtime*\ , \ *eventtype*\ , \ *id*\ , \ *message*\ , \ *monitor*\ , \ *monnode*\ , \ *node*\ , \ *rawdata*\ , \ *recid*\ , \ *severity*\ *********** @@ -40,87 +40,87 @@ 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) - + 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. - + @@ -129,5 +129,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 2c8ee454d..43a6da7cc 100644 --- a/docs/source/guides/admin-guides/references/man7/firmware.7.rst +++ b/docs/source/guides/admin-guides/references/man7/firmware.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **firmware Attributes:**\ \ *cfgfile*\ , \ *comments*\ , \ *disable*\ +\ **firmware Attributes:**\ \ *cfgfile*\ , \ *comments*\ , \ *disable*\ *********** @@ -40,21 +40,21 @@ 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. - + @@ -63,5 +63,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index c4d1849d7..0fd1d23b7 100644 --- a/docs/source/guides/admin-guides/references/man7/group.7.rst +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -19,7 +19,7 @@ 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*\ +\ **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*\ *********** @@ -40,601 +40,601 @@ group Attributes: \ **addkcmdline**\ (bootparams.addkcmdline) - + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ") - + \ **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. - + \ **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. - - + + .. code-block:: perl - + 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. - + \ **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=, runimage=, 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 allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. 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'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0', the value for PCI device format also can be like:'devpassthrough:0001:01:00.1', the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. - + \ **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) - + 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...". 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=]![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 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: - - + + .. code-block:: perl - + 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!,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 . - + \ **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 | . !|,!, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices. 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: !,!, 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. If only one ip address is associated with each NIC: !,!,..., for example, eth0!eth0-,ib0!ib- @@ -642,222 +642,222 @@ group Attributes: !|,!|,..., 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) 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: !,!,..., for example, eth0!-eth0,ib0!-ib0 If multiple ip addresses are associated 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. - - + + .. code-block:: perl - + 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: !,!,..., 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. 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. - + \ **nicsadapter**\ (nics.nicsadapter) - + Comma-separated list of NIC information collected by getadapter. !,!, 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. !,!, 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, 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\*,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 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. + - 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. + 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. @@ -866,510 +866,510 @@ group Attributes: 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: + 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) - + - 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 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: / - + \ **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 allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. 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'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0', the value for PCI device format also can be like:'devpassthrough:0001:01:00.1', the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. - + \ **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/ 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: imageformat=[raw|fullraw|qcow2] @@ -1380,31 +1380,31 @@ group Attributes: 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. - + @@ -1413,5 +1413,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man7/kit.7.rst b/docs/source/guides/admin-guides/references/man7/kit.7.rst index d5626623d..e6062763f 100644 --- a/docs/source/guides/admin-guides/references/man7/kit.7.rst +++ b/docs/source/guides/admin-guides/references/man7/kit.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kit Attributes:**\ \ *basename*\ , \ *description*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *kitname*\ , \ *ostype*\ , \ *release*\ , \ *version*\ +\ **kit Attributes:**\ \ *basename*\ , \ *description*\ , \ *isinternal*\ , \ *kitdeployparams*\ , \ *kitdir*\ , \ *kitname*\ , \ *ostype*\ , \ *release*\ , \ *version*\ *********** @@ -40,57 +40,57 @@ 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 - + @@ -99,5 +99,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 6ab65f5aa..a5d222d13 100644 --- a/docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst +++ b/docs/source/guides/admin-guides/references/man7/kitcomponent.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kitcomponent Attributes:**\ \ *basename*\ , \ *description*\ , \ *driverpacks*\ , \ *exlist*\ , \ *genimage_postinstall*\ , \ *kitcompdeps*\ , \ *kitcompname*\ , \ *kitname*\ , \ *kitpkgdeps*\ , \ *kitreponame*\ , \ *postbootscripts*\ , \ *prerequisite*\ , \ *release*\ , \ *serverroles*\ , \ *version*\ +\ **kitcomponent Attributes:**\ \ *basename*\ , \ *description*\ , \ *driverpacks*\ , \ *exlist*\ , \ *genimage_postinstall*\ , \ *kitcompdeps*\ , \ *kitcompname*\ , \ *kitname*\ , \ *kitpkgdeps*\ , \ *kitreponame*\ , \ *postbootscripts*\ , \ *prerequisite*\ , \ *release*\ , \ *serverroles*\ , \ *version*\ *********** @@ -40,93 +40,93 @@ 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. - + @@ -135,5 +135,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 4abf1a4bf..e5bf6c359 100644 --- a/docs/source/guides/admin-guides/references/man7/kitrepo.7.rst +++ b/docs/source/guides/admin-guides/references/man7/kitrepo.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **kitrepo Attributes:**\ \ *compat_osbasenames*\ , \ *kitname*\ , \ *kitrepodir*\ , \ *kitreponame*\ , \ *osarch*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ +\ **kitrepo Attributes:**\ \ *compat_osbasenames*\ , \ *kitname*\ , \ *kitrepodir*\ , \ *kitreponame*\ , \ *osarch*\ , \ *osbasename*\ , \ *osmajorversion*\ , \ *osminorversion*\ *********** @@ -40,51 +40,51 @@ 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. - + @@ -93,5 +93,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 478824ad7..8c7953e7f 100644 --- a/docs/source/guides/admin-guides/references/man7/monitoring.7.rst +++ b/docs/source/guides/admin-guides/references/man7/monitoring.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **monitoring Attributes:**\ \ *comments*\ , \ *disable*\ , \ *name*\ , \ *nodestatmon*\ +\ **monitoring Attributes:**\ \ *comments*\ , \ *disable*\ , \ *name*\ , \ *nodestatmon*\ *********** @@ -40,27 +40,27 @@ 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 monitoring 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". - + @@ -69,5 +69,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 9702cc574..593a52fb0 100644 --- a/docs/source/guides/admin-guides/references/man7/network.7.rst +++ b/docs/source/guides/admin-guides/references/man7/network.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **network Attributes:**\ \ *ddnsdomain*\ , \ *dhcpserver*\ , \ *domain*\ , \ *dynamicrange*\ , \ *gateway*\ , \ *logservers*\ , \ *mask*\ , \ *mgtifname*\ , \ *mtu*\ , \ *nameservers*\ , \ *net*\ , \ *netname*\ , \ *nodehostname*\ , \ *ntpservers*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *tftpserver*\ , \ *usercomment*\ , \ *vlanid*\ +\ **network Attributes:**\ \ *ddnsdomain*\ , \ *dhcpserver*\ , \ *domain*\ , \ *dynamicrange*\ , \ *gateway*\ , \ *logservers*\ , \ *mask*\ , \ *mgtifname*\ , \ *mtu*\ , \ *nameservers*\ , \ *net*\ , \ *netname*\ , \ *nodehostname*\ , \ *ntpservers*\ , \ *staticrange*\ , \ *staticrangeincrement*\ , \ *tftpserver*\ , \ *usercomment*\ , \ *vlanid*\ *********** @@ -40,93 +40,93 @@ 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. - + \ **mtu**\ (networks.mtu) - + The default MTU for the network, If multiple networks are applied to the same nic on the SN and/or CN, the MTU shall be the same for those networks. - + \ **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) @@ -134,21 +134,21 @@ network Attributes: \ **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. - + @@ -157,5 +157,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 0a57e2ceb..c8f61824d 100644 --- a/docs/source/guides/admin-guides/references/man7/node.7.rst +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **node Attributes:**\ \ *addkcmdline*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *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*\ , \ *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*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *node*\ , \ *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*\ , \ *primarysn*\ , \ *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*\ , \ *status*\ , \ *statustime*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *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*\ +\ **node Attributes:**\ \ *addkcmdline*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *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*\ , \ *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*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *node*\ , \ *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*\ , \ *primarysn*\ , \ *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*\ , \ *status*\ , \ *statustime*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *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*\ *********** @@ -40,601 +40,601 @@ node Attributes: \ **addkcmdline**\ (bootparams.addkcmdline) - + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ") - + \ **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 - + \ **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. - + \ **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. - - + + .. code-block:: perl - + 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. - + \ **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=, runimage=, 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 allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. 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'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0', the value for PCI device format also can be like:'devpassthrough:0001:01:00.1', the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. - + \ **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. - + \ **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...". 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. - + \ **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=]![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 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: - - + + .. code-block:: perl - + 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!,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 . - + \ **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 | . !|,!, e.g. bond0!eth0|eth2,br0!bond0. The xCAT object definition commands support to use nicdevices. 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: !,!, 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. If only one ip address is associated with each NIC: !,!,..., for example, eth0!eth0-,ib0!ib- @@ -642,228 +642,228 @@ node Attributes: !|,!|,..., 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) 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: !,!,..., for example, eth0!-eth0,ib0!-ib0 If multiple ip addresses are associated 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. - - + + .. code-block:: perl - + 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: !,!,..., 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. 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. - + \ **nicsadapter**\ (nics.nicsadapter) - + Comma-separated list of NIC information collected by getadapter. !,!, 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. !,!, 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, 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\*,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 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. + - 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. + 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. @@ -872,540 +872,540 @@ node Attributes: 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: + 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. - + \ **primarysn**\ (nodelist.primarysn) - + Not used currently. The primary servicenode, used by this node. - + \ **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) - + - 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 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. - + \ **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 sequences are: For installation: defined->[discovering]->[configuring]->[standingby]->installing->booting->[postbooting]->booted->[alive], For diskless deployment: defined->[discovering]->[configuring]->[standingby]->netbooting->[postbooting]->booted->[alive], For booting: [alive/unreachable]->booting->[postbooting]->booted->[alive], For powering off: [alive]->powering-off->[unreachable], For monitoring: alive->unreachable. Discovering and configuring are for x Series discovery process. Alive and unreachable are set only when there is a monitoring plug-in start monitor the node status for xCAT. 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. 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 - + \ **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, 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 allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. 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'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0', the value for PCI device format also can be like:'devpassthrough:0001:01:00.1', the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively, the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. - + \ **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/ 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: imageformat=[raw|fullraw|qcow2] @@ -1416,31 +1416,31 @@ node Attributes: 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. - + @@ -1449,5 +1449,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index e7dbb4f1d..c93c46647 100644 --- a/docs/source/guides/admin-guides/references/man7/notification.7.rst +++ b/docs/source/guides/admin-guides/references/man7/notification.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **notification Attributes:**\ \ *comments*\ , \ *filename*\ , \ *tableops*\ , \ *tables*\ +\ **notification Attributes:**\ \ *comments*\ , \ *filename*\ , \ *tableops*\ , \ *tables*\ *********** @@ -40,27 +40,27 @@ 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. - + @@ -69,5 +69,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 2f1dad7dd..f1a87361c 100644 --- a/docs/source/guides/admin-guides/references/man7/osdistro.7.rst +++ b/docs/source/guides/admin-guides/references/man7/osdistro.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **osdistro Attributes:**\ \ *arch*\ , \ *basename*\ , \ *dirpaths*\ , \ *majorversion*\ , \ *minorversion*\ , \ *osdistroname*\ , \ *type*\ +\ **osdistro Attributes:**\ \ *arch*\ , \ *basename*\ , \ *dirpaths*\ , \ *majorversion*\ , \ *minorversion*\ , \ *osdistroname*\ , \ *type*\ *********** @@ -40,45 +40,45 @@ 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 - + @@ -87,5 +87,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 11cf48b50..17850864c 100644 --- a/docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst +++ b/docs/source/guides/admin-guides/references/man7/osdistroupdate.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **osdistroupdate Attributes:**\ \ *dirpath*\ , \ *downloadtime*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *usercomment*\ +\ **osdistroupdate Attributes:**\ \ *dirpath*\ , \ *downloadtime*\ , \ *osdistroname*\ , \ *osupdatename*\ , \ *usercomment*\ *********** @@ -40,33 +40,33 @@ 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. - + @@ -75,5 +75,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 060118843..ee93d48b0 100644 --- a/docs/source/guides/admin-guides/references/man7/osimage.7.rst +++ b/docs/source/guides/admin-guides/references/man7/osimage.7.rst @@ -19,7 +19,7 @@ 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*\ +\ **osimage Attributes:**\ \ *addkcmdline*\ , \ *boottarget*\ , \ *bosinst_data*\ , \ *cfmdir*\ , \ *configdump*\ , \ *crashkernelsize*\ , \ *description*\ , \ *driverupdatesrc*\ , \ *dump*\ , \ *environvar*\ , \ *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*\ *********** @@ -40,245 +40,251 @@ osimage Attributes: \ **addkcmdline**\ (linuximage.addkcmdline) - + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" "). 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_source_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. + +\ **environvar**\ (osimage.environvar) + + Comma delimited environment variables for the osimage + + \ **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 and urls of internet repos from which the non-distro packages are retrived. Only 1 local directory is supported at present. The entries should be delimited with comma ",". Currently, the internet repos are only supported on Ubuntu and Redhat. - + \ **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 to multiple paths. The multiple paths must be separated 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) - + Only available for diskful osimages and statelite osimages(localdisk enabled). The full path of the partition file or the script to generate the partition file. The valid value includes: "": For diskful osimages, the partition file contains the partition definition that will be inserted directly into the template file for os installation. The syntax and format of the partition file should confirm to the corresponding OS installer of the Linux distributions(e.g. kickstart for RedHat, autoyast for SLES, pressed for Ubuntu). For statelite osimages, when the localdisk is enabled, the partition file with specific syntax and format includes the partition scheme of the local disk, please refer to the statelite documentation for details. "s:": a shell script to generate the partition file "/tmp/partitionfile" inside the installer before the installation start. @@ -286,44 +292,44 @@ osimage Attributes: "s:d:": only available for ubuntu osimages, a script to generate the disk name file "/tmp/xcat.install_disk" inside the debian installer. This script is run in the "pressed/early_command" section. "c:": only availbe for ubuntu osimages, contains the additional pressed entries in "d-i ..." form. This can be used to specify some additional preseed options to support RAID or LVM in Ubuntu. "s:c:": only available for ubuntu osimages, 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 to multiple paths. The multiple paths must be separated 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 diskful 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) - - Supported in diskless image only. The fully qualified name of the scripts running in non-chroot mode after the package installation but before initrd generation during genimage. If multiple scripts are specified, they should be seperated with comma ",". A set of osimage attributes are exported as the environment variables to be used in the postinstall scripts: - - + + Supported in diskless image only. The fully qualified name of the scripts and the user-specified arguments running in non-chroot mode after the package installation but before initrd generation during genimage. If multiple scripts are specified, they should be seperated with comma ",". The arguments passed to each postinstall script include 4 implicit arguments(,,,) and the user-specified arguments. A set of osimage attributes are exported as the environment variables to be used in the postinstall scripts: + + .. code-block:: perl - + IMG_ARCH(The architecture of the osimage, such as "ppc64le","x86_64"), IMG_NAME(The name of the osimage, such as "rhels7.3-ppc64le-netboot-compute"), IMG_OSVER(The os release of the osimage, such as "rhels7.3","sles11.4"), @@ -334,118 +340,118 @@ osimage Attributes: IMG_OTHERPKGLIST(the "otherpkglist" attribute of the osimage), IMG_OTHERPKGDIR(the "otherpkgdir" attribute of the osimage), IMG_ROOTIMGDIR(the "rootimgdir" attribute of the osimage) - - + + \ **postscripts**\ (osimage.postscripts) - + Comma separated list of scripts that should be run on this image after diskful 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. - + \ **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 - + @@ -454,5 +460,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man7/pdu.7.rst b/docs/source/guides/admin-guides/references/man7/pdu.7.rst index 72e27fd3d..de02c50e9 100644 --- a/docs/source/guides/admin-guides/references/man7/pdu.7.rst +++ b/docs/source/guides/admin-guides/references/man7/pdu.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *outlet*\ +\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *outlet*\ *********** @@ -40,21 +40,21 @@ pdu Attributes: \ **node**\ (pdu.node) - + The hostname/address of the pdu to which the settings apply - + \ **nodetype**\ (pdu.nodetype) - + The node type should be pdu - + \ **outlet**\ (pdu.outlet) - + The pdu outlet count - + @@ -63,5 +63,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 8967d20e9..b920c052f 100644 --- a/docs/source/guides/admin-guides/references/man7/policy.7.rst +++ b/docs/source/guides/admin-guides/references/man7/policy.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **policy Attributes:**\ \ *commands*\ , \ *host*\ , \ *name*\ , \ *noderange*\ , \ *parameters*\ , \ *priority*\ , \ *rule*\ , \ *time*\ , \ *usercomment*\ +\ **policy Attributes:**\ \ *commands*\ , \ *host*\ , \ *name*\ , \ *noderange*\ , \ *parameters*\ , \ *priority*\ , \ *rule*\ , \ *time*\ , \ *usercomment*\ *********** @@ -40,57 +40,57 @@ 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, trusted. Allow 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. - + @@ -99,5 +99,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index b2ddd3795..1403a7da0 100644 --- a/docs/source/guides/admin-guides/references/man7/rack.7.rst +++ b/docs/source/guides/admin-guides/references/man7/rack.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **rack Attributes:**\ \ *displayname*\ , \ *height*\ , \ *num*\ , \ *rackname*\ , \ *room*\ , \ *usercomment*\ +\ **rack Attributes:**\ \ *displayname*\ , \ *height*\ , \ *num*\ , \ *rackname*\ , \ *room*\ , \ *usercomment*\ *********** @@ -40,39 +40,39 @@ 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. - + @@ -81,5 +81,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 55b451253..1cbef8fc8 100644 --- a/docs/source/guides/admin-guides/references/man7/route.7.rst +++ b/docs/source/guides/admin-guides/references/man7/route.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **route Attributes:**\ \ *gateway*\ , \ *ifname*\ , \ *mask*\ , \ *net*\ , \ *routename*\ , \ *usercomment*\ +\ **route Attributes:**\ \ *gateway*\ , \ *ifname*\ , \ *mask*\ , \ *net*\ , \ *routename*\ , \ *usercomment*\ *********** @@ -40,39 +40,39 @@ 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. - + @@ -81,5 +81,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index 7c341e89b..c617ecd0f 100644 --- a/docs/source/guides/admin-guides/references/man7/site.7.rst +++ b/docs/source/guides/admin-guides/references/man7/site.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **site Attributes:**\ \ *installdir*\ , \ *master*\ , \ *xcatdport*\ +\ **site Attributes:**\ \ *installdir*\ , \ *master*\ , \ *xcatdport*\ *********** @@ -40,21 +40,21 @@ site Attributes: \ **installdir**\ (site.value) - + The installation directory - + \ **master**\ (site.value) - + The management node - + \ **xcatdport**\ (site.value) - + Port used by xcatd daemon on master - + @@ -63,5 +63,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man7/taskstate.7.rst b/docs/source/guides/admin-guides/references/man7/taskstate.7.rst index 09209820a..464a2206d 100644 --- a/docs/source/guides/admin-guides/references/man7/taskstate.7.rst +++ b/docs/source/guides/admin-guides/references/man7/taskstate.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **taskstate Attributes:**\ \ *command*\ , \ *disable*\ , \ *node*\ , \ *pid*\ , \ *reserve*\ , \ *state*\ +\ **taskstate Attributes:**\ \ *command*\ , \ *disable*\ , \ *node*\ , \ *pid*\ , \ *reserve*\ , \ *state*\ *********** @@ -40,39 +40,39 @@ taskstate Attributes: \ **command**\ (taskstate.command) - + Current command is running - + \ **disable**\ (taskstate.disable) - + Set to 'yes' or '1' to comment out this row. - + \ **node**\ (taskstate.node) - + The node name. - + \ **pid**\ (taskstate.pid) - + The process id of the request process. - + \ **reserve**\ (taskstate.reserve) - + used to lock the node - + \ **state**\ (taskstate.state) - + The task state(callback, running) for the node. - + @@ -81,5 +81,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **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 index e96c9c0c3..7dca58ceb 100644 --- a/docs/source/guides/admin-guides/references/man7/zone.7.rst +++ b/docs/source/guides/admin-guides/references/man7/zone.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **zone Attributes:**\ \ *defaultzone*\ , \ *sshbetweennodes*\ , \ *sshkeydir*\ , \ *usercomment*\ , \ *zonename*\ +\ **zone Attributes:**\ \ *defaultzone*\ , \ *sshbetweennodes*\ , \ *sshkeydir*\ , \ *usercomment*\ , \ *zonename*\ *********** @@ -40,33 +40,33 @@ 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. - + @@ -75,5 +75,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man7/zvmivp.7.rst b/docs/source/guides/admin-guides/references/man7/zvmivp.7.rst index 8d7c12ac9..5a8aeb8bf 100644 --- a/docs/source/guides/admin-guides/references/man7/zvmivp.7.rst +++ b/docs/source/guides/admin-guides/references/man7/zvmivp.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **zvmivp Attributes:**\ \ **\ +\ **zvmivp Attributes:**\ \ **\ *********** @@ -45,5 +45,5 @@ SEE ALSO ******** -\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ +\ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ diff --git a/docs/source/guides/admin-guides/references/man8/chtab.8.rst b/docs/source/guides/admin-guides/references/man8/chtab.8.rst index 65e69fbc2..cfe8e265c 100644 --- a/docs/source/guides/admin-guides/references/man8/chtab.8.rst +++ b/docs/source/guides/admin-guides/references/man8/chtab.8.rst @@ -58,11 +58,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -73,64 +73,64 @@ EXAMPLES -1. To add a node=node1 to the nodelist table with groups=all: - - +1. To add a node=node1 to the nodelist table with groups=all: + + .. code-block:: perl - + chtab node=node1 nodelist.groups=all - - + + 2. To add a keyword (tftpdir) and value (/tftpboot) to the site table: - - + + .. code-block:: perl - + chtab key=tftpdir site.value=/tftpboot + + - - -3. To add node1 to the nodetype table with os=rhel5: - - +3. To add node1 to the nodetype table with os=rhel5: + + .. code-block:: perl - + chtab node=node1 nodetype.os=rhel5 + + - - -4. To change node1 in nodetype table setting os=sles: - - +4. To change node1 in nodetype table setting os=sles: + + .. code-block:: perl - + chtab node=node1 nodetype.os=sles - - + + 5. To change node1 by appending otherpkgs to the postbootscripts field in the postscripts table: - - + + .. code-block:: perl - + chtab node=node1 postscripts.postbootscripts+=otherpkgs - - + + 6. To delete node1 from nodetype table: - - + + .. code-block:: perl - + chtab -d node=node1 nodetype - - + + diff --git a/docs/source/guides/admin-guides/references/man8/copycds-cdrom.8.rst b/docs/source/guides/admin-guides/references/man8/copycds-cdrom.8.rst index bc9f48015..ef33aff24 100644 --- a/docs/source/guides/admin-guides/references/man8/copycds-cdrom.8.rst +++ b/docs/source/guides/admin-guides/references/man8/copycds-cdrom.8.rst @@ -11,7 +11,7 @@ SYNOPSIS ******** -\ **copycds-cdrom**\ \ *[copycds options]*\ \ *[drive]*\ +\ **copycds-cdrom**\ \ *[copycds options]*\ \ *[drive]*\ *********** diff --git a/docs/source/guides/admin-guides/references/man8/copycds.8.rst b/docs/source/guides/admin-guides/references/man8/copycds.8.rst index 6353a9dde..37c399113 100644 --- a/docs/source/guides/admin-guides/references/man8/copycds.8.rst +++ b/docs/source/guides/admin-guides/references/man8/copycds.8.rst @@ -44,40 +44,40 @@ OPTIONS -\ **-n|-**\ **-name|-**\ **-osver**\ =\ *distroname*\ - +\ **-n|-**\ **-name|-**\ **-osver**\ =\ *distroname*\ + The linux distro name and version that the ISO/DVD contains. Examples: rhels6.3, sles11.2, fedora9. Note the 's' in rhels6.3 which denotes the Server version of RHEL, which is typically used. + - -\ **-a|-**\ **-arch**\ =\ *architecture*\ - +\ **-a|-**\ **-arch**\ =\ *architecture*\ + The architecture of the linux distro on the ISO/DVD. Examples: x86, x86_64, ppc64, s390x. + - -\ **-p|-**\ **-path**\ =\ *ospkgpath*\ - +\ **-p|-**\ **-path**\ =\ *ospkgpath*\ + The destination directory to which the contents of ISO/DVD will be copied. When this option is not specified, the default destination directory will be formed from the \ **installdir**\ site table attribute and the distro name and architecture, for example: /install/rhel6.3/x86_64. This option is only supported for distributions of sles, redhat and windows. + - -\ **-i|-**\ **-inspection**\ - +\ **-i|-**\ **-inspection**\ + Check whether xCAT can recognize the DVDs/ISOs in the argument list, but do not copy the disc. Displays the os distribution name, architecture and disc no of each recognized DVD/ISO. This option is only supported for distributions of sles, redhat and windows. + - -\ **-o|-**\ **-noosimage**\ - +\ **-o|-**\ **-noosimage**\ + Do not create the default osimages based on the osdistro copied in. By default, \ **copycds**\ will create a set of osimages based on the osdistro. + - -\ **-w|-**\ **-nonoverwrite**\ - +\ **-w|-**\ **-nonoverwrite**\ + Complain and exit if the os disc has already been copied in. By default, \ **copycds**\ will overwrite the os disc already copied in. - + @@ -98,74 +98,74 @@ EXAMPLES 1. To copy the RPMs from a set of ISOs that represent the DVDs of a distro: - - + + .. code-block:: perl - + copycds dvd1.iso dvd2.iso - - + + 2. To copy the RPMs from a physical DVD to /depot/kits/3 directory: - - + + .. code-block:: perl - + copycds -p /depot/kits/3 /dev/dvd - - + + 3. To copy the RPMs from a DVD ISO of a very recently released distro: - - + + .. code-block:: perl - + copycds -n rhels6.4 -a x86_64 dvd.iso - - + + 4. To check whether a DVD ISO can be recognized by xCAT and display the recognized disc info: - - + + .. code-block:: perl - + copycds -i /media/RHEL/6.2/RHEL6.2-20111117.0-Server-ppc64-DVD1.iso - - + + Output will be similar to: - - + + .. code-block:: perl - + OS Image:/media/RHEL/6.2/RHEL6.2-20111117.0-Server-ppc64-DVD1.iso DISTNAME:rhels6.2 ARCH:ppc64 DISCNO:1 - - + + For the attributes that are not recognized, the value will be blank. - + 5. To copy the packages from a supplemental DVD ISO file: - - + + .. code-block:: perl - + copycds /isodir/RHEL6.5/RHEL6.5-Supplementary-20131114.2-Server-ppc64-DVD1.iso -n rhels6.5-supp - - + + Also, remember to add the new directory to your osimage definition: - - + + .. code-block:: perl - + chdef -t osimage myosimage -p pkgdir=/install/rhels6.5-supp/ppc64 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/makedhcp.8.rst b/docs/source/guides/admin-guides/references/man8/makedhcp.8.rst index ee3a581d5..da215317c 100644 --- a/docs/source/guides/admin-guides/references/man8/makedhcp.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makedhcp.8.rst @@ -29,9 +29,9 @@ SYNOPSIS \ **makedhcp**\ \ *noderange*\ [\ **-s**\ \ *statements*\ ] [\ **-l | -**\ **-localonly**\ ] -\ **makedhcp**\ \ **-q**\ \ *noderange*\ +\ **makedhcp**\ \ **-q**\ \ *noderange*\ -\ **makedhcp**\ \ **[-h|-**\ **-help]**\ +\ **makedhcp**\ \ **[-h|-**\ **-help]**\ *********** @@ -44,30 +44,30 @@ The \ **makedhcp**\ command is supported for both Linux and AIX clusters. 1. - + Start by filling out the networks(5)|networks.5 table properly. - + 2. - + Then use the \ **makedhcp -n**\ option to create a new dhcp configuration file. You can set the site table, dhcplease attribute to the lease time for the dhcp client. The default value is 43200. - + 3. - + Next, get the node IP addresses and MACs defined in the xCAT database. Also, get the hostnames and IP addresses pushed to /etc/hosts (using makehosts(8)|makehosts.8) and to DNS (using makedns(8)|makedns.8). - + 4. - + Then run \ **makedhcp**\ with a noderange or the \ **-a**\ option. This will inject into dhcpd configuration data pertinent to the specified nodes. On linux, the configuration information immediately takes effect without a restart of DHCP. - + If you need to delete node entries from the DHCP configuration, use the \ **-d**\ flag. @@ -79,8 +79,8 @@ OPTIONS -\ **-n**\ - +\ **-n**\ + Create a new dhcp configuration file with a network statement for each network the dhcp daemon should listen on. (Which networks dhcpd should listen on can be controlled by the dhcpinterfaces attribute in the site(5)|site.5 table.) The \ **makedhcp**\ command will automatically restart the dhcp daemon after this operation. @@ -88,58 +88,58 @@ OPTIONS For Linux systems the file will include network entries as well as certain general parameters such as a dynamic range and omapi configuration. For AIX systems the file will include network entries. On AIX systems, if there are any non-xCAT entries in the existing configuration file they will be preserved and added to the end of the new configuration file. + - -\ **-a**\ - +\ **-a**\ + Define all nodes to the DHCP server. (Will only add nodes that can be reached, network-wise, by this DHCP server.) The dhcp daemon does not have to be restarted after this. On AIX systems \ **makedhcp**\ will not add entries for cluster nodes that will be installed using NIM. The entries for these nodes will be managed by NIM. + - -\ *noderange*\ - +\ *noderange*\ + Add the specified nodes to the DHCP server configuration. + - -\ **-s**\ \ *statements*\ - +\ **-s**\ \ *statements*\ + For the input noderange, the argument will be interpreted like dhcp configuration file text. + - -\ **-d**\ \ *noderange*\ - +\ **-d**\ \ *noderange*\ + Delete node entries from the DHCP server configuration. On AIX, any entries created by NIM will not be removed. + - -\ **-a -d**\ - +\ **-a -d**\ + Delete all node entries, that were added by xCAT, from the DHCP server configuration. + - -\ **-l | -**\ **-localonly**\ - +\ **-l | -**\ **-localonly**\ + Configure dhcpd on the local machine only. Without this option, makedhcp will also send this operation to any service nodes that service the nodes in the noderange. + - -\ **-q**\ \ *noderange*\ - +\ **-q**\ \ *noderange*\ + Query the node entries from the DHCP server configuration. On AIX, any entries created by NIM will not be listed. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -153,7 +153,7 @@ RETURN VALUE -1. An error has occurred. +1. An error has occurred. @@ -165,46 +165,46 @@ EXAMPLES 1. Create a new DHCP configuration file and add the network definitions: - - + + .. code-block:: perl - + makedhcp -n - - + + 2. Define all nodes to the dhcp server: - - + + .. code-block:: perl - + makedhcp -a - - + + Note: This does not add nodes that will be installed with AIX/NIM. - + 3. Will cause dhcp on the next request to set root-path appropriately for only node5. Note some characters (e.g. ") must be doubly escaped (once for the shell, and once for the OMAPI layer). - - + + .. code-block:: perl - + makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";' - - + + 4. Query a node from the DHCP server. - - + + .. code-block:: perl - + # makedhcp -q node01 node01: ip-address = 91.214.34.156, hardware-address = 00:00:c9:c6:6c:42 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/makedns.8.rst b/docs/source/guides/admin-guides/references/man8/makedns.8.rst index 961a13037..a97c1401a 100644 --- a/docs/source/guides/admin-guides/references/man8/makedns.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makedns.8.rst @@ -59,36 +59,36 @@ OPTIONS -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Verbose mode. + - -\ **-n | -**\ **-new**\ - +\ **-n | -**\ **-new**\ + Use this flag to create new named configuration and db files. + - -\ **-d | -**\ **-delete**\ - +\ **-d | -**\ **-delete**\ + Remove the DNS records. + - -\ **-e | -**\ **-external**\ - +\ **-e | -**\ **-external**\ + Update DNS records to the external DNS server listed in /etc/resolv.conf. - + Enabling the site attribute \ *externaldns*\ means use 'external' DNS by default. If setting \ *externaldns*\ to 1, you need NOT use \ **-e**\ flag in every makedns call. + - -\ **noderange**\ - +\ **noderange**\ + A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats. - + @@ -99,43 +99,43 @@ Examples 1. To set up DNS for all the hosts in /etc/hosts file. - - + + .. code-block:: perl - + makedns - - + + 2. To set up DNS for \ *node1*\ . - - + + .. code-block:: perl - + makedns node1 - - + + 3. To create a new named configuration and db files for all hosts in /etc/hosts. - - + + .. code-block:: perl - + makedns -n - - + + 4. To delete the DNS records for \ *node1*\ . - - + + .. code-block:: perl - + makedns -d node1 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst index 2ba2fe660..dc4af7e75 100644 --- a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst @@ -29,6 +29,8 @@ DESCRIPTION *********** +In order to use \ *goconserver*\ instead of \ *conserver*\ , reference https://xcat-docs.readthedocs.io/en/latest/advanced/goconserver/quickstart.html for more information. + The \ **makegocons**\ command will start the goconserver service if it is not started, then send the REST request to create or delete the session resource in the goconserver service. The session information including the session command or ssh connection parameters (for openbmc) is generated by xcat @@ -49,7 +51,7 @@ which nodes will have their consoles accessed from the management node and which To start goconserver on the specified service node, setup goconserver package on that service node, then set the \ **console**\ column of \ **servicenode**\ table to \ **2**\ . -To support diskless service node, a new column \ **consoleenabled**\ has been added in \ **nodehm**\ table, it is used by \ **makegocons**\ +To support diskless service node, a new column \ **consoleenabled**\ has been added in \ **nodehm**\ table, it is used by \ **makegocons**\ command to save the current console state for the node. After reinstalling the service node, the console storage file which maintain the console nodes by goconserver is lost, xCAT would register the console nodes into goconserver based on \ **consoleenabled**\ attribute when restarting xcatd service. @@ -66,40 +68,40 @@ OPTIONS -\ **-d|-**\ **-delete**\ - +\ **-d|-**\ **-delete**\ + Delete rather than add or refresh the nodes specified as a noderange. + - -\ **-C|-**\ **-cleanup**\ - +\ **-C|-**\ **-cleanup**\ + Remove the entries for the nodes whose definitions have been removed from xCAT db. + - -\ **-q|-**\ **-query**\ - +\ **-q|-**\ **-query**\ + List the console connection of the nodes. If noderange is not specified, all of the console nodes will be displayed. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -109,11 +111,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -125,43 +127,43 @@ EXAMPLES 1. To create goconserver configuration for all the nodes. - - + + .. code-block:: perl - + makegocons - - + + 2. To create goconserver configuration for nodes node01-node10. - - + + .. code-block:: perl - + makegocons node01-node10 - - + + 3. To remove goconserver configuration for node01. - - + + .. code-block:: perl - + makegocons -d node01 - - + + 4. To list console connection for node01. - - + + .. code-block:: perl - + makegocons -q node01 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/makehosts.8.rst b/docs/source/guides/admin-guides/references/man8/makehosts.8.rst index 377da28ff..b94406219 100644 --- a/docs/source/guides/admin-guides/references/man8/makehosts.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makehosts.8.rst @@ -49,32 +49,32 @@ OPTIONS -\ **-n**\ - +\ **-n**\ + Completely replace the /etc/hosts file, losing any previous content. If this option is not specified, it will only replace the lines in the file that correspond to the nodes in the specified noderange. + - -\ **-l | -**\ **-longnamefirst**\ - +\ **-l | -**\ **-longnamefirst**\ + The FQDN (Fully Qualified Domain Name) of the host will appear before the PQDN (Partially Qualified Domain Name) for each host in the /etc/hosts file. The default is PQDN first. After xCAT is installed, the attribute name "FQDNfirst" can be added into "site" table manually. If the value is set as "1", "yes" or "enable", the /etc/hosts entries generated by "makehosts" will put the FQDN before the PQDN. Otherwise, the original behavior will be performed. + - -\ **-m | -**\ **-mactolinklocal**\ - +\ **-m | -**\ **-mactolinklocal**\ + Updates /etc/hosts file with IPv6 link local addresses, the link local address is generated from the mac address stored in mac table. + - -\ **-d**\ - +\ **-d**\ + Delete rather than create records. This will also delete any additional network interfaces (NICs) included in the node definitions. - + @@ -85,26 +85,26 @@ EXAMPLES 1. Add entries to /etc/hosts for all nodes included in the xCAT node group called "compute". - - + + .. code-block:: perl - + makehosts compute - - + + 2. If the xCAT hosts table contains: - - + + .. code-block:: perl - + "compute","|node(\d+)|1.2.3.($1+0)|","|(.*)|($1).cluster.net|",, - - + + Assuming the group "compute" contains node01, node02, etc., then in /etc/hosts they will be given IP addresses of 1.2.3.1, 1.2.3.2, etc. - + diff --git a/docs/source/guides/admin-guides/references/man8/makeknownhosts.8.rst b/docs/source/guides/admin-guides/references/man8/makeknownhosts.8.rst index b82da98f3..fe31b65ad 100644 --- a/docs/source/guides/admin-guides/references/man8/makeknownhosts.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makeknownhosts.8.rst @@ -46,29 +46,29 @@ OPTIONS -\ *noderange*\ - +\ *noderange*\ + A set of comma delimited node names and/or group names. See the \ *noderange*\ man page for details on supported formats. + - -\ **-d|-**\ **-delete**\ - +\ **-d|-**\ **-delete**\ + Only removes the entries for the nodes from the known_hosts file. + - -\ **-r|-**\ **-remove**\ - +\ **-r|-**\ **-remove**\ + Synonymous to \ **-d|-**\ **-delete**\ . + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Verbose mode. - + @@ -79,32 +79,32 @@ EXAMPLES 1. To build the known_hosts entry for the nodes in the compute group - - + + .. code-block:: perl - + makeknownhosts compute - - + + 2. To build the known_hosts entry for the nodes in the lpars and service groups - - + + .. code-block:: perl - + makeknownhosts lpars,service - - + + 3. To remove the known_hosts entry for node02 - - + + .. code-block:: perl - + makeknownhosts node02 -d - - + + diff --git a/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst b/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst index 99f296e05..6cead8f4d 100644 --- a/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst @@ -47,7 +47,7 @@ For example: .. code-block:: perl makenetworks -d > mynetstanzas - + cat mynetstanzas | mkdef -z @@ -88,11 +88,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -104,31 +104,31 @@ EXAMPLES 1. Gather cluster network information and create xCAT network definitions. - - + + .. code-block:: perl - + makenetworks - - + + 2. Display cluster network information but do not write the network definitions to the xCAT database. - - + + .. code-block:: perl - + makenetworks -d - - + + The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the lsdef, mkdef, chdef and rmdef commands. - + 9_114_37_0-255_255_255_0: objtype=network gateway=9.114.37.254 mask=255.255.255.0 net=9.114.37.0 - + diff --git a/docs/source/guides/admin-guides/references/man8/makeroutes.8.rst b/docs/source/guides/admin-guides/references/man8/makeroutes.8.rst index c369fa26b..1bb33dd5c 100644 --- a/docs/source/guides/admin-guides/references/man8/makeroutes.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makeroutes.8.rst @@ -54,28 +54,28 @@ OPTIONS -\ **-d|-**\ **-delete**\ - +\ **-d|-**\ **-delete**\ + Specifies to delete the given routes. If not specified, the action is to add routes. + - -\ **-r|-**\ **-routename**\ - +\ **-r|-**\ **-routename**\ + Specifies a list of comma separated route names defined in the \ **routes**\ table. If omitted, all routes defined in \ **noderes.routenames**\ for nodes or \ **site.mnroutenames**\ for the management node will be used. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. - + @@ -86,43 +86,43 @@ EXAMPLES 1. To add all routes from the \ **site.mnroutenames**\ to the os route table for the management node. - - + + .. code-block:: perl - + makeroutes - - + + 2. To add all the routes from \ **noderes.routenames**\ to the os route table for node1. - - + + .. code-block:: perl - + makeroutes node1 - - + + 3. To add route rr1 and rr2 to the os route table for the management node. - - + + .. code-block:: perl - + makeroutes -r rr1,rr2 - - + + 4. To delete route rr1 and rr2 from the os route table on node1 and node1. - - + + .. code-block:: perl - + makeroutes node1,node2 -d -r rr1,rr2 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/mknb.8.rst b/docs/source/guides/admin-guides/references/man8/mknb.8.rst index 174e140a8..4dd9d6c4b 100644 --- a/docs/source/guides/admin-guides/references/man8/mknb.8.rst +++ b/docs/source/guides/admin-guides/references/man8/mknb.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **mknb**\ \ *arch*\ +\ **mknb**\ \ *arch*\ *********** @@ -43,10 +43,10 @@ OPTIONS -\ *arch*\ - +\ *arch*\ + The hardware architecture for which to build the boot image. - + @@ -56,11 +56,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. diff --git a/docs/source/guides/admin-guides/references/man8/nodeadd.8.rst b/docs/source/guides/admin-guides/references/man8/nodeadd.8.rst index 9a92b2edc..1025f7770 100644 --- a/docs/source/guides/admin-guides/references/man8/nodeadd.8.rst +++ b/docs/source/guides/admin-guides/references/man8/nodeadd.8.rst @@ -47,16 +47,16 @@ OPTIONS -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -66,11 +66,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -82,23 +82,23 @@ EXAMPLES 1. To add nodes in noderange node1-node4 with group all: - - + + .. code-block:: perl - + nodeadd node1-node4 groups=all - - + + 2. To add nodes in noderange node1-node4 to the nodetype table with os=rhel5: - - + + .. code-block:: perl - + nodeadd node1-node4 groups=all,rhel5 nodetype.os=rhel5 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/nodeset.8.rst b/docs/source/guides/admin-guides/references/man8/nodeset.8.rst index e09d07592..97ebf1649 100644 --- a/docs/source/guides/admin-guides/references/man8/nodeset.8.rst +++ b/docs/source/guides/admin-guides/references/man8/nodeset.8.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -23,13 +23,13 @@ Name \ **nodeset**\ \ *noderange*\ \ **osimage**\ [=\ *imagename*\ ] [\ **-**\ **-noupdateinitrd**\ ] [\ **-**\ **-ignorekernelchk**\ ] -\ **nodeset**\ \ *noderange*\ \ **runimage=**\ \ *task*\ +\ **nodeset**\ \ *noderange*\ \ **runimage=**\ \ *task*\ \ **nodeset**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -65,94 +65,94 @@ A user can supply their own scripts to be run on the mn or on the service node ( *************** -\ **Options**\ +\ **Options**\ *************** -\ **boot**\ - +\ **boot**\ + Instruct network boot loader to be skipped, generally meaning boot to hard disk + - -\ **offline**\ - +\ **offline**\ + Cleanup the current pxe/tftp boot configuration files for the nodes requested + - -\ **osimage | osimage=**\ \ *imagename*\ - +\ **osimage | osimage=**\ \ *imagename*\ + Prepare server for installing a node using the specified os image. The os image is defined in the \ *osimage*\ table and \ *linuximage*\ table. If the is omitted, the os image name will be obtained from \ *nodetype.provmethod*\ for the node. + - -\ **-**\ **-noupdateinitrd**\ - +\ **-**\ **-noupdateinitrd**\ + Skip the rebuilding of initrd when the 'netdrivers', 'driverupdatesrc' or 'osupdatename' were set for injecting new drivers to initrd. But, the \ **geninitrd**\ command should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of \ **nodeset**\ command. + - -\ **-**\ **-ignorekernelchk**\ - +\ **-**\ **-ignorekernelchk**\ + Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel. + - -\ **runimage**\ =\ *task*\ - +\ **runimage**\ =\ *task*\ + If you would like to run a task after deployment, you can define that task with this attribute. + - -\ **stat**\ - +\ **stat**\ + Display the current boot loader config file description for the nodes requested. When \ **disjointdhcps**\ is set, using \ **-a**\ to display them on all available service nodes. + - -\ **runcmd=**\ \ *command*\ - +\ **runcmd=**\ \ *command*\ + This instructs the node to boot to the xCAT genesis environment and specified command to be executed. + - -\ **shell**\ - +\ **shell**\ + This instructs the node to boot to the xCAT genesis environment, and present a shell prompt on console. The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems. + - -\ **shutdown**\ - +\ **shutdown**\ + To make the node to get into power off status. This status only can be used after \ **runcmd**\ and \ **runimage**\ to power off the node after the performing of operations. + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Verbose mode. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Print help. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Print version. - + ************* -\ **Files**\ +\ **Files**\ ************* @@ -173,44 +173,44 @@ root directory and the TFTP xCAT subdirectory. /tftpboot and **************** -\ **Examples**\ +\ **Examples**\ **************** 1. To setup to install mycomputeimage on the compute node group. - - + + .. code-block:: perl - + nodeset compute osimage=mycomputeimage - - + + 2. To run http://$master/image.tgz after deployment: - - + + .. code-block:: perl - + nodeset $node runimage=http://$MASTER/image.tgz - - + + 3. Boot node1 into xCAT genesis environment and execute bmcsetup script. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration in node object definition. - - + + .. code-block:: perl - + rinstall node1 runcmd=bmcsetup - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man8/rescanplugins.8.rst b/docs/source/guides/admin-guides/references/man8/rescanplugins.8.rst index 91badc206..6de8cd178 100644 --- a/docs/source/guides/admin-guides/references/man8/rescanplugins.8.rst +++ b/docs/source/guides/admin-guides/references/man8/rescanplugins.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **rescanplugins**\ +\ **rescanplugins**\ \ **rescanplugins**\ [\ **-h | -**\ **-help**\ ] @@ -44,22 +44,22 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-s|-**\ **-servicenodes**\ - +\ **-s|-**\ **-servicenodes**\ + Process the rescanplugins on the management node and on all service nodes. The rescanplugins command will be sent to the xcatd daemon on all nodes defined in the servicenode table. The default is to only run on the management node. - + @@ -70,22 +70,22 @@ EXAMPLES 1. To rescan the plugins only on the xCAT Management Node: - - + + .. code-block:: perl - + rescanplugins - - + + 2. To rescan the plugins on the xCAT Management Node and on all service nodes: - - + + .. code-block:: perl - + rescanplugins -s - - + + diff --git a/docs/source/guides/admin-guides/references/man8/rinstall.8.rst b/docs/source/guides/admin-guides/references/man8/rinstall.8.rst index c0923a4f3..501048030 100644 --- a/docs/source/guides/admin-guides/references/man8/rinstall.8.rst +++ b/docs/source/guides/admin-guides/references/man8/rinstall.8.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -23,13 +23,13 @@ Name \ **rinstall**\ \ *noderange*\ \ **osimage**\ [=\ *imagename*\ ] [\ **-**\ **-noupdateinitrd**\ ][\ **-**\ **-ignorekernelchk**\ ] [\ **-c | -**\ **-console**\ ] [\ **-u | -**\ **-uefimode**\ ] [\ **-V | -**\ **-verbose**\ ] -\ **rinstall**\ \ *noderange*\ \ **runimage=**\ \ *task*\ +\ **rinstall**\ \ *noderange*\ \ **runimage=**\ \ *task*\ \ **rinstall**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -41,132 +41,134 @@ If \ **-c**\ is specified, it will then run \ **rcons**\ on the node. This is *************** -\ **Options**\ +\ **Options**\ *************** -\ **boot**\ - +\ **boot**\ + Instruct network boot loader to be skipped, generally meaning boot to hard disk - + \ **osimage**\ [=\ *imagename*\ ] - + Prepare server for installing a node using the specified OS image. The OS image is defined in the \ *osimage*\ table and \ *linuximage*\ table. If the \ *imagename*\ is omitted, the OS image name will be obtained from \ *nodetype.provmethod*\ for the node. + - -\ **-**\ **-noupdateinitrd**\ Skip the rebuilding of initrd when the 'netdrivers', 'driverupdatesrc' or 'osupdatename' were set for injecting new drivers to initrd. But, the \ **geninitrd**\ command should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of \ **rinstall**\ command. +\ **-**\ **-noupdateinitrd**\ + + Skip the rebuilding of initrd when the 'netdrivers', 'driverupdatesrc' or 'osupdatename' were set for injecting new drivers to initrd. But, the \ **geninitrd**\ command should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of \ **rinstall**\ command. + - -\ **-**\ **-ignorekernelchk**\ - +\ **-**\ **-ignorekernelchk**\ + Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel. + - -\ **runimage=**\ \ *task*\ - +\ **runimage=**\ \ *task*\ + If you would like to run a task after deployment, you can define that task with this attribute. + - -\ **runcmd=**\ \ *command*\ - +\ **runcmd=**\ \ *command*\ + This instructs the node to boot to the xCAT genesis environment and specified command to be executed. + - -\ **shell**\ - +\ **shell**\ + This instructs the node to boot to the xCAT genesis environment, and present a shell prompt on console. The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display version. + - -\ **-u | -**\ **-uefimode**\ - +\ **-u | -**\ **-uefimode**\ + For BMC-based servers, to specify the next boot mode to be "UEFI Mode". + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Verbose output. + - -\ **-c | -**\ **-console**\ - +\ **-c | -**\ **-console**\ + Requests that \ **rinstall**\ runs \ **rcons**\ once the provision starts. This will only work if there is only one node in the noderange. See winstall(8)|winstall.8 for starting consoles on multiple nodes. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. Provision nodes 1 through 20, using their current configuration. - - + + .. code-block:: perl - + rinstall node1-node20 - - + + 2. Provision nodes 1 through 20 with the osimage rhels6.4-ppc64-netboot-compute. - - + + .. code-block:: perl - + rinstall node1-node20 osimage=rhels6.4-ppc64-netboot-compute - - + + 3. Provision node1 and start a console to monitor the process. - - + + .. code-block:: perl - + rinstall node1 -c - - + + 4. Boot node1 into xCAT genesis environment and execute bmcsetup script. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration in node object definition. - - + + .. code-block:: perl - + rinstall node1 runcmd=bmcsetup - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man8/rmosdistro.8.rst b/docs/source/guides/admin-guides/references/man8/rmosdistro.8.rst index 51f8268b1..396299699 100644 --- a/docs/source/guides/admin-guides/references/man8/rmosdistro.8.rst +++ b/docs/source/guides/admin-guides/references/man8/rmosdistro.8.rst @@ -38,22 +38,22 @@ OPTIONS -\ **-a | -**\ **-all**\ - +\ **-a | -**\ **-all**\ + If specified, try to delete all the OS Distros. + - -\ **-f | -**\ **-force**\ - +\ **-f | -**\ **-force**\ + Remove referenced OS Distros, never prompt. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Show info of rmosdistro usage. - + @@ -76,32 +76,32 @@ EXAMPLES 1. To remove OS Distro "rhels6.2-ppc64" and "sles11.2-ppc64": - - + + .. code-block:: perl - + rmosdistro rhels6.2-ppc64 sles11.2-ppc64 - - + + 2. To remove OS Distro "rhels6.2-ppc64", regardless of whether is referenced by any osimage: - - + + .. code-block:: perl - + rmosdistro -f rhels6.2-ppc64 - - + + 3. To remove all OS Distros: - - + + .. code-block:: perl - + rmosdistro -a - - + + diff --git a/docs/source/guides/admin-guides/references/man8/runsqlcmd.8.rst b/docs/source/guides/admin-guides/references/man8/runsqlcmd.8.rst index 1f6790e4b..7554e407d 100644 --- a/docs/source/guides/admin-guides/references/man8/runsqlcmd.8.rst +++ b/docs/source/guides/admin-guides/references/man8/runsqlcmd.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **runsqlcmd**\ +\ **runsqlcmd**\ \ **runsqlcmd**\ [\ **-h | -**\ **-help**\ ] @@ -49,48 +49,48 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays current code version. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Displays extra debug information. + - -\ **-d|-**\ **-dir**\ - +\ **-d|-**\ **-dir**\ + To use a directory other than the default directory, enter the directory path here. + - -\ **-f|-**\ **-files**\ - +\ **-f|-**\ **-files**\ + Comma separated list of files (full path), wildcard (\*) can be used. + - -\ **File format**\ - +\ **File format**\ + The files must be of the form .sql or _.sql where - + is mysql,pgsql, or db2. Files must have permission 0755. + - -\ *sql statement*\ - +\ *sql statement*\ + Quoted sql statement syntax appropriate for the current database. - + @@ -101,52 +101,52 @@ EXAMPLES 1. To run the database appropriate \*.sql files in /opt/xcat/lib/perl/xCAT_schema : - - + + .. code-block:: perl - + runsqlcmd - - + + 2. To run the database appropriate \*.sql files in /tmp/mysql: - - + + .. code-block:: perl - + runsqlcmd -d /tmp/mysql - - + + 3. To run the database appropriate \*.sql files in the input list: - - + + .. code-block:: perl - + runsqlcmd -f "/tmp/mysql/test*,/tmp/mysql/test1*" - - + + 4. To checkout one DB2 sql file: - - + + .. code-block:: perl - + runsqlcmd -f /tmp/db2/test_db2.sql - - + + 5. To run the following command to the database: - - + + .. code-block:: perl - + runsqlcmd "Select * from site;" - - + + diff --git a/docs/source/guides/admin-guides/references/man8/setupiscsidev.8.rst b/docs/source/guides/admin-guides/references/man8/setupiscsidev.8.rst index ab4b2beee..7685b9efb 100644 --- a/docs/source/guides/admin-guides/references/man8/setupiscsidev.8.rst +++ b/docs/source/guides/admin-guides/references/man8/setupiscsidev.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **setupiscsidev**\ [\ **-s|-**\ **-size**\ ] \ *noderange*\ +\ **setupiscsidev**\ [\ **-s|-**\ **-size**\ ] \ *noderange*\ \ **setupiscsidev**\ [\ **-h|-**\ **-help|-v|-**\ **-version**\ ] @@ -40,22 +40,22 @@ OPTIONS -\ **-s|-**\ **-size**\ - +\ **-s|-**\ **-size**\ + The size of the LUN that should be created. Default is 4096. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display version. + - -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. - + @@ -65,11 +65,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. diff --git a/docs/source/guides/admin-guides/references/man8/tabch.8.rst b/docs/source/guides/admin-guides/references/man8/tabch.8.rst index 109b5705e..2e0d6e076 100644 --- a/docs/source/guides/admin-guides/references/man8/tabch.8.rst +++ b/docs/source/guides/admin-guides/references/man8/tabch.8.rst @@ -56,11 +56,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -71,64 +71,64 @@ EXAMPLES -1. To add a node=node1 to the nodelist table with groups=all: - - +1. To add a node=node1 to the nodelist table with groups=all: + + .. code-block:: perl - + tabch node=node1 nodelist.groups=all + + - - -2. To add a keyword (tftpdir) and value (/tftpboot) to the site table: - - +2. To add a keyword (tftpdir) and value (/tftpboot) to the site table: + + .. code-block:: perl - + tabch key=tftpdir site.value=/tftpboot + + - - -3. To add node1 to the nodetype table with os=rhel5: - - +3. To add node1 to the nodetype table with os=rhel5: + + .. code-block:: perl - + tabch node=node1 nodetype.os=rhel5 + + - - -4. To change node1 in nodetype table setting os=sles: - - +4. To change node1 in nodetype table setting os=sles: + + .. code-block:: perl - + tabch node=node1 nodetype.os=sles + + - - -5. To change node1 by appending otherpkgs to the postbootscripts field in the postscripts table: - - +5. To change node1 by appending otherpkgs to the postbootscripts field in the postscripts table: + + .. code-block:: perl - + tabch node=node1 postscripts.postbootscripts+=otherpkgs + + - - -6. To delete node1 from nodetype table: - - +6. To delete node1 from nodetype table: + + .. code-block:: perl - + tabch -d node=node1 nodetype - - + + diff --git a/docs/source/guides/admin-guides/references/man8/tabdump.8.rst b/docs/source/guides/admin-guides/references/man8/tabdump.8.rst index 7b67d827f..c83ce5cf1 100644 --- a/docs/source/guides/admin-guides/references/man8/tabdump.8.rst +++ b/docs/source/guides/admin-guides/references/man8/tabdump.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **tabdump**\ +\ **tabdump**\ \ **tabdump**\ [\ **-d**\ ] [\ *table*\ ] @@ -54,40 +54,40 @@ OPTIONS -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. + - -\ **-d**\ - +\ **-d**\ + Show descriptions of the tables, instead of the contents of the tables. If a table name is also specified, descriptions of the columns (attributes) of the table will be displayed. Otherwise, a summary of each table will be displayed. + - -\ **-n**\ - +\ **-n**\ + Shows the most recent number of entries as supplied on the -n flag from the auditlog or eventlog table. + - -\ **-f**\ - +\ **-f**\ + File name or path to file in which to dump the table. Without this the table is dumped to stdout. Using the -f flag allows the table to be dumped one record at a time. If tables are very large, dumping to stdout can cause problems such as running out of memory. - + \ **-w**\ \ *'attr==val'*\ \ **-w**\ \ *'attr=~val'*\ ... - + Use one or multiple -w flags to specify the selection string that can be used to select particular rows of the table. See examples. - + Operator descriptions: - - + + .. code-block:: perl - + == Select nodes where the attribute value is exactly this value. != Select nodes where the attribute value is not this specific value. > Select nodes where the attribute value is greater than this specific value. @@ -96,8 +96,8 @@ OPTIONS <= Select nodes where the attribute value is less than or equal to this specific value. =~ Select nodes where the attribute value matches the SQL LIKE value. !~ Select nodes where the attribute value matches the SQL NOT LIKE value. - - + + @@ -107,11 +107,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -123,105 +123,105 @@ EXAMPLES 1. To display the contents of the site table: - - + + .. code-block:: perl - + tabdump site - - + + 2. To display the contents of the nodelist table where the groups attribute is compute : - - + + .. code-block:: perl - + tabdump -w 'groups==compute' nodelist - - + + 3. To display the contents of the nodelist table where the groups attribute is comput% where % is a wildcard and can represent any string and the status attribute is booted : - - + + .. code-block:: perl - + tabdump -w 'groups=~comput%' -w 'status==booted' nodelist - - + + 4. To display the records of the auditlog on date 2011-04-18 11:30:00 : - - + + .. code-block:: perl - + tabdump -w 'audittime==2011-04-18 11:30:00' auditlog - - + + 5. To display the records of the auditlog starting on 2011-04-18: - - + + .. code-block:: perl - + tabdump -w 'audittime>2011-04-18 11:30:00' auditlog - - + + 6. To display the 10 most recent entries in the auditlog: - - + + .. code-block:: perl - + tabdump -n 10 auditlog - - + + 7. To see what tables exist in the xCAT database: - - + + .. code-block:: perl - + tabdump - - + + 8. To back up all the xCAT database tables, instead of running \ **tabdump**\ multiple times, you can use the \ **dumpxCATdb**\ command as follows: - - + + .. code-block:: perl - + dumpxCATdb -p /tmp/xcatbak - - + + See the \ **dumpxCATdb**\ man page for details. - + 9. To display a summary description of each table: - - + + .. code-block:: perl - + tabdump -d - - + + 10. To display a description of each column in the nodehm table: - - + + .. code-block:: perl - + tabdump -d nodehm - - + + diff --git a/docs/source/guides/admin-guides/references/man8/tabedit.8.rst b/docs/source/guides/admin-guides/references/man8/tabedit.8.rst index 0cfdc0260..0bd593d78 100644 --- a/docs/source/guides/admin-guides/references/man8/tabedit.8.rst +++ b/docs/source/guides/admin-guides/references/man8/tabedit.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **tabedit**\ \ *table*\ +\ **tabedit**\ \ *table*\ \ **tabedit**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ ] @@ -43,10 +43,10 @@ OPTIONS -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. - + @@ -57,11 +57,11 @@ ENVIRONMENT VARIABLES TABEDITOR - + The editor that should be used to edit the table, for example: vi, vim, emacs, oocalc, pico, gnumeric, nano. If \ **TABEDITOR**\ is not set, the value from \ **EDITOR**\ will be used. If \ **EDITOR**\ is not set, it will default to vi. - + @@ -71,11 +71,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -87,13 +87,13 @@ EXAMPLES 1. To edit the site table: - - + + .. code-block:: perl - + tabedit site - - + + diff --git a/docs/source/guides/admin-guides/references/man8/tabprune.8.rst b/docs/source/guides/admin-guides/references/man8/tabprune.8.rst index 8eb9f39c5..58c489334 100644 --- a/docs/source/guides/admin-guides/references/man8/tabprune.8.rst +++ b/docs/source/guides/admin-guides/references/man8/tabprune.8.rst @@ -21,7 +21,7 @@ SYNOPSIS \ **tabprune**\ [\ **eventlog | auditlog**\ ] [\ **-V**\ ] [\ **-i**\ \ *recid*\ | \ **-n**\ \ *number of records*\ | \ **-p**\ \ *percentage*\ | \ **-d**\ \ *number of days*\ | \ **-a**\ ] -\ **tabprune**\ \ *tablename*\ \ **-a**\ +\ **tabprune**\ \ *tablename*\ \ **-a**\ \ **tabprune**\ [\ **-h | -**\ **-help**\ ] [\ **-v | -**\ **-version**\ ] @@ -40,47 +40,47 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Display usage message. + - -\ **-V**\ - +\ **-V**\ + Verbose mode. This will cause tabprune to display the records that are being deleted from the table, in case you want to redirect them to a file to archive them. + - -\ **-a**\ - +\ **-a**\ + Remove all records from the input table name. This option can be used on any xCAT table. + - -\ **-i**\ \ *recid number*\ - +\ **-i**\ \ *recid number*\ + Remove the records whose recid is less than the input recid number. + - -\ **-n**\ \ *number*\ - +\ **-n**\ \ *number*\ + Remove the number of records input. + - -\ **-p**\ \ *percent*\ - +\ **-p**\ \ *percent*\ + Remove the number of records input. + - -\ **-d**\ \ *number of days*\ - +\ **-d**\ \ *number of days*\ + Remove all records that occurred >= than number of days ago. - + @@ -106,63 +106,63 @@ EXAMPLES 1. To remove all the records in the eventlog table: - - + + .. code-block:: perl - + tabprune eventlog -a - - + + 2. To remove all the records in the eventlog table saving the deleted records in eventlog.csv: - - + + .. code-block:: perl - + tabprune eventlog -V -a > eventlog.csv - - + + 3. To remove all the records before recid=200 in the auditlog table: - - + + .. code-block:: perl - + tabprune auditlog -i 200 - - + + 4. To remove 400 records from the auditlog table and display the remove records: - - + + .. code-block:: perl - + tabprune auditlog -V -n 400 - - + + 5. To remove 50% of the eventlog table: - - + + .. code-block:: perl - + tabprune eventlog -p 50 - - + + 6. To remove all records that occurred >= 5 days ago in the eventlog: - - + + .. code-block:: perl - + tabprune eventlog -d 5 - - + + diff --git a/docs/source/guides/admin-guides/references/man8/tabrestore.8.rst b/docs/source/guides/admin-guides/references/man8/tabrestore.8.rst index 25318187d..10b6c2331 100644 --- a/docs/source/guides/admin-guides/references/man8/tabrestore.8.rst +++ b/docs/source/guides/admin-guides/references/man8/tabrestore.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **tabrestore**\ [\ **-a**\ ] \ *table.csv*\ +\ **tabrestore**\ [\ **-a**\ ] \ *table.csv*\ \ **tabrestore**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ ] @@ -47,22 +47,22 @@ OPTIONS -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Display version. + - -\ **-a|-**\ **-addrows**\ - +\ **-a|-**\ **-addrows**\ + Add rows from the CSV file to the table instead of replacing the table with the CSV file. - + @@ -88,42 +88,42 @@ EXAMPLES 1. To replace the rows in the mp table with the rows in the mp.csv file: - - + + .. code-block:: perl - + tabrestore mp.csv - - + + The file mp.csv could contain something like: - - + + .. code-block:: perl - + #node,mpa,id,comments,disable "blade","|\D+(\d+)|amm(($1-1)/14+1)|","|\D+(\d+)|(($1-1)%14+1)|",, - - + + 2. To add the rows in the mp.csv file to the rows in the mp table: - - + + .. code-block:: perl - + tabrestore -a mp.csv - - + + 3. To restore database tables from restore_directory that we dumped with dumpxCATdb: - - + + .. code-block:: perl - + restorexCATdb -p restore_directory - - + + diff --git a/docs/source/guides/admin-guides/references/man8/winstall.8.rst b/docs/source/guides/admin-guides/references/man8/winstall.8.rst index cbf27cf7f..e939b5554 100644 --- a/docs/source/guides/admin-guides/references/man8/winstall.8.rst +++ b/docs/source/guides/admin-guides/references/man8/winstall.8.rst @@ -15,7 +15,7 @@ Name **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** @@ -27,7 +27,7 @@ Name ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -39,102 +39,102 @@ It will then run \ **wcons**\ on the noderange. *************** -\ **Options**\ +\ **Options**\ *************** -\ **boot**\ - +\ **boot**\ + Instruct network boot loader to be skipped, generally meaning boot to hard disk + - -\ *imagename*\ | \ **osimage=**\ \ *imagename*\ - +\ *imagename*\ | \ **osimage=**\ \ *imagename*\ + Prepare server for installing a node using the specified os image. The os image is defined in the \ *osimage*\ table and \ *linuximage*\ table. If the \ *imagename*\ is omitted, the os image name will be obtained from \ *nodetype.provmethod*\ for the node. + - -\ **-**\ **-ignorekernelchk**\ - +\ **-**\ **-ignorekernelchk**\ + Skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. That means all drivers from osimage.driverupdatesrc will be injected to initrd for the specific target kernel. + - -\ **runimage=**\ \ *task*\ - +\ **runimage=**\ \ *task*\ + If you would like to run a task after deployment, you can define that task with this attribute. + - -\ **runcmd=bmcsetup**\ - +\ **runcmd=bmcsetup**\ + This instructs the node to boot to the xCAT nbfs environment and proceed to configure BMC for basic remote access. This causes the IP, netmask, gateway, username, and password to be programmed according to the configuration table. + - -\ **shell**\ - +\ **shell**\ + This instructs the node to boot to the xCAT genesis environment, and present a shell prompt on console. The node will also be able to be sshed into and have utilities such as wget, tftp, scp, nfs, and cifs. It will have storage drivers available for many common systems. + - -\ **-h | -**\ **-help**\ - +\ **-h | -**\ **-help**\ + Display usage message. + - -\ **-v | -**\ **-version**\ - +\ **-v | -**\ **-version**\ + Display version. + - -\ **-u | -**\ **-uefimode**\ - +\ **-u | -**\ **-uefimode**\ + For BMC-based servers, to specify the next boot mode to be "UEFI Mode". + - -\ **-V | -**\ **-verbose**\ - +\ **-V | -**\ **-verbose**\ + Verbose output. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. Provision nodes 1 through 20, using their current configuration. - - + + .. code-block:: perl - + winstall node1-node20 - - + + 2. Provision nodes 1 through 20 with the osimage rhels6.4-ppc64-netboot-compute. - - + + .. code-block:: perl - + winstall node1-node20 osimage=rhels6.4-ppc64-netboot-compute - - + + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************ diff --git a/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst b/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst index 4002f73e8..85a089555 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst @@ -46,80 +46,80 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-V|-**\ **-verbose**\ - +\ **-V|-**\ **-verbose**\ + Displays verbose messages. + - -\ **-i|-**\ **-initialinstall**\ - +\ **-i|-**\ **-initialinstall**\ + The install option is normally run as a post operation from the rpm xCAT.spec file during the initial install of xCAT on the Management Node. It will setup the root ssh keys, ssh node keys, xCAT credentials, initialize the database, export directories, start syslog and other daemons as needed after the initial install of xCAT. + - -\ **-u|-**\ **-updateinstall**\ - +\ **-u|-**\ **-updateinstall**\ + The update install option is normally run as a post operation from the rpm xCAT.spec file during an update install of xCAT on the Management Node. It will check the setup the root ssh keys, ssh node keys, xCAT credentials, database, exported directories, syslog and the state of daemons needed by xCAT, after the updateinstall of xCAT. If setup is required, it will perform the operation. It will restart the necessary daemons. + - -\ **-k|-**\ **-sshkeys**\ - +\ **-k|-**\ **-sshkeys**\ + This option will remove and regenerate the root id_rsa keys. It should only be used, if the keys are deleted or corrupted. The keys must then be distributed to the nodes by installing, running updatenode -k, or using xdsh -K option, for root to be able to ssh to the nodes without being prompted for a password. rspconfig will need to be run to distribute the key to the MM and HMCs. Any device, we need to ssh from the MN to the device will also have to be updated with the new ssh keys. + - -\ **-s|-**\ **-sshnodehostkeys**\ - +\ **-s|-**\ **-sshnodehostkeys**\ + This option will remove and regenerate the node host ssh keys. It should only be used, if the keys are deleted or are corrupted. The keys must then be redistribute to the nodes by installing, running updatenode -k or using xdcp or pcp to copy the keys from /etc/xcat/hostkeys directory to the /etc/ssh directory on the nodes. + - -\ **-c|-**\ **-credentials**\ - +\ **-c|-**\ **-credentials**\ + This option will remove all xcat credentials for root and any userids where credentials have been created. It will regenerate roots credentials, but the admin will have to add back all the userid credentials needed with the /opt/xcat/share/xcat/scripts/setup-local-client.sh command. It should only be used, if they are deleted or become corrupted. The root credentials must be redistributed to the service nodes by installing the service node or using updatenode -k. makeconservercf must be rerun to pick up the new credentials, and conserver must be stopped and started. + - -\ **-d|-**\ **-database**\ - +\ **-d|-**\ **-database**\ + This option will reinitialize the basic xCAT database table setup. It will not remove any new database entries that have been added, but it is strongly suggested that you backup you database (dumpxCATdb) before using it. + - -\ **-f|-**\ **-force**\ - +\ **-f|-**\ **-force**\ + The force option may be used after the install to reinitialize the Management Node. This option will regenerate keys, credential and reinitialize the site table. This option should be used, if keys or credentials become corrupt or lost. Additional action must be taken after using the force options. ssh keys must be redistributed to the nodes, site table attributes might need to be restored, makeconservercf needs to be rerun to pick up the new credentials and conserver stopped and started, rspconfig needs to be rerun to distribute the new keys to the MM and the HMCs. A new set of common ssh host keys will have been generated for the nodes. If you wish your nodes to be able to ssh to each other with out password intervention, then you should redistribute these new keys to the nodes. If the nodes hostkeys are updated then you will need to remove their entries from the known_hosts files on the management node before using ssh, xdsh, xdcp. Redistribute credentials and ssh keys to the service nodes and ssh keys to the nodes by using the updatenode -k command. + - -\ **-m|-**\ **-mgtnode**\ - +\ **-m|-**\ **-mgtnode**\ + This option will add the Management Node to the database with the correct attributes set to be recognized by xCAT. This should be run after the hostname of the Management Node is set to the name that will resolve to the cluster-facing NIC. + - -\ **-t|-**\ **-tunables**\ - +\ **-t|-**\ **-tunables**\ + This option will set tunable parameters on the Management and Service nodes recommended for your Linux cluster. It will only set them during initial install, if you run xcatconfig -f or xcatconfig -t. - + @@ -130,52 +130,52 @@ EXAMPLES 1. To force regeneration of keys and credentials and reinitialize the site table: - - + + .. code-block:: perl - + xcatconfig -f - - + + 2. To regenerate root's ssh keys: - - + + .. code-block:: perl - + xcatconfig -k - - + + 3. To regenerate node host ssh keys: - - + + .. code-block:: perl - + xcatconfig -s - - + + 4. To regenerate node host ssh keys and credentials: - - + + .. code-block:: perl - + xcatconfig -s -c - - + + 5. To add the Management Node to the DB: - - + + .. code-block:: perl - + xcatconfig -m - - + + diff --git a/docs/source/guides/admin-guides/references/man8/xcatd.8.rst b/docs/source/guides/admin-guides/references/man8/xcatd.8.rst index adb1479d4..ab01ab2dd 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatd.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatd.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **xcatd**\ +\ **xcatd**\ *********** @@ -41,33 +41,33 @@ EXAMPLES 1. To start/stop/restart xcatd on Linux, enter: - - + + .. code-block:: perl - + service xcatd start - + service xcatd stop - + service xcatd restart - - + + 2. To start/stop/restart xcatd on AIX, enter: - - + + .. code-block:: perl - + restartxcatd - + or - + startsrc -s xcatd - + stopsrc -s xcatd - - + + diff --git a/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst b/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst index ce0dc1705..6a32f61e7 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst @@ -30,15 +30,15 @@ DESCRIPTION xCAT offers two trace facilities to debug the xCAT: -\ **Subroutine calling trace**\ +\ **Subroutine calling trace**\ Display the calling trace for subroutine when it is called. The trace message includes: The name of the called subroutine; The arguments which passed to the called subroutine; The calling stack of the subroutine. By default, the trace will be enabled to all the subroutines in the xcatd and plugin modules. The target subroutine can be configured by configuration file or through xcatdebug command line. The flag \ **-c**\ is used to specify the subroutine list for \ **subroutine calling trace**\ , it can only work with \ **-f**\ . The value of \ **-c**\ can be a configuration file or a subroutine list. - \ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\ - \ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\ + \ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\ + \ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\ \ **SUBROUTINE_DEFINITION**\ : is the element for the \ **-c**\ to specify the subroutine list. @@ -53,7 +53,7 @@ Otherwise, the package name of the plugin should be specified. The trace log will be written to /var/log/xcat/subcallingtrace. The log file subcallingtrace will be backed up for each running of the \ **xcatdebug -f enable**\ . -\ **Commented trace log**\ +\ **Commented trace log**\ The trace log code is presented as comments in the code of xCAT. In general mode, it will be kept as comments. But in debug mode, it will be commented back as common code to display the trace log. @@ -88,39 +88,39 @@ OPTIONS -\ **-f**\ - +\ **-f**\ + Enable or disable the \ **subroutine calling trace**\ . - + For \ **enable**\ , if ignoring the \ **-c**\ flag, all the subroutines in the xcatd and plugin modules will be enabled. - + For \ **disable**\ , all the subroutines which has been enabled by \ **-f enable**\ will be disabled. \ **-c**\ will be ignored. + - -\ **-c**\ - +\ **-c**\ + Specify the configuration file or subroutine list. - - - \ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\ + + + \ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\ e.g. (plugin_command) xCAT_plugin::DBobjectdefs(defls,process_request) xCAT::DBobjUtils(getobjdefs) - - \ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\ + + \ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\ e.g. "(plugin_command)|xCAT_plugin::DBobjectdefs(defls,process_request)|xCAT::DBobjUtils(getobjdefs)" + - -\ **-d**\ - +\ **-d**\ + Enable or disable the \ **commented trace log**\ . - - Note: The xcatd will be restarted for the performing of \ **-d**\ - + + Note: The xcatd will be restarted for the performing of \ **-d**\ + @@ -131,62 +131,62 @@ EXAMPLES 1. Enable the \ **subroutine calling trace**\ for all the subroutines in the xcatd and plugin modules. - - + + .. code-block:: perl - + xcatdebug -f enable - - + + 2. Enable the \ **subroutine calling trace**\ for the subroutines configured in the /opt/xcat/share/xcat/samples/tracelevel0 - - + + .. code-block:: perl - + xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 - - + + 3. Enable the \ **subroutine calling trace**\ for the plugin_command in xcatd and defls,process_request in the xCAT_plugin::DBobjectdefs module. - - + + .. code-block:: perl - + xcatdebug -f enable -c "xCAT_plugin::DBobjectdefs(defls,process_request)|(plugin_command)" - - + + 4. Disable the \ **subroutine calling trace**\ for all the subroutines which have been enabled by \ **xcatdebug -f enable**\ . - - + + .. code-block:: perl - + xcatdebug -f disable + + - - -5. Enable the \ **commented trace log**\ - - +5. Enable the \ **commented trace log**\ + + .. code-block:: perl - + xcatdebug -d enable + + - - -6. Enable both the \ **subroutine calling trace**\ and \ **commented trace log**\ - - +6. Enable both the \ **subroutine calling trace**\ and \ **commented trace log**\ + + .. code-block:: perl - + xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 -d enable - - + + diff --git a/docs/source/guides/admin-guides/references/man8/xcatsetup.8.rst b/docs/source/guides/admin-guides/references/man8/xcatsetup.8.rst index 011d5506e..1bb93617d 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatsetup.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatsetup.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **xcatsetup**\ [\ **-s|-**\ **-stanzas**\ \ *stanza-list*\ ] [\ **-**\ **-yesreallydeletenodes**\ ] \ *cluster-config-file*\ +\ **xcatsetup**\ [\ **-s|-**\ **-stanzas**\ \ *stanza-list*\ ] [\ **-**\ **-yesreallydeletenodes**\ ] \ *cluster-config-file*\ \ **xcatsetup**\ [\ **-?**\ | \ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ] @@ -36,51 +36,51 @@ the hardware that is connected to the service and cluster networks. The typical 1. - + Install the xCAT software on the management node - + 2. - + Create the cluster config file and run xcatsetup - + 3. - + Put hardware control passwords in the ppchcp or ppcdirect database table - + 4. - + Run makenetworks and makedhcp - + 5. - + Run the discovery commands (lsslp, mkhwconn, rspconfig) as described in the System P Hardware Management cookbook. - + 6. - + Configure and start services using makehosts, makedns, mkconserver.cf, etc. - + 7. - + Create the images that should be installed or booted on the nodes - + 8. - + Run nodeset and rpower/rnetboot to boot up the nodes. - + The \ **xcatsetup**\ command is intended as a quick way to fill out the database for a cluster that has very regular @@ -140,16 +140,16 @@ This sample configuration file is for a 2 building block cluster. # ISR network topology. For example, one of the following: 128D, 64D, 32D, 16D, 8D, 4D, 2D, 1D topology = 32D # The nameservers in site table will be set with the value of master automatically. - + xcat-service-lan: # IP range used for DHCP. If you set the entry, the networks table will be filled # automatically with this range and the dhcp interface will be set in the site table. dhcp-dynamic-range = 50.0.0.0-50.0.0.200 - + xcat-hmcs: hostname-range = hmc1-hmc2 starting-ip = 10.200.1.1 - + xcat-frames: # these are the connections to the frames hostname-range = frame[1-6] @@ -170,8 +170,8 @@ This sample configuration file is for a 2 building block cluster. # second BPA/FSP in the Frame/CEC). For BPAs "y" is always be 0 and for FSPs "y" is the cec id. vlan-1 = 40 vlan-2 = 41 - - + + xcat-cecs: # These are the connections to the CECs. Either form of hostname is supported. #hostname-range = cec01-cec64 @@ -189,12 +189,12 @@ This sample configuration file is for a 2 building block cluster. #fsp-b-0-starting-ip = 10.230.4.1 #fsp-a-1-starting-ip = 10.231.3.1 #fsp-b-1-starting-ip = 10.231.4.1 - - + + xcat-building-blocks: num-frames-per-bb = 3 num-cecs-per-bb = 32 - + xcat-lpars: num-lpars-per-cec = 8 # If you set these, then do not set the corresponding attributes in the other node stanzas below. @@ -205,7 +205,7 @@ This sample configuration file is for a 2 building block cluster. aliases = -hf0 # ml0 is for aix. For linux, use bond0 instead. otherinterfaces = -hf1:11.1.1.1,-hf2:12.1.1.1,-hf3:13.1.1.1,-ml0:14.1.1.1 - + xcat-service-nodes: num-service-nodes-per-bb = 2 # which cecs within the bldg block that the SNs are located in @@ -216,7 +216,7 @@ This sample configuration file is for a 2 building block cluster. # this value is the same format as the hosts.otherinterfaces attribute except # the IP addresses are starting IP addresses #otherinterfaces = -hf0:10.10.1.1,-hf1:10.11.1.1,-hf2:10.12.1.1,-hf3:10.13.1.1,-ml0:10.14.1.1 - + xcat-storage-nodes: num-storage-nodes-per-bb = 3 # which cecs within the bldg block that the storage nodes are located in @@ -225,7 +225,7 @@ This sample configuration file is for a 2 building block cluster. #starting-ip = 10.20.1.1 #aliases = -hf0 #otherinterfaces = -hf1:10.21.1.1,-hf2:10.22.1.1,-hf3:10.23.1.1,-ml0:10.24.1.1 - + xcat-compute-nodes: #hostname-range = n001-n502 #starting-ip = 10.30.1.1 @@ -312,16 +312,16 @@ VPD data or supernode numbers at this time. xcat-site: use-direct-fsp-control = 1 - + xcat-frames: hostname-range = frame[1-2] - + xcat-cecs: #hostname-range = cec[01-24] hostname-range = f[1-2]c[01-12] num-cecs-per-frame = 12 - - + + xcat-lpars: hostname-range = f[1-2]c[01-12]p[01,05,09,13,17,21,25,29] @@ -335,154 +335,154 @@ The following lists which database attributes are filled in as a result of each in the stanza, some attributes might not be filled in. -\ **xcat-site**\ - +\ **xcat-site**\ + site table: domain, nameservers, topology + - -\ **xcat-hmcs**\ - +\ **xcat-hmcs**\ + site table: ea_primary_hmc, ea_backup_hmc - + nodelist table: node, groups (all HMCs (hmc) ), hidden - + hosts table: node, ip - + ppc table: node, comments - + nodetype table: node, nodetype + - -\ **xcat-frames**\ - +\ **xcat-frames**\ + nodelist table: node, groups (all frames (frame) ), hidden - + ppc table: node, id, hcp, nodetype, sfp - + nodetype table: node, nodetype - + nodehm table: node, mgt - + vpd table: node, serial, mtm, side + - -\ **xcat-bpas**\ - +\ **xcat-bpas**\ + nodelist table: node, groups (bpa,all) , hidden - + ppc table: node, id, hcp, nodetype, parent - + nodetype table: node, nodetype - + nodehm table: node, mgt - + vpd table: node, serial, mtm, side + - -\ **xcat-cecs**\ - +\ **xcat-cecs**\ + nodelist table: node, groups (all CECs (cec), all CECs in a frame (cec) ), hidden - + ppc table: node, supernode, hcp, id, parent - + nodetype table: node, nodetype - + nodehm table: node, mgt - + nodegroup table: groupname, grouptype, members, wherevals (all nodes in a CEC (nodes) ) - + nodepos: rack, u + - -\ **xcat-fsps**\ - +\ **xcat-fsps**\ + nodelist table: node, groups (fsp,all), hidden - + ppc table: node, id, hcp, nodetype, parent - + nodetype table: node, nodetype - + nodehm table: node, mgt - + vpd table: node, serial, mtm, side + - -\ **xcat-building-blocks**\ - +\ **xcat-building-blocks**\ + site table: sharedtftp, sshbetweennodes(service) - + ppc table: node, parent (for frame) + - -\ **xcat-service-nodes**\ - +\ **xcat-service-nodes**\ + nodelist table: node, groups (all service nodes (service), all service nodes in a BB (bbservice) ) - + hosts table: node, ip, hostnames, otherinterfaces - + ppc table: node, id, hcp, parent - + nodetype table: node, nodetype, arch - + nodehm table: node, mgt, cons - + noderes table: netboot - + servicenode table: node, nameserver, dhcpserver, tftpserver, nfsserver, conserver, monserver, ftpserver, nimserver, ipforward - + nodegroup table: groupname, grouptype, members, wherevals (all nodes under a service node (nodes) ) - + nodepos: rack, u + - -\ **xcat-storage-nodes**\ - +\ **xcat-storage-nodes**\ + nodelist table: node, groups (all storage nodes (storage), all storage nodes in a BB (bbstorage) ) - + hosts table: node, ip, hostnames, otherinterfaces - + ppc table: node, id, hcp, parent - + nodetype table: node, nodetype, arch - + nodehm table: node, mgt, cons - + noderes table: netboot, xcatmaster, servicenode - + nodepos: rack, u + - -\ **xcat-compute-nodes**\ - +\ **xcat-compute-nodes**\ + nodelist table: node, groups (all compute nodes (compute) ) - + hosts table: node, ip, hostnames, otherinterfaces - + ppc table: node, id, hcp, parent - + nodetype table: node, nodetype, arch - + nodehm table: node, mgt, cons - + noderes table: netboot, xcatmaster, servicenode - + nodepos: rack, u + - -\ **ll-config**\ - +\ **ll-config**\ + postscripts: postscripts - + @@ -493,36 +493,36 @@ OPTIONS -\ **-s|-**\ **-stanzas**\ \ *stanza-list*\ - +\ **-s|-**\ **-stanzas**\ \ *stanza-list*\ + A comma-separated list of stanza names that \ **xcatsetup**\ should process in the configuration file. If not specified, it will process all the stanzas that start with 'xcat' and some other stanzas that give xCAT hints about how to set up the HPC products. - + This option should only be specified if you have already run \ **xcatsetup**\ earlier with the stanzas that occur before this in the configuration file. Otherwise, objects will be created that refer back to other objects that do not exist in the database. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Command Version. + - -\ **-?|-h|-**\ **-help**\ - +\ **-?|-h|-**\ **-help**\ + Display usage message. + - -\ **-**\ **-yesreallydeletenodes**\ - +\ **-**\ **-yesreallydeletenodes**\ + Delete the nodes represented in the cluster config file, instead of creating them. This is useful if your first attempt with the cluster config file wasn't quite right and you want to start over. But use this option with extreme caution, because it will potentially delete a lot of nodes. If the only thing you have done so far in your database is add nodes by running \ **xcatsetup**\ , then it is safe to use this option to start over. If you have made other changes to your database, you should first back it up using dumpxCATdb(1)|dumpxCATdb.1 before using this option. - + @@ -532,11 +532,11 @@ RETURN VALUE -0. The command completed successfully. +0. The command completed successfully. -1. An error has occurred. +1. An error has occurred. @@ -549,45 +549,45 @@ EXAMPLES 1. Use the sample config.txt file at the beginning of this man page to create all the objects/nodes for a 2 building block cluster. - - + + .. code-block:: perl - + xcatsetup config.txt - - + + The output: - - + + .. code-block:: perl - + Defining site attributes... Defining HMCs... Defining frames... Defining CECs... Defining building blocks... Defining LPAR nodes... - - + + 2. Use the simpler config file shown earlier in this man page to create just the frame and cec objects: - - + + .. code-block:: perl - + xcatsetup config-simple.txt - - + + The output: - - + + .. code-block:: perl - + Defining frames... Defining CECs... - - + + diff --git a/docs/source/guides/admin-guides/references/man8/xcatsnap.8.rst b/docs/source/guides/admin-guides/references/man8/xcatsnap.8.rst index 6474da807..7ff985b66 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatsnap.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatsnap.8.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **xcatsnap**\ +\ **xcatsnap**\ \ **xcatsnap**\ [\ **-h | -**\ **-help**\ ] @@ -46,28 +46,28 @@ OPTIONS -\ **-h|-**\ **-help**\ - +\ **-h|-**\ **-help**\ + Displays the usage message. + - -\ **-v|-**\ **-version**\ - +\ **-v|-**\ **-version**\ + Displays the release version of the code. + - -\ **-B|-**\ **-bypass**\ - +\ **-B|-**\ **-bypass**\ + Runs in bypass mode, use if the xcatd daemon is hung. + - -\ **-d|-**\ **-dir**\ - +\ **-d|-**\ **-dir**\ + The directory to put the snap information. Default is /tmp/xcatsnap. - + @@ -84,22 +84,22 @@ EXAMPLES 1. Run the xcatsnap routine in bypass mode and put info in /tmp/mydir : - - + + .. code-block:: perl - + xcatsnap -B -d /tmp/mydir + + - - -2. To run the xcatsnap routine and use default directory /tmp/xcatsnap : - - +2. To run the xcatsnap routine and use default directory /tmp/xcatsnap : + + .. code-block:: perl - + xcatsnap - - + + diff --git a/xCAT-client/pods/man8/rinstall.8.pod b/xCAT-client/pods/man8/rinstall.8.pod index 68da3c407..9d731858d 100644 --- a/xCAT-client/pods/man8/rinstall.8.pod +++ b/xCAT-client/pods/man8/rinstall.8.pod @@ -33,6 +33,7 @@ Instruct network boot loader to be skipped, generally meaning boot to hard disk Prepare server for installing a node using the specified OS image. The OS image is defined in the I table and I table. If the I is omitted, the OS image name will be obtained from I for the node. =item B<--noupdateinitrd> + Skip the rebuilding of initrd when the 'netdrivers', 'driverupdatesrc' or 'osupdatename' were set for injecting new drivers to initrd. But, the B command should be run to rebuild the initrd for new drivers injecting. This is used to improve the performance of B command. =item B<--ignorekernelchk>