Smart Update Manager CLI Help Abstract Part Number: Published: 2019-November Edition: © Copyright 2017 - 2019 Hewlett Packard Enterprise Development LP Notices The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard Enterprise has no control over and is not responsible for information outside the Hewlett Packard Enterprise website. Acknowledgments Intel^®, Itanium^®, Pentium^®, Intel Inside^®, and the Intel Inside logo are trademarks of Intel Corporation in the United States and other countries. Microsoft^® and Windows^® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Adobe^® and Acrobat^® are trademarks of Adobe Systems Incorporated. Java^® and Oracle^® are registered trademarks of Oracle and/or its affiliates. UNIX^® is a registered trademark of The Open Group. About SUM and interactive CLI command-line options The SUM CLI, interactive CLI, and Input file modes allow you to deploy updates from a baseline to the local and remote nodes. In CLI mode, add all parameters in one command line to execute the entire sequence on multiple nodes without any user interaction. This method requires the silent command. You can update one or more nodes using this method. You can script most of the commands that are available in the SUM GUI in interactive CLI mode. Functionality available from interactive CLI mode includes: * Adding nodes and baselines * Deploying nodes * Collecting log files * Generating reports Use Input file mode to add all parameters to a text file, and then call SUM using the inputfile command with the text file name as the parameter. This method requires the silent command. Using the Input file method allows you to provide a larger number of nodes to update. The SUM CLI and Input file modes are process-oriented tools. SUM finishes the command, and then it does not save the settings or results. If you want to perform a few steps and save the work for later, use the GUI or interactive CLI mode. SUM CLI modes Choose the SUM CLI mode that fits your server environment best. CLI Number of nodes: 1–3 Strengths: * Use one command to issue all instructions to the nodes. Input file CLI Number of nodes: 1–50 NOTE: You can use only 10 VMware nodes. Strengths: * Create a file that includes all information for baselines and nodes. * Save files for future use. * Issue CLI command that calls the Input file. Interactive CLI Number of nodes: 1–50 Scheduling updates Use standard operating system tools to schedule SUM to run an Input file or CLI command. For example, use Task Scheduler for Windows or cron for Linux systems. Be sure to include the s (silent) parameter in the command. See the operating system documentation for more information about scheduling tasks. Linux root credentials for remote nodes You can provide root credentials, a user with sudo permissions, or provide nonroot with root credentials for remote nodes. To use super user functionality, configure the user as a super user with all root privileges. You can also use nonroot user with a root user to update components. Prerequisites for using Linux sudo credentials * Provide one of the following: * Username and password * Username and SSH key file path (in PEM format) * Give the sudo users write access to the /var/tmp directory. * For sudo users, add the user to the /etc/sudoers file. The following shows the privileges and specifications for users. * User: <Sudo_user> (the actual name of the user account) * Privilege: ALL * Specification: ALL * Edit the entry in the /etc/sudoers file so the system asks for the sudo user password instead of root user password when you run the sudo command. * The following shows the privileges to comment or remove from /etc/sudoers. * User: ALL * Privilege: ALL * Specification: ALL NOTE: Only use this option with Defaults targetpw on all systems. * When using SSH keys for login credentials combined with sudo, edit the entry in the /etc/sudoers file so that the system does not ask for the user password as follows: * User: sudo_user * Privilege: ALL * Specification: NOPASSWD:ALL Using an SSH keyfile with root credentials SUM allows you to log in with a password or by providing an SSH key. Procedure 1. On the node that is running SUM, type ssh-keygen -t rsa. SUM also supports DSA encryption key format. To create a DSA encryption key, type ssh-keygen -t dsa. A passphrase is optional. 2. Save the key in the directory .ssh/id_rsa.pub. Root users, use the directory /root/.ssh. 3. Verify that the private key is in PEM format by opening the key and viewing the top of the key for the following text: ---- BEGIN RSA PRIVATE KEY ---- 4. If necessary, on the node you want to update, create an .ssh directory at the root level. Set the permissions level on the directory to 700. 5. Determine if the node you want to update has the filename .ssh/authorized_keys. If this file is not present, create or append this file. Set the permissions on the authorized_keys file to 640. NOTE: If you append the file, more users are authorized to use the private key. 6. Copy the contents of .ssh/id_rsa.pub on the host node, and then paste them into the filename .ssh/authorized_keys on the remote node. 7. Open an SSH path between the host node and the node you want to update. a. Type ssh root@10.0.0.1. This parameter opens a shell path. b. Type ssh root@10.0.0.1 uname. This parameter executes the command and returns. 8. SUM requires access to id_rsa (private key file), and the optional passphrase. NOTE: If other applications require the public key in PEM format, you can convert it by typing ssh-keygen -e -f id_rsa.pub > id_rsa_pub.pem. Open the key, and look at the PEM format for ---- BEGIN SSH2 PUBLIC KEY ----. To create a private key on a Windows system, you can use an application like PuTTY or PuTTY Key Generator (PuTTYGen). For more information, see https://www.digitalocean.com/community/tutorials/how-to-create-ssh-keys-with-putty-to-connect-to-a-vps. To export the file to PEM format, select Conversion > Export OpenSSH key. Command-line syntax In SUM CLI mode, you must enter all parameters in one command line. When you press the Enter key, SUM executes the entire sequence. All CLI commands require the /s (Windows) or --s (Linux) to run. IMPORTANT: Command-line mode does not support double-byte character sets. Any commands entered in the command line using a double-byte character set do not display correctly. The general command-line syntax for SUM is as follows: * On Windows, use a slash before each argument. smartupdate /s /use_location <baseline_directory> * On Linux, use two hyphens before each argument. smartupdate --s --use_location <baseline_directory> NOTE: If you update Onboard Administrator (Enclosure firmware) after the /target and OA IP address, you must provide the username and credentials of the OA administrator. The user ID must be an administrator equivalent ID and not an operator or user equivalent level ID. Command-line description smartupdate Launches SUM. --s (Linux) /s (Windows) Initiates the CLI mode. For more installation parameters, see Installation parameters. --target (Linux) /target (Windows) Provides details about the target node. For more node parameters, see Node parameters. --on_failed_dependency (Linux) /on_failed_dependency (Windows) This parameters tells SUM how to handle dependency issues. For more override error parameters, see Override error parameters. --r (Linux) /r (Windows) Tells SUM whether to reboot a node after deploying updates. For more reboot parameters, see Reboot parameters. --v (Linux) /v (Windows) Tells SUM to use verbose log settings. For more log parameters, see Log file parameters. --report (Linux) /report (Windows) Generates SUM reports. For more report parameters, see Report parameters. --h (Linux) /h (Windows) Launches the SUM CLI help file. Input file overview The Input files contain configuration details and target node information. You can include user credentials and remote host information for updates. IMPORTANT: Input files are plain-text files, for greater security, omit the credentials from the file and pass them to SUM using the command line. If you provide user credentials on the command line, all nodes in the Input file must use the same user ID and password. SUM CLI with Input files allows you to create .txt file scripts for updating nodes. Use a plain-text editor to create the Input file. It is similar to markup languages that require headers and trailers to match. Use commas as list separators for parameters that can take list values. After creating your script file, add it as the inputfile <filename> parameter to a SUM command line. For example, to run the Input file update.in, type: * Linux: smartupdate --inputfile update.in * Windows: smartupdate /inputfile update.in You can add full paths to the Input file location when the file is not stored in the same location as the SUM executable files. Enclose the <filename> field in double quotes to enable paths with spaces. NOTE: There is no Input file parameter to open a firewall port. If you want to open the firewall, add the parameter --open_firewall (Linux) or /open_firewall (Windows) to the command that calls the input file. For example: * Linux: smartupdate --inputfile update.in --open_firewall --s * Windows: smartupdate /inputfile update.in /open_firewall /s To modify an Input file without editing the file, use all the command-line options along with the Input file. The command-line options take precedence over the commands in the Input file. Input file sections An Input file contains Configuration and Targets information sections. An Input file only supports one parameter per line of text. #Input file sample SILENT = YES IGNOREERRORS = ServerNotFound,BadPassword, FailedDependencies SKIPTARGET = NO SOURCEPATH = C:\SPP FORCEALL = YES REBOOTALLOWED = YES REBOOTDELAY = 30 REBOOTMESSAGE = “Install complete, server will reboot in 30 seconds” [TARGETS] HOST = 192.168.1.1 UID = user PWD = password [END] [TARGETS] HOST = 192.168.1.2 HOST = 192.168.1.2 UID = user2 PWD = password2 [END] Configuration section This section assigns all parameters for an Input file. The configuration section ends at the beginning of the TARGETS section. Lines that begin with a pound (#) character are notes. No more than 1 pound character is allowed on a line. #Input file sample SILENT = YES IGNOREERRORS = ServerNotFound,BadPassword, FailedDependencies SKIPTARGET = NO SOURCEPATH = C:\SPP FORCEALL = YES REBOOTALLOWED = YES REBOOTDELAY = 30 REBOOTMESSAGE = “Install complete, server will reboot in 30 seconds” Targets section This section defines each node that you are updating. [TARGETS] HOST = 192.168.1.1 UID = user PWD = password [END] Targets section [TARGETS_GROUP_HOME] HOST = 192.168.1.2 HOST = 192.168.1.2 UID = user2 PWD = password2 [END] If more than one node uses the same user credentials, list them all in the same TARGETS section. You can add text to a [TARGETS] title to provide more target details. Management agent installation parameters To find out if you have any management agents installed, use SUM to create the Firmware Details Report. For example: $ ./smartupdate --firmware_report --s (Linux) C:\ smartupdate /firmware_report /s (Windows) NOTE: If the node already has management agents installed on it, SUM upgrades the agents if a newer version is available. For example, if the node has SNMP installed on it, and you use the use_ams parameter, AMS is installed and SNMP is upgraded. The following describes what SUM deploys when you issue the given commands: If you provide no management agent parameters. Gen8 and later servers installed agent: AMS --no_mgmt (Linux) /no_mgmt (Windows) This parameter prevents any installation or upgrade of SNMP, AMS, and WBEM agents. It has no impact on any management agents installed on the system. Gen8 and Gen9 servers installed agent: None --use_ams (Linux) /use_ams (Windows) Gen8 and later servers installed agent: AMS --use_snmp (Linux) /use_snmp (Windows) NOTE: Gen10 servers do not support SNMP agents. /use_wmi (Windows only) Gen8 and later servers installed agent: WBEM NOTE: Gen10 servers do not support WBEM agents. --use_ams --use_snmp (Linux)/use_ams /use_snmp (Windows) Gen8 and Gen9 servers installed agents: AMS and SNMP /use_ams /use_wmi (Windows) Gen8 and Gen9 servers installed agents: AMS and WBEM /use_wmi /use_snmp (Windows) Gen8 and Gen9 servers installed agents: WBEM and SNMP /use_ams /use_wmi /use_snmp (Windows) Gen8 and Gen9 servers installed agents: AMS, SNMP, and WBEM Gen9 only: SUM installs SMH templates when it installs SMNP agents. SUM CLI parameters SUM recognizes the following command-line arguments. You cannot use some arguments, such as --romonly and --softwareonly, together. Help View the help for the CLI by typing smartupdate --s --h. Syntax --h[elp] or --? (Linux) /h[elp] or /? (Windows) Description Displays command-line help information. Installation parameters The following section lists attributes you can use while installing updates. Force Syntax --f[orce] (Linux) /f[orce] (Windows) Description Rewrites or downgrades an existing software installation. This parameter produces the same results as f:software. Options f[orce]:bundle Rewrites or downgrades the existing installation of components in the selected bundle. f[orce]:rom Rewrites or downgrades the existing installation of the applicable firmware components (applies to firmware only). f[orce]:software Rewrites or downgrades the existing installation of the selected software components. f[orce]:all Rewrites or downgrades the existing installation of applicable software and firmware components. Downgrade Syntax --g or --downgrade (Linux) /g or /downgrade (Windows) Description Selects components for installation that have an available version lower than the currently installed version. Upgrades also occur when you issue this command. Can be combined with rewrite. Rewrite Syntax --e or --rewrite (Linux) /e or /rewrite (Windows) Description Selects components for installation that have an available version lower than the same as the installed version. Upgrades also occur when you issue this command. Can be combined with downgrade. ROM deployment only Syntax --romonly (Linux) /romonly (Windows) Description Limits components considered for installation to only firmware components. Cannot be used with softwareonly. If softwareonly or romonly are not used, all components are considered for possible installation. Software deployment only Syntax --softwareonly (Linux) /softwareonly (Windows) Description Limits components considered for installation to only software components. Cannot be used with romonly. If softwareonly or romonly are not used, all components are considered for installation. Network port used Syntax --port <n> (Linux) /port <n> (Windows) Description Changes the port SUM uses for the internal HTTP server from 63001 to the selected port. SSL port Syntax --ssl_port <n> (Linux) /ssl_port <n> (Windows) Description Changes the port SUM uses for the internal HTTPS server from 63002 to the selected port. Open firewall Syntax --open_firewall (Linux) /open_firewall (Windows) Description Allows SUM to open the HTTP and HTTPS ports used by SUM for external access. Also used to open the ports for remote node functionality and for remote browser access. SUM deploys updates to nodes even when ip_tables include DROP commands. Use open_firewall to bypass the DROP rules. Include this parameter with the command that calls an Input file. SUM Input files do not support a parameter to open a firewall. Silent deployment Syntax --s[ilent] (Linux) /s[ilent] (Windows) Description Causes the installation to run silently with no GUI or interactive CLI output. All data writes to the log file. Do not use the express_install parameter with the silent parameter. Usage SUM requires the silent parameter for CLI commands. Stage components Syntax --stage_only (Linux) /stage_only (Windows) Description Enables you to upload all applicable components to an iLO Repository by creating a new install set. After staging, you can choose to deploy the node, which will invoke the new install set and complete deployment. Example smartupdate --silent <other_params> --save_install_set --install_set_name Test1 --stage_only (Linux) /smartupdate /silent <other_params> /save_install_set /install_set_name Test1 /stage_only (Windows) Specify components to deploy Syntax --c[omponent]<component_to_install> or <component1_to_install> <component2_to_install> (Linux) /c[omponent]<component_to_install> or <component1_to_install> <component2_to_install> (Windows) Description Specifies which components to install. If you use the c[omponent] parameter, specify only one component per parameter. You can include multiple c parameters with individual components in the same command line. * If you do not use the --c[omponent] argument, specify multiple components separated by a blank space, and listed after all other arguments on the command line. * By default SUM deploys components in the order listed in the command. SUM changes deployment order based on dependency issues. * Specify multiple components (see --c[omponent]<component_to_install>) and bundles on the same command line. When you mix components and bundles on the command line, the filter switches control what components and bundles are installed. * SUM only uses the component name. If you enter the entire directory path, SUM ignores the path. If you use --use_location and c, SUM checks both the default repository and the directory provided. If you specify more than five components, either issue multiple commands or use an Input file. Example smartupdate --silent <other_params> --save_install_set --install_set_name Test1 --c[omponent]<component1_to_install> (Linux) /smartupdate /silent <other_params> /save_install_set /install_set_name Test1 /c[omponent]<component1_to_install> (Windows) Define bundles to install Syntax --b[undle] <bundlename> (Linux) /b[undle] <bundlename> (Windows) Description This argument specifies bundles to install. Specify multiple components and bundles (see b[undle] <bundlename>) on the same command line. When you mix components and bundles on the command line, the filter switches control which components and bundles are installed. Define baseline location Syntax --use_location "[filepath]" (Linux) /use_location "filepath"\"file_share" (Windows) Description Specifies a directory or file share that contains the SPP and components for use with SUM. SUM expects that the targeted file_share is a mapped file share or UNC format. Without this argument, SUM defaults to the directory that contains SUM. Make sure that the logged-in account has access to this location. If the location is a UNC file share, you must provide credentials to the file share using the unc_username and unc_password. If you do not provide these credentials, SUM uses the current credentials to access the share. SUM does not support http baselines in CLI mode. Import component configuration Syntax --import_configuration <directory_path> (Linux) /import_configuration <directory_path> (Windows) Description This parameter specifies the directory that contains component configuration settings for components in the specified baseline. Imported component configurations override components configurations in the baseline. UNC user credentials Syntax /unc_username (Windows) Description Username credentials for accessing the file share. SUM supports Windows domains, for example: domain1/userid1 UNC password credentials Syntax /unc_password (Windows) Description Password credentials for accessing the file share. No management agent components Syntax --no_mgmt (Linux) /no_mgmt (Windows) Description Indicates that management components for AMS, SNMP, and WBEM Providers are not selected automatically. In silent mode, SUM does not update any management components. For more information on management options, see Management agent installation parameters. Use SNMP agent components Syntax --use_snmp (Linux) /use_snmp (Windows) Description Gen8 and Gen9 servers: SUM automatically selects SNMP components for installation. Gen10 servers: SUM lists SNMP components as not applicable. Restrictions Linux and Gen9 only: SUM selects the SNMP RPMs and the smh_templates RPMs. Use WMI agent components Syntax /use_wmi Description SUM automatically selects WBEM components for installation. Restrictions Windows only Use AMS agent components Syntax --use_ams (Linux) /use_ams (Windows) Description (Gen8 and later only) SUM automatically selects AMS components for installation. skip_prereqs Syntax /skip_prereqs (Windows only) Description SUM does not install the prerequisite self-inventory components, such as the CHIF driver, on the remote Windows node. Restrictions * Valid for Windows nodes only. Example input smartupdate /s /target "10.0.0.1" /skip_prereqs Express install Syntax --express_install (Linux) /express_install (Windows) Description Starts the GUI and begins Localhost Guided update in automatic mode. This parameter is ignored when the silent parameter is used. Override error parameters The following attributes determine how SUM handles errors. SUM applies these attributes to all nodes included in the command. Bypass TPM Syntax --tpmbypass or --ignore_tpm (Linux) /tpmbypass or /ignore_tpm (Windows) Description If you have enabled TPM on target iLO 5, Windows, Linux, or VMware ESXi, ignore the warning message and continue with component installation. For more information about TPM, see the Smart Update Manager User Guide. NOTE: Provide this parameter at the end of the CLI command. Ignore warnings Syntax --ignore_warnings (Linux) /ignore_warnings (Windows) Description Allows installation to proceed after SUM receives warnings on nodes. Some warnings include: * Active member of a Serviceguard cluster. If you do not specify this option, and the node is an active member of a Serviceguard cluster, the node does not enter the installation or deploy phases. * TPM warning * Superdome X-specific warnings * Low disk space * A system managed by HPE OneView * Pending iLO installation queue warning * Exception task queue warning * iLO 5 and iSUT warnings Continue installation and ignore errors Syntax --continue_on_error <error> (Linux) /continue_on_error <error> (Windows) Description Causes the installation to continue and ignore errors. Options Valid values: All Bypasses remote nodes that return any kind of error and continues deployment on other nodes. ServerNotFound Use the ServerNotFound option to bypass inactive or unavailable remote hosts when you deploy firmware or software to multiple remote hosts at the same time. BadPassword Use the BadPassword option to bypass remote nodes that report incorrect credentials provided and continue with other nodes. FailedDependencies Use the FailedDependencies option to bypass remote nodes with failed dependencies and continue with other nodes that are ready to be installed. Override this parameter by using on_failed_dependency:Force or :OmitComponent. iLOCACEnabled Use the iLOCACEnabled option to bypass the nodes on which CAC mode is enabled in iLO and continue with other nodes. iLO Administrator credentials are not required. iLOHighSecurityMode Use the iLOHighSecurityMode option to bypass the nodes on which High Security mode is enabled in iLO and continue with other nodes. iLO Administrator credentials are not required. CHIFSignFailure Use the CHIFSignFailure option to bypass the nodes when Signature verification of a CHIF driver component has failed and continue with other nodes. CHIFInstallFailure Use the CHIFInstallFailure option to bypass the nodes when a CHIF driver installation has failed and continue with other nodes. Override existing connection Syntax --override_existing_connection (Linux) /override_existing_connection (Windows) Description Instructs SUM to override a session in progress and reinitialize the installation framework on the remote node. If you do not include this parameter, SUM skips the node if a SUM session is already running on the remote node. Failed dependencies Syntax --on_failed_dependency (Linux) /on_failed_dependency (Windows) Description This parameter gives options to either omit the components or skip the installation on host when a failed dependency is encountered, and SUM does not attempt an installation. Options OmitHost (default) Puts the target into a failure state, and no installation is attempted. OmitComponent Deselects the affected components and proceeds with any updates that do not have dependency failures. Force Attempts all updates, even with dependency failures. Samples --on_failed_dependency:OmitHost (Linux) /on_failed_dependency:OmitHost (Windows) --on_failed_dependency:OmitComponent (Linux) /on_failed_dependency:OmitComponent (Windows) --on_failed_dependency:Force (Linux) /on_failed_dependency:Force (Windows) Reboot parameters The following attributes determine how SUM performs reboots. Reboot Syntax --r[eboot] (Linux) /r[eboot] (Windows) Description The following conditions cause the server (or host server in a remote installation) to reboot: * When you select the reboot option or use it in a command-line argument. * When all components selected for installation are successfully installed. * When at least one of the installed components requires a reboot to complete its installation. Reboot message Syntax --reboot_message "reboot message" (Linux) /reboot_message "reboot message" (Windows) Description Displays the specified reboot message on remote consoles connected to the server that you want to reboot. Use this parameter with the reboot option, or the argument is ignored. NOTE: The reboot_message cli parameter is not functional for SLES12 OS because the SLES12 OS image has a constraint that does not permit executing the parameter as a cli command. Reboot delay Syntax --reboot_delay timeout_in_secs (Linux) /reboot_delay timeout_in_secs (Windows) Description Delays the reboot of the server for the length of time that the timeout_in_seconds variable specifies. Defaults to 60 seconds. Linux systems convert the reboot delay time from seconds to minutes, and any value under a full minute (59 seconds or less) rounds to the next minute. Options Acceptable values are between 15 and 3600. Requirements Use this argument with the reboot option, or the argument is ignored. Reboot always Syntax --reboot_always (Linux) /reboot_always (Windows) Description SUM always reboots the server when this command line option is passed. Node parameters The following attributes define update options for nodes. When providing an attribute, provide the target node and then the attribute, do not specify the attribute before the target node. For example: Valid: smartupdate /s /target 10.0.1.2 /user root /password root Invalid: smartupdate /s /user root /password root /target 10.0.1.2 Global attributes can be applied to nodes that have no provided attributes. Provide global attributes at the end of the command line with one target node where the attributes apply. For example: smartupdate /s /target 10.0.1.3 /target 10.0.1.4 /target 10.0.1.5 /user root /password root The following attributes can be used globally: username/user, password/passwd, use_location, current_credential, su_username, su_password, use_sshkey, vcenter_host, vcenter_username, and vcenter_password. User name Syntax --user <username> or --username <username> (Linux) /user <username> or /username <username> (Windows) Description Use this argument to log in to the remote nodes with the user ID. Requirements Make sure that the user name belongs to the root or administrator group. SUM supports Windows domains, for example: domain1\userid1 If you are managing a Linux node that is part of a Windows domain, use the following format: <domain>\<username> User password Syntax --password <password> (Linux) /password <password> (Windows) smartupdate also supports passwd and pwd (Windows) Description Password for the user ID specified in the user parameter. The system uses the password to log in to remote nodes. iLO user name Syntax --ilo_username <username> (Linux) /ilo_username <username> (Windows) Description Use this parameter to connect to iLO from the host OS when the iLO of server has been configured in High Security mode. Provide iLO Administrator credentials. This parameter is valid only for Windows, Linux, and Unknown node types. Requirements Make sure that the iLO Administrator account has Configure iLO Settings permissions. iLO password Syntax --ilo_password <password>(Linux) /ilo_password <password> (Windows) Description Password associated with the iLO user name that is specified in ilo_username parameter. Use SSH key file Syntax --use_sshkey (Linux) /use_sshkey (Windows) Description Use SSH Key to connect to the Linux nodes. SUM ignores this parameter for other nodes types. When you provide this parameter, SUM requires the Private key file location. A key file, in PEM format, is an optional parameter you can pass. Private key file location Syntax privatekeyfile smartupdate /target 10.0.1.2 /user root /use_sshkey privatekeyfile=c:/<keyfile_directory/ssh.pem> /r /s Description If a dedicated SSH key file is generated, then SUM automatically detects that a passphrase is required and prompts for one. Requirements Use with the parameter use_sshkey. SSH passphrase Syntax passphrase Description Use this option to provide the passphrase that is used with the parameter use_sshkey and the option privatekeyfile. If passphrase is required by the key file and is not provided as a parameter, SUM prompts for the passphrase. smartupdate /target 10.0.1.2 /user root use_sshkey privatekeyfile=c:/<keyfile_directory/ssh.pem> passphrase=12345 /r /s Requirements Use with the parameter use_sshkey. Super user name Syntax --su_username (Linux) /su_username (Windows) Description Use root (super user) username to start a session on a remote node, inventory, and update components when the credentials specified in username and passwd do not have root privileges to update components. Do not use this command on the local host. Super user password Syntax --su_password (Linux) /su_password (Windows) Description Use root (super user) username to start a session on a remote node, inventory, and update components when the credentials specified in username and passwd do not have root privileges to update components. Do not use this command on the local host. To launch SUM on the local host using su, use the following example: su root smartupdate --s --f --use_location /mnt/spp Use sudo credentials Syntax --use_sudo (Linux) /use_sudo (Windows) Description Specifies that username and password for a remote node are sudo user credentials. Requirements When used with username and passwd, indicates that both parameters are sudo user credentials. Define target address Syntax --target “netAddress” (Linux) /target “netAddress” (Windows) Description The IP address or the DNS name of a remote host, which can be a remote server, remote iLO NIC port, Virtual Connect Ethernet or Fibre Channel Module for c-Class BladeSystem, or BladeSystem OA. When two OAs are in an enclosure, use the active OA as the argument. When specifying the IP address, use either the IPv4 or IPv6 format. If you are adding a VC node, use the IP address of the primary Enet module. Define target type Syntax --targettype “type” (Linux) /targettype “type” (Windows) Description Reduces inventory time for scripted deployments. This is an optional command-line argument. Possible values Windows Linux iLO fc_switch oa virtual_connect—Use the IP address of the primary VC Enet module. sas_switch VMware sdx sdflex Use targettype with the target parameter. You can interchange the sequence of targettype and target. If the node name includes spaces, enclose the name in quotation marks: “ “ User current credentials Syntax /current_credential (Windows only) Description Enables the use of the localhost credential to access the nodes instead of providing the user name and password explicitly for each node. Assumes that the current credential is valid for the nodes you are processing. Applies to Windows nodes only. OA username Syntax --oa_username (Linux) /oa_username (Windows) Description Provides the associated OA user name credential for the VC target specified using the target command. You can specify only one set of OA credentials using command-line parameters. To add multiple VC nodes using the target parameter, make sure that the OA credentials for each specified VC are the same. You do not need to provide an OA network address associated with the VC. SUM obtains it from a specified VC node. To update VCs with OAs having different credentials, use the corresponding oa_username and oa_password. OA user password Syntax --oa_password (Linux) /oa_password (Windows) Description Provides the password credential for OA associated with VC specified using the target command. Only one set of OA credentials can be specified with command-line parameters. Add multiple VC nodes to command-line parameters with the "node" parameter only if the credentials of OAs associated with specified VCs are the same. You do not need to provide an OA network address associated with VC. SUM queries it from a specified VC node. To update VCs with OAs having different credentials, use the corresponding oa_username and oa_password. Enable VC in FIPS mode Syntax --encryption_key (Linux) /encryption_key (Windows) Description This parameter is used to provide the encryption key for FIPS-enabled VC. Possible value String of a minimum eight characters. VC-Enet module activation order Syntax --ethactorder (Linux) /ethactorder (Windows) Description Use this command to set the VC-Enet module activation order. Possible values ODDEVEN (Default) PARALLEL SERIAL MANUAL VC-FC activation order Syntax --fcactorder (Linux) /fcactorder (Windows) Description Use this command to set the VC-FC activation order. Possible values ODDEVEN PARALLEL SERIAL (Default) MANUAL VC-Enet activation and reboot options Syntax --ethactdelay (Linux) /ethactdelay (Windows) Description Use this command to specify the time, in minutes, between activating or rebooting VC-Enet modules. Possible values Maximum 60 minutes; the default is 0 minutes. VC-FC activation and reboot options Syntax --fcactdelay (Linux) /fcactdelay (Windows) Description Use this command to specify the time to wait between activating or rebooting VC-FC modules. Possible values Maximum 60 minutes; the default is 0 minutes. VCenter Host Syntax --vcenter_host (Linux) /vcenter_host (Windows) Description Enter the IP address for the VMware vCenter. Use this command with VMware ESXi nodes to generate a ticket from VMware vCenter nodes that are in lockdown mode. This command applies to all targets in the command line. For non-VMware nodes, the command is ignored. VCenter user name Syntax --vcenter_username (Linux) /vcenter_username (Windows) Description Enter the username to log in to the VMware vCenter. See the vcenter_host for more information. VCenter password Syntax --vcenter_password (Linux) /vcenter_password (Windows) Description Enter the password to log in to the VMware vCenter. See the vcenter_host for more information. Skip iLO Syntax --skip_ilo (Linux) /skip_ilo (Windows) Description This command tells SUM to remove iLO smart components from an install set. (EFM only) iLO Repository parameters The following attributes determine how SUM manages an iLO Repository. Save install set Syntax smartupdate --save_install_set (Linux) smartupdate /save_install_set (Windows) Description Saves the install set on the iLO Repository. Requirements Provide the following parameters with save_install_set: * install_set_name * install_set_description Example input smartupdate --s --target <ip> --use_location <SPP/baseline_directory> --save_install_set --install_set_name <name> --install_set_description <description> Install set name Syntax smartupdate --install_set_name (Linux) smartupdate /install_set_name (Windows) Description Save the install set name to the iLO Repository. Parameters <install_set_name> Provide the name of the install set that you want to save on the iLO Repository. Example input smartupdate --install_set_name="<my_install_set" Install set description Syntax smartupdate --install_set_description (Linux) smartupdate /install_set_description (Windows) Description Description of the install set SUM is saving to the iLO Repository. Example input smartupdate --install_set_description="<_install_set_description" Manually manage iLO Repository Syntax smartupdate --manually_manage_iLO_repository (Linux) smartupdate /manually_manage_iLO_repository (Windows) Description Instructs SUM not to automatically remove install sets from the iLO Repository to make space for new install sets. Example input smartupdate /s /target <ip> /use_location <SPP/baseline directory> /save_install_set /install_set_name <name> /install_set_description <description> /manually_manage_ilo_repository use_ilo_saved Syntax smartupdate --use_ilo_saved <install_set_name> (Linux) smartupdate /use_ilo_saved <install_set_name> (Windows) Description Uses the install set that is already saved on an iLO Repository. Parameters install_set_name Provide the name of the install set to install. Example input smartupdate --s --target <ip> --use_ilo_saved <install_set_name> skip_missing_compsig Syntax smartupdate --skip_missing_compsig (Linux) smartupdate /skip_missing_compsig (Windows) Description Skips components that have a missing component signature file. Example input smartupdate --skip_missing_compsig Update recovery set Syntax smartupdate --update_existing_recoveryset (Linux) smartupdate /update_existing_recoveryset (Windows) Description Updates the existing recovery set in iLO Repository with new firmware versions of iLO, BIOS, CPLD, IE, and ME (IE and ME only for Intel Processor) from current deployment. Requirements: Use the update_existing_recoveryset parameter along with save_install_set. Example input smartupdate --s --target <ip> --use_location <SPP/baseline_directory> -- save_install_set --install_set_name <name> --install_set_description <description> --update_existing_recoveryset Log file parameters The following attributes determine how SUM creates log files. Log parameters Log directory Syntax --logdir “path" (Linux) /logdir “path" (Windows) Description Redirects the output from SUM to a directory other than the default location. For SUM running on Windows systems, the default location is %SYSTEMDRIVE%\CPQSYSTEM\sum\log\<netAddress> and the redirected location is <path>\sum\log\<netAddress>. SUM creates the %SYSTEMDRIVE%\CPQSYSTEM\ directory as it processes components. SUM writes only the smartupdate_log.txt, smartupdate_detail_log.txt, and smartupdate_InstallDetails.txt files to the redirected directory. SUM writes other logs to the default directory. For SUM running on Linux systems, the default location is /var/log/sum/<netAddress> and the redirected location is <path>/log/sum/<netAddress>. Debug log directory Syntax --debuglogdir [directory_path] (Linux) /debuglogdir [directory_path] (Windows) Description This parameter assigns the directory where SUM saves debug log files. Cleanup on exit Syntax --cleanup_onexit (Linux) /cleanup_onexit (Windows) Description This parameter removes the following from target and host: * Firmware RPMs copied to the Linux folder /usr/lib/i386-linux-gnu/* or /usr/lib/x86_64-linux-gnu. * Extracted Firmware RPM directory and folder contents. * Extracted components during baseline inventory. * If SUM is run from a read-only location, this parameter deletes the 'localsum' directory. NOTE: This parameter does not delete the debug log files. Cleanup all logs on exit Syntax --cleanupall_onexit (Linux) /cleanupall_onexit (Windows) Description This parameter removes all files, including debug files from target and host. This parameter does not delete the user logs. Logging verbosity level Syntax --v[erbose] or --veryv[erbose] (Linux) /v[erbose] or --veryv[erbose] (Windows) Description Sets the verbosity level for the SUM execution log file, sum_execution_log_*.log. Allows you to increase the level of detail that the log files retain. Defaults to normal verbosity. Test run parameter Syntax --dryrun (Linux) /dryrun (Windows) Description Use this attribute along with other attributes to have SUM run through all processes in the command, except the actual deployment. Use this parameter to verify connections and configurations for remote nodes and to see what SUM will update. Requirements This argument simulates the installation for a test run. SUM does not deploy any updates. Report parameters NOTE: The combined report and installed reports can only be generated after completing a deployment. SUM generates reports about the specified system or repository location using the command-line arguments. If you do not specify additional locations on the command line, SUM uses the local host and default repository locations (the directory where SUM was initiated). Specify a node if you provide the appropriate credentials. Specify a repository by using other command-line parameters to generate reports. For specific commands, see SUM CLI parameters. SUM generates the reports as XML or HTML files that you can view in a JavaScript-enabled web browser, or a CSV-format report that you can open in any application that supports CSV format. HTML reports are generated under a directory named SUM_<Type>_Report_<date>_<time>. The location defaults to the present working directory where SUM is initiated. If that location is write-protected, SUM saves the report to the same directory as the SUM log files. Use the reportdir parameter to specify a different directory where SUM can save the reports. The SUM report files are located in these default directories: Windows: C:\cpqsystem\sum\log Linux: /var/log/sum When SUM generates the report, the SUM GUI does not appear. SUM displays the file location for the generated report. Generate node summary report Syntax --report (Linux) /report (Windows) Description Generates a deploy preview report that describes the node summary and how the components in the repository affect the node. For example, whether each component applies to the node. The report is generated in HTML, XML, and CSV formats with file names SUM_Deploy_preview_Report_<date>_<time>.html, SUM_Deploy_preview_Report_<date>_<time>.xml, and SUM_Deploy_preview_Report_<date>_<time>.csv. SUM performs inventory, generates the report, and then exits. It does not deploy any updates. Generate inventory repository report Syntax --inventory_report (Linux) /inventory_report (Windows) Description Generates a report listing of the components in the specified repository. The report is generated in HTML, XML, and CSV formats with file names SUM_Inventory_Report_<date>_<time>.html, SUM_Inventory_Report_<date>_<time>.xml and SUM_Inventory_Report_<date>_<time>.csv. SUM performs inventory, generates the report, and then exits. It does not deploy any updates. Generate installed firmware report Syntax --firmware_report (Linux) /firmware_report (Windows) Description Generates a report listing of the firmware, software installed, and details of the node. The report is generated in HTML, XML, and CSV formats with file names SUM_Firmware_Report_<date>_<time>.html, SUM_Firmware_Report_<date>_<time>.xml, and SUM_Firmware_Report_<date>_<time>.csv. SUM performs inventory, generates the report, and then exits. It does not deploy any updates. Generate failed dependencies report Syntax --dependency_report (Linux) /dependency_report (Windows) Description Generates a report listing of the failed dependencies for all nodes. The report is generated in HTML, XML, and CSV formats with file names SUM_FailedDependency_Report_<date>_<time>.html, SUM_FailedDependency_Report_<date>_<time>.xml, and SUM_FailedDependency_Report_<date>_<time>.csv. SUM performs inventory, generates the report, and then closes. It does not deploy any updates. Generate installed updates report Syntax --installed_report (Linux) /installed_report (Windows) Description Generates a report that lists all firmware, software, and driver versions installed on all nodes during this session of SUM. The report is generated in HTML, XML, and CSV formats with file namesSUM_Installed_Report_<date>_<time>.html, SUM_Installed_Report_<date>_<time>.xml, and SUM_Installed_Report_<date>_<time>.csv. SUM inventories the node, deploys updates, and then generates the report. Generate combined report Syntax --combined_report (Linux) /combined_report (Windows) Description This report generates all report types in one file. The report is generated in HTML, XML, and CSV formats with file names SUM_Combined_Report_<date>_<time>.html, SUM_Combined_Report_<date>_<time>.xml, and SUM_Combined_Report_<date>_<time>.csv. SUM inventories the node, deploys updates, and then generates the report. Report directory Syntax --reportdir (Linux) /reportdir (Windows) Description Use this parameter with all report commands to specify a directory where SUM saves reports. For example, smartupdate --report --reportdir /etc/user/reports. Input file parameters Use the following parameters to script the update of multiple or individual nodes, or groups of nodes. Use an input file Syntax --inputfile “filename” (Linux) /inputfile “filename” (Windows) Description When this parameter is used with file name, SUM uses the file contents to generate a list of targets and baselines for performing deployment. For more information, see Input file sections. Delete an input file Syntax --deleteinputfile (Linux) /deleteinputfile (Windows) Description Instruct SUM to delete the Input file after it has been read. Superdome X server commands The following attributes apply to Superdome X servers. Firmware update type Syntax --update_type <type> (Linux) /update_type <type> (Windows) Description Determines which Superdome X firmware is updated. Options ALL (Default) COMPLEX PARTITIONS Example update_type PARTITIONS Update specific devices Syntax --device_list <device[,device]…> (Linux) /device_list <device[,device]…> (Windows) Description Use this argument when the update_type argument is PARTITIONS. This argument specifies the subset of partitions or unassigned blades to update when you do not want to update all partitions or unassigned blades. Options npar(number) blade(enc)/(bay) Do not put any spaces between the parameters. Example device_list npar1,npar2,blade1/1,blade1/2 Partition reboot options Syntax --reboot_list <npar[,npar]…> (Linux) /reboot_list <npar[,npar]…> (Windows) Description Use this argument when the update_type is ALL or PARTITIONS. This argument specifies specific partitions to reboot after the partition firmware has been updated. Options npar values are npar(number). Do not put any spaces between parameters. Example reboot_list npar1,npar2 Return codes SUM has consolidated return codes from Linux and Windows smart components into an enhanced return-code mapping. These return codes determine the status of the component installation. You can also use return codes in a script to control the execution of the script and determine any required branching. In Linux, a negative return code is recalculated to a positive return code by subtracting the value from 256. SUCCESS_NO_REBOOT Linux: 0 Windows: 0 Text: The installation was successful. SUCCESS_REBOOT Linux: 1 Windows: 1 Text: The installation was successful, but a reboot is required. SUCCESS_NOT_REQUIRED Linux: 3 Windows: 3 Text: The component was current or not required. FAILURE_GENERAL Linux: 255 Windows: -1 Text: A general failure occurred. For details, see the error log. FAILURE_BAD_PARM Linux: 254 Windows: -2 Text: A bad input parameter was encountered. FAILURE_COMPONENT_FAILED Linux: 253 Windows: -3 Text: The installation of the component failed or was blocked by a failed dependency. FAILURE_COMMAND_FAILED Linux: 252 Windows: -4 Text: The CLI command execution failed. Windows smart-component return codes 0 The smart component was not installed. For more information, see the log file. 1 The smart component was installed successfully. 2 The smart component was installed successfully, but the system must be restarted. 3 The installation was not attempted because the required hardware is not present, the software is current or not applicable, or there is nothing to install. Linux smart-component and firmware RPM return codes 0 The smart component was installed successfully. 1 The smart component was installed successfully, but the system must be restarted. 2 The installation was not attempted because the required hardware is not present, the software is current, or there is nothing to install. 3 The installation was not attempted because the required hardware is not present, the software is current or not applicable, or there is nothing to install. 4 If the component is being installed to a remote note, such as an OA or other network-based deployment, this return code indicates that the node cannot be found. 5 A user canceled the installation before anything could be installed. 6 The installer cannot run because of an unmet dependency or installation tool failure. 7 The actual installation operation (not the installation tool) failed. Linux software RPM return codes 0 The Linux RPM installation was successful. 1 The Linux RPM installation failed. VMware ESXi smart-component return codes 0 The installation of the deliverable was successful. No reboot is required. 1 The installation of the deliverable was successful. Reboot is required for the deliverable to be enabled. 2 The installation was not attempted because the version to be installed matches the version already installed. 3 The installation was not attempted because of one of the following: * The version to be installed is older than the version already installed. * The supported hardware is not present, not enabled, or in a state that an installation could not be attempted. * The smart component does not support the environment. 4 If the component is being installed to a remote node, such as an OA or other network-based deployment, this return code indicates that the node cannot be found. 5 A user canceled the installation before anything could be installed. 6 The installer cannot run because of an unmet dependency or installation tool failure. 7 The actual installation operation (not the installation tool) failed. Component-specific configuration in Input files Use component short names in Input files to define component configurations. The component filename might change in a release. See the SPP Release Notes to view the filename. To get a list of available configuration parameters for components in a baseline, use the following interactive CLI command: * Linux: smartupdate configure --show * Windows: smartupdate configure /show NOTE: The interactive CLI does not support component short names, use the full component name when you show configuration parameters. For more information on using the interactive CLI, see the Smart Update Manager User Guide. hpsmh-windows-x64 HP System Management Homepage for Windows x64 hpinsightmgmtwbemprovider-windows-x64 HP Insight Management WBEM Providers for Windows Server x64 Editions hpinsightmgmtagent-windows-x64 HP Insight Management Agents for Windows Server x64 Editions hpmouse-linux HP iLO High-Performance Mouse for Linux hpsmh-linux-x64 HP System Management Homepage for Linux (AMD64/EM64T) hpsnmpagent-rhel6-x64 HP SNMP Agents for Red Hat Enterprise Linux 6 (AMD64/EM64T) hpsnmpagent-sles11-x64 HP SNMP Agents for SUSE Linux Enterprise Server 11 (AMD64/EM64T) hpsnmpagent-rhel5-x64 HP SNMP Agents for Red Hat Enterprise Linux 5 (AMD64/EM64T) hpsnmpagent-rhel7–x64 HP SNMP Agents for Red Hat Enterprise Linux 7 (AMD64/EM64T) hpsnmpagent-sles12–x64 HP SNMP Agents for SUSE Linux Enterprise Server 12 (AMD64/EM64T) hpqlogic-smartsan-windows-x64 HPE QLogic SmartSAN Enablement Kit for Windows 64 bit operating systems hpemulex-smartsan-windows-x64 HPE Emulex SmartSAN Enablement Kit for Windows 64 bit operating systems hpemulex-smartsan-linux Emulex SmartSAN Enablement Kit for Linux hpqlogic-smartsan-linux QLogic SmartSAN enablement kit for Linux Configuring components with an Input file [COMPONENT_CONFIG=<component short name>] [<PARAM_NAME1>] Value1-line1 Value1-line2 [<PARAM_NAME1>] Value1-line1 Value1-line2 [END_COMPONENT_CONFIG] Configuring the component cp032867.exe Component cp032867.exe is the HP System Management Homepage for Windows 64-bit component. SOURCEPATH = usr/john/updates/Component Configuration/RPM [COMPONENT_CONFIG=hpsmh-windows-x64] [<force-overwrite>] YES [<admin-group>] ADMINGRP1 ADMINGRP2 [<CERTNAME_2>] PRAMS2 [<CERTNAME_2>] -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1.4.9 (Darwin) mQENBErJM6oBCAC7NG5NZ5kiJg+KTTaIDjX9BU8bc7FI5a2zCYc3p9eikJfyyZYM lflfhsl20242309482048039482080(*)(*)(*)(*)(*)( sWbckvcIjJRcAtRliKbAf+KjplbcEIzt+kxmweE5XeKvDFtzAD041FGAphIkKcuu IAzL+XcMWzc3DA== =+ojz -----END PGP PUBLIC KEY BLOCK----- [<OPERATOR-GROUP>] OPTGRP1 OPTGRP2 [<ANONYMOUS-ACCESS>] YES [END_COMPONENT_CONFIG] [TARGETS] HOST = LocalHost UID = admin PWD = ******** [END] Configuring component cp031262.exe SILENT = YES FORCEALL = YES SOURCEPATH = usr/john/SPPGen8Snap6.2013_1119.56/hp/swpackages COMPONENTSLIST = cp031262.exe [COMPONENT_CONFIG= hpinsightmgmtagent-windows-x64] [<pollinterval>] 15 seconds [<snmpsetsenabled>] Y [<remoterebootenabled>] Y [END_COMPONENT_CONFIG] [TARGETS] HOST = LocalHost UID = Administrator PWD = 12iso*help [END] Configuring component cp031895.exe SILENT = YES FORCEALL = YES SOURCEPATH = usr/john/SPPGen8Snap6.2013_1119.56/hp/swpackages COMPONENTSLIST = cp031895.exe [COMPONENT_CONFIG= hpinsightmgmtwbemprovider-windows-x64] [<config:rwmiuser>] Useradmin [END_COMPONENT_CONFIG] [TARGETS] HOST = LocalHost UID = Administrator PWD = 12iso*help [END] Configuring component hpsmh-linux-x86 SILENT = YES FORCEALL = YES SOURCEPATH = /usr/john/SPP/58/sum COMPONENTSLIST = hpsmh-7.4.0-11.i386.rpm [COMPONENT_CONFIG= hpsmh-linux-x86] [<FORCE-OVERWRITE>] YES [<ADMIN-GROUP>] ADMINGRP1 [<OPERATOR-GROUP>] OPTGRP1 [<USER-GROUP>] USGRP1 [<ANONYMOUS-ACCESSED>] YES [<LOCAL-ACCESS-ENABLED>] YES [<LOCAL-ACCESS-TYPE>] Administrator [<XENAMELIST>] SUM_123 [<PORT-2301-ENABLED>] YES [<IP-BINDING>] YES [<IP-BINDING-LIST>] 99.99.99.3/255.255.255.0 [<IP-RESTRICTED-LOGINS>] YES [<IP-RESTRICTED-EXCLUDE>] 99.99.99.187 [<IP-RESTRICTED-INCLUDE>] 99.99.99.157 [<TRUSTMODE>] TrustByAll [END_COMPONENT_CONFIG] [TARGETS] HOST = 15.154.112.81 UID = root PWD = iso*help [END] Configuring component hpsnmpagent-rhel5–x86 SILENT = YES FORCEALL = YES COMPONENTSTLIST = <snmp-linux-component> [COMPONENT_CONFIG= hpsnmpagent-rhel5-x86] [<CMASTARTWEBAGENT>] YES [<CMASTARTSTORAGEAGENT>] YES [<CMASTARTNICAGENT>] YES [<CMANOTAINTEDKERNEL>] YES [<CMALOCALHOSTRWCOMMSTR>] localhost_rw_com_string [<CMALOCALHOSTROCOMMSTR>] localhost_ron_com_string [<CMAMGMTSTATIONRWIPORDNS>] 15.154.123.123 [<CMAMGMTSTATIONRWCOMMSTR>] SNMP_rw_authmgmtstncomm [<CMAMGMTSTATIONROIPORDNS>] 15.154.112.234 [<CMAMGMTSTATIONROCOMMSTR>] SNMP_ro_authmgmtstncomm [<CMADEFTRAPCOMMSTR>] def_snmp_trap_strng [<CMATRAPDESTINATIONIPORDNS>] 15.156.23.45 [<CMATRAPDESTINATIONCOMMSTR>] snmptrap_abovestring [<CMASYSCONTACT>] SUMind [<CMASYSLOCATION>] HPSTSD123 [END_COMPONENT_CONFIG] [TARGETS] HOST = LocalHost UID = root PWD = iso*help [END] About Input file encoding Use UTF-8 formatting for Input files. UTF-8 allows double-byte characters. Error reporting If errors occur in the Input file, SUM exits with a return value of –2 (bad parameter). Find the location and nature of the error in the log file smartupdate_execution_log_<date>_<time>.raw. Input file parameters When using an Input file, you must include the target nodes and baseline you want to use. If you are running SUM in a directory that includes a baseline, SUM uses the baseline in that directory by default. The following attributes are related to the session, and you can only use them once. Session attributes BUNDLESLIST Possible values: <bundlefilename> Bundle file names List of bundle xml files to be considered for update if there are multiple bundle files in the provided baseline location. CLEANUPALLONEXIT Possible values: YES, Default = NO This parameter removes all files, including debug files. This parameter does not delete the user logs. CLEANUPONEXIT Possible values: YES, Default = NO This parameter removes the following: * Firmware RPMs copied to the Linux folder /usr/lib/i386-linux-gnu/* or /usr/lib/x86_64-linux-gnu. * Extracted Firmware RPM directory and folder contents. * Extracted components during baseline inventory. * If SUM is run from a read-only location, this parameter deletes the 'localsum' directory. NOTE: This parameter does not delete the debug log files. COMBINED_REPORT Possible values: YES, NO This report generates all report types in one file. SUM performs the inventory, deploys updates, generates the report, and then exits. For information about where SUM saves reports, see Report parameters. COMPONENTSLIST Possible values: Component names with file extensions .exe, .rpm, or .scexe. Limits the list of components to be updated. DEBUGLOGDIR Possible value: <directorypath> Tells SUM where to save debug files. DELETEINPUTFILE Possible values: YES, Default = NO Instructs SUM to delete the Input file after it has been read. DEPENDENCY_REPORT Possible values: YES, NO Generates a report listing of the failed dependencies for all nodes. SUM performs the inventory, generates the report, and then exits. It does not deploy updates. For information about where SUM saves reports, see Report parameters. DEVICELIST Possible values: For example: DEVICELIST=npar1,blade1/1 Do not put spaces between the parameters. For Superdome X servers only, use this argument when the UPDATETYPE is set to PARTITIONS. This argument specifies the subset of partitions or blades to update when you do not want to update all partitions. Valid devices are: npar(number) and blade(enc)/(bay). DOWNGRADE Possible values: YES, NO Selects components for installation that have an available version lower than the currently installed version. This is in addition to upgrades. Can be combined with rewrite. DRYRUN Possible values: YES, NO Simulates the installation for a test run. Nothing is installed. FIRMWARE_REPORT Possible values: YES, NO Generates a report listing of the firmware installed, software installed, and details of the node. SUM performs the inventory, generates the report, and then exits. It does not deploy updates. For information about where SUM saves reports, see Report parameters. FORCEALL Possible values: YES, NO Rewrites or downgrades the existing installation of the selected software components, firmware components, and bundles. FORCEBUNDLE Possible values: YES, Default = NO Rewrites or downgrades the existing installation of components in the selected bundle. FORCEROM Possible values: YES, NO Rewrites or downgrades the existing installation of the selected firmware components. FORCESOFTWARE Possible values: YES, NO Rewrites or downgrades the existing installation of the selected software components. HOST Possible values: IP address, DNS name The IP address or the DNS name of a remote server, remote iLO NIC port, Virtual Connect Ethernet, or Fibre Channel Module for c-Class BladeSystem or BladeSystem OA. With two OAs in an enclosure, this parameter is the active OA. When specifying the IP address, use either the IPv4 or IPv6 format. IGNOREERRORS This parameter causes the installation to continue and ignore errors. Possible values: All—Ignores remote nodes with an error and continues deployment to other nodes. ServerNotFound—Bypasses inactive or unavailable remote hosts when deploying firmware or software to multiple remote hosts at the same time. BadPassword—Bypasses remote nodes that report incorrect credentials provided and continue with other nodes. FailedDependencies—Ignores any nodes with failed dependencies and proceeds with nodes that are ready. ILOCACENABLED—Bypasses the nodes on which CAC mode is enabled in iLO and continues with other nodes. iLO Administrator credentials are not required. iLOHighSecurityMode—Bypasses the nodes on which High Security mode is enabled in iLO and continues with other nodes. iLO Administrator credentials are not required. CHIFSignFailure—Bypasses the nodes when Signature verification of a CHIF driver component has failed and continues with other nodes. CHIFInstallFailure—Bypasses the nodes when a CHIF driver installation has failed and continues with other nodes. IGNORETPM Possible values: YES, NO If you have enabled TPM, ignore the warning message and continue with component installation. For more information about TPM, see the Smart Update Manager User Guide. IGNOREWARNINGS Possible values: YES, NO Allows installation to proceed after SUM receives warnings on nodes. Some warnings include: * Active member of a Serviceguard cluster * TPM warning * Superdome X-specific warnings * Pending iLO installation queue warnings * iLO task queue exceptions * iLO 5 and iSUT warnings IMPORT_CONFIGURATION=<path> This parameter specifies the directory that contains component configuration settings for components in the specified baseline. Imported component configurations override components configurations in the baseline. INSTALLED_REPORT Possible values: YES, NO Generates a report that lists all installed firmware, software, and driver versions installed on all nodes. SUM performs the inventory, deploys updates, generates the report, and then exits. For information about where SUM saves reports, see Report parameters. INVENTORY_REPORT Possible values: YES, NO Generates a report listing of the components in the specified repository. SUM performs the inventory, generates the report, and then exits. It does not deploy updates. For information about where SUM saves reports, see Report parameters. LOGFILENAME = "path" Possible values: Log file name Redirects the output from SUM or the BladeSystem c-Class OA flash utility to a directory other than the default location. For Windows components, the default location is %SYSTEMDRIVE%\CPQSYSTEM\sum\log\<netAddress> and the redirected location is <path>\sum\log\<netAddress>. SUM creates the directory %SYSTEMDRIVE%\CPQSYSTEM\ when it processes components. SUM writes only the files smartupdate_log.txt, smartupdate_detail_log.txt, and smartupdate_InstallDetails.txt to the redirected directory. SUM writes all other log files to the default directory. For Linux components, the default location is /var/log/sum/<netAddress> and the redirected location is <path>/log/sum/<netAddress>. NOMGMT Possible values: YES Specifies listing components using SNMP and WBEM Providers as optional updates on the Components Selection screen. In silent mode, SUM does not update AMS, SNMP, or WBEM Providers. OAPWD User can define OAPWD variable multiple times before each HOST variable. Provides the password credentials for the OA associated with VC. Define a value for these variables before the HOST variable in the [TARGETS] section. This parameter applies only to VC target. You can also use OAPASSWORD. OAUID User can define the OAUID variable multiple times before each HOST variable. Provides the user name credentials for the OA associated with VC. Define a value for these variables before the HOST variable in the [TARGETS] section. This parameter applies only to VC firmware. You can also use OAUSER or OAUSERNAME. ONFAILEDDEPENDENCY Tells SUM how to proceed when a component has a failed dependency. Possible values: OmitHost (default)—Puts the host in a failure state, and SUM does not attempt installation. OmitComponent—Clears the affected components and proceeds with any updates that do not have dependency failures. Force—Attempts all updates, even if they have dependency failures. OPTIONS Possible values: One or more CLI switches Specify the SUM CLI options inside the Input file, which overrides the configuration settings. Separate parameters with a comma. This parameter replaces the LSPOPTIONS parameter that was previously supported with LDU. REBOOTALLOWED Possible values: YES, NO Enables you to reboot, if required. REBOOTALWAYS Possible values: YES, NO It always reboots the node. REBOOTDELAY Possible values: Time in seconds Adds wait time before rebooting. REBOOTLIST Possible values: For example: REBOOTLIST=npar1,npar2 Do not put spaces between the parameters. For Superdome X servers only, use this argument with the UPDATETYPE= ALL or UPDATETYPE= PARTITIONS argument. Specifies the partitions to reboot after updating the partition firmware. Valid npar values are npar(number). REBOOTMESSAGE Possible values: Any string (not exceeding 256 characters) Creates a message to be displayed prior to rebooting. REPORT Possible values: YES, NO Generates a report listing of the node summary and describes how the components in the repository affect the node—for example, whether each component applies to the node. SUM performs the inventory, generates the report, and then exits. It does not deploy updates. For information about where SUM saves reports, see Report parameters. REPORTDIR Use this parameter with all report commands to specify a directory where you want SUM to save reports. REWRITE Possible values: YES, Default = NO Selects components for installation that have an available version that is the same as the installed version. This is in addition to upgrades. Can be combined with downgrade. ROMONLY Possible values: YES, NO Limits components considered for installation to only firmware components. Cannot be used with softwareonly. If softwareonly and romonly are not used, all components are considered for possible installation. SCHEDULEDEPLOYFROM Possible value: For example: SCHEDULEDEPLOYFROM = MMDDYYYY HH:MM Adds schedule start time to current deployment. SCHEDULEDEPLOYTO Possible value: For example: SCHEDULEDEPLOYTO = MMDDYYYY HH:MM Adds schedule end time to current deployment. SILENT Possible value: YES Causes the installation to run silently with no GUI or interactive CLI output. Writes all data to the log file. Any generated prompts use the default option and continue the installation without user input. NOTE: If you enter the value NO, the input file will not work correctly. SUM will try to launch the GUI mode. SKIPTARGET Possible values: YES (default), NO The default setting skips a remote node if SUM finds a remote session running on the node. Defines the behavior when a remote node has an existing SUM session in progress. Use this parameter to skip the host if a SUM session already exists. A value of NO overrides the session in progress and reinitializes the installation framework on the remote host. SOFTWAREONLY Possible values: YES, NO Limits components considered for installation to only software components. Cannot be used with romonly. If softwareonly or romonly are not used, all components are considered for possible installation. TPMBYPASS Use this parameter to bypass TPM warnings. UPDATEEXISTINGRECOVERYSET Possible values: YES, NO Updates the existing recovery set in iLO Repository with new firmware versions of iLO, BIOS, CPLD, IE, and ME (IE and ME for Intel Processor) from current deployment. Gen10 servers only. UPDATETYPE Possible values: ALL, COMPLEX, PARTITIONS This argument determines which Superdome X firmware is updated. USE_SSHKEY Possible values: YES, NO Allows you to use an SSH PEM-format keyfile for Linux nodes. Must be used as a session attribute, not as a node attribute. USEAMS Possible values: YES Specifies SUM to install the AMS component. This option applies to Gen8 and later servers. If you set this parameter for a ProLiant G7 and earlier server, SUM ignores the parameter. These components are only installed by default on Gen8 and later servers. This parameter does not apply to Integrity servers. USECURRENTCREDENTIAL Possible values: YES, NO Allows you to use the credentials of the local host to access the nodes instead of providing the user name and password explicitly for each node. Assumes that the current credentials are valid for the nodes that are being accessed. (Applies to Windows only.) USESNMP Possible values: YES Specifies SUM to install the SNMP component. These components are optional by default and are not installed unless you use this parameter. This parameter does not apply to Integrity servers. Gen9 only: SUM installs SMH templates when it installs SNMP agents. NOTE: Gen10 servers do not support SNMP agents. USEWMI Possible values: YES (Windows only) Specifies SUM to install the WBEM component. These components are optional by default and are not installed unless you use this parameter. NOTE: Gen10 servers do not support WBEM agents. VERBOSE Possible values: YES, NO This parameter determines the amount of details SUM provides during deployment. The following attributes are related to nodes and baselines. Use these attributes for each node or baseline. ETHACTDELAY Use this command to specify the time, in minutes, between activating or rebooting VC-Enet modules. Possible value: 0 (default) to 60 minutes. ETHACTORDER Use this command to determine VC-Enet module activation order. Possible value: ODDEVEN (default) PARALLEL SERIAL MANUAL FCACTDELAY Use this command to specify the time to wait between activating or rebooting VC-FC modules. Possible value: 0 (default) to 60 minutes. FCACTORDER Use this command to specify VC-FC activation order. Possible value: ODDEVEN (default) PARALLEL SERIAL MANUAL ILO_PASSWORD Possible values: <ilo password> The iLO Administrator password associated with ILO_USERNAME parameter. ILO_USERNAME Possible values: <ilo username> Provide iLO Administrator credentials. Use this parameter to connect to iLO from the host OS when the iLO of the server has been configured in High Security mode. INSTALLSETDESCRIPTION Possible value: <string> Set a description for the install set. Gen10 servers only. INSTALLSETNAME Possible value: <string> Set the name for the install set that must be stored on the iLO. Gen10 servers only. MANUALLYMANAGEILOREPOSITORY Possible values: YES, NO YES does not allow SUM to automatically remove install sets on the iLO Repository to create space for new install sets. Gen10 servers only. Default is automatic, which means that if iLO NAND does not have space to accommodate new components that SUM uploads, SUM deletes the install set with minimum size (based on total component size) and creates space for new components and install set. PASSPHRASE Possible values: <passphrase=12345> Passphrase for the SSHkey file. Use with the USE_SSHKEY and PRIVATEKEYFILE parameters. PRIVATEKEYFILE Possible values: <c:/keyfile_directory/ssh.pem> Provide the full path to the private key file. Use with the USE_SSHKEY parameter. PWD Possible values: <password> Uses the password for the user ID specified in the UID. Specifies the password for logging in to the nodes. SAVEINSTALLSET Possible values: YES, NO Saves the install set on the iLO Repository. Gen10 servers only. SKIP_PREREQS Possible values: YES, NO (Windows only) If you provide the parameter YES, then prerequisite self-inventory components, such as the CHIF driver, are not installed. SKIPMISSINGCOMPSIG Possible values: YES, NO YES instructs SUM to skip components that are missing a component signature file. Gen10 servers only. SOURCEPATH Possible values: Directory path, UNC location Provides a single local baseline path or a UNC file share. This action creates an inventory from the given path instead of the local or default baseline. SUM CLI with Input File mode does not support http baselines. STAGEONLY Possible values: YES, Default = NO Uploads all applicable components to an iLO Repository by creating an install set. Does not initiate the install set created to perform deployment. The install set created can be used for updating the system later. SUPASSWORD Possible values: <superuserpassword> Use this argument to provide a superuser password. After you log in to a Linux node, using the regular credentials, you can elevate the session using these credentials. SUM requires an Administrator level access to perform any updates. SUUSERNAME Possible values: <superusername> Use this argument to provide a superuser username. NOTE: <superuserpassword> and <superusername> are used to provide superuser username and password. After you log in to a Linux node, using the regular credentials, you can elevate the session using these credentials. SUM requires an Administrator level access to perform any updates. TARGETTYPE Specifies the type of node (--targettype Linux (Linux) /targettype (Windows), and can shorten the inventory process. Valid node types are: Windows Linux fc_switch OA sdx iLO virtual_connect—Use the IP address of the primary VC Enet module. sas_switch VMware If you use the command with a group, SUM assumes that all nodes in the group are the same node type. UID Possible values: <username> Specifies the user ID for logging in to the nodes. SUM supports Windows domains, for example: domain1/userid1 UNC_PASSWORD Possible values: <password> Provides the password to access the UNC location. UNC_USERNAME Possible values: <username> Provides the user name credentials for the UNC location provided in the SOURCEPATH. USEILOSAVED Possible value: <string> Uses an install set with the provided name saved on the iLO Repository as a baseline for the nodes. Gen10 servers only. USESUDO Possible values: YES, NO Allows use of the sudo command. Specifies that username and password for a remote node are sudo user credentials. When you specify USESUDO in the Input file along with username and password, then the username and password are considered sudo credentials. VCENTER_HOST Enter the IP address for the VMware vCenter. Use this command with VMware ESXi nodes to generate a ticket from VMware vCenter server that is in lockdown mode. VCENTER_PASSWORD Enter the password to log in to the VMware vCenter. See VCENTER_HOST for more information. VCENTER_USERNAME Enter the username to log in to the VMware vCenter. See VCENTER_HOST for more information. Downloading SUM and components from the SDR If you are using a Linux system, you can download SUM as an RPM from the SDR. You can download and install SUM and components from the SDR using common YUM commands. For more information about downloading and installing SUM as an RPM, see Linux best practices: Using Service Pack for ProLiant (SPP) and Software Delivery Repository (SDR) at: http://www.hpe.com/info/spp/documentation For information on using the SDR, see: https://www.hpe.com/servers/sdr