diff --git a/README.rst b/README.rst index 6d1848fbf..1b8779f68 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ Documentation xCAT documentation is available at: http://xcat-docs.readthedocs.io/en/latest/ -|docs_latest| |docs_2138| |docs_2137| |docs_2136| |docs_2135| |docs_2134| |docs_2133| |docs_2132| |docs_2131| |docs_2130| |docs_212| +|docs_latest| |docs_2139| |docs_2138| |docs_2137| |docs_2136| |docs_2135| |docs_2134| |docs_2133| |docs_2132| |docs_2131| |docs_2130| |docs_212| Open Source License ------------------- @@ -22,6 +22,11 @@ Developers Developers and prospective contributors are encouraged to read the `Developers Guide `_ In particular the `GitHub `_ related subsection. +.. |docs_2139| image:: https://readthedocs.org/projects/xcat-docs/badge/?version=2.13.9 + :alt: 2.13.9 documentation status + :scale: 100% + :target: http://xcat-docs.readthedocs.io/en/2.13.9/ + .. |docs_2138| image:: https://readthedocs.org/projects/xcat-docs/badge/?version=2.13.8 :alt: 2.13.8 documentation status :scale: 100% diff --git a/Version b/Version index 6ad4f1e46..3caff04ae 100644 --- a/Version +++ b/Version @@ -1 +1 @@ -2.13.9 +2.13.10 diff --git a/docs/source/QA/index.rst b/docs/source/QA/index.rst index 00069abdd..2c8c72c0c 100644 --- a/docs/source/QA/index.rst +++ b/docs/source/QA/index.rst @@ -1,7 +1,8 @@ -Q/A list -======== +Questions & Answers +=================== .. toctree:: :maxdepth: 2 - makehosts_qa.rst + + makehosts.rst \ No newline at end of file diff --git a/docs/source/QA/makehosts.rst b/docs/source/QA/makehosts.rst new file mode 100644 index 000000000..ba9755033 --- /dev/null +++ b/docs/source/QA/makehosts.rst @@ -0,0 +1,133 @@ +DNS, Hostname, Alias +==================== + +Q: When there are multiple NICs, how to generate ``/etc/hosts`` records? +------------------------------------------------------------------------ + +When there are multiple NICs, and you want to use ``confignetwork`` to configure these NICs, suggest to use ``hosts`` table to configure the installation NIC (``installnic``) and to use ``nics`` table to configure secondary NICs. Refer to the following example to generate ``/etc/hosts`` records. + +**Best practice example**: + + * There are 2 networks in different domains: ``mgtnetwork`` and ``pubnetwork`` + * ``mgtnetwork`` is xCAT management network + * There are 2 adapters in system node1: ``eth0`` and ``eth1`` + * Add installnic ``eth0`` ``10.5.106.101`` record in ``/etc/hosts``, its alias is ``mgtnic`` + * hostnames ``node1-pub`` and ``node1.public.com`` are for nic ``eth1``, IP is ``192.168.30.101`` + +**Steps**: + + #. Add networks entry in ``networks`` table: :: + + chdef -t network mgtnetwork net=10.0.0.0 mask=255.0.0.0 domain=cluster.com + chdef -t network pubnetwork net=192.168.30.0 mask=255.255.255.0 domain=public.com + + #. Create ``node1`` with installnic IP ``10.5.106.101``, its alias is ``mgtnic``: :: + + chdef node1 ip=10.5.106.101 hostnames=mgtnic groups=all + + #. Configure ``eth1`` in ``nics`` table: :: + + chdef node1 nicips.eth1=192.168.30.101 nichostnamesuffixes.eth1=-pub nicaliases.eth1=node1.public.com nictypes.eth1=Ethernet nicnetworks.eth1=pubnetwork + + #. Check ``node1`` definition: :: + + lsdef node1 + Object name: node1 + groups=all + ip=10.5.106.101 + hostnames=mgtnic + nicaliases.eth1=node1.public.com + nichostnamesuffixes.eth1=-pub + nicips.eth1=192.168.30.101 + nicnetworks.eth1=pubnetwork + nictypes.eth1=Ethernet + postbootscripts=otherpkgs + postscripts=syslog,remoteshell,syncfiles + + #. Execute ``makehosts -n`` to generate ``/etc/hosts`` records: :: + + makehosts -n + + #. Check results in ``/etc/hosts``: :: + + 10.5.106.101 node1 node1.cluster.com mgtnic + 192.168.30.101 node1-pub node1.public.com + + #. Edit ``/etc/resolv.conf``, xCAT management node IP like ``10.5.106.2`` is nameserver: :: + + search cluster.com public.com + nameserver 10.5.106.2 + + #. Execute ``makedns -n`` to configure DNS + + +Q: How to configure aliases? +---------------------------- + +There are 3 methods to configure aliases: + +#. Use ``hostnames`` in ``hosts`` table to configure aliases for the installnic. +#. If you want to use script ``confignetwork`` to configure secondary NICs, suggest to use ``aliases`` in ``nics`` table to configure aliases. Refer to :doc:`Configure Aliases <../guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_aliases>` +#. If you want to generate aliases records in ``/etc/hosts`` for secondary NICs and you don't want to use the script ``confignetwork`` to configure these NICs, suggest to use ``otherinterfaces`` in ``hosts`` table to configure aliases. Refer to following example: + + * If you want to add ``node1-hd`` ``20.1.1.1`` in ``hosts`` table, and don't use ``confignetwork`` to configure it, you can add ``otherinterfaces`` like this: :: + + chdef node1 otherinterfaces="node1-hd:20.1.1.1" + + * After executing ``makehosts -n``, you can get records in ``/etc/hosts`` like following: :: + + 20.1.1.1 node1-hd + +**Note**: If suffixes or aliases for the same IP are configured in both ``hosts`` table and ``nics`` table, will cause conflicts. ``makehosts`` will use values from ``nics`` table. The values from ``nics`` table will over-write that from ``hosts`` table to create ``/etc/hosts`` records. + +Q: How to handle the same short hostname in different domains? +-------------------------------------------------------------- + +You can follow the best practice example. + +**Best practice example**: + + * There are 2 networks in different domains: ``mgtnetwork`` and ``pubnetwork`` + * ``mgtnetwork`` is xCAT management network + * Generate 2 records with the same hostname in ``/etc/hosts``, like: :: + + 10.5.106.101 node1.cluster.com + 192.168.20.101 node1.public.com + + * Nameserver is xCAT management node IP + +**Steps**: + + #. Add networks entry in ``networks`` table: :: + + chdef -t network mgtnetwork net=10.0.0.0 mask=255.0.0.0 domain=cluster.com + chdef -t network pubnetwork net=192.168.30.0 mask=255.255.255.0 domain=public.com + + #. Create ``node1`` with ``ip=10.5.106.101``, xCAT can manage and install this node: :: + + chdef node1 ip=10.5.106.101 groups=all + + #. Create ``node1-pub`` with ``ip=192.168.30.101``, this node is only used to generate ``/etc/hosts`` records for public network, can use ``_unmanaged`` group name to label it: :: + + chdef node1-pub ip=192.168.30.101 hostnames=node1.public.com groups=_unmanaged + + #. Execute ``makehosts -n`` to generate ``/etc/hosts`` records: :: + + makehosts -n + + #. Check results in ``/etc/hosts``: :: + + 10.5.106.101 node1 node1.cluster.com + 192.168.30.101 node1-pub node1.public.com + + #. Edit ``/etc/resolv.conf``, for example, xCAT management node IP is 10.5.106.2 : :: + + search cluster.com public.com + nameserver 10.5.106.2 + + #. Execute ``makedns -n`` to configure DNS + +Q: When to use ``hosts`` table and ``nics`` table? +-------------------------------------------------- + +``hosts`` table is used to store IP addresses and hostnames of nodes. ``makehosts`` use these data to create ``/etc/hosts`` records. ``nics`` table is used to stores secondary NICs details. Some scripts like ``confignetwork`` use data from ``nics`` table to configure secondary NICs. ``makehosts`` also use these data to create ``/etc/hosts`` records for each NIC. diff --git a/docs/source/conf.py b/docs/source/conf.py index f62bace59..f5c5b3eaa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ author = u'IBM Corporation' # The short X.Y version. version = '2' # The full version, including alpha/beta/rc tags. -release = '2.13.8' +release = '2.13.9' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_routes.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_routes.rst new file mode 100644 index 000000000..d9a4bcb70 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_routes.rst @@ -0,0 +1,93 @@ +Configure routes +----------------- + +There are 2 ways to configure OS route in xCAT: + + * ``makeroutes``: command to add or delete routes on the management node or any given nodes. + * ``setroute``: script to replace/add the routes to the node, it can be used in postscripts/postbootscripts. + +``makeroutes`` or ``setroute`` will modify OS temporary route, it also modifies persistent route in ``/etc/sysconfig/static-routes`` file. + +Before using ``makeroutes`` or ``setroute`` to configure OS route, details of the routes data such as routename, subnet, net mask and gateway should be stored in ``routes`` table. + +Configure ``routes`` table +`````````````````````````` + +#. Store default route data in ``routes`` table: :: + + chdef -t route defaultroute net=default mask=255.0.0.0 gateway=10.0.0.101 + +#. Store additional route data in ``routes`` table: :: + + chdef -t route 20net net=20.0.0.0 mask=255.0.0.0 gateway=0.0.0.0 ifname=eth1 + +#. Check data in ``routes`` table: :: + + tabdump routes + #routename,net,mask,gateway,ifname,comments,disable + "30net","30.0.0.0","255.0.0.0","0.0.0.0","eth2",, + "20net","20.0.0.0","255.0.0.0","0.0.0.0","eth1",, + "defaultroute","default","255.0.0.0","10.0.0.101",,, + +Use ``makeroutes`` to configure OS route on xCAT management node +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +#. define the names of the routes to be setup on the management node in ``site`` table: :: + + chdef -t site mnroutenames="defaultroute,20net" + lsdef -t site clustersite -i mnroutenames + Object name: clustersite + mnroutenames=defaultroute,20net + +#. add all routes from the ``mnroutenames`` to the OS route table for the management node: :: + + makeroutes + +#. add route ``20net`` and ``30net`` to the OS route table for the management node: :: + + makeroutes -r 20net,30net + +#. delete route ``20net`` from the OS route table for the management node: :: + + makeroutes -d -r 20net + +Use ``makeroutes`` to configure OS route for compute node +''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +#. define the names of the routes to be setup on the compute node: :: + + chdef -t cn1 routenames="defaultroute,20net" + +#. add all routes from the ``routenames`` to the OS route table for the compute node: :: + + makeroutes cn1 + +#. add route ``20net`` and ``30net`` to the OS route table for the compute node: :: + + makeroutes cn1 -r 20net,30net + +#. delete route ``20net`` from the OS route table for the compute node: :: + + makeroutes cn1,cn2 -d -r 20net + +Use ``setroute`` to configure OS route for compute node +''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +#. define the names of the routes to be setup on the compute node: :: + + chdef -t cn1 routenames="defaultroute,20net" + +#. If adding ``setroute [replace | add]`` into the node’s postscripts list, ``setroute`` will be executed during OS deployment on compute node to replace/add routes from ``routenames``: :: + + chdef cn1 -p postscripts="setroute replace" + +#. Or if the compute node is already running, use ``updatenode`` command to run ``setroute [replace | add]`` postscript: :: + + updatenode cn1 -P "setroute replace" + +Check result +```````````` + +#. Use ``route`` command in xCAT management node to check OS route table. + +#. Use ``xdsh cn1 route`` to check compute node OS route table. diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_routes.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_routes.rst new file mode 100644 index 000000000..9fb5d6b78 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_routes.rst @@ -0,0 +1 @@ +.. include:: ../../../../common/deployment/network/cfg_routes.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/index.rst index 43286943d..1300effb7 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/index.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/index.rst @@ -8,3 +8,4 @@ This section describes how to configure network adapters with persistent configu cfg_network_adapter.rst cfg_second_adapter.rst + cfg_routes.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_routes.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_routes.rst new file mode 100644 index 000000000..9fb5d6b78 --- /dev/null +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_routes.rst @@ -0,0 +1 @@ +.. include:: ../../../../common/deployment/network/cfg_routes.rst diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/index.rst index 43286943d..1300effb7 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/index.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/index.rst @@ -8,3 +8,4 @@ This section describes how to configure network adapters with persistent configu cfg_network_adapter.rst cfg_second_adapter.rst + cfg_routes.rst diff --git a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst index 6fde20bb8..b341c4d92 100644 --- a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst @@ -25,10 +25,6 @@ SYNOPSIS \ **bmcdiscover**\ [\ **-**\ **-sn**\ \ *SN_nodename*\ ] [\ **-s**\ \ *scan_method*\ ] [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] [\ **-z**\ ] [\ **-w**\ ] \ **-**\ **-range**\ \ *ip_ranges*\ -\ **bmcdiscover**\ \ **-u**\ \ *bmc_user*\ \ **-p**\ \ *bmc_passwd*\ \ **-i**\ \ *bmc_ip*\ \ **-**\ **-check**\ - -\ **bmcdiscover**\ [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] \ **-i**\ \ *bmc_ip*\ \ **-**\ **-ipsource**\ - *********** DESCRIPTION @@ -98,18 +94,6 @@ OPTIONS -\ **-**\ **-check**\ - - Check BMC administrator User/Password. - - - -\ **-**\ **-ipsource**\ - - Display the BMC IP configuration. - - - \ **-h|-**\ **-help**\ Display usage message @@ -187,22 +171,6 @@ Output is similar to: bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z -5. To check if the username or password is correct against the BMC: - - -.. code-block:: perl - - bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --check - - -6. Get BMC IP Address source, DHCP Address or static Address - - -.. code-block:: perl - - bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource - - ******** SEE ALSO diff --git a/docs/source/guides/admin-guides/references/man1/reventlog.1.rst b/docs/source/guides/admin-guides/references/man1/reventlog.1.rst index 8d5e4bff2..108ccbe9d 100644 --- a/docs/source/guides/admin-guides/references/man1/reventlog.1.rst +++ b/docs/source/guides/admin-guides/references/man1/reventlog.1.rst @@ -19,10 +19,17 @@ Name **************** -\ **reventlog**\ \ *noderange*\ {\ *number-of-entries*\ [\ **-s**\ ]|\ **all [-s] | clear**\ } +\ **reventlog**\ \ *noderange*\ [\ *number-of-entries*\ [\ **-s**\ ]|\ **all [-s] | clear**\ ] \ **reventlog**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] +OpenPOWER OpenBMC specific : +============================ + + +\ **reventlog**\ \ *noderange*\ [\ **resolved=**\ {\ *id-list*\ |\ **LED**\ }] + + ******************* \ **Description**\ @@ -64,6 +71,12 @@ logs are stored on each servers service processor. +\ **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**\ Print help. @@ -83,7 +96,7 @@ logs are stored on each servers service processor. -1. +1. List last 5 event log entries from node4 and node5 .. code-block:: perl @@ -110,7 +123,7 @@ logs are stored on each servers service processor. -2. +2. Clear all event log entries from node4 and node5 .. code-block:: perl @@ -129,6 +142,27 @@ logs are stored on each servers service processor. +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. + + + + ******** SEE ALSO diff --git a/docs/source/guides/admin-guides/references/man1/rflash.1.rst b/docs/source/guides/admin-guides/references/man1/rflash.1.rst index 7a6493de9..4eb48fa80 100644 --- a/docs/source/guides/admin-guides/references/man1/rflash.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rflash.1.rst @@ -63,7 +63,9 @@ OpenPOWER OpenBMC specific : \ **rflash**\ \ *noderange*\ \ *tar_file_path*\ {[\ **-c | -**\ **-check**\ ] | [\ **-a | -**\ **-activate**\ ] | [\ **-u | -**\ **-upload**\ ]} -\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-d | -**\ **-delete**\ ]} +\ **rflash**\ \ *noderange*\ \ *tar_file_directory*\ [\ **-d**\ ] [\ **-**\ **-no-host-reboot**\ ] + +\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-**\ **-delete**\ ]} @@ -148,36 +150,34 @@ The command will update firmware for OpenPOWER BMC when given an OpenPOWER node \ **-l|-**\ **-list**\ : +The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels. -.. code-block:: perl - - The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels. - - The (*) symbol indicates the active running firmware on the server. - - The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level. +The (\*) symbol indicates the active running firmware on the server. +The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level. \ **-u|-**\ **-upload**\ : - -.. code-block:: perl - - The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result. - +The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result. \ **-a|-**\ **-activate**\ : - -.. code-block:: perl - - The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step - +The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step To apply the firmware level, a reboot is required to BMC and HOST. \ **Note:**\ When using \ **rflash**\ in hierarchical environment, the .tar file must be accessible from Service Nodes. +\ **-d**\ : + +This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR 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. + +\ **Note:**\ When using \ **-**\ **-no-host-reboot**\ , it will not reboot the host after BMC is reboot. + +\ **-**\ **-delete**\ : + +This delete option will delete update image from BMC. It expects an ID as the input. + *************** @@ -264,7 +264,7 @@ To apply the firmware level, a reboot is required to BMC and HOST. -\ **-d|-**\ **-delete**\ +\ **-**\ **-delete**\ Delete update image from BMC @@ -357,7 +357,7 @@ To apply the firmware level, a reboot is required to BMC and HOST. -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 and BMC and/or PNOR update files: +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 PNOR update files: .. code-block:: perl @@ -372,7 +372,7 @@ To apply the firmware level, a reboot is required to BMC and HOST. .. code-block:: perl - rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar + rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar diff --git a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst index 3655a78b5..221319ff5 100644 --- a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst @@ -90,7 +90,7 @@ OPTIONS \ **-C|-**\ **-cleanup**\ - Perform additional cleanup by running \ **nodeset offline**\ on the objects specified in the \ *noderange*\ . + Perform additional cleanup by running \ **nodeset offline**\ and \ **makeconservercf -d**\ on the objects specified in the \ *noderange*\ . diff --git a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst index dab879fa5..b6956de5d 100644 --- a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst @@ -49,6 +49,8 @@ OpenBMC specific: \ **rspconfig**\ \ *noderange*\ {\ **ipsrc | ip | netmask | gateway | hostname | vlan | sshcfg**\ } +\ **rspconfig**\ \ *noderange*\ \ **dump**\ [\ **-l | -**\ **-list**\ ] [\ **-g | -**\ **-generate**\ ] [\ **-c | -**\ **-clear**\ {\ *id*\ |\ **all**\ }] [\ **-d | -**\ **-download**\ \ *id*\ ] + MPA specific: ============= @@ -430,6 +432,29 @@ OPTIONS +\ **dump**\ + + Manage OpenBMC system dumps. If no sub-option is provided, will generate, wait, and download the dump. + + + \ **-c**\ will clear a single specified dump, or use 'all' to clear all dumps on the BMC. + + + + \ **-l**\ will list all the generated dumps on the BMC. + + + + \ **-g**\ will generate a new dump on the BMC. Dump generation can take a few minutes. + + + + \ **-d**\ will download a single dump from the BMC to /var/log/xcat/dump on management or service node. + + + + + \ **network**\ ={[\ *ip*\ ],[\ *host*\ ],[\ *gateway*\ ],[\ *netmask*\ ]|\*} For MPA: get or set the MPA network parameters. If '\*' is specified, all parameters are read from the xCAT database. @@ -1230,6 +1255,48 @@ EXAMPLES +31. To list BMC dumps available for download: + + + .. code-block:: perl + + rspconfig p9euh02 dump -l + + + Output is similar to: + + + .. code-block:: perl + + p9euh02: [1] Generated: 09/06/2017 14:31:49, Size: 4528 + p9euh02: [2] Generated: 09/06/2017 14:31:55, Size: 4516 + p9euh02: [3] Generated: 09/06/2017 14:32:01, Size: 4236 + p9euh02: [4] Generated: 09/06/2017 14:32:07, Size: 4248 + p9euh02: [5] Generated: 09/06/2017 14:32:11, Size: 4268 + + + + +32. To generate and download BMC dump: + + + .. code-block:: perl + + rspconfig p9euh02 dump + + + Output is similar to: + + + .. code-block:: perl + + Capturing BMC Diagnostic information, this will take some time... + p9euh02: Dump requested. Target ID is 6, waiting for BMC to generate... + p9euh02: Dump 6 generated. Downloading to /var/log/xcat/dump/20171211-0951_p9euh02_dump_6.tar.xz + + + + ******** SEE ALSO diff --git a/docs/source/guides/admin-guides/references/man1/rvitals.1.rst b/docs/source/guides/admin-guides/references/man1/rvitals.1.rst index 7fa7e62d6..f67fe481d 100644 --- a/docs/source/guides/admin-guides/references/man1/rvitals.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rvitals.1.rst @@ -67,7 +67,7 @@ OpenPOWER (OpenBMC) specific: ============================= -\ **rvitals**\ \ *noderange*\ [\ **temp | voltage | wattage | fanspeed | power | altitude | all**\ ] +\ **rvitals**\ \ *noderange*\ [\ **temp | voltage | wattage | fanspeed | power | leds | altitude | all**\ ] diff --git a/docs/source/guides/admin-guides/references/man5/pdu.5.rst b/docs/source/guides/admin-guides/references/man5/pdu.5.rst index 5d5076cfb..c94edf9fe 100644 --- a/docs/source/guides/admin-guides/references/man5/pdu.5.rst +++ b/docs/source/guides/admin-guides/references/man5/pdu.5.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *outlet*\ , \ *machinetype*\ , \ *modelnum*\ , \ *serialnum*\ , \ *comments*\ , \ *disable*\ +\ **pdu Attributes:**\ \ *node*\ , \ *nodetype*\ , \ *pdutype*\ , \ *outlet*\ , \ *username*\ , \ *password*\ , \ *snmpversion*\ , \ *community*\ , \ *snmpuser*\ , \ *authtype*\ , \ *authkey*\ , \ *privtype*\ , \ *privkey*\ , \ *seclevel*\ , \ *comments*\ , \ *disable*\ *********** @@ -48,27 +48,75 @@ pdu Attributes: +\ **pdutype**\ + + The type of pdu + + + \ **outlet**\ The pdu outlet count -\ **machinetype**\ +\ **username**\ - The pdu machine type + The remote login user name -\ **modelnum**\ +\ **password**\ - The pdu model number + The remote login password -\ **serialnum**\ +\ **snmpversion**\ - The pdu serial number + The version to use to communicate with switch. SNMPv1 is assumed by default. + + + +\ **community**\ + + The community string to use for SNMPv1/v2 + + + +\ **snmpuser**\ + + The username to use for SNMPv3 communication, ignored for SNMPv1 + + + +\ **authtype**\ + + The authentication protocol(MD5|SHA) to use for SNMPv3. + + + +\ **authkey**\ + + The authentication passphrase for SNMPv3 + + + +\ **privtype**\ + + The privacy protocol(AES|DES) to use for SNMPv3. + + + +\ **privkey**\ + + The privacy passphrase to use for SNMPv3. + + + +\ **seclevel**\ + + The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3. diff --git a/docs/source/guides/admin-guides/references/man5/servicenode.5.rst b/docs/source/guides/admin-guides/references/man5/servicenode.5.rst index 3da4820e5..e202132f4 100644 --- a/docs/source/guides/admin-guides/references/man5/servicenode.5.rst +++ b/docs/source/guides/admin-guides/references/man5/servicenode.5.rst @@ -44,67 +44,67 @@ servicenode Attributes: \ **nameserver**\ - Do we set up DNS on this service node? Valid values: 2, 1, no or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If no or 0, it does not change the current state of the service. + Do we set up DNS on this service node? Valid values: 2, 1, or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If 0, it does not change the current state of the service. \ **dhcpserver**\ - Do we set up DHCP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, runs makedhcp -n. If no or 0, it does not change the current state of the service. + Do we set up DHCP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, runs makedhcp -n. If 0, it does not change the current state of the service. \ **tftpserver**\ - Do we set up TFTP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, configures and starts atftp. If no or 0, it does not change the current state of the service. + Do we set up TFTP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, configures and starts atftp. If 0, it does not change the current state of the service. \ **nfsserver**\ - Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:yes or 1, no or 0.If no or 0, it does not change the current state of the service. + Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:1 or 0.If 0, it does not change the current state of the service. \ **conserver**\ - Do we set up Conserver on this service node? Valid values:yes or 1, no or 0. If yes, configures and starts conserver daemon. If no or 0, it does not change the current state of the service. + Do we set up Conserver on this service node? Valid values:1 or 0. If 1, configures and starts conserver daemon. If 0, it does not change the current state of the service. \ **monserver**\ - Is this a monitoring event collection point? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Is this a monitoring event collection point? Valid values: 1 or 0. If 0, it does not change the current state of the service. \ **ldapserver**\ - Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:1 or 0. If 0, it does not change the current state of the service. \ **ntpserver**\ - Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **ftpserver**\ - Do we set up a ftp server on this service node? Not supported on AIX Valid values:yes or 1, no or 0. If yes, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If no or 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes + Do we set up a ftp server on this service node? Not supported on AIX Valid values:1 or 0. If 1, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes \ **nimserver**\ - Not used. Do we set up a NIM server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Do we set up a NIM server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **ipforward**\ - Do we set up ip forwarding on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ip forwarding on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. @@ -116,7 +116,7 @@ servicenode Attributes: \ **proxydhcp**\ - Do we set up proxydhcp service on this node? valid values: yes or 1, no or 0. If yes, the proxydhcp daemon will be enabled on this node. + Do we set up proxydhcp service on this node? valid values: 1 or 0. If 1, the proxydhcp daemon will be enabled on this node. diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst index a90adca50..de06fff57 100644 --- a/docs/source/guides/admin-guides/references/man7/group.7.rst +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **group Attributes:**\ \ *addkcmdline*\ , \ *arch*\ , \ *authdomain*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *bmcvlantag*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *consport*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *dockercpus*\ , \ *dockerflag*\ , \ *dockerhost*\ , \ *dockermemory*\ , \ *dockernics*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groupname*\ , \ *grouptype*\ , \ *hcp*\ , \ *height*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *machinetype*\ , \ *membergroups*\ , \ *members*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *modelnum*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *outlet*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *pdu*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *serial*\ , \ *serialflow*\ , \ *serialnum*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *wherevals*\ , \ *xcatmaster*\ +\ **group Attributes:**\ \ *addkcmdline*\ , \ *arch*\ , \ *authdomain*\ , \ *authkey*\ , \ *authtype*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *bmcvlantag*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *community*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *consport*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *dockercpus*\ , \ *dockerflag*\ , \ *dockerhost*\ , \ *dockermemory*\ , \ *dockernics*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groupname*\ , \ *grouptype*\ , \ *hcp*\ , \ *height*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *membergroups*\ , \ *members*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *outlet*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *pdu*\ , \ *pdutype*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *privkey*\ , \ *privtype*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *seclevel*\ , \ *serial*\ , \ *serialflow*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpuser*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *wherevals*\ , \ *xcatmaster*\ *********** @@ -57,6 +57,18 @@ group Attributes: +\ **authkey**\ (pdu.authkey) + + The authentication passphrase for SNMPv3 + + + +\ **authtype**\ (pdu.authtype) + + The authentication protocol(MD5|SHA) to use for SNMPv3. + + + \ **bmc**\ (ipmi.bmc, openbmc.bmc) The hostname of the BMC adapter. @@ -179,6 +191,12 @@ group Attributes: +\ **community**\ (pdu.community) + + The community string to use for SNMPv1/v2 + + + \ **cons**\ (nodehm.cons) The console method. If nodehm.serialport is set, this will default to the nodehm.mgt setting, otherwise it defaults to unused. Valid values: cyclades, mrv, or the values valid for the mgt attribute. @@ -457,12 +475,6 @@ group Attributes: -\ **machinetype**\ (pdu.machinetype) - - The pdu machine type - - - \ **membergroups**\ (nodegroup.membergroups) This attribute stores a comma-separated list of nodegroups that this nodegroup refers to. This attribute is only used by PCM. @@ -529,12 +541,6 @@ group Attributes: -\ **modelnum**\ (pdu.modelnum) - - The pdu model number - - - \ **monserver**\ (noderes.monserver) The monitoring aggregation point for this node. The format is "x,y" where x is the ip address as known by the management node and y is the ip address as known by the node. @@ -780,7 +786,7 @@ group Attributes: -\ **password**\ (ppchcp.password, mpa.password, websrv.password, switches.sshpassword) +\ **password**\ (ppchcp.password, mpa.password, websrv.password, pdu.password, switches.sshpassword) Password of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is abc123 for HMCs and padmin for IVMs. @@ -794,6 +800,10 @@ group Attributes: or + The remote login password + + or + The remote login password. It can be for ssh or telnet. If it is for telnet, set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. @@ -804,6 +814,12 @@ group Attributes: +\ **pdutype**\ (pdu.pdutype) + + The type of pdu + + + \ **postbootscripts**\ (postscripts.postbootscripts) Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". On AIX these scripts are run during the processing of /etc/inittab. On Linux they are run at the init.d time. xCAT automatically adds the scripts in the xcatdefaults.postbootscripts attribute to run first in the list. Please note that the postbootscripts specified for "xcatdefaults" will be assigned to node automatically, they can not be removed from "postbootscripts" attribute of a node with "chdef -m" command @@ -867,6 +883,18 @@ group Attributes: +\ **privkey**\ (pdu.privkey) + + The privacy passphrase to use for SNMPv3. + + + +\ **privtype**\ (pdu.privtype) + + The privacy protocol(AES|DES) to use for SNMPv3. + + + \ **productkey**\ (prodkey.key) The product key relevant to the aforementioned node/group and product combination @@ -909,6 +937,12 @@ group Attributes: +\ **seclevel**\ (pdu.seclevel) + + The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3. + + + \ **serial**\ (vpd.serial) The serial number of the node. @@ -921,12 +955,6 @@ group Attributes: -\ **serialnum**\ (pdu.serialnum) - - The pdu serial number - - - \ **serialport**\ (nodehm.serialport) The serial port for this node, in the linux numbering style (0=COM1/ttyS0, 1=COM2/ttyS1). For SOL on IBM blades, this is typically 1. For rackmount IBM servers, this is typically 0. @@ -947,67 +975,67 @@ group Attributes: \ **setupconserver**\ (servicenode.conserver) - Do we set up Conserver on this service node? Valid values:yes or 1, no or 0. If yes, configures and starts conserver daemon. If no or 0, it does not change the current state of the service. + Do we set up Conserver on this service node? Valid values:1 or 0. If 1, configures and starts conserver daemon. If 0, it does not change the current state of the service. \ **setupdhcp**\ (servicenode.dhcpserver) - Do we set up DHCP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, runs makedhcp -n. If no or 0, it does not change the current state of the service. + Do we set up DHCP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, runs makedhcp -n. If 0, it does not change the current state of the service. \ **setupftp**\ (servicenode.ftpserver) - Do we set up a ftp server on this service node? Not supported on AIX Valid values:yes or 1, no or 0. If yes, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If no or 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes + Do we set up a ftp server on this service node? Not supported on AIX Valid values:1 or 0. If 1, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes \ **setupipforward**\ (servicenode.ipforward) - Do we set up ip forwarding on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ip forwarding on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupldap**\ (servicenode.ldapserver) - Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupnameserver**\ (servicenode.nameserver) - Do we set up DNS on this service node? Valid values: 2, 1, no or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If no or 0, it does not change the current state of the service. + Do we set up DNS on this service node? Valid values: 2, 1, or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If 0, it does not change the current state of the service. \ **setupnfs**\ (servicenode.nfsserver) - Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:yes or 1, no or 0.If no or 0, it does not change the current state of the service. + Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:1 or 0.If 0, it does not change the current state of the service. \ **setupnim**\ (servicenode.nimserver) - Not used. Do we set up a NIM server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Do we set up a NIM server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupntp**\ (servicenode.ntpserver) - Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupproxydhcp**\ (servicenode.proxydhcp) - Do we set up proxydhcp service on this node? valid values: yes or 1, no or 0. If yes, the proxydhcp daemon will be enabled on this node. + Do we set up proxydhcp service on this node? valid values: 1 or 0. If 1, the proxydhcp daemon will be enabled on this node. \ **setuptftp**\ (servicenode.tftpserver) - Do we set up TFTP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, configures and starts atftp. If no or 0, it does not change the current state of the service. + Do we set up TFTP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, configures and starts atftp. If 0, it does not change the current state of the service. @@ -1067,13 +1095,23 @@ group Attributes: +\ **snmpuser**\ (pdu.snmpuser) + + The username to use for SNMPv3 communication, ignored for SNMPv1 + + + \ **snmpusername**\ (switches.username) The username to use for SNMPv3 communication, ignored for SNMPv1 -\ **snmpversion**\ (switches.snmpversion) +\ **snmpversion**\ (pdu.snmpversion, switches.snmpversion) + + The version to use to communicate with switch. SNMPv1 is assumed by default. + + or The version to use to communicate with switch. SNMPv1 is assumed by default. @@ -1195,7 +1233,7 @@ group Attributes: -\ **username**\ (ppchcp.username, mpa.username, websrv.username, switches.sshusername) +\ **username**\ (ppchcp.username, mpa.username, websrv.username, pdu.username, switches.sshusername) Userid of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is hscroot for HMCs and padmin for IVMs. @@ -1209,6 +1247,10 @@ group Attributes: or + The remote login user name + + or + The remote login user name. It can be for ssh or telnet. If it is for telnet, set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst index 02b84092a..63d82dfa8 100644 --- a/docs/source/guides/admin-guides/references/man7/node.7.rst +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -19,7 +19,7 @@ SYNOPSIS ******** -\ **node Attributes:**\ \ *addkcmdline*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *arch*\ , \ *authdomain*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *bmcvlantag*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *consport*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *dockercpus*\ , \ *dockerflag*\ , \ *dockerhost*\ , \ *dockermemory*\ , \ *dockernics*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groups*\ , \ *hcp*\ , \ *height*\ , \ *hidden*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *machinetype*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *modelnum*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *node*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *outlet*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *pdu*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *primarysn*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *serial*\ , \ *serialflow*\ , \ *serialnum*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *status*\ , \ *statustime*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *xcatmaster*\ , \ *zonename*\ +\ **node Attributes:**\ \ *addkcmdline*\ , \ *appstatus*\ , \ *appstatustime*\ , \ *arch*\ , \ *authdomain*\ , \ *authkey*\ , \ *authtype*\ , \ *bmc*\ , \ *bmcpassword*\ , \ *bmcport*\ , \ *bmcusername*\ , \ *bmcvlantag*\ , \ *cfgmgr*\ , \ *cfgmgtroles*\ , \ *cfgserver*\ , \ *chain*\ , \ *chassis*\ , \ *cmdmapping*\ , \ *community*\ , \ *cons*\ , \ *conserver*\ , \ *consoleondemand*\ , \ *consport*\ , \ *cpucount*\ , \ *cputype*\ , \ *currchain*\ , \ *currstate*\ , \ *dhcpinterfaces*\ , \ *disksize*\ , \ *displayname*\ , \ *dockercpus*\ , \ *dockerflag*\ , \ *dockerhost*\ , \ *dockermemory*\ , \ *dockernics*\ , \ *domainadminpassword*\ , \ *domainadminuser*\ , \ *domaintype*\ , \ *getmac*\ , \ *groups*\ , \ *hcp*\ , \ *height*\ , \ *hidden*\ , \ *hostcluster*\ , \ *hostinterface*\ , \ *hostmanager*\ , \ *hostnames*\ , \ *hosttype*\ , \ *hwtype*\ , \ *id*\ , \ *initrd*\ , \ *installnic*\ , \ *interface*\ , \ *ip*\ , \ *iscsipassword*\ , \ *iscsiserver*\ , \ *iscsitarget*\ , \ *iscsiuserid*\ , \ *kcmdline*\ , \ *kernel*\ , \ *linkports*\ , \ *mac*\ , \ *memory*\ , \ *mgt*\ , \ *micbridge*\ , \ *michost*\ , \ *micid*\ , \ *miconboot*\ , \ *micpowermgt*\ , \ *micvlog*\ , \ *migrationdest*\ , \ *monserver*\ , \ *mpa*\ , \ *mtm*\ , \ *nameservers*\ , \ *netboot*\ , \ *nfsdir*\ , \ *nfsserver*\ , \ *nicaliases*\ , \ *niccustomscripts*\ , \ *nicdevices*\ , \ *nicextraparams*\ , \ *nichostnameprefixes*\ , \ *nichostnamesuffixes*\ , \ *nicips*\ , \ *nicnetworks*\ , \ *nicsadapter*\ , \ *nictypes*\ , \ *nimserver*\ , \ *node*\ , \ *nodetype*\ , \ *ondiscover*\ , \ *os*\ , \ *osvolume*\ , \ *otherinterfaces*\ , \ *ou*\ , \ *outlet*\ , \ *parent*\ , \ *passwd.HMC*\ , \ *passwd.admin*\ , \ *passwd.celogin*\ , \ *passwd.general*\ , \ *passwd.hscroot*\ , \ *password*\ , \ *pdu*\ , \ *pdutype*\ , \ *postbootscripts*\ , \ *postscripts*\ , \ *power*\ , \ *pprofile*\ , \ *prescripts-begin*\ , \ *prescripts-end*\ , \ *primarynic*\ , \ *primarysn*\ , \ *privkey*\ , \ *privtype*\ , \ *productkey*\ , \ *profile*\ , \ *protocol*\ , \ *provmethod*\ , \ *rack*\ , \ *room*\ , \ *routenames*\ , \ *seclevel*\ , \ *serial*\ , \ *serialflow*\ , \ *serialport*\ , \ *serialspeed*\ , \ *servicenode*\ , \ *setupconserver*\ , \ *setupdhcp*\ , \ *setupftp*\ , \ *setupipforward*\ , \ *setupldap*\ , \ *setupnameserver*\ , \ *setupnfs*\ , \ *setupnim*\ , \ *setupntp*\ , \ *setupproxydhcp*\ , \ *setuptftp*\ , \ *sfp*\ , \ *side*\ , \ *slot*\ , \ *slotid*\ , \ *slots*\ , \ *snmpauth*\ , \ *snmppassword*\ , \ *snmpprivacy*\ , \ *snmpuser*\ , \ *snmpusername*\ , \ *snmpversion*\ , \ *status*\ , \ *statustime*\ , \ *storagcontroller*\ , \ *storagetype*\ , \ *supernode*\ , \ *supportedarchs*\ , \ *supportproxydhcp*\ , \ *switch*\ , \ *switchinterface*\ , \ *switchport*\ , \ *switchtype*\ , \ *switchvlan*\ , \ *syslog*\ , \ *termport*\ , \ *termserver*\ , \ *tftpdir*\ , \ *tftpserver*\ , \ *unit*\ , \ *updatestatus*\ , \ *updatestatustime*\ , \ *urlpath*\ , \ *usercomment*\ , \ *userid*\ , \ *username*\ , \ *vmbeacon*\ , \ *vmbootorder*\ , \ *vmcfgstore*\ , \ *vmcluster*\ , \ *vmcpus*\ , \ *vmhost*\ , \ *vmmanager*\ , \ *vmmaster*\ , \ *vmmemory*\ , \ *vmnicnicmodel*\ , \ *vmnics*\ , \ *vmothersetting*\ , \ *vmphyslots*\ , \ *vmstorage*\ , \ *vmstoragecache*\ , \ *vmstorageformat*\ , \ *vmstoragemodel*\ , \ *vmtextconsole*\ , \ *vmvirtflags*\ , \ *vmvncport*\ , \ *webport*\ , \ *xcatmaster*\ , \ *zonename*\ *********** @@ -69,6 +69,18 @@ node Attributes: +\ **authkey**\ (pdu.authkey) + + The authentication passphrase for SNMPv3 + + + +\ **authtype**\ (pdu.authtype) + + The authentication protocol(MD5|SHA) to use for SNMPv3. + + + \ **bmc**\ (ipmi.bmc, openbmc.bmc) The hostname of the BMC adapter. @@ -191,6 +203,12 @@ node Attributes: +\ **community**\ (pdu.community) + + The community string to use for SNMPv1/v2 + + + \ **cons**\ (nodehm.cons) The console method. If nodehm.serialport is set, this will default to the nodehm.mgt setting, otherwise it defaults to unused. Valid values: cyclades, mrv, or the values valid for the mgt attribute. @@ -469,12 +487,6 @@ node Attributes: -\ **machinetype**\ (pdu.machinetype) - - The pdu machine type - - - \ **memory**\ (hwinv.memory) The size of the memory for the node in MB. @@ -529,12 +541,6 @@ node Attributes: -\ **modelnum**\ (pdu.modelnum) - - The pdu model number - - - \ **monserver**\ (noderes.monserver) The monitoring aggregation point for this node. The format is "x,y" where x is the ip address as known by the management node and y is the ip address as known by the node. @@ -786,7 +792,7 @@ node Attributes: -\ **password**\ (ppchcp.password, mpa.password, websrv.password, switches.sshpassword) +\ **password**\ (ppchcp.password, mpa.password, websrv.password, pdu.password, switches.sshpassword) Password of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is abc123 for HMCs and padmin for IVMs. @@ -800,6 +806,10 @@ node Attributes: or + The remote login password + + or + The remote login password. It can be for ssh or telnet. If it is for telnet, set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. @@ -810,6 +820,12 @@ node Attributes: +\ **pdutype**\ (pdu.pdutype) + + The type of pdu + + + \ **postbootscripts**\ (postscripts.postbootscripts) Comma separated list of scripts that should be run on this node after diskful installation or diskless boot. Each script can take zero or more parameters. For example: "script1 p1 p2,script2,...". On AIX these scripts are run during the processing of /etc/inittab. On Linux they are run at the init.d time. xCAT automatically adds the scripts in the xcatdefaults.postbootscripts attribute to run first in the list. Please note that the postbootscripts specified for "xcatdefaults" will be assigned to node automatically, they can not be removed from "postbootscripts" attribute of a node with "chdef -m" command @@ -879,6 +895,18 @@ node Attributes: +\ **privkey**\ (pdu.privkey) + + The privacy passphrase to use for SNMPv3. + + + +\ **privtype**\ (pdu.privtype) + + The privacy protocol(AES|DES) to use for SNMPv3. + + + \ **productkey**\ (prodkey.key) The product key relevant to the aforementioned node/group and product combination @@ -921,6 +949,12 @@ node Attributes: +\ **seclevel**\ (pdu.seclevel) + + The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3. + + + \ **serial**\ (vpd.serial) The serial number of the node. @@ -933,12 +967,6 @@ node Attributes: -\ **serialnum**\ (pdu.serialnum) - - The pdu serial number - - - \ **serialport**\ (nodehm.serialport) The serial port for this node, in the linux numbering style (0=COM1/ttyS0, 1=COM2/ttyS1). For SOL on IBM blades, this is typically 1. For rackmount IBM servers, this is typically 0. @@ -959,67 +987,67 @@ node Attributes: \ **setupconserver**\ (servicenode.conserver) - Do we set up Conserver on this service node? Valid values:yes or 1, no or 0. If yes, configures and starts conserver daemon. If no or 0, it does not change the current state of the service. + Do we set up Conserver on this service node? Valid values:1 or 0. If 1, configures and starts conserver daemon. If 0, it does not change the current state of the service. \ **setupdhcp**\ (servicenode.dhcpserver) - Do we set up DHCP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, runs makedhcp -n. If no or 0, it does not change the current state of the service. + Do we set up DHCP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, runs makedhcp -n. If 0, it does not change the current state of the service. \ **setupftp**\ (servicenode.ftpserver) - Do we set up a ftp server on this service node? Not supported on AIX Valid values:yes or 1, no or 0. If yes, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If no or 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes + Do we set up a ftp server on this service node? Not supported on AIX Valid values:1 or 0. If 1, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes \ **setupipforward**\ (servicenode.ipforward) - Do we set up ip forwarding on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ip forwarding on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupldap**\ (servicenode.ldapserver) - Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupnameserver**\ (servicenode.nameserver) - Do we set up DNS on this service node? Valid values: 2, 1, no or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If no or 0, it does not change the current state of the service. + Do we set up DNS on this service node? Valid values: 2, 1, or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If 0, it does not change the current state of the service. \ **setupnfs**\ (servicenode.nfsserver) - Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:yes or 1, no or 0.If no or 0, it does not change the current state of the service. + Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:1 or 0.If 0, it does not change the current state of the service. \ **setupnim**\ (servicenode.nimserver) - Not used. Do we set up a NIM server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Do we set up a NIM server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupntp**\ (servicenode.ntpserver) - Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service. + Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service. \ **setupproxydhcp**\ (servicenode.proxydhcp) - Do we set up proxydhcp service on this node? valid values: yes or 1, no or 0. If yes, the proxydhcp daemon will be enabled on this node. + Do we set up proxydhcp service on this node? valid values: 1 or 0. If 1, the proxydhcp daemon will be enabled on this node. \ **setuptftp**\ (servicenode.tftpserver) - Do we set up TFTP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, configures and starts atftp. If no or 0, it does not change the current state of the service. + Do we set up TFTP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, configures and starts atftp. If 0, it does not change the current state of the service. @@ -1079,13 +1107,23 @@ node Attributes: +\ **snmpuser**\ (pdu.snmpuser) + + The username to use for SNMPv3 communication, ignored for SNMPv1 + + + \ **snmpusername**\ (switches.username) The username to use for SNMPv3 communication, ignored for SNMPv1 -\ **snmpversion**\ (switches.snmpversion) +\ **snmpversion**\ (pdu.snmpversion, switches.snmpversion) + + The version to use to communicate with switch. SNMPv1 is assumed by default. + + or The version to use to communicate with switch. SNMPv1 is assumed by default. @@ -1231,7 +1269,7 @@ node Attributes: -\ **username**\ (ppchcp.username, mpa.username, websrv.username, switches.sshusername) +\ **username**\ (ppchcp.username, mpa.username, websrv.username, pdu.username, switches.sshusername) Userid of the HMC or IVM. If not filled in, xCAT will look in the passwd table for key=hmc or key=ivm. If not in the passwd table, the default used is hscroot for HMCs and padmin for IVMs. @@ -1245,6 +1283,10 @@ node Attributes: or + The remote login user name + + or + The remote login user name. It can be for ssh or telnet. If it is for telnet, set protocol to "telnet". If the sshusername is blank, the username, password and protocol will be retrieved from the passwd table with "switch" as the key. diff --git a/docs/source/guides/admin-guides/references/man7/osimage.7.rst b/docs/source/guides/admin-guides/references/man7/osimage.7.rst index d8b2c77ce..8e2faea1f 100644 --- a/docs/source/guides/admin-guides/references/man7/osimage.7.rst +++ b/docs/source/guides/admin-guides/references/man7/osimage.7.rst @@ -255,7 +255,7 @@ osimage Attributes: \ **otherpkgdir**\ (linuximage.otherpkgdir) - The base directory where the non-distro packages are stored. Only 1 local directory supported at present. + The base directory and urls of internet repos from which the non-distro packages are retrived. Only 1 local directory is supported at present. The entries should be delimited with comma ",". Currently, the internet repos are only supported on Ubuntu and Redhat. diff --git a/docs/source/guides/admin-guides/references/man7/pdu.7.rst b/docs/source/guides/admin-guides/references/man7/pdu.7.rst index 1e2397a42..a9aaae2b6 100644 --- a/docs/source/guides/admin-guides/references/man7/pdu.7.rst +++ b/docs/source/guides/admin-guides/references/man7/pdu.7.rst @@ -40,15 +40,11 @@ pdu Attributes: \ **machinetype**\ (pdu.machinetype) - - The pdu machine type - + \ **modelnum**\ (pdu.modelnum) - - The pdu model number - + \ **node**\ (pdu.node) @@ -70,9 +66,7 @@ pdu Attributes: \ **serialnum**\ (pdu.serialnum) - - The pdu serial number - + diff --git a/docs/source/guides/admin-guides/references/man8/makeconservercf.8.rst b/docs/source/guides/admin-guides/references/man8/makeconservercf.8.rst index 19ae43ea6..249be78f4 100644 --- a/docs/source/guides/admin-guides/references/man8/makeconservercf.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makeconservercf.8.rst @@ -21,6 +21,8 @@ SYNOPSIS \ **makeconservercf**\ [\ **-V|-**\ **-verbose**\ ] [\ **-d|-**\ **-delete**\ ] [\ *noderange*\ ] +\ **makeconservercf**\ [\ **-V|-**\ **-verbose**\ ] [\ **-C|-**\ **-cleanup**\ ] + \ **makeconservercf**\ [\ **-V|-**\ **-verbose**\ ] [\ **-l|-**\ **-local**\ ] [\ *noderange*\ ] \ **makeconservercf**\ [\ **-V|-**\ **-verbose**\ ] [\ **-c|-**\ **-conserver**\ ] [\ *noderange*\ ] @@ -42,6 +44,8 @@ does not have nodehm.cons set, it will not be written to the file. If \ **-d**\ is specified, \ **makeconservercf**\ will remove specified nodes from /etc/conserver.cf file. If \ *noderange*\ is not specified, all xCAT nodes will be removed from /etc/conserver.cf file. +If \ **-C|-**\ **-cleanup**\ is specified, \ **makeconservercf**\ will remove console configuration entries from /etc/conserver.cf for the nodes whose definitions have been removed from xCATdb. \ **Don't**\ specify any noderange. + In the case of a hierarchical cluster (i.e. one with service nodes) \ **makeconservercf**\ will determine which nodes will have their consoles accessed from the management node and which from a service node (based on the nodehm.conserver attribute). The /etc/conserver.cf file will be created accordingly on @@ -60,6 +64,12 @@ OPTIONS +\ **-C|-**\ **-cleanup**\ + + Remove the entries for the nodes whose definitions have been removed from xCAT db. + + + \ **-c|-**\ **-conserver**\ Only set up the conserver on the conserver host. If no conserver host diff --git a/docs/source/guides/admin-guides/references/man8/makegocons.8.rst b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst new file mode 100644 index 000000000..76eb7a5fc --- /dev/null +++ b/docs/source/guides/admin-guides/references/man8/makegocons.8.rst @@ -0,0 +1,151 @@ + +############ +makegocons.8 +############ + +.. highlight:: perl + + +**** +NAME +**** + + +\ **makegocons**\ - Register or unregister the node in the goconserver service + + +******** +SYNOPSIS +******** + + +\ **makegocons**\ [\ **-V|-**\ **-verbose**\ ] [\ **-d|-**\ **-delete**\ ] [\ *noderange*\ ] + +\ **makeconservercf**\ [\ **-h|-**\ **-help|-v|-**\ **-version**\ ] + + +*********** +DESCRIPTION +*********** + + +The \ **makegocons**\ command will start the goconserver service if it is not started, then +send the REST request to create or delete the session resource in the goconserver service. The session +information including the session command or ssh connection parameters (for openbmc) is generated by xcat +based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc). + +By default \ **makegocons**\ will register the session for all of the nodes in xcat. + +If a \ *noderange*\ is specified, only the session in the specified scope will be affected, goconserver +service will not be restarted and the other session will not be disconnected. This is the advantage +of goconserver over the conserver service with \ **makeconservercf**\ . + +If \ **-d**\ is specified, \ **makegocons**\ will remove the session in the goconserver service. + +In the case of a hierarchical cluster (i.e. one with service nodes) \ **makegocons**\ will determine +which nodes will have their consoles accessed from the management node and which from a service node +(based on the nodehm.conserver attribute). + +For openbmc which uses ssh as the terminal session connection method, goconserver can help save the system +resources as goconserver could handle the ssh connection within goroutine which is more light-weighted than the command process. + +\ **Note:**\ goconserver is an experimental feature, it will not be installed with xcat and will only support the systemd based systems. +Download and setup the rpm or deb package manually. Release link: + + +.. code-block:: perl + + https://github.com/chenglch/goconserver/releases + + + +******* +OPTIONS +******* + + + +\ **-d|-**\ **-delete**\ + + Delete rather than add or refresh the nodes specified as a noderange. + + + +\ **-v|-**\ **-version**\ + + Display version. + + + +\ **-V|-**\ **-verbose**\ + + Verbose mode. + + + +\ **-h|-**\ **-help**\ + + Display usage message. + + + + +************ +RETURN VALUE +************ + + + +0. The command completed successfully. + + + +1. An error has occurred. + + + + +******** +EXAMPLES +******** + + + +1. To create goconserver configuration for all the nodes. + + + .. code-block:: perl + + makegocons + + + + +2. To create goconserver configuration for nodes node01-node10. + + + .. code-block:: perl + + makegocons node01-node10 + + + + +3. To remove goconserver configuration for node01. + + + .. code-block:: perl + + makegocons -d node01 + + + + + +******** +SEE ALSO +******** + + +rcons(1)|rcons.1 + diff --git a/docs/source/overview/xcat2_release.rst b/docs/source/overview/xcat2_release.rst index 53c2c5c89..56e021d2c 100644 --- a/docs/source/overview/xcat2_release.rst +++ b/docs/source/overview/xcat2_release.rst @@ -14,6 +14,17 @@ xCAT 2.13.x |xCAT |New OS |New |New Feature | |Version | |Hardware | | +=================================+===============+=============+==================================+ +|| xCAT 2.13.9 | | |- OpenBMC support: | +|| 2017/12/18 | | | | +|| | | | rflash -a/-u enhance, add -d | +| `2.13.9 Release Notes `_ | | | | +| | | | rspconfig dump,hostname, | +| | | | ntpserver,admin_passwd | +| | | | | +| | | |- goconserver for OpenBMC | ++---------------------------------+---------------+-------------+----------------------------------+ || xCAT 2.13.8 | | |- OpenBMC support: | || 2017/11/3 | | | | || | | | rflash/rpower run parallelly | diff --git a/docs/source/security/2017/20171212_tls.rst b/docs/source/security/2017/20171212_tls.rst new file mode 100644 index 000000000..87eeffd86 --- /dev/null +++ b/docs/source/security/2017/20171212_tls.rst @@ -0,0 +1,29 @@ +2017-12-12 - TLS Vulnerabilities +================================ + +*Dec 12, 2017*, TLS implementations may disclose side channel information via discrepencies between valid and invalid PKCS#1 padding + +Advisory CVEs +------------- + +* CWE-203 - http://cwe.mitre.org/data/definitions/203.html + +Summary +------- + +Transport Layer Security (TLS) is a mechanism for a security transport over network connections, and is defined in RFC 5246. TLS may utilize RSA cryptography to secure the connection, and section 7.4.7 describes how client and server may exchange keys. Implementations that don't closely follow the descriptions in RFC 5246 may leak information to an attacker when they handle PKCS #1 v1.5 padding errors in ways that lets the attacker distinguish between valid and invalid messages. An attacker may utilize discrepancies in TLS error messages to obtain the pre-master secret key private RSA key used by TLS to decrypt sensitive data. This type of attack has become known as a Bleichenbacher attack. CERT/CC previously published CERT Advisory CA-1998-07 for this type of attack. + +Action +------ + +Consider the following recommended actions: + +1. Disable TLS RSA +2. Apply an update (if available) + + +xCAT uses OpenSSL for client-server communication but **does not** ship it. + +It is highly recommended to keep your OpenSSL levels up-to-date. Obtain the updated software packages from your Operating system distribution channels. + + diff --git a/docs/source/security/2017/index.rst b/docs/source/security/2017/index.rst index 78e927e17..1786e2562 100644 --- a/docs/source/security/2017/index.rst +++ b/docs/source/security/2017/index.rst @@ -4,6 +4,7 @@ .. toctree:: :maxdepth: 1 + 20171212_tls.rst 20170828_openssl.rst 20170216_openssl.rst 20170126_openssl.rst diff --git a/perl-xCAT/xCAT/DSHCLI.pm b/perl-xCAT/xCAT/DSHCLI.pm index 7e22de2d3..c1f59fdea 100644 --- a/perl-xCAT/xCAT/DSHCLI.pm +++ b/perl-xCAT/xCAT/DSHCLI.pm @@ -835,7 +835,7 @@ sub fork_fanout_dcp my @target_file = split '/', $$options{'source'}; $rcp_config{'dest-file'} = -"$$options{'target'}/$target_file[$#target_file]._$$target_properties{'hostname'}"; + "$$options{'target'}/$target_file[$#target_file]._$$target_properties{'hostname'}"; } @@ -850,6 +850,8 @@ sub fork_fanout_dcp $$options{'destDir_srcFile'}{$user_target}; } + $dsh_trace + && ($rcp_config{'trace'} = 1); #eval "require RemoteShell::$rsh_extension"; eval "require xCAT::$rsh_extension"; my $remoteshell = "xCAT::$rsh_extension"; @@ -5198,8 +5200,10 @@ sub parse_rsync_input_file_on_MN foreach my $target_node (@dest_host) { - # skip the node if it's NOT in the permitted list - if ($dest_node && !grep /^$target_node$/, @dest_nodes) { + # skip the node if it's NOT in the permitted list and if + # it's not a SN doing a hierarchical mode transfer + if ($dest_node && !(grep /^$target_node$/, @dest_nodes) + && ($rsyncSN != 1) ) { next; } $$options{'destDir_srcFile'}{$target_node} ||= {}; @@ -5214,7 +5218,13 @@ sub parse_rsync_input_file_on_MN if ($rsyncSN == 1) { # syncing the SN $dest_dir = $syncdir; # the SN sync dir - $dest_dir .= dirname($srcfile); + if($srcfile =~ /\/$/){ + #the srcfile is a directory + $dest_dir .= $srcfile; + }else{ + #the srcfile is a file + $dest_dir .= dirname($srcfile); + } $dest_dir =~ s/\s*//g; #remove blanks } $$options{'destDir_srcFile'}{$target_node}{$dest_dir} ||= @@ -5655,11 +5665,30 @@ sub parse_rsync_input_file_on_SN } else { # not processing EXECUTE, EXECUTEALWAYS or APPEND # otherwise it is just the synclist - if ($line =~ /(.+) -> (.+)/) + # xCAT supports the syncfile format: + # file -> file + # file -> (noderange for permitted nodes) file + if ($line =~ /(.+) -> (.+)/ || $line =~ /(.+) -> +\((.+)\) +(.+)/) { $process_line = 1; - my $src_file = $1; - my $dest_file = $2; + my $src_file; + my $dest_file; + my $dest_node; + my @dest_nodes; + if ($line =~ /(.+) -> +\((.+)\) +(.+)/) { + $src_file = $1; + $dest_node = $2; + $dest_file = $3; + } elsif ($line =~ /(.+) -> (.+)/) { + $src_file = $1; + $dest_file = $2; + } + + # get all the permitted nodes for the line + $dest_node =~ s/\s//g; + if ($dest_node) { + @dest_nodes = noderange($dest_node); + } $dest_file =~ s/[\s;]//g; # remove blanks # see if destination is a directory @@ -5688,6 +5717,10 @@ sub parse_rsync_input_file_on_SN foreach my $target_node (@dest_host) { + # skip the node if it's NOT in the permitted list + if ($dest_node && ! grep /^$target_node$/, @dest_nodes) { + next; + } $$options{'destDir_srcFile'}{$target_node} ||= {}; # for each file on the line diff --git a/perl-xCAT/xCAT/MacMap.pm b/perl-xCAT/xCAT/MacMap.pm index 34f303aaa..2a1931397 100644 --- a/perl-xCAT/xCAT/MacMap.pm +++ b/perl-xCAT/xCAT/MacMap.pm @@ -510,7 +510,7 @@ sub refresh_table { # if we are doing switch discovery and the node is not a switch, skip # if we are NOT doing switch discovery, and the node is a switch, skip my $ntype = $typehash->{$entry->{node}}->[0]->{nodetype}; - if ( (($discover_switch) and ( $ntype ne "switch")) + if ( (($discover_switch) and ($ntype ne "switch") and ($ntype ne "pdu") ) or ( !($discover_switch) and ( $ntype eq "switch")) ){ xCAT::MsgUtils->trace(0, "d", "refresh_table: skip node=$entry->{node} switch=$entry->{switch} discover_switch=$discover_switch nodetype=$ntype\n"); next; diff --git a/perl-xCAT/xCAT/RSYNC.pm b/perl-xCAT/xCAT/RSYNC.pm index b40158d80..bd6d6efa3 100644 --- a/perl-xCAT/xCAT/RSYNC.pm +++ b/perl-xCAT/xCAT/RSYNC.pm @@ -156,7 +156,11 @@ sub remote_copy_command $dest_user_host = "$$config{'dest-user'}@" . "$$config{'dest-host'}"; } - print RSCYCCMDFILE "#!/bin/sh\n"; + if ($$config{'trace'}) { + print RSCYCCMDFILE "#!/bin/sh -x\n"; + } else { + print RSCYCCMDFILE "#!/bin/sh\n"; + } if ($localhost == 1) { # running to the MN from the MN print RSCYCCMDFILE "/bin/mkdir -p $dest_dir_list\n"; diff --git a/perl-xCAT/xCAT/Schema.pm b/perl-xCAT/xCAT/Schema.pm index df3a8758f..a22af4008 100755 --- a/perl-xCAT/xCAT/Schema.pm +++ b/perl-xCAT/xCAT/Schema.pm @@ -694,17 +694,25 @@ passed as argument rather than by table value', }, }, pdu => { - cols => [qw(node nodetype outlet machinetype modelnum serialnum comments disable)], + cols => [qw(node nodetype pdutype outlet username password snmpversion community snmpuser authtype authkey privtype privkey seclevel comments disable)], keys => [qw(node)], nodecol => "node", table_desc => 'Parameters to use when interrogating pdus', descriptions => { node => 'The hostname/address of the pdu to which the settings apply', nodetype => 'The node type should be pdu ', + pdutype => 'The type of pdu ', outlet => 'The pdu outlet count', - machinetype => 'The pdu machine type', - modelnum => 'The pdu model number', - serialnum => 'The pdu serial number', + username => 'The remote login user name', + password => 'The remote login password', + snmpversion => 'The version to use to communicate with switch. SNMPv1 is assumed by default.', + community => 'The community string to use for SNMPv1/v2', + snmpuser => 'The username to use for SNMPv3 communication, ignored for SNMPv1', + authtype => 'The authentication protocol(MD5|SHA) to use for SNMPv3.', + authkey => 'The authentication passphrase for SNMPv3 ', + privtype => 'The privacy protocol(AES|DES) to use for SNMPv3.', + privkey => 'The privacy passphrase to use for SNMPv3.', + seclevel => 'The Security Level(noAuthNoPriv|authNoPriv|authPriv) to use for SNMPv3.', comments => 'Any user-written notes.', disable => "Set to 'yes' or '1' to comment out this row.", }, @@ -950,19 +958,19 @@ passed as argument rather than by table value', table_desc => 'List of all Service Nodes and services that will be set up on the Service Node.', descriptions => { node => 'The hostname of the service node as known by the Management Node.', - nameserver => 'Do we set up DNS on this service node? Valid values: 2, 1, no or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If no or 0, it does not change the current state of the service. ', - dhcpserver => 'Do we set up DHCP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, runs makedhcp -n. If no or 0, it does not change the current state of the service. ', - tftpserver => 'Do we set up TFTP on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If yes, configures and starts atftp. If no or 0, it does not change the current state of the service. ', - nfsserver => 'Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:yes or 1, no or 0.If no or 0, it does not change the current state of the service. ', - conserver => 'Do we set up Conserver on this service node? Valid values:yes or 1, no or 0. If yes, configures and starts conserver daemon. If no or 0, it does not change the current state of the service.', - monserver => 'Is this a monitoring event collection point? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.', - ldapserver => 'Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.', - ntpserver => 'Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.', - ftpserver => 'Do we set up a ftp server on this service node? Not supported on AIX Valid values:yes or 1, no or 0. If yes, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If no or 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes', - nimserver => 'Not used. Do we set up a NIM server on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.', - ipforward => 'Do we set up ip forwarding on this service node? Valid values:yes or 1, no or 0. If no or 0, it does not change the current state of the service.', + nameserver => 'Do we set up DNS on this service node? Valid values: 2, 1, or 0. If 2, creates named.conf as dns slave, using the management node as dns master, and starts named. If 1, creates named.conf file with forwarding to the management node and starts named. If 0, it does not change the current state of the service. ', + dhcpserver => 'Do we set up DHCP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, runs makedhcp -n. If 0, it does not change the current state of the service. ', + tftpserver => 'Do we set up TFTP on this service node? Not supported on AIX. Valid values:1 or 0. If 1, configures and starts atftp. If 0, it does not change the current state of the service. ', + nfsserver => 'Do we set up file services (HTTP,FTP,or NFS) on this service node? For AIX will only setup NFS, not HTTP or FTP. Valid values:1 or 0.If 0, it does not change the current state of the service. ', + conserver => 'Do we set up Conserver on this service node? Valid values:1 or 0. If 1, configures and starts conserver daemon. If 0, it does not change the current state of the service.', + monserver => 'Is this a monitoring event collection point? Valid values: 1 or 0. If 0, it does not change the current state of the service.', + ldapserver => 'Do we set up ldap caching proxy on this service node? Not supported on AIX. Valid values:1 or 0. If 0, it does not change the current state of the service.', + ntpserver => 'Not used. Use setupntp postscript to setup a ntp server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service.', + ftpserver => 'Do we set up a ftp server on this service node? Not supported on AIX Valid values:1 or 0. If 1, configure and start vsftpd. (You must manually install vsftpd on the service nodes before this.) If 0, it does not change the current state of the service. xCAT is not using ftp for compute nodes provisioning or any other xCAT features, so this attribute can be set to 0 if the ftp service will not be used for other purposes', + nimserver => 'Not used. Do we set up a NIM server on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service.', + ipforward => 'Do we set up ip forwarding on this service node? Valid values:1 or 0. If 0, it does not change the current state of the service.', dhcpinterfaces => 'The network interfaces DHCP server should listen on for the target node. This attribute can be used for management node and service nodes. If defined, it will override the values defined in site.dhcpinterfaces. This is a comma separated list of device names. !remote! indicates a non-local network for relay DHCP. For example: !remote!,eth0,eth1', - proxydhcp => 'Do we set up proxydhcp service on this node? valid values: yes or 1, no or 0. If yes, the proxydhcp daemon will be enabled on this node.', + proxydhcp => 'Do we set up proxydhcp service on this node? valid values: 1 or 0. If 1, the proxydhcp daemon will be enabled on this node.', comments => 'Any user-written notes.', disable => "Set to 'yes' or '1' to comment out this row.", @@ -2951,24 +2959,64 @@ my @nodeattrs = ( tabentry => 'pdu.nodetype', access_tabentry => 'pdu.node=attr:node', }, + { attr_name => 'pdutype', + only_if => 'nodetype=pdu', + tabentry => 'pdu.pdutype', + access_tabentry => 'pdu.node=attr:node', + }, { attr_name => 'outlet', only_if => 'nodetype=pdu', tabentry => 'pdu.outlet', access_tabentry => 'pdu.node=attr:node', }, - { attr_name => 'machinetype', + { attr_name => 'username', only_if => 'nodetype=pdu', - tabentry => 'pdu.machinetype', + tabentry => 'pdu.username', access_tabentry => 'pdu.node=attr:node', }, - { attr_name => 'modelnum', + { attr_name => 'password', only_if => 'nodetype=pdu', - tabentry => 'pdu.modelnum', + tabentry => 'pdu.password', access_tabentry => 'pdu.node=attr:node', }, - { attr_name => 'serialnum', + { attr_name => 'snmpversion', only_if => 'nodetype=pdu', - tabentry => 'pdu.serialnum', + tabentry => 'pdu.snmpversion', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'community', + only_if => 'nodetype=pdu', + tabentry => 'pdu.community', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'snmpuser', + only_if => 'nodetype=pdu', + tabentry => 'pdu.snmpuser', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'authtype', + only_if => 'nodetype=pdu', + tabentry => 'pdu.authtype', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'authkey', + only_if => 'nodetype=pdu', + tabentry => 'pdu.authkey', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'privtype', + only_if => 'nodetype=pdu', + tabentry => 'pdu.privtype', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'privkey', + only_if => 'nodetype=pdu', + tabentry => 'pdu.privkey', + access_tabentry => 'pdu.node=attr:node', + }, + { attr_name => 'seclevel', + only_if => 'nodetype=pdu', + tabentry => 'pdu.seclevel', access_tabentry => 'pdu.node=attr:node', }, diff --git a/perl-xCAT/xCAT/Scope.pm b/perl-xCAT/xCAT/Scope.pm index 39bb3da44..215709361 100644 --- a/perl-xCAT/xCAT/Scope.pm +++ b/perl-xCAT/xCAT/Scope.pm @@ -219,6 +219,10 @@ sub get_broadcast_disjoint_scope_with_parallel { my $reqs = get_parallel_scope($req); my $handled4me = 0; # indicate myself is already handled. + if (xCAT::Utils->isMN()) { # For MN, add itself always. + push @requests, @$reqs; + $handled4me = 1; + } my %prehandledhash = ();# the servers which is already handled. foreach (@$extras) { my $xcatdest = $_; diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index 67d1bee90..551cabd05 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -83,13 +83,14 @@ my %usage = ( OpenPOWER (IPMI) specific: rvitals noderange [temp|voltage|wattage|fanspeed|power|leds|chassis|all] OpenPOWER (OpenBMC) specific: - rvitals noderange [temp|voltage|wattage|fanspeed|power|altitude|all] + rvitals noderange [temp|voltage|wattage|fanspeed|power|leds|altitude|all] MIC specific: rvitals noderange {thermal|all} pdu specific: rvitals noderange ", "reventlog" => "Usage: reventlog [all [-s]|clear| [-s]] [-V|--verbose] + reventlog [resolved={|LED}] reventlog [-h|--help|-v|--version]", "rinv" => "Usage: @@ -146,6 +147,7 @@ my %usage = ( rspconfig [userid= username= password=] OpenBMC specific: rspconfig [ipsrc|ip|netmask|gateway|hostname|vlan] + rspconfig dump [-l|--list] [-g|--generate] [-c|--clear {|all}] [-d|--download ] iDataplex specific: rspconfig [thermprofile] rspconfig [thermprofile=] @@ -353,7 +355,8 @@ my %usage = ( OpenPOWER OpenBMC specific: rflash {[-c|--check] | [-l|--list]} rflash {[-c|--check] | [-a|--activate] | [-u|--upload]} - rflash {[-a|--activate] | [-d|--delete]}", + rflash [-d] [--no-host-reboot] + rflash {[-a|--activate] | [--delete]}", "mkhwconn" => "Usage: mkhwconn [-h|--help] diff --git a/perl-xCAT/xCAT/data/switchinfo.pm b/perl-xCAT/xCAT/data/switchinfo.pm index 53ceaa6f1..b5793f01c 100644 --- a/perl-xCAT/xCAT/data/switchinfo.pm +++ b/perl-xCAT/xCAT/data/switchinfo.pm @@ -41,7 +41,10 @@ our %global_switch_type = ( MELLAN => "Mellanox", Cumulus => "onie", cumulus => "onie", - Edgecore => "onie" + Edgecore => "onie", + sLEN => "irpdu", + sIBM => "irpdu", + coral => "crpdu" ); diff --git a/xCAT-client/bin/rcons b/xCAT-client/bin/rcons index 63c9bbe63..fd10fa4d4 100755 --- a/xCAT-client/bin/rcons +++ b/xCAT-client/bin/rcons @@ -149,11 +149,27 @@ elif [ $USE_GOCONSERVER == "1" ]; then CONGO_SSL_CERT=$HOME/.xcat/client-cred.pem \ CONGO_SSL_CA_CERT=$HOME/.xcat/ca.pem \ CONGO_PORT=12430 \ - CONGO_SERVER_HOST=$CONSERVER" - + CONGO_CLIENT_TYPE=xcat \ + CONGO_SSL_INSECURE=true" if [ "$CONSERVER" == `hostname` ]; then + host=`hostname -s` + if [ $? -ne 0 ]; then + echo "Error: could not get the short hostname for $CONSERVER." + exit 1 + fi + CONGO_ENV="$CONGO_ENV \ + CONGO_SERVER_HOST=$host \ + CONGO_URL=https://$host:12429" exec env $CONGO_ENV /usr/bin/congo console $1 else + host=`ssh $CONSERVER hostname -s` + if [ $? -ne 0 ]; then + echo "Error: could not get the short hostname for $CONSERVER." + exit 1 + fi + CONGO_ENV="$CONGO_ENV \ + CONGO_SERVER_HOST=$host \ + CONGO_URL=https://$host:12429" exec ssh -t $CONSERVER "$CONGO_ENV /usr/bin/congo console $1" fi diff --git a/xCAT-client/pods/man1/bmcdiscover.1.pod b/xCAT-client/pods/man1/bmcdiscover.1.pod index fc9ddfe5a..20ffd84b4 100644 --- a/xCAT-client/pods/man1/bmcdiscover.1.pod +++ b/xCAT-client/pods/man1/bmcdiscover.1.pod @@ -10,10 +10,6 @@ B [B<-v>|B<--version>] B [B<--sn> I] [B<-s> I] [B<-u> I] [B<-p> I] [B<-z>] [B<-w>] B<--range> I -B B<-u> I B<-p> I B<-i> I B<--check> - -B [B<-u> I] [B<-p> I] B<-i> I B<--ipsource> - =head1 DESCRIPTION @@ -61,14 +57,6 @@ BMC user name. BMC user password. -=item B<--check> - -Check BMC administrator User/Password. - -=item B<--ipsource> - -Display the BMC IP configuration. - =item B<-h|--help> Display usage message @@ -117,14 +105,6 @@ Output is similar to: bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z -5. To check if the username or password is correct against the BMC: - - bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --check - -6. Get BMC IP Address source, DHCP Address or static Address - - bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource - =head1 SEE ALSO L diff --git a/xCAT-client/pods/man1/reventlog.1.pod b/xCAT-client/pods/man1/reventlog.1.pod index b18de103d..2877a7b32 100644 --- a/xCAT-client/pods/man1/reventlog.1.pod +++ b/xCAT-client/pods/man1/reventlog.1.pod @@ -4,10 +4,15 @@ B - retrieve or clear remote hardware event logs =head1 B -B I {I [B<-s>]|B|B} +B I [I [B<-s>]|B|B] B [B<-h>|B<--help>|B<-v>|B<--version>] +=head2 OpenPOWER OpenBMC specific : + +B I [B{I|B}] + + =head1 B B can display any number of remote hardware event log entries @@ -34,6 +39,10 @@ To sort the entries from latest (always the last entry in event DB) to oldest (a Clear event logs. +=item B{I|B} + +Mark event log entries as resolved. Use comma separated list of entry ids to specify individual entries. Use B to mark as resolved all event log entries that contribute to LED fault. + =item B<-h>|B<--help> Print help. @@ -50,6 +59,7 @@ Print version. =over 2 =item 1. +List last 5 event log entries from node4 and node5 reventlog node4,node5 5 @@ -67,6 +77,7 @@ Output is similar to: node5: SERVPROC I 09/06/00 15:21:29 System spn1 started a RS485 connection with us[00] =item 2. +Clear all event log entries from node4 and node5 reventlog node4,node5 clear @@ -75,6 +86,18 @@ Output is similar to: node4: clear node5: clear +=item 3. +Mark as resolved all event log entries from node4 that contribute to LED fault + + reventlog node4 resolved=LED + +Output is similar to: + + Attempting to resolve the following log entries: LED... + node4: Resolved 51. + node4: Resolved 52. + node4: Resolved 58. + =back =head1 SEE ALSO diff --git a/xCAT-client/pods/man1/rflash.1.pod b/xCAT-client/pods/man1/rflash.1.pod index 62db1eecd..f6985b970 100644 --- a/xCAT-client/pods/man1/rflash.1.pod +++ b/xCAT-client/pods/man1/rflash.1.pod @@ -34,7 +34,9 @@ B I {[B<-c>|B<--check>] | [B<-l>|B<--list>]} B I I {[B<-c>|B<--check>] | [B<-a>|B<--activate>] | [B<-u>|B<--upload>]} -B I I {[B<-a>|B<--activate>] | [B<-d>|B<--delete>]} +B I I [B<-d>] [B<--no-host-reboot>] + +B I I {[B<-a>|B<--activate>] | [B<--delete>]} =head1 B @@ -101,24 +103,34 @@ The command will update firmware for OpenPOWER BMC when given an OpenPOWER node B<-l|--list>: - The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels. +The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels. - The (*) symbol indicates the active running firmware on the server. +The (*) symbol indicates the active running firmware on the server. - The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level. +The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level. B<-u|--upload>: - The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result. +The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result. B<-a|--activate>: - The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step +The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step To apply the firmware level, a reboot is required to BMC and HOST. B When using B in hierarchical environment, the .tar file must be accessible from Service Nodes. +B<-d>: + +This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR 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. + +B When using B<--no-host-reboot>, it will not reboot the host after BMC is reboot. + +B<--delete>: + +This delete option will delete update image from BMC. It expects an ID as the input. + =head1 B =over 7 @@ -179,7 +191,7 @@ List currently uploaded update images. "(*)" indicates currently active image. Upload update image. Specified file must be in .tar format. -=item B<-d|--delete> +=item B<--delete> Delete update image from BMC @@ -233,14 +245,14 @@ Print verbose message to rflash log file (/var/log/xcat/rflash/fs3.log) when upd rflash fs3 /firmware/8335_810.1543.20151021b_update.hpm -V =item 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 and BMC and/or PNOR update files: +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 PNOR update files: rflash briggs01 -d /root/supermicro/OP825 =item 7. To update the firmware on the OpenBMC machine, specify the firmare update file to upload and activate: - rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar + rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar =back diff --git a/xCAT-client/pods/man1/rmdef.1.pod b/xCAT-client/pods/man1/rmdef.1.pod index 95b4358b1..38b67b077 100644 --- a/xCAT-client/pods/man1/rmdef.1.pod +++ b/xCAT-client/pods/man1/rmdef.1.pod @@ -58,7 +58,7 @@ A set of comma delimited object types. =item B<-C|--cleanup> -Perform additional cleanup by running B on the objects specified in the I. +Perform additional cleanup by running B and B on the objects specified in the I. =item B<-V|--verbose> diff --git a/xCAT-client/pods/man1/rspconfig.1.pod b/xCAT-client/pods/man1/rspconfig.1.pod index a61149197..fbd1fa6f0 100644 --- a/xCAT-client/pods/man1/rspconfig.1.pod +++ b/xCAT-client/pods/man1/rspconfig.1.pod @@ -26,6 +26,8 @@ B I B=I