xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
Code Issues Releases Wiki Activity

Regenerate .rst man pages with create_man_pages

Browse Source
This commit is contained in:
Mark Gurevich 2018-08-30 15:25:25 -04:00
parent 99c16e1998
commit b993ee9f0c
269 changed files with 11835 additions and 11818 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/source/guides/admin-guides/references/man1/addkit.1.rst
View File

@ -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.

58
docs/source/guides/admin-guides/references/man1/addkitcomp.1.rst
View File

@ -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.

62
docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst
View File

@ -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

272
docs/source/guides/admin-guides/references/man1/buildkit.1.rst
View File

@ -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 <kit_location>/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 <kit_location>/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 <kit_location>/\ *kitname*\ .tar.bz2.
\ **cleantar**\
\ **cleantar**\
Reads the <kit_location>/buildkit.conf file and \ *deletes*\ the following:
- Kit tar files matching <kit_location>/\ *kit_name\\*.tar.bz2*\ .
- <kit_location>/build/\ *kit_name*\
- <kit_location>/build/\ *kit_name*\
- <kit_location>/rpmbuild
- <kit_location>/tmp
- <kit_location>/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
<B>0
The command completed successfully.
<B>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**\

138
docs/source/guides/admin-guides/references/man1/cfgve.1.rst
View File

@ -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 <nw> 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 <FQDN of rhev manager> -o sd1 -c
2. To deactivate the Storage Domain 'sd1' from data center, enter:
.. code-block:: perl
cfgve -t sd -m <FQDN of rhev manager> -o sd1 -s
3. To remove the Storage Domain 'sd1', enter:
.. code-block:: perl
cfgve -t sd -m <FQDN of rhev manager> -o sd1 -r
4. To create the network 'nw1', enter:
.. code-block:: perl
cfgve -t nw -m <FQDN of rhev manager> -o nw1 -c
5. To remove the template 'tpl01', enter:
.. code-block:: perl
cfgve -t tpl -m <FQDN of rhev manager> -o tpl01 -r

4
docs/source/guides/admin-guides/references/man1/cfm2xcat.1.rst
View File

@ -15,7 +15,7 @@ NAME
****************
\ **SYNOPSIS**\
\ **SYNOPSIS**\
****************
@ -25,7 +25,7 @@ NAME
*******************
\ **DESCRIPTION**\
\ **DESCRIPTION**\
*******************

240
docs/source/guides/admin-guides/references/man1/chdef.1.rst
View File

@ -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

202
docs/source/guides/admin-guides/references/man1/chhypervisor.1.rst
View File

@ -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

32
docs/source/guides/admin-guides/references/man1/chkkitcomp.1.rst
View File

@ -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.

48
docs/source/guides/admin-guides/references/man1/chkosimage.1.rst
View File

@ -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

76
docs/source/guides/admin-guides/references/man1/chvlan.1.rst
View File

@ -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

28
docs/source/guides/admin-guides/references/man1/chvlanports.1.rst
View File

@ -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

338
docs/source/guides/admin-guides/references/man1/chvm.1.rst
View File

@ -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.

62
docs/source/guides/admin-guides/references/man1/clonevm.1.rst
View File

@ -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

42
docs/source/guides/admin-guides/references/man1/configfpc.1.rst
View File

@ -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

2
docs/source/guides/admin-guides/references/man1/csm2xcat.1.rst
View File

@ -73,7 +73,7 @@ EXAMPLES
.. code-block:: perl
cat node.stanza | chdef -z
cat device.stanza | chdef -z

110
docs/source/guides/admin-guides/references/man1/db2sqlsetup.1.rst
View File

@ -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

4
docs/source/guides/admin-guides/references/man1/dumpxCATdb.1.rst
View File

@ -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

176
docs/source/guides/admin-guides/references/man1/genimage.1.rst
View File

@ -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/<osver>/<arch> (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/<os> 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

20
docs/source/guides/admin-guides/references/man1/geninitrd.1.rst
View File

@ -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

30
docs/source/guides/admin-guides/references/man1/getmacs.1.rst
View File

@ -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.

48
docs/source/guides/admin-guides/references/man1/getslnodes.1.rst
View File

@ -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

54
docs/source/guides/admin-guides/references/man1/gettab.1.rst
View File

@ -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

2
docs/source/guides/admin-guides/references/man1/groupfiles4dsh.1.rst
View File

@ -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)

82
docs/source/guides/admin-guides/references/man1/imgcapture.1.rst
View File

@ -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.

38
docs/source/guides/admin-guides/references/man1/imgexport.1.rst
View File

@ -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.

