HP Smart Update Manager CLI Help Version 7.1.0 ---------------------------------------------------------------------- Chapter 1 Using the command line interface (CLI) to deploy updates To view this file use a text browser, for example Notepad or Vi. 1.1 Command-line interface You can use the HP SUM CLI to script custom installations. For more information on using HP SUM, see the HP Smart Update Manager User's Guide HP SUM documentation website at http://www.hp.com/go/hpsum/documentation. 1.1.1 Command-line syntax The general command-line syntax for HP SUM is as follows: hpsum [/s] [/h] [/f]:bundle] [/r[eboot] [NOTE] : On Windows, use a slash before each argument. On Linux, use a hyphen before each argument. For example: hpsum /s /h (Windows) hpsum -s -h (Linux) HP SUM with OA requires a user ID and password to log in. The user ID must be an administrator equivalent ID and not an operator or user equivalent level ID. Use the /s[ilent] argument for all commands, except when you use /express_install. [NOTE] : Command-line syntax does not support double-byte character sets. Any messages entered through the command line via a double-byte character set will not be displayed correctly. 1.1.1.1 Switch update commands G7 and earlier servers do not support AMS agents. The following tables show what updates occur when you use the switch agent commands. [NOTE] : To find out if you have any switches installed, use HP SUM to create the Firmware Details Report. The following table shows what updates occur if no switches are currently installed. +------------------------------------------------------------------------+ | Command | G7 and earlier | Gen8 servers | | | servers | | |---------------------------+----------------------+---------------------| | no switches | SNMP | AMS | |---------------------------+----------------------+---------------------| | /no_mgmt | Nothing | Nothing | |---------------------------+----------------------+---------------------| | /use_ams | SNMP | AMS | |---------------------------+----------------------+---------------------| | /use_snmp | SNMP | SNMP | |---------------------------+----------------------+---------------------| | /use_wmi | WBEM | WBEM | |---------------------------+----------------------+---------------------| | /use_ams /use_snmp | SNMP | AMS and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | SNMP and WBEM | AMS and WBEM | |---------------------------+----------------------+---------------------| | /use_wmi /use_snmp | WBEM and SNMP | WBEM and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | WBEM and SNMP | AMS, SNMP, and WBEM | | /use_snmp | | | +------------------------------------------------------------------------+ [NOTE] : G7 and earlier servers do not support AMS. 1.1.2 Command-line arguments HP SUM recognizes the following command-line arguments: [NOTE] : You cannot use some arguments, such as /romonly and /softwareonly, together. +---------------------------------------------------------+ | Help | Description | |---------------+-----------------------------------------| | /h[elp] or /? | Displays command line help information. | +---------------------------------------------------------+ +------------------------------------------------------------------------+ | Installation options | Description | |---------------------------------------+--------------------------------| | | Overrides or downgrades an | | | existing component | | /f[orce] | installation. This produces | | | the same results as | | | /f:software. | |---------------------------------------+--------------------------------| | | Overrides or downgrades the | | /f[orce]:bundle | existing installation of | | | components in the selected | | | bundle. | |---------------------------------------+--------------------------------| | | Overrides or downgrades the | | /f[orce]:rom | existing installation of the | | | selected firmware components | | | (applies to firmware only). | |---------------------------------------+--------------------------------| | | Overrides or downgrades the | | /f[orce]:software | existing installation of the | | | selected software components. | |---------------------------------------+--------------------------------| | | Overrides or downgrades the | | | existing installation of the | | /f[orce]:all | selected software components, | | | firmware components, and | | | bundles. | |---------------------------------------+--------------------------------| | /g or /downgrade | Downgrades to an earlier | | | version of components. | |---------------------------------------+--------------------------------| | /e or /rewrite | Rewrites the current version | | | of components. | |---------------------------------------+--------------------------------| | | Changes the port HP SUM uses | | /port | for the internal HTTP server | | | from 63001 to the selected | | | port. | |---------------------------------------+--------------------------------| | | Changes the port HP SUM uses | | /ssl_port | for the internal HTTPS server | | | from 63002 to the selected | | | port. | |---------------------------------------+--------------------------------| | | HP SUM uses the | | | command to open the HTTP and | | | HTTPS ports used by HP SUM for | | /open_firewall | external access. Open the | | | ports for remote node | | | functionality and for remote | | | browser access. | |---------------------------------------+--------------------------------| | /offline_automatic | Runs an HP SUM update | | | automatically in offline mode. | |---------------------------------------+--------------------------------| | /offline_interactive | Runs an HP SUM update in | | | interactive (GUI) mode. | |---------------------------------------+--------------------------------| | | Causes the installation to run | | /s[ilent] | silently with no GUI or | | | interactive CLI output. All | | | data writes to the log file. | | | HP SUM 6.0.0 and requires | | | silent mode for CLI commands. | |---------------------------------------+--------------------------------| | | Specifies which components to | | | install. Components to install | | | can be specified with or | | | without the /c[omponent] | | | argument. | | | | | | o If you are using the | | | /c[omponent] argument, | | /c[omponent] or | then only one component | | | can specified with the | | | argument. However, | | | multiple /c arguments and | | | components can be | | | specified on the same | | | line. | | | | | | o If you do not use the | | | /c[omponent] argument, | | | multiple components can be | | | specified at the same | | | time, but the components | | | must be separated by a | | | blank and listed after all | | | the arguments on the | | | command line. | | | | | | o The components are | | | installed in the order | | | provided unless | | | dependencies between | | | components require | | | installation in a | | | different order. If so, | | | the utility changes the | | | installation order based | | | on the component | | | dependencies to ensure the | | | successful installation of | | | as many components as | | | possible. | | | | | | o Multiple components and | | | bundles can be specified | | | on the same command line. | | | When you are mixing | | | components and bundles on | | | the command line, the | | | filter switches control | | | what components and | | | bundles are installed. | | | | | | o HP SUM only uses the | | | component name. If you | | | type the entire directory | | | path, HP SUM will ignore | | | the path. If you use | | | /use_location and /c, HP | | | SUM checks both the | | | default repository and the | | | directory provided. | |---------------------------------------+--------------------------------| | | This argument specifies an | | /group "group_name" | already defined group name in | | | the HP SUM GUI. | |---------------------------------------+--------------------------------| | | o If you are using the | | /b[undle] | /b[undle] argument, only | | | one bundle can specified | | | with the argument. || |---------------------------------------+--------------------------------| | | This argument is a filter | | | switch. It enables you to | | | install newer versions of | | | components defined in a PSP, | | | ISP, or firmware bundle. | | /allow_update_to_bundle | | | | This argument enables these | | | components to replace the | | | older versions of the same | | | component that might have | | | shipped with the bundles. | | | By default this is set to true.| |---------------------------------------+--------------------------------| | | This argument is a filter | | | switch. It enables you to | | /allow_non_bundle_components | install components that are | | | not included in the bundle but | | | reside in the directory with | | | the components in the bundle. | | | By default this is set to true.| |---------------------------------------+--------------------------------| | | This argument is a filter | | | switch for use with bundles. | | | The argument enables the | | | latest version of the bundle | | | to be used when multiple | | | versions of bundles are listed | | /use_latest | on the command line. If there | | | are no bundles specified on | | | the command line, and multiple | | | bundles are in the directory, | | | the /use_latest argument | | | allows HP SUM to use the | | | bundle that has the latest | | | version for installation. | |---------------------------------------+--------------------------------| | | Specifies a directory or file | | | share that contains the SPP, | | | HP Integrity Smart Update | | | Firmware Bundles, and | | | components for use with HP | | | SUM. The file_share format | | | must be a mapped file share or | | | UNC format. If this argument | | | is not specified, the | | | directory that contains | | | hpsum.exe or HP SUM is used by | | | default. | | /use_location "file_share" | | | | Make sure the logged-in | | | account has access to this | | | location. If the location is a | | | UNC file share, credentials to | | | the file share must be | | | provided using the | | | /unc_username and | | | /unc_password options. If you | | | do not provide these argument | | | HP SUM uses the current | | | credentials to access the | | | share. | |---------------------------------------+--------------------------------| | | Specifies the username | | /unc_username | credentials to access the file | | | share. | |---------------------------------------+--------------------------------| | | Specifies the password | | /unc_password | credentials to access the file | | | share. | |---------------------------------------+--------------------------------| | | Specifies that AMS, SNMP, and | | | WBEM Providers management | | | components are optional on the | | /no_mgmt | Components Selection screen. | | | In silent mode, HP SUM will | | | not update any management | | | components. | |---------------------------------------+--------------------------------| | | Specifies that components that | | | use SNMP protocol and the AMS | | | components are available for | | /use_snmp | installation by default. When | | | the /use_snmp argument is | | | used, the AMS components are | | | required, but the WMI | | | components are optional. | |---------------------------------------+--------------------------------| | | Specifies that components that | | | use the WMI protocol are | | | available for installation. | | | These components are optional | | | and are not installed unless | | | this argument is used. When | | /use_wmi | the /use_wmi argument is used, | | | and the /use_snmp & /use_ams | | | arguments are not, the SNMP | | | and AMS components are | | | optional. This argument does | | | not apply to HP Integrity | | | servers. | |---------------------------------------+--------------------------------| | | Specifies which AMS components | | | can be installed along with | | | SNMP components. The AMS and | | | SNMP components are available | | /use_ams | to select by default. When the | | | /use_ams argument is used, the | | | SNMP components are required, | | | and the WMI components are | | | optional. | |---------------------------------------+--------------------------------| | | This filter switch allows you | | | to see only the firmware | | | components needed for | | | installation. When you are | | | using this filter switch, you | | | must exit and restart HP SUM | | /romonly | if you want to return to an | | | unfiltered state. | | | | | | Do not use the /romonly | | | argument with the | | | /softwareonly argument. | | | (Applies to firmware only.) | |---------------------------------------+--------------------------------| | | This filter switch allows you | | | to see only the software | | | components needed for | | | installation. When you are | | | using this filter switch, you | | /softwareonly | must exit and restart HP SUM | | | if you want to return to an | | | unfiltered state. | | | | | | Do not use the /softwareonly | | | argument with the /romonly | | | argument. | |---------------------------------------+--------------------------------| | | If you run scripts that | | | contain this command, HP SUM | | | will execute this command the | | /express_install | same way it runs /silent. HP | | | SUM shuts down ten seconds | | | after the script finishes | | | running. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Overriding errors | Description | |-------------------------------+----------------------------------------| | | Specifies that if a TPM is enabled, | | | the warning message should be ignored | | /tpmbypass or /ignore_tpm | and component installation can | | | continue. For more information about | | | TPM, see the HP Smart Update Manager | | | User Guide. | |-------------------------------+----------------------------------------| | | Allows the installation to proceed on | | | a Linux of HP-UX node which is an | | | active menber of a Serviceguard | | /ignore_warnings | 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. | |-------------------------------+----------------------------------------| | | Causes the installation to continue | | | and ignore errors. Valid values are as | | | follows: | | | | | | * =ServerNotFound and | | | | | | * =BadPassword. | | /continue_on_error | | | | * =FailedDependencies | | | | | | You can use the ServerNotFound option | | | to bypass inactive or unavailable | | | remote hosts when you are deploying | | | firmware or software to multiple | | | remote hosts at the same time. | |-------------------------------+----------------------------------------| | | Defines the behavior when a remote | | | node has an existing HP SUM session in | | /override_existing_connection | progress. It overrides the session in | | | progress and re-initializes the | | | installation framework on the remote | | | host. | |-------------------------------+----------------------------------------| | | Provides HP SUM the | | | information on how to proceed when a | | | component has a failed dependency. The | | | supported parameters for this argument | | | are OmitHost (default), OmitComponent | | /On_failed_dependency: | , and Force. OmitHost causes the host | | | to be put 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 if they have dependency failures. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Reboot options | Description | |-------------------------+----------------------------------------------| | | If the following conditions are met, this | | | argument causes the server (or host server | | | in a remote installation) to reboot: | | | | | /r[eboot] | | | | o The /reboot option is selected or given | | | as a command-line argument. | | | | | | o All components selected for installation | | | are successfully installed. | | | | | | o At least one of the installed components | | | requires a reboot to complete its | | | installation. | |-------------------------+----------------------------------------------| | | Displays the specified reboot message on | | /reboot_message "reboot | remote consoles connected to the server that | | message" | you want to reboot. You must use this | | | argument with the /reboot option, or the | | | argument is ignored. | |-------------------------+----------------------------------------------| | | Delays the reboot of the server for the | | | length of time that the timeout_in_seconds | | | variable specifies. You must use this | | | argument with the /reboot option, or the | | | argument is ignored. Acceptable values are | | | between 15 and 3600. | | | | | /reboot_delay | | | timeout_in_secs | | | | o The default timeout value is 15 seconds | | | for Microsoft Windows operating systems | | | and 60 seconds for Linux. | | | | | | o For Linux, the reboot delay time is | | | converted from seconds to minutes, and | | | any value under a full minute (59 | | | seconds or less) rounds to the next | | | minute. | |-------------------------+----------------------------------------------| | | | | /reboot_always | If the following conditions are met, this | | | argument forces the server to reboot: | | | | | | o The /reboot_always option is selected or | | | given as a command-line argument. | | | | | | o All components selected for installation | | | are successfully installed. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Simulating HP SUM | Description | |-------------------+----------------------------------------------------| | /dryrun | This argument simulates the installation for a | | | test run. Nothing is installed. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Nodes | Description | |----------------------+-------------------------------------------------| | | Use this argument to log in to the remote nodes | | /user or | by using the user ID. | | /username | | | | The user name needs to belong to the root or | | | administrator group. | |----------------------+-------------------------------------------------| | /password | Use this argument to use this password for the | | | user ID specified in the /user parameter | | HP SUM also supports | (except for the OA node). The password is used | | passwd and pwd | to log in to remote nodes. | |----------------------+-------------------------------------------------| | | Use root (super user) username to start a | | | session, and inventory and update components | | | when the credentials specified in /username and | | | /passwd do not have root privileges to update | | | components. | | | | | /su_username | /su_username cannot be used with /use_sudo | | | access level. | | | | | | [NOTE] : | | | Specifying /targettype linux reduces | | | inventory time for deployments. This is | | | an optional command line argument. | |----------------------+-------------------------------------------------| | | Use root (super user) password to start a | | | session, and inventory and update components | | | when the credentials specified in /username and | | | /passwd do not have root privileges to update | | | components. | | | | | /su_password | /su_password cannot be used with /use_sudo | | | access level. | | | | | | [NOTE] : | | | Specifying /targettype linux reduces | | | inventory time for deployments. This is | | | an optional command line argument. | |----------------------+-------------------------------------------------| | | Specifies that username and passwd are sudo | | | user credentials. | | | | | | When you specify /use_sudo in the CLI along | | | with username and passwd, then username and | | | passwd are considered as sudo credentials. | | /use_sudo | | | | /use_sudo cannot be used with /su_username and | | | /su_password access level. | | | | | | [NOTE] : | | | Specifying /targettype linux reduces | | | inventory time for deployments. This is | | | an optional command line argument. | |----------------------+-------------------------------------------------| | | This is 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 | | /target "netAddress" | BladeSystem, or BladeSystem OA. | | | | | | When two OAs are in an enclosure, this argument | | | should be the active OA. When specifying the IP | | | address, use either the IPv4 or IPv6 format. | |----------------------+-------------------------------------------------| | | Reduces inventory time for scripted | | | deployments. This is an optional command line | | | argument. | | | | | | The following are valid node types: | | | | | | o Server | | | | | | o Windows | | | | | | o Linux | | | | | | o HPUX | | | | | | o EVA or Command View for EVA | | | | | | o FC Switch or Fibre Channel Switch | | | | | | o OA or Onboard Administrator | | /targettype "type" | | | | o SUPERDOME 2 or SUPERDOME2 or Superdome 2 | | | Onboard Administrator | | | | | | o iLO | | | | | | o iLOFederation | | | | | | o VC or Virtual Connect | | | | | | o HP SAS or HP SAS B/L Interconnect Switch | | | | | | o VMware or VMware Host | | | | | | o iPDU or Intelligent Power Distribution Unit | | | (iPDU) | | | | | | o Moonshot | | | | | | Use /targettype with /target parameter. You can | | | interchange the sequence of /targettype and | | | /target. If the node name includes spaces, make | | | sure you enclose the name in quotation marks, " | | | ". | | | | | | [NOTE] : | | | /targettype is an optional command line | | | argument. Use /targettype and /target | | | together. | |----------------------+-------------------------------------------------| | | Enables the credential of the local host to be | | | used as the credential to access the nodes | | /current_credential | instead of providing the user name and password | | | explicitly for each node. The assumption is | | | that the current credential is valid for the | | | nodes being accessed. (Applies to Windows only) | |----------------------+-------------------------------------------------| | | This argument provides the user name credential | | | for OA associated with VC specified with the | | | target command-line parameter. Only one set of | | | OA credentials can be specified with | | | command-line parameters. You can add multiple | | | VC nodes to command-line parameters with the | | | target parameter only if the credentials of OAs | | /oa_username | associated with specified VCs are the same. You | | | do not need to provide an OA network address | | | associated with VC. HP SUM queries it from a | | | specified VC node. | | | | | | To update multiple VCs with different user | | | names and passwords, or VCs with OAs that have | | | different credentials, use the corresponding | | | input files OAUID and OAPWD. | |----------------------+-------------------------------------------------| | | Provides the password credential for OA | | | associated with VC specified with the "node" | | | command-line parameter. Only one set of OA | | | credentials can be specified with command-line | | | parameters. You can add multiple VC nodes to | | | command-line parameters with the "node" | | | parameter only if the credentials of OAs | | /oa_password | associated with specified VCs are the same. You | | | do not need to provide an OA network address | | | associated with VC. HP SUM queries it from a | | | specified VC node. | | | | | | To update multiple VCs with different user | | | names and passwords, or VCs with OAs that have | | | different credentials, use the corresponding | | | input files OAUID and OAPWD . | |----------------------+-------------------------------------------------| | /switch_username | Use this command to specify Moonshot switch | | | credentials. | |----------------------+-------------------------------------------------| | /switch_password | Use this command to specify Moonshot switch | | | passwords. | |----------------------+-------------------------------------------------| | /switch_enable | Use this command to enable a Moonshot node. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Log files | Description | |----------------+-------------------------------------------------------| | | Redirects the output from HP SUM or the HP | | | BladeSystem c-Class OA flash utility to a different | | | directory than the default location. | | | | | /logdir "path" | | | | | | | o For Windows components, the default location is | | | %SYSTEMDRIVE%\CPQSYSTEM\hp\log and | | | the redirected location is | | | \hp\log\. | | | | | | o For Linux components, the default location is | | | /var/hp/log/ and the redirected | | | location is /hp/log/. | |----------------+-------------------------------------------------------| | | Sets the verbosity level for the HP SUM execution log | | /v[erbose] or | file, hpsum_execution_log__