﻿1 SetAttributes

   setattributes enables you to change the attributes of an HP SUM node or
   session. The setattributes command might return an invalid parameter
   notice if the permissions are not correct, or if either the parameter is
   not part of the requested set or if the value is not allowed.

   Use this example to assign session attributes in the interactive CLI:

   hpsum setattributes --session <attribute>=<value> (Linux)

   hpsum setattributes /session <attribute>=<value> (Windows)

      ---------------------------------------------------------------------   
    NOTE: To view a list of attributes you can change, use the command        
    getattributes. The available attributes change based on the nodes and     
    baselines added in each session. For example:                             
                                                                              
    hpsum /getattributes /session (Windows) or hpsum --nodes                  
      ---------------------------------------------------------------------   

   +------------------------------------------------------------------------+
   | Session attributes           | Possible value                          |
   |------------------------------+-----------------------------------------|
   | auto_save_session            | [true|false]                            |
   |------------------------------+-----------------------------------------|
   | auto_save_session_time       | <integer>-The time in minutes. The      |
   |                              | default is 15 minutes.                  |
   |------------------------------+-----------------------------------------|
   | engine_mode                  | [debug|release]                         |
   |------------------------------+-----------------------------------------|
   | software                     | [true|false]-This defines the option    |
   |                              | for all nodes added in this session.    |
   |------------------------------+-----------------------------------------|
   | firmware                     | [true|false]-This defines the option    |
   |                              | for all nodes added in this session.    |
   |------------------------------+-----------------------------------------|
   | rewrite                      | [true|false]-This defines the option    |
   |                              | for all nodes added in this session.    |
   |------------------------------+-----------------------------------------|
   | downgrade                    | [true|false]-This defines the option    |
   |                              | for all nodes added in this session.    |
   |------------------------------+-----------------------------------------|
   | language                     | [en|ja|cn]                              |
   |------------------------------+-----------------------------------------|
   |                              | [normal|verbose|veryverbose]            |
   |                              |                                         |
   |                              |   o normal-The default amount of        |
   |                              |     information provided by HP SUM      |
   |                              |     about a deployment.                 |
   |                              |                                         |
   | verbosity                    |   o verbose-Provides more details about |
   |                              |     a deployment, if information is     |
   |                              |     available.                          |
   |                              |                                         |
   |                              |   o veryverbose-Provides more details   |
   |                              |     about a deployment, if information  |
   |                              |     is available.                       |
   |------------------------------+-----------------------------------------|
   |                              | [true|false]                            |
   |                              |                                         |
   | verbose                      | hpsum setattributes /nodes verbose=true |
   |                              |                                         |
   |                              | Determines the amount of details HP SUM |
   |                              | provides during deployment.             |
   |------------------------------+-----------------------------------------|
   |                              | [directory_path] - Directory path where |
   | report_dir                   | you want HP SUM to save reports. For    |
   |                              | example: C:\hpsum_reports\.             |
   |------------------------------+-----------------------------------------|
   |                              | [true|false]                            |
   |                              |                                         |
   | use_proxy_script             | The proxy settings are primarily used   |
   |                              | for downloading an HTTP or FTP          |
   |                              | baseline.                               |
   |------------------------------+-----------------------------------------|
   | proxy_url                    | <string> - Proxy server URL.            |
   |------------------------------+-----------------------------------------|
   | proxy_ftp_port               | <string> - Proxy server FTP port.       |
   |------------------------------+-----------------------------------------|
   | proxy_script                 | <string> - Full path for the proxy      |
   |                              | script.                                 |
   |------------------------------+-----------------------------------------|
   | proxy_username               | <string> - Username for the proxy       |
   |                              | server.                                 |
   |------------------------------+-----------------------------------------|
   | proxy_password               | <string> - User's password for the      |
   |                              | proxy server.                           |
   |------------------------------+-----------------------------------------|
   |                              | [yes|no]                                |
   | open_firewall                |                                         |
   |                              | Opens the required firewall ports to    |
   |                              | communicate with remote nodes.          |
   |------------------------------+-----------------------------------------|
   |                              | Use a valid HP Passport Credentials API |
   | hp-passport-token=[token id] | Token Authentication key to access      |
   |                              | baseline bundles available on hp.com.   |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   | Node-specific attributes | Potential attributes                        |
   |--------------------------+---------------------------------------------|
   |                          | [true|false]                                |
   |                          |                                             |
   |                          | If you set this attribute as true, enter    |
   |                          | the following settings:                     |
   |                          |                                             |
   |                          |   o vcenter_host-IP address for the VMware  |
   |                          |     vCenter node.                           |
   |                          |                                             |
   | VMware nodes             |   o vcenter_username                        |
   |                          |                                             |
   | Use_vCenter              |     -Username for the VMware vCenter node.  |
   |                          |                                             |
   |                          |   o vcenter_password                        |
   |                          |                                             |
   |                          |     -Password for the user connecting to    |
   |                          |     the VMware vCenter node.                |
   |                          |                                             |
   |                          | These parameters can also be set as session |
   |                          | attributes.                                 |
   |--------------------------+---------------------------------------------|
   |                          | Option:                                     |
   |                          |                                             |
   |                          | Sting of a minimum of 8 characters.         |
   |                          |                                             |
   | encryption_key           |   o true                                    |
   |                          |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | Use this command to enable VC in FIPS mode. |
   |--------------------------+---------------------------------------------|
   |                          | Possible value:                             |
   |                          |                                             |
   |                          | ODDEVEN/PARALLEL/SERIAL/MANUAL, the default |
   | ethactorder              | value is ODDEVEN.                           |
   |                          |                                             |
   |                          | Use this command to determine VC-Enet       |
   |                          | module activation order.                    |
   |--------------------------+---------------------------------------------|
   |                          | Possible value:                             |
   |                          |                                             |
   |                          | ODDEVEN/PARALLEL/SERIAL/MANUAL, the default |
   | fcactorder               | value is ODDEVEN.                           |
   |                          |                                             |
   |                          | Use this command to determine VC-FC         |
   |                          | activation order.                           |
   |--------------------------+---------------------------------------------|
   |                          | Valid entries:                              |
   |                          |                                             |
   |                          | 0-60 minutes. The default is 0 minutes.     |
   | ethactdelay              |                                             |
   |                          | Use this command to determine the time, in  |
   |                          | minutes, between activating or rebooting    |
   |                          | VC-Enet modules.                            |
   |--------------------------+---------------------------------------------|
   |                          | Valid entries:                              |
   |                          |                                             |
   |                          | 0-60 minutes. The default is 0 minutes.     |
   | fcactdelay               |                                             |
   |                          | Use this command to determine the time, in  |
   |                          | minutes, between activating or rebooting    |
   |                          | VC-FC modules.                              |
   |--------------------------+---------------------------------------------|
   |                          | Potential options:                          |
   |                          |                                             |
   |                          |   o true                                    |
   |                          |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | Other attributes:                           |
   | Linux nodes              |                                             |
   |                          |   o privatekeyfile -Enter the address for   |
   | use_sshkey               |     the private key. The private key must   |
   |                          |     be in PEM format.                       |
   |                          |                                             |
   |                          |   o passphrase - (Optional) Enter the       |
   |                          |     passphrase for the private key.         |
   |                          |                                             |
   |                          | These parameters can also be set as session |
   |                          | attributes.                                 |
   |--------------------------+---------------------------------------------|
   |                          | Potential options:                          |
   |                          |                                             |
   |                          |   o true                                    |
   | no_mgmt                  |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | No AMS, SNMP, or WBEM Providers are         |
   |                          | selected for deployment.                    |
   |--------------------------+---------------------------------------------|
   |                          | (Linux only)                                |
   |                          |                                             |
   |                          | Potential options:                          |
   |                          |                                             |
   | use_snmp                 |   o true                                    |
   |                          |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | HP SUM deploys SNMP components.             |
   |--------------------------+---------------------------------------------|
   |                          | (Windows only)                              |
   |                          |                                             |
   |                          | Potential options:                          |
   |                          |                                             |
   | use_wmi                  |   o true                                    |
   |                          |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | HP SUM deploys WBEM Provider components.    |
   |--------------------------+---------------------------------------------|
   |                          | (Gen8 and later)                            |
   |                          |                                             |
   |                          | Potential options:                          |
   |                          |                                             |
   | use_ams                  |   o true                                    |
   |                          |                                             |
   |                          |   o false                                   |
   |                          |                                             |
   |                          | HP SUM deploys AMS components to both       |
   |                          | Windows and Linux systems.                  |
   |--------------------------+---------------------------------------------|
   |                          | Potential options:                          |
   |                          |                                             |
   |                          | [true|false]                                |
   |                          |                                             |
   | ignore_tpm               | This parameter tells HP SUM to ignore the   |
   |                          | TPM warning message when a TPM or TM module |
   |                          | is installed on a server.                   |
   |                          |                                             |
   |                          | This parameter is supported on server and   |
   |                          | iLO nodes.                                  |
   |--------------------------+---------------------------------------------|
   |                          | [omithost|omitcomponent|force]              |
   |                          |                                             |
   |                          |   o omithost-HP SUM skips the host if it    |
   |                          |     discovers a dependency failure.         |
   |                          |     (Default)                               |
   |                          |                                             |
   | on_failed_dependency     |   o omitcomponent-HP SUM only skips         |
   |                          |     components if it discovers dependency   |
   |                          |     failures. Other components on the node  |
   |                          |     are deployed.                           |
   |                          |                                             |
   |                          |   o force-HP SUM forces the components with |
   |                          |     a failed dependency to deploy.          |
   |--------------------------+---------------------------------------------|
   |                          | Potential options:                          |
   |                          |                                             |
   | ignore_warnings          | [true|false]                                |
   |                          |                                             |
   |                          | This parameter tells HP SUM to ignore       |
   |                          | warnings it encounters.                     |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   | Superdome 2/X-specific |                                               |
   | attributes             | Potential attributes                          |
   |------------------------+-----------------------------------------------|
   | update_type            | [ALL/COMPLEX/PARTITIONS]-This value tells HP  |
   |                        | SUM what to Superdome 2/X nodes to update.    |
   |------------------------+-----------------------------------------------|
   | device_list            | [devicelist]-This value tells HP SUM which    |
   |                        | Superdome 2/X nodes you want to update.       |
   |------------------------+-----------------------------------------------|
   |                        | [rebootlist]-This value tells HP SUM which    |
   | reboot_list            | Superdome 2/X nodes to reboot after           |
   |                        | deployment.                                   |
   +------------------------------------------------------------------------+

   You can set the following Moonshot-specific attributes for switch B if
   those credentials differ from switch A. These parameters can also be set
   as session attributes.

   +------------------------------------------------------------------------+
   | Moonshot-specific |                                                    |
   | attributes        | Potential attributes                               |
   |-------------------+----------------------------------------------------|
   | switch_username   | [username]-User name for the Moonshot A switch.    |
   |-------------------+----------------------------------------------------|
   | switch_password   | [password]-Password for the Moonshot A switch.     |
   |-------------------+----------------------------------------------------|
   | switch_enable     | [enable_password]-Enablement password for the      |
   |                   | Moonshot A switch.                                 |
   |-------------------+----------------------------------------------------|
   | switchb_username  | [username]-User name for the Moonshot B switch.    |
   |-------------------+----------------------------------------------------|
   | switchb_password  | [password]-Password for the Moonshot B switch.     |
   |-------------------+----------------------------------------------------|
   | switchb_enable    | [enable_password]-Enablement password for the      |
   |                   | Moonshot B switch.                                 |
   +------------------------------------------------------------------------+

   The following table shows the combinations for downgrade and rewrite
   attributes:

   +------------------------------------------------------------------------+
   | GUI selection deploys | interactive CLI mode command example           |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Software only         | rewrite=false downgrade=false firmware=false   |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Firmware only         | rewrite=false downgrade=false firmware=true    |
   |                       | software=false                                 |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Firmware and software | rewrite=false downgrade=false firmware=true    |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Downgrade software    | rewrite=false downgrade=true firmware=false    |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Downgrade firmware    | rewrite=false downgrade=true firmware=true     |
   |                       | software=false                                 |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Downgrade both        | rewrite=false downgrade=true firmware=true     |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Rewrite software      | rewrite=true downgrade=false firmware=false    |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Rewrite firmware      | rewrite=true downgrade=false firmware=true     |
   |                       | software=false                                 |
   |-----------------------+------------------------------------------------|
   |                       | hpsum setattributes /nodes localhost           |
   | Rewrite both          | rewrite=true downgrade=false firmware=true     |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   | Rewrite and downgrade | hpsum setattributes /nodes localhost           |
   | software              | rewrite=true downgrade=true firmware=false     |
   |                       | software=true                                  |
   |-----------------------+------------------------------------------------|
   | Rewrite and downgrade | hpsum setattributes /nodes localhost           |
   | firmware              | rewrite=true downgrade=true firmware=true      |
   |                       | software=false                                 |
   |-----------------------+------------------------------------------------|
   | Rewrite and downgrade | hpsum setattributes /nodes localhost           |
   | both                  | rewrite=true downgrade=true firmware=true      |
   |                       | software=true                                  |
   +------------------------------------------------------------------------+

  1.1 Syntax

   hpsum setattributes --nodes [<nodelist>] attribute1=value1
   attribute2=value2

   hpsum setattributes --session attribute1=value1

  1.2 Parameters

   The setattributes command provides the following options:

   +------------------------------------------------------------------------+
   | Parameter                 | Description                                |
   |---------------------------+--------------------------------------------|
   | hpsum                     | The HP SUM script initiates this action.   |
   |---------------------------+--------------------------------------------|
   | setattributes             | The command to set attributes pending HP   |
   |                           | SUM operations.                            |
   |---------------------------+--------------------------------------------|
   | --nodes [<nodelist>]      | Specify the nodes and attributes that you  |
   | attribute=value           | want to apply to nodes.                    |
   |---------------------------+--------------------------------------------|
   | --session attribute=value | Specify the session attribute you want to  |
   |                           | apply. Session attributes are global.      |
   +------------------------------------------------------------------------+

  1.3 Return codes

   +------------------------------------------------------------------------+
   | Return Code            | Windows | Linux | Text                        |
   |------------------------+---------+-------+-----------------------------|
   | SUCCESS_NO_REBOOT      | 0       | 0     | The command was successful. |
   |------------------------+---------+-------+-----------------------------|
   | FAILURE_GENERAL        | -1      | 255   | A general failure occurred. |
   |                        |         |       | For details, see the logs.  |
   |------------------------+---------+-------+-----------------------------|
   |                        |         |       | A bad input parameter was   |
   | FAILURE_BAD_PARM       | -2      | 254   | encountered. For details,   |
   |                        |         |       | see the logs.               |
   |------------------------+---------+-------+-----------------------------|
   | FAILURE_COMMAND_FAILED | -4      | 252   | The command failed. For     |
   |                        |         |       | details, see the logs.      |
   +------------------------------------------------------------------------+

  1.4 Example

    Windows sample command line

   C:\> hpsum setattributes /nodes 10.0.1.5 forcefirmware=true
   forcesoftware=true rewrite=true downgrade=true

   C:\> hpsum setattributes /nodes 10.0.1.5 update_type=all

   C:\> hpsum setattributes /session open_firewall=yes

   C:\> hpsum setattributes /nodes 10.0.0.4 use_vcenter=true
   vcenter_host=10.0.0.1 vcenter_username=test vcenter_password=password

    Linux sample command line

   $ ./hpsum setattributes --nodes 10.0.1.5 forcefirmware=true
   forcesoftware=true rewrite=true downgrade=true

   $ ./hpsum setattributes --nodes 10.0.1.5 update_type=all

   $ ./hpsum setattributes -session open_firewall=yes

   $ ./hpsum setattributes --nodes 10.0.0.5 use_vcenter=true
   vcenter_host=10.0.0.1 vcenter_username=test vcenter_password=password