26
docs/source/guides/admin-guides/references/man1/imgimport.1.rst
View File

@ -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.

22
docs/source/guides/admin-guides/references/man1/liteimg.1.rst
View File

@ -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.

336
docs/source/guides/admin-guides/references/man1/lsdef.1.rst
View File

@ -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 "<object name>: <data>".
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 "attr<operator>val" needs to be quoted. If the operator is "!~", the "attr<operator>val" 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

44
docs/source/guides/admin-guides/references/man1/lsdocker.1.rst
View File

@ -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

152
docs/source/guides/admin-guides/references/man1/lsflexnode.1.rst
View File

@ -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

88
docs/source/guides/admin-guides/references/man1/lshwconn.1.rst
View File

@ -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

148
docs/source/guides/admin-guides/references/man1/lskit.1.rst
View File

@ -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
<data>
<kitinfo>
...
@ -95,58 +95,58 @@ OPTIONS
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for one kit. The info inside <kitinfo> is structured as follows:
.. code-block:: perl
The <kit> sub-tag contains the kit's basic info.
The <kitrepo> sub-tags store info about the kit's repositories.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
.. code-block:: perl
<kitinfo>
<kit>
...
</kit>
<kitrepo>
...
</kitrepo>
...
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
\ **-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

150
docs/source/guides/admin-guides/references/man1/lskitcomp.1.rst
View File

@ -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
<data>
<kitinfo>
...
@ -87,52 +87,52 @@ OPTIONS
...
</kitinfo>
</data>
Each <kitinfo> tag contains info for a group of kit components belonging to the same kit. The info inside <kitinfo> is structured as follows:
.. code-block:: perl
The <kit> sub-tag contains the kit's name.
The <kitcomponent> sub-tags store info about the kit's components.
The data inside <kitinfo> is returned as:
.. code-block:: perl
<kitinfo>
<kit>
...
</kit>
<kitcomponent>
...
</kitcomponent>
...
</kitinfo>
\ **-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

68
docs/source/guides/admin-guides/references/man1/lskitdeployparam.1.rst
View File

@ -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
<data>
<kitdeployparam>
<name>KIT_KIT1_PARAM1</name>
@ -76,26 +76,26 @@ OPTIONS
</kitdeployparam>
</data>
...
\ **-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

70
docs/source/guides/admin-guides/references/man1/lskmodules.1.rst
View File

@ -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 <osdistro.dirpaths>/Packages/kernel-<kernelversion>.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 <osdistroupdate.dirpath>/kernel-<kernelversion>.rpm file.
\ **-x|-**\ **-xml|-**\ **-XML**\
\ **-x|-**\ **-xml|-**\ **-XML**\
Return the output with XML tags. The data is returned as:
.. code-block:: perl
<module>
<name> xxx.ko </name>
<description> this is module xxx </description>
</module>
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

76
docs/source/guides/admin-guides/references/man1/lslite.1.rst
View File

@ -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
........

12
docs/source/guides/admin-guides/references/man1/lsslp.1.rst
View File

@ -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

190
docs/source/guides/admin-guides/references/man1/lstree.1.rst
View File

@ -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

118
docs/source/guides/admin-guides/references/man1/lsve.1.rst
View File

@ -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<dc> - Data Center (For type of 'dc', all the elements belongs to the data center will be listed.)
B<cl> - Cluster
B<sd> - Storage Domain (To get the status of Storage Doamin, show it from I<data center> it attached to.
B<nw> - Network
B<tpl> - Template
@ -97,18 +97,18 @@ EXAMPLES
1. To list the data center 'Default', enter:
.. code-block:: perl
lsve -t dc -m <FQDN of rhev manager> -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 <FQDN of rhev manager> -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 <FQDN of rhev manager> -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 <FQDN of rhev manager> -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 <FQDN of rhev manager> -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

46
docs/source/guides/admin-guides/references/man1/lsvlan.1.rst
View File

@ -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

26
docs/source/guides/admin-guides/references/man1/lsvm.1.rst
View File

@ -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**\ .

74
docs/source/guides/admin-guides/references/man1/lsxcatd.1.rst
View File

@ -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

50
docs/source/guides/admin-guides/references/man1/makentp.1.rst
View File

@ -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

248
docs/source/guides/admin-guides/references/man1/mkdef.1.rst
View File

@ -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 "attr<operator>val" needs to be quoted. If the operator is "!~", the "attr<operator>val" 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

108
docs/source/guides/admin-guides/references/man1/mkdocker.1.rst
View File

@ -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": { "<port>/\<tcp|udp>: {}" }
\ **HostConfig: {"Binds"}**\
\ **HostConfig: {"Binds"}**\
A list of volume bindings for this docker instance, the form will be:
.. code-block:: perl
"HostConfig": {"Binds":["<dir_on_dockerhost>:<dir_in_instance>"]}

186
docs/source/guides/admin-guides/references/man1/mkdsklsnode.1.rst
View File

@ -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 "<xcat_node_name>_<image_name>" 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

26
docs/source/guides/admin-guides/references/man1/mkflexnode.1.rst
View File

@ -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

108
docs/source/guides/admin-guides/references/man1/mkhwconn.1.rst
View File

@ -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

368
docs/source/guides/admin-guides/references/man1/mknimimage.1.rst
View File

@ -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.

62
docs/source/guides/admin-guides/references/man1/mkvlan.1.rst
View File

@ -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

84
docs/source/guides/admin-guides/references/man1/mkvm.1.rst
View File

@ -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.

78
docs/source/guides/admin-guides/references/man1/monadd.1.rst
View File

@ -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.

6
docs/source/guides/admin-guides/references/man1/moncfg.1.rst
View File

@ -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]**\
***********

6
docs/source/guides/admin-guides/references/man1/mondecfg.1.rst
View File

@ -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]**\
***********

8
docs/source/guides/admin-guides/references/man1/monls.1.rst
View File

@ -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]**\
***********

6
docs/source/guides/admin-guides/references/man1/monrm.1.rst
View File

@ -19,11 +19,11 @@ SYNOPSIS
********
\ **monrm [-h| -**\ **-help]**\
\ **monrm [-h| -**\ **-help]**\
\ **monrm [-v| -**\ **-version]**\
\ **monrm [-v| -**\ **-version]**\
\ **monrm**\ \ *name*\
\ **monrm**\ \ *name*\
***********

4
docs/source/guides/admin-guides/references/man1/monshow.1.rst
View File

@ -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}**\ ]

4
docs/source/guides/admin-guides/references/man1/monstart.1.rst
View File

@ -19,9 +19,9 @@ SYNOPSIS
********
\ **monstart [-h| -**\ **-help]**\
\ **monstart [-h| -**\ **-help]**\
\ **monstart [-v| -**\ **-version]**\
\ **monstart [-v| -**\ **-version]**\
\ **monstart**\ \ *name*\ \ *[noderange]*\ [\ **-r|-**\ **-remote**\ ]

4
docs/source/guides/admin-guides/references/man1/monstop.1.rst
View File

@ -19,9 +19,9 @@ SYNOPSIS
********
\ **monstop [-h| -**\ **-help]**\
\ **monstop [-h| -**\ **-help]**\
\ **monstop [-v| -**\ **-version]**\
\ **monstop [-v| -**\ **-version]**\
\ **monstop**\ \ *name*\ [\ *noderange*\ ] [\ **-r|-**\ **-remote**\ ]

108
docs/source/guides/admin-guides/references/man1/mysqlsetup.1.rst
View File

@ -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

42
docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst
View File

@ -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.

58
docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst
View File

@ -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.

10
docs/source/guides/admin-guides/references/man1/nodeaddunmged.1.rst
View File

@ -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 <node-name> 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

68
docs/source/guides/admin-guides/references/man1/nodech.1.rst
View File

@ -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

10
docs/source/guides/admin-guides/references/man1/nodechmac.1.rst
View File

@ -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 <node-name> 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 <mac-address> is the NICs new MAC address.

34
docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst
View File

@ -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 <image-profile> 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 <network-profile> 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 <hardware-profile> 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

144
docs/source/guides/admin-guides/references/man1/nodediscoverdef.1.rst
View File

@ -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=<noderange> ...).
\* \ **profile**\ - Profile discovery (started via nodediscoverstart networkprofile=<network-profile> ...).
\* \ **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.

154
docs/source/guides/admin-guides/references/man1/nodediscoverls.1.rst
View File

@ -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=<noderange> ...).
\* \ **profile**\ - Profile discovery (started via nodediscoverstart networkprofile=<network-profile> ...).
\* \ **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

154
docs/source/guides/admin-guides/references/man1/nodediscoverstart.1.rst
View File

@ -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 <nodename> 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

6
docs/source/guides/admin-guides/references/man1/nodediscoverstatus.1.rst
View File

@ -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.

4
docs/source/guides/admin-guides/references/man1/nodediscoverstop.1.rst
View File

@ -37,11 +37,11 @@ OPTIONS
*******
\ **-h|-**\ **-help**\
\ **-h|-**\ **-help**\
Display usage message.
\ **-v|-**\ **-version**\
\ **-v|-**\ **-version**\
Command Version.

24
docs/source/guides/admin-guides/references/man1/nodegrpch.1.rst
View File

@ -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

34
docs/source/guides/admin-guides/references/man1/nodeimport.1.rst
View File

@ -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 <nodeinfo-filename> 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 <image-profile> 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 <network-profile> 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 <hardware-profile> 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 <node-name-format> 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 <node-group> 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

282
docs/source/guides/admin-guides/references/man1/nodels.1.rst
View File

@ -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

10
docs/source/guides/admin-guides/references/man1/nodepurge.1.rst
View File

@ -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.

10
docs/source/guides/admin-guides/references/man1/noderefresh.1.rst
View File

@ -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.

4
docs/source/guides/admin-guides/references/man1/noderm.1.rst
View File

@ -19,9 +19,9 @@ SYNOPSIS
********
\ **noderm [-h| -**\ **-help]**\
\ **noderm [-h| -**\ **-help]**\
\ **noderm noderange**\
\ **noderm noderange**\
***********

126
docs/source/guides/admin-guides/references/man1/nodestat.1.rst
View File

@ -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**\
************************

8
docs/source/guides/admin-guides/references/man1/packimage.1.rst
View File

@ -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
************

186
docs/source/guides/admin-guides/references/man1/pasu.1.rst
View File

@ -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.

6
docs/source/guides/admin-guides/references/man1/pcons.1.rst
View File

@ -11,12 +11,12 @@ SYNOPSIS
********
\ **pcons**\ \ *noderange*\ \ *command*\
\ **pcons**\ \ *noderange*\ \ *command*\
\ **pcons**\
\ **pcons**\
[\ **-h | -**\ **-help**\ ]
\ **pcons**\
\ **pcons**\
[\ **-v | -**\ **-version**\ ]

84
docs/source/guides/admin-guides/references/man1/pgsqlsetup.1.rst
View File

@ -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

70
docs/source/guides/admin-guides/references/man1/pping.1.rst
View File

@ -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 <nodename>-<interface>. 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

86
docs/source/guides/admin-guides/references/man1/ppping.1.rst
View File

@ -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 <nodename>-<interface>. 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

82
docs/source/guides/admin-guides/references/man1/prsync.1.rst
View File

@ -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**\
************************

82
docs/source/guides/admin-guides/references/man1/pscp.1.rst
View File

@ -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**\
************************

106
docs/source/guides/admin-guides/references/man1/psh.1.rst
View File

@ -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**\
************************

30
docs/source/guides/admin-guides/references/man1/pushinitrd.1.rst
View File

@ -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 <noderange>

112
docs/source/guides/admin-guides/references/man1/rbootseq.1.rst
View File

@ -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

36
docs/source/guides/admin-guides/references/man1/rcons.1.rst
View File

@ -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**\
************************

4
docs/source/guides/admin-guides/references/man1/regnotif.1.rst
View File

@ -19,9 +19,9 @@ SYNOPSIS
********
\ **regnotif [-h| -**\ **-help]**\
\ **regnotif [-h| -**\ **-help]**\
\ **regnotif [-v| -**\ **-version]**\
\ **regnotif [-v| -**\ **-version]**\
\ **regnotif**\ \ *filename tablename[,tablename]...*\ [\ **-o | -**\ **-operation**\ \ *actions*\ ]

690
docs/source/guides/admin-guides/references/man1/renergy.1.rst
View File

File diff suppressed because it is too large Load Diff

36
docs/source/guides/admin-guides/references/man1/replaycons.1.rst
View File

@ -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

4
docs/source/guides/admin-guides/references/man1/restartxcatd.1.rst
View File

@ -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.

108
docs/source/guides/admin-guides/references/man1/reventlog.1.rst
View File

@ -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.

192
docs/source/guides/admin-guides/references/man1/rflash.1.rst
View File

@ -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**\
*****

418
docs/source/guides/admin-guides/references/man1/rinv.1.rst
View File

@ -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:
<SYSTEM>
<System_type>IH</System_type>
@ -380,74 +380,74 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, number of CPUs, amou
<RID>800</RID>
</NODE>
</SYSTEM>
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,,,

98
docs/source/guides/admin-guides/references/man1/rmdef.1.rst
View File

@ -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.)

2
docs/source/guides/admin-guides/references/man1/rmdocker.1.rst
View File

@ -32,7 +32,7 @@ OPTIONS
\ **-f|-**\ **-force**\
\ **-f|-**\ **-force**\

Some files were not shown because too many files have changed in this diff Show More