mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-21 19:22:05 +00:00
manpage spelling corrections, updated rst files
This commit is contained in:
besawn
parent
a6f1809c3e
commit
f43ca04022
@ -11,7 +11,7 @@ NAME
|
||||
****
|
||||
|
||||
|
||||
\ **addkit**\ - Adds product software Kits to an xCAT cluster environmnet.
|
||||
\ **addkit**\ - Adds product software Kits to an xCAT cluster environment.
|
||||
|
||||
|
||||
********
|
||||
|
||||
@ -128,7 +128,7 @@ EXAMPLES
|
||||
addkitcomp -a -i rhels6.2-ppc64-netboot-compute comp-test2-1.0-1-rhels-6.2-ppc64
|
||||
|
||||
|
||||
3. To add a kit component to osimage with incompatable osarch, osversion or ostype, use the -f (force) option:
|
||||
3. To add a kit component to osimage with incompatible osarch, osversion or ostype, use the -f (force) option:
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -132,7 +132,7 @@ RHEV specific :
|
||||
|
||||
\ **netmask**\ - The network mask for the interface.
|
||||
|
||||
\ **gateway**\ - The gateay for the interface. This field only can be set when
|
||||
\ **gateway**\ - The gateway for the interface. This field only can be set when
|
||||
the interface is added to 'rhevm' network.
|
||||
|
||||
|
||||
|
||||
@ -446,7 +446,7 @@ zVM specific:
|
||||
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. xCAT will
|
||||
find the a zFCP device in the specified pool that meets the size required, if
|
||||
find a zFCP device in the specified pool that meets the size required, if
|
||||
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'.
|
||||
|
||||
@ -140,7 +140,7 @@ RETRUN VALUE
|
||||
************
|
||||
|
||||
|
||||
0 The command completed sucessfully.
|
||||
0 The command completed successfully.
|
||||
|
||||
1 An error has occurred.
|
||||
|
||||
|
||||
@ -61,7 +61,7 @@ For statelite:
|
||||
|
||||
where x is the name of the profile.
|
||||
|
||||
Any files specified by the \ **-e**\ flag will also be exported. If \ **-p**\ flag is specified, the names of the postscripts and the postbootscripts for the given node will be exported. The postscripts themselves need to be manualy exported using \ **-e**\ flag.
|
||||
Any files specified by the \ **-e**\ flag will also be exported. If \ **-p**\ flag is specified, the names of the postscripts and the postbootscripts for the given node will be exported. The postscripts themselves need to be manually exported using \ **-e**\ flag.
|
||||
|
||||
For statelite, the litefile table settings for the image will also be exported. The litetree and statelite tables are not exported.
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ OPTIONS
|
||||
|
||||
\ **-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.
|
||||
Use this option to display the framework values of the specified Kit tarfile. This information is retrieved 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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ OPTIONS
|
||||
|
||||
\ **-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.
|
||||
Setup NTP servers for both management node and the service node. If management node has SLES installed and used as \ *ntpservers*\ , it is recommended to use the \ *setupntp*\ postscript to set up NTP server for service nodes.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -79,11 +79,11 @@ To list the contents of the xCAT osimage definition use the xCAT \ **lsdef**\ c
|
||||
|
||||
To check the validity of a SPOT or lpp_source resource
|
||||
|
||||
To remove an xCAT osimage definition along with the associated NIM resource definitions use the \ **rmnimimage**\ command. Be careful not to accidently remove NIM resources if they are still needed.
|
||||
To remove an xCAT osimage definition along with the associated NIM resource definitions use the \ **rmnimimage**\ command. Be careful not to accidentally remove NIM resources if they are still needed.
|
||||
|
||||
To list a NIM resource definition use the AIX \ **lsnim**\ command ("lsnim -l <resource_name>").
|
||||
|
||||
To check the validity of a SPOT or lpp_source resource use the AIX \ **nim**\ command ("nim -o check <resourec-name>").
|
||||
To check the validity of a SPOT or lpp_source resource use the AIX \ **nim**\ command ("nim -o check <resource-name>").
|
||||
|
||||
To remove specific NIM resource definitions use the AIX \ **nim**\ command. ("nim -o remove <resource-name>").
|
||||
|
||||
|
||||
@ -150,7 +150,7 @@ OPTIONS
|
||||
|
||||
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.
|
||||
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 assigned 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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@ OPTIONS
|
||||
|
||||
\ **-h | -**\ **-help**\ Display usage message.
|
||||
|
||||
\ **-r | -**\ **-remote**\ Specifies that the operation will also be performed on the nodes. For example, the3rd party monitoring software daemons on the nodes will also be started.
|
||||
\ **-r | -**\ **-remote**\ Specifies that the operation will also be performed on the nodes. For example, the 3rd party monitoring software daemons on the nodes will also be started.
|
||||
|
||||
\ **-v | -**\ **-version**\ Command Version.
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@ OPTIONS
|
||||
|
||||
\ **-h | -help**\ Display usage message.
|
||||
|
||||
\ **-r | -**\ **-remote**\ Specifies that the operation will also be performed on the nodes. For example, the3rd party monitoring software daemons on the nodes will also be stopped.
|
||||
\ **-r | -**\ **-remote**\ Specifies that the operation will also be performed on the nodes. For example, the 3rd party monitoring software daemons on the nodes will also be stopped.
|
||||
|
||||
\ **-v | -version**\ Command Version.
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ DESCRIPTION
|
||||
***********
|
||||
|
||||
|
||||
Runs the a command to the noderange using the console.
|
||||
Runs a command to the noderange using the console.
|
||||
|
||||
|
||||
********
|
||||
|
||||
@ -567,7 +567,7 @@ so no additional plugins are needed for BladeCenter.)
|
||||
module node.
|
||||
|
||||
Note: for the attribute without the leading 'pd1' which
|
||||
means there's only one power doamin in the chassis.
|
||||
means there's only one power domain in the chassis.
|
||||
|
||||
|
||||
|
||||
@ -870,7 +870,7 @@ so no additional plugins are needed for BladeCenter.)
|
||||
|
||||
|
||||
|
||||
5. Query all the attirbutes for blade server node blade1.
|
||||
5. Query all the attributes for blade server node blade1.
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -106,7 +106,7 @@ Any previously activated code on the affected systems will be automatically acce
|
||||
|
||||
\ **IMPORTANT!**\ If the power subsystem is recycled, all of its attached managed systems will be recycled.
|
||||
|
||||
If it outputs \ **"Timeout waiting for prompt"**\ during the upgrade, set the \ **"ppctimeout"**\ larger in the \ **site**\ table. After the upgrade, remeber to change it back. If run the \ **"rflash"**\ command on an AIX management node, need to make sure the value of \ **"useSSHonAIX"**\ is \ **"yes"**\ in the site table.
|
||||
If it outputs \ **"Timeout waiting for prompt"**\ during the upgrade, set the \ **"ppctimeout"**\ larger in the \ **site**\ table. After the upgrade, remember to change it back. If run the \ **"rflash"**\ command on an AIX management node, need to make sure the value of \ **"useSSHonAIX"**\ is \ **"yes"**\ in the site table.
|
||||
|
||||
|
||||
PPC (using Direct FSP Management) specific:
|
||||
@ -170,7 +170,7 @@ To apply the firmware level, a reboot is required to BMC and HOST.
|
||||
|
||||
\ **-d**\ :
|
||||
|
||||
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and Host .tar files. When BMC and Host tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
|
||||
This option streamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and Host .tar files. When BMC and Host tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
|
||||
|
||||
\ **-**\ **-delete**\ :
|
||||
|
||||
@ -345,7 +345,7 @@ This delete option will delete update image from BMC. It expects an ID as the in
|
||||
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:
|
||||
Print verbose message to rflash log file (/var/log/xcat/rflash/fs3.log) when updating firmware:
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
@ -365,7 +365,7 @@ This delete option will delete update image from BMC. It expects an ID as the in
|
||||
|
||||
|
||||
|
||||
7. To update the firmware on the OpenBMC machine, specify the firmare update file to upload and activate:
|
||||
7. To update the firmware on the OpenBMC machine, specify the firmware update file to upload and activate:
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -136,7 +136,7 @@ Output is similar to:
|
||||
kitcomponents comp-test1-1.0-1-rhels-6.2-ppc64 were removed from osimage rhels6.2-ppc64-netboot-compute successfully
|
||||
|
||||
|
||||
3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM. So in next genimage for statelss image and updatenode for stateful nodes, the kit component meta RPM and package RPM will be uninstalled.
|
||||
3. To remove a kit component from osimage and also remove the kit component meta RPM and package RPM. So in next genimage for stateless image and updatenode for stateful nodes, the kit component meta RPM and package RPM will be uninstalled.
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -66,7 +66,7 @@ OPTIONS
|
||||
|
||||
\ **-d|-**\ **-delete**\
|
||||
|
||||
Delete any files or directories that were left after the "nim -o remove" command was run. This option will also remove the lpp_source resouce and all files contained in the lpp_source directories. When this command completes all definitions and files will be completely erased so use with caution!
|
||||
Delete any files or directories that were left after the "nim -o remove" command was run. This option will also remove the lpp_source resource and all files contained in the lpp_source directories. When this command completes all definitions and files will be completely erased so use with caution!
|
||||
|
||||
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Note: if the "val" fields includes spaces or any other characters that will be p
|
||||
|
||||
\ **-r**\
|
||||
|
||||
specify the number of retries that the monitoring process will perform before declaring the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag.
|
||||
Specify the number of retries that the monitoring process will perform before declaring the failure. The default value is 3. Setting the retrycount to 0 means only monitoring the os installation progress and will not re-initiate the installation if the node status has not been changed to the expected value after timeout. This flag must be used with -m flag.
|
||||
|
||||
\ **-t**\
|
||||
|
||||
|
||||
@ -250,7 +250,7 @@ Output is similar to:
|
||||
fsp Server-9125-F2A-SN0262672-B 3 9125-F2A 0262672 192.168.200.243
|
||||
|
||||
|
||||
5. To collects the node information from one or more hardware control points on zVM AND populate the database with details collected by rscan:
|
||||
5. To collect the node information from one or more hardware control points on zVM AND populate the database with details collected by rscan:
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -342,13 +342,13 @@ OPTIONS
|
||||
|
||||
\ **frame**\ ={\ *framenumber*\ | \*}
|
||||
|
||||
Set or get frame number. If no framenumber and \* specified, framenumber for the nodes will be displayed and updated in xCAAT database. If framenumber is specified, it only supports single node and the framenumber will be set for that frame. If \* is specified, it supports noderange and all the frame numbers for the noderange will be read from xCAT database and set to frames. Setting the frame number is a disruptive command which requires all CECs to be powered off prior to issuing the command.
|
||||
Set or get frame number. If no framenumber and \* specified, framenumber for the nodes will be displayed and updated in the xCAT database. If framenumber is specified, it only supports single node and the framenumber will be set for that frame. If \* is specified, it supports noderange and all the frame numbers for the noderange will be read from xCAT database and set to frames. Setting the frame number is a disruptive command which requires all CECs to be powered off prior to issuing the command.
|
||||
|
||||
|
||||
|
||||
\ **cec_off_policy**\ ={\ **poweroff | stayon**\ }
|
||||
|
||||
Set or get cec off policy after lpars are powered off. If no cec_off_policy value specified, the cec_off_policy for the nodes will be displayed. the cec_off_policy has two values: \ **poweroff**\ and \ **stayon**\ . \ **poweroff**\ means Power off when last partition powers off. \ **stayon**\ means Stay running after last partition powers off. If cec_off_policy value is specified, the cec off policy will be set for that cec.
|
||||
Set or get cec off policy after lpars are powered off. If no cec_off_policy value specified, the cec_off_policy for the nodes will be displayed. The cec_off_policy has two values: \ **poweroff**\ and \ **stayon**\ . \ **poweroff**\ means Power off when last partition powers off. \ **stayon**\ means Stay running after last partition powers off. If cec_off_policy value is specified, the cec off policy will be set for that cec.
|
||||
|
||||
|
||||
|
||||
@ -670,7 +670,7 @@ OPTIONS
|
||||
|
||||
\ **sysname**\
|
||||
|
||||
Query or set sysname for CEC or Frame. If no value specified, means to query sysname of the specified nodes. If '\*' specified, it means to set sysname for the specified nodes, and the sysname values would get from xCAT datebase. If a string is specified, it means to use the string as sysname value to set for the specified node.
|
||||
Query or set sysname for CEC or Frame. If no value specified, means to query sysname of the specified nodes. If '\*' specified, it means to set sysname for the specified nodes, and the sysname values would get from xCAT database. If a string is specified, it means to use the string as sysname value to set for the specified node.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -94,7 +94,7 @@ Command Protocol can be used. See man \ **xdsh**\ for more details.
|
||||
which will automatically build the template for you from the
|
||||
seed node named.
|
||||
|
||||
If a a seed node is not provided, then command will automatically use the first node in the noderange as
|
||||
If a seed node is not provided, then command will automatically use the first node in the noderange as
|
||||
the seed node.
|
||||
|
||||
|
||||
|
||||
@ -126,7 +126,7 @@ OPTIONS
|
||||
|
||||
\ **-s|-**\ **-source**\
|
||||
|
||||
Specifies the hostname of the current (source) service node sa known by (facing) the management node.
|
||||
Specifies the hostname of the current (source) service node as known by (facing) the management node.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -173,7 +173,7 @@ EXAMPLES
|
||||
|
||||
|
||||
|
||||
4. To process switch-based switch discovery, the core switch has to be configured and top-of-rack (edge) switch has to be predefine into xCAT databse with attribute \ **switch**\ and \ **switchport**\ to core switch:
|
||||
4. To process switch-based switch discovery, the core switch has to be configured and top-of-rack (edge) switch has to be predefine into xCAT database with attribute \ **switch**\ and \ **switchport**\ to core switch:
|
||||
|
||||
|
||||
.. code-block:: perl
|
||||
|
||||
@ -11,7 +11,7 @@ NAME
|
||||
****
|
||||
|
||||
|
||||
\ **unregnotif**\ - unregister a Perl module or a command that was watching for the changes of the desired xCAT database tables.
|
||||
\ **unregnotif**\ - unregister a Perl module or a command that was watching for the changes of the desired xCAT database tables.
|
||||
|
||||
|
||||
********
|
||||
|
||||
@ -38,7 +38,7 @@ definition and the command that you wish to have run in the spot.
|
||||
|
||||
Be very careful when using this command!!! Make sure you are
|
||||
very clear about exactly what you are changing so that you do
|
||||
not accidently corrupt the image.
|
||||
not accidentally corrupt the image.
|
||||
|
||||
As a precaution it is advisable to make a copy of the original
|
||||
spot in case your changes wind up corrupting the image.
|
||||
|
||||
@ -231,7 +231,7 @@ running commands, are terminated (SIGTERM).
|
||||
of relevant device configuration file. The devicetype value must
|
||||
correspond to a valid device configuration file.
|
||||
xCAT ships some default configuration files
|
||||
for Ethernet switches and and IB switches under
|
||||
for Ethernet switches and IB switches under
|
||||
\ */opt/xcat/share/xcat/devicetype*\ directory. If you want to overwrite
|
||||
any of the configuration files, copy them to \ */var/opt/xcat/*\
|
||||
directory and customize.
|
||||
|
||||
@ -172,7 +172,7 @@ right sides:
|
||||
Any combination or multiple combinations of inclusive and exclusive
|
||||
ranges of nodes and groups is legal. There is no precedence implied in
|
||||
the order of the arguments. Exclusive ranges have precedence over
|
||||
inclusive. Parentheses can be used to explicitly specify precendence of any operators.
|
||||
inclusive. Parentheses can be used to explicitly specify precedence of any operators.
|
||||
|
||||
Nodes have precedence over groups. If a node range match is made then
|
||||
no group range match will be attempted.
|
||||
@ -194,7 +194,7 @@ Throughout this man page the term \ **xCAT Node Name Format**\ is used.
|
||||
|
||||
|
||||
In plain English, a node or group name is in \ **xCAT Node Name Format**\ if starting
|
||||
from the begining there are:
|
||||
from the beginning there are:
|
||||
|
||||
|
||||
\* one or more alpha characters of any case and any number of "-" in any combination
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user