HP Smart Update Manager CLI Help Copyright (c) 2009, 2012 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP 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. HP shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Valid license from HP 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. Acknowledgments Microsoft(R), Windows(R), Windows Vista(R), and Windows Server(R) are U.S. registered trademarks of Microsoft Corporation. June 2012 ---------------------------------------------------------------------- Table of Contents 1 Using scripts to deploy updates 1.1 Command-line interface 1.1.1 Command-line syntax 1.1.2 Command-line arguments 1.1.3 Component configuration for Windows components only 1.1.4 Command-line examples 1.1.5 Return codes 1.1.6 Windows smart-component return codes 1.1.7 Linux smart-component return codes 1.1.8 Linux RPM return codes 1.2 Input files 1.2.1 Input file format and rules 1.2.2 File encoding 1.2.3 Error reporting 1.2.4 Input file parameters 1.3 Reports Chapter 1 Using scripts to deploy updates Table of Contents 1.1 Command-line interface 1.1.1 Command-line syntax 1.1.2 Command-line arguments 1.1.3 Component configuration for Windows components only 1.1.4 Command-line examples 1.1.5 Return codes 1.1.6 Windows smart-component return codes 1.1.7 Linux smart-component return codes 1.1.8 Linux RPM return codes 1.2 Input files 1.2.1 Input file format and rules 1.2.2 File encoding 1.2.3 Error reporting 1.2.4 Input file parameters 1.3 Reports 1.1 Command-line interface You can use the HP SUM command-line interface 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 [/h[elp]] [/?] [/f[orce]] [/f[orce]:bundle] [/f[orce]:rom] [/f[orce]:software] [/f[orce]:all ] [/g (/downgrade)] [/e (/rewrite) [/r[eboot]] [/reboot_message "reboot message"] [/reboot_delay timeout_in_seconds] [/reboot_always] [/s[ilent]] [/c[omponent] ] [/group "group_name"] [/b[undle] ] [/allow_update_to_bundle] [/allow_non_bundle_components] [/use_latest] [/use_location "file_share"] [/use_web] [/use_d[ownloaded]] [/tpmbypass] [/ignore_tpm] [/use_snmp] [/use_wmi] [/use_ams][/romonly] [/softwareonly] [/dryrun] [/continue_on_error ] [/override_existing_connection] [/express_install] [/user or /username ] [/passwd ] [/current_credential] [/target "netAddress"] [/logdir "path"] [/v[erbose]] [/veryv[erbose]] [/report][/inventory_report] [/firmware_report] [/On_failed_dependency:] [/oa_username ] [/oa_password ] [/use_proxy ] [/proxy_script ] [/proxy_user ] [/proxy_passwd ][/inputfile "filename"] [/c[omponent] ][ ...][ ...] The following commands are supported only by Superdome 2 servers: [/update_type ] [/device_list ] [/reboot_list ] 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. [Note] Note: All parameters and information enclosed in brackets are optional. The parameters may be prefixed with either a hypen (-) or slash (/) character. These examples show only the slash. On Windows operating systems, use a slash before each argument. On Linux operating systems, use a hyphen before each argument. If the /s[ilent] argument is not included on the command line, the HP SUM GUI appears. [Note] 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. The following table shows what updates occur if no switches are currently installed. +------------------------------------------------------------------------+ | Command | G7 and earlier | Gen8 servers | | | servers | | |---------------------------+-----------------------+--------------------| | no switches | SNMP | AMS | |---------------------------+-----------------------+--------------------| | /use_ams | N/A | AMS | |---------------------------+-----------------------+--------------------| | /use_snmp | SNMP | SNMP | |---------------------------+-----------------------+--------------------| | /use_wmi | WBEM | WBEM | |---------------------------+-----------------------+--------------------| | /use_ams /use_snmp | SNMP | AMS and SNMP | |---------------------------+-----------------------+--------------------| | /use_ams /use_wmi | 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 | | | +------------------------------------------------------------------------+ The following table shows what updates occur if SNMP switches are currently installed. +------------------------------------------------------------------------+ | Command | G7 and earlier | Gen8 servers | | | servers | | |---------------------------+----------------------+---------------------| | no switches | SNMP | SNMP | |---------------------------+----------------------+---------------------| | /use_ams | SNMP | SNMP and AMS | |---------------------------+----------------------+---------------------| | /use_snmp | SNMP | SNMP | |---------------------------+----------------------+---------------------| | /use_wmi | WBEM and SNMP | WBEM and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_snmp | SNMP | AMS and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | WBEM and SNMP | AMS, SNMP, 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 | | | +------------------------------------------------------------------------+ The following table shows what updates occur if WBEM switches are currently installed. +------------------------------------------------------------------------+ | Command | G7 and earlier | Gen8 servers | | | servers | | |---------------------------+----------------------+---------------------| | no switches | WBEM | WBEM | |---------------------------+----------------------+---------------------| | /use_ams | WBEM | WBEM and AMS | |---------------------------+----------------------+---------------------| | /use_snmp | WBEM and SNMP | WBEM and SNMP | |---------------------------+----------------------+---------------------| | /use_wmi | WBEM | WBEM | |---------------------------+----------------------+---------------------| | /use_ams /use_snmp | WBEM and SNMP | AMS, SNMP, and WBEM | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | WBEM | WBEM and AMS | |---------------------------+----------------------+---------------------| | /use_wmi /use_snmp | WBEM and SNMP | WBEM and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | WBEM and SNMP | AMS, SNMP, and WBEM | | /use_snmp | | | +------------------------------------------------------------------------+ The following table shows what updates occur if AMS switches are currently installed. +------------------------------------------------------------------------+ | Command | G7 and earlier | Gen8 servers | | | servers | | |---------------------------+----------------------+---------------------| | no switches | N/A | AMS | |---------------------------+----------------------+---------------------| | /use_ams | N/A | AMS | |---------------------------+----------------------+---------------------| | /use_snmp | N/A | AMS and SNMP | |---------------------------+----------------------+---------------------| | /use_wmi | N/A | AMS and WBEM | |---------------------------+----------------------+---------------------| | /use_ams /use_snmp | N/A | AMS and SNMP | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | N/A | AMS and WBEM | |---------------------------+----------------------+---------------------| | /use_wmi /use_snmp | N/A | AMS, SNMP, and WBEM | |---------------------------+----------------------+---------------------| | /use_ams /use_wmi | N/A | AMS, SNMP, and WBEM | | /use_snmp | | | +------------------------------------------------------------------------+ [Note] Note: G7 and earlier servers do not support AMS. 1.1.2 Command-line arguments HP SUM recognizes the following command-line arguments, which you can use to pre-populate the GUI on the Source Selection and Review/Install Updates screens. If you specify the target and credentials, use the /s[ilent] parameter to proceed with the installation. 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. | |---------------------------------------+--------------------------------| | | Downgrades to an earlier | | | version of firmware for | | /g or /downgrade | multi-target devices such as | | | hard drives and array | | | controllers (applies to | | | firmware only). | |---------------------------------------+--------------------------------| | | Downgrades to an earlier | | | version of firmware for | | /e or /rewrite | multi-target devices such as | | | hard drives and array | | | controllers (applies to | | | firmware only). | |---------------------------------------+--------------------------------| | | Causes the installation to run | | | silently with no GUI or | | | console output. All data | | | writes to the log file. Any | | | generated prompts use the | | | default option and continue | | | the installation without user | | | input. If a component requires | | | input before installation | | | (such as configuration | | | information), then the | | /s[ilent] | component installation fails, | | | and an error message writes to | | | the log file. | | | | | | Failed dependencies are not | | | reported to the user when you | | | are using the /s[ilent] | | | argument. To check for failed | | | dependencies, remove the | | | /s[ilent] argument and reissue | | | the command line. The HP SUM | | | GUI appears. | |---------------------------------------+--------------------------------| | | 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, | | | 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, | | | then multiple components | | | can be specified at the | | | same time, but the | | | components must be | | | separated by a blank and | | | listed after all the | | /c[omponent] or | 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. | |---------------------------------------+--------------------------------| | | This argument specifies an | | /group "group_name" | already defined group name in | | | the HP SUM GUI. | |---------------------------------------+--------------------------------| | | This argument specifies | | | bundles to install. Bundles to | | | install can be specified with | | | or without the /b[undle] | | | argument. | | | | | | o If you are using the | | | /b[undle] argument, only | | | one bundle can specified | | | with the argument. | | /b[undle] or | However, multiple /b | | | arguments and bundles can | | | be specified on the same | | | line. | | | | | | o If you do not use the | | | /b[undle] argument, | | | multiple bundles can be | | | specified at the same | | | time, but the bundles must | | | be separated by a blank | | | and listed after all the | | | arguments on the command | | | line. | |---------------------------------------+--------------------------------| | | 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. | |---------------------------------------+--------------------------------| | | 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. | |---------------------------------------+--------------------------------| | | 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 PSP, | | | ISP, and components for use | | | with HP SUM. The file_share | | | format must be a mapped file | | | share and not in 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" | | | | The logged-in account must | | | have access to this location. | | | | | | The /user and /passwd | | | arguments do not have any | | | effect when you are attempting | | | to access the file share. Use | | | those arguments only when you | | | are connecting to a target | | | system. | |---------------------------------------+--------------------------------| | | Specifies that the check box | | | for Check ftp.hp.com on the | | | Source Selection screen is | | /use_web | selected. This enables | | | components to be retrieved | | | from ftp.hp.com and used in | | | the list of possible updates. | |---------------------------------------+--------------------------------| | | Enables the inclusion of a | | | proxy server (and port number) | | | to access ftp.hp.com. This | | /use_proxy | parameter must be used with | | | /use_web. For example, | | | /use_web /use_proxy | | | <1.22.33.44:80>. | |---------------------------------------+--------------------------------| | | Enables the inclusion of a | | | proxy script to access | | /proxy_script | ftp.hp.com. This parameter | | | must be used with /use_web. | | | For example, /use_web | | | /proxy_script . | |---------------------------------------+--------------------------------| | | Sets the password to be used | | /proxy_password | for an authenticating proxy | | | server. | |---------------------------------------+--------------------------------| | | Specifies that the check box | | | for Use last downloaded | | | repository from ftp.hp.com on | | | the Source Selection screen in | | /use_d[ownloaded] | the GUI is selected. This | | | enables the previously | | | downloaded components to be | | | included in the list of | | | possible updates. | |---------------------------------------+--------------------------------| | | 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. | |---------------------------------------+--------------------------------| | | Starts an express installation | | | (for the local host only). The | | | HP SUM performs discovery, | | | installation, or exit without | | | user interaction. You can | | | cancel or terminate HP SUM. An | | | express installation will | | | force install all components | | | in the default repository and | | /express_install | may downgrade drivers and | | | firmware to the versions in | | | the default directory as part | | | of the installation operation. | | | The express installation | | | feature allows you to set a | | | baseline and enforce it | | | regardless of the currently | | | installed version of drivers | | | and firmware on the local | | | server. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | 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 | | /ignore_warnings | a Superdome 2 target even when | | | warnings are returned during analysis. | |-------------------------------+----------------------------------------| | | 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 | | | target has an existing HP SUM session | | /override_existing_connection | in 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 Omit_Host (default), | | | Omit_Component , and Force. Omit_Host | | /On_failed_dependency: | causes the host to be put into a | | | failure state, and no installation is | | | attempted. Omit_Component 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. | |-------------------------------+----------------------------------------| | | Use this argument to select a | | | partition to update. | | /partition_only | | | | This command is for HP Integrity | | | servers only. | |-------------------------------+----------------------------------------| | | Use these arguments if you do not use | | | the /partition_only argument. If you | | | do not enter the selections, then the | | /oa_name and /oa_password | update will display and error and | | | exit. | | | | | | This command is for HP Integrity | | | servers only. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Reboot options | Description | |-------------------------+----------------------------------------------| | | If the following conditions are met, this | | | argument causes the server (or host server | | | in a remote installation) to reboot: | | | | | | o The /reboot option is selected or given | | | as a command-line argument. | | /r[eboot] | | | | 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 | o The default timeout value is 15 seconds | | timeout_in_secs | 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. | |-------------------------+----------------------------------------------| | | If the following conditions are met, this | | | argument forces the server to reboot: | | | | | /reboot_always | 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 | Simulates the installation for a test run. Nothing | | | is installed. | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | Targets | Description | |------------------------------+-----------------------------------------| | | Use this argument to log in to the | | /user or /username | remote targets by using the user ID. | | | For the OA target, use the /oa_username | | | argument. | |------------------------------+-----------------------------------------| | | Use this argument to use this password | | | for the user ID specified in the /user | | /psswd | parameter (except for the OA target). | | | The password is used to log in to | | | remote targets. For the OA target, use | | | the /oa_password 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 BladeSystem, or | | /target "netAddress" | 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. | |------------------------------+-----------------------------------------| | | Enables the credential of the local | | | host to be used as the credential to | | | access the targets instead of providing | | /current_credential | the user name and password explicitly | | | for each target. The assumption is that | | | the current credential is valid for the | | | targets 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 targets to command-line | | | parameters with the target parameter | | | only if the credentials of OAs | | | associated with specified VCs are the | | /oa_username | same. The argument oa_username is not | | | required if VC has the same credentials | | | as the associated OA. You do not need | | | to provide an OA network address | | | associated with VC. HP SUM queries it | | | from a specified VC target. | | | | | | 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 | | | "target" command-line parameter. Only | | | one set of OA credentials can be | | | specified with command-line parameters. | | | You can add multiple VC targets to | | | command-line parameters with the | | | "target" parameter only if the | | | credentials of OAs associated with | | | specified VCs are the same. The | | /_password | argument oa_password is not required if | | | VC has the same credentials as the | | | associated OA. You do not need to | | | provide an OA network address | | | associated with VC. HP SUM queries it | | | from a specified VC target. | | | | | | 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 . | +------------------------------------------------------------------------+ +------------------------------------------------------------------------+ | 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. | | | | | | o For Windows components, the default location is | | /logdir "path" | %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__