hpsum(8) USER COMMANDS hpsum(8) NAME hpsum - HP Smart Update Manager Interactive CLI mode hpsum Interactive Command Line Interface [options] Abort abort safely terminates any command. If you do not pass any specifics, the HP SUM terminates the command as soon as it is safe. hpsum abort --nodes 100.2.3.4 100.2.4.5 hpsum abort --baselines /root/hpsum/spp Activate activate enables you to activate updates previously staged or installed. This may involve rebooting or other processes based on spe- cific devices. hpsum activate --nodes a.b.c.d a.b.c2.d2 Add add enables you to add baselines or nodes to the current working set for the current session. hpsum add --nodes N1 user= password= x.x.x.x y.y.y.y hpsum add [--nodes n1 type= user= pass- word=] NOTE: Do not assign baselines in the same command as nodes. Delete delete enables you to delete both selected and non-selected baselines or nodes (or all) from the current session. You cannot delete a base- line if it is assigned to a node and HP SUM is performing inventory on the node or deploy the node. hpsum delete [--nodes ] hpsum delete [--baselines ] NOTE: Do not delete a baseline and node in the same command. Deploy deploy enables you to perform the deployment for nodes in the current working set for the current session. If you do not specify any nodes, the default is all in the currently selected list. hpsum deploy [--nodes [nodelist]] FindAvailableNodes findavailablenodes enables you to search the network for available nodes. To be available, you must be able to reach nodes and another management system must not have exclusive control of the nodes. This command searches the range of IP addresses provided and accepts an optional port. hpsum findavailablenodes --type ip|LDAP|port [ipAddrLow ipAddrHi] [port] GenerateReports generatereports enables you to generate reports for the HP SUM session. These reports include inventory, node firmware, node installables, failed dependency details, and installed details. The output defaults to attributes values and the type of report to all available. hpsum generatereports [--type inventory | firmware | installables | faileddep | installed | combined] [--output html | xml | csv] [--nodes --baselines ] Getattributes getattributes enables you to view any of the attributes for the selected node. You can change attributes using the SetAttributes com- mand. hpsum getattributes [--nodes [nodelist] GetBaselines getbaselines enables you to show the list of the baselines in the cur- rent HP SUM session. hpsum getbaselines [--details] [--list hp.com] GetComponentLogs getcomponentlogs enables you to view the component logs for a node. hpsum getcomponentlogs [--nodes [--component ]] GetEngineStatus getenginestatus enables you to retrieve the status information of the HP SUM session. hpsum getenginestatus GetCurrentlyInstalledVersions getcurrentlyinstalledversions enables you to get the currently installed versions of components on nodes in the current HP SUM ses- sion. hpsum getcurrentlyinstalledversions [--nodes [nodelist]] GetLogs getlogs launches the GatherLogs function for HP SUM. hpsum getlogs Getneededupdates getneededupdates enables you to see the details of needed updates based on either the state of the current selections or items passed in as part of the command. If you do not specify any nodes, the command uses those currently selected in the session. hpsum getneededupdates [--nodes [nodelist]] GetNodes getnodes enables you to show the list of the nodes in the current HP SUM session. hpsum getnodes [--nodes [nodelist --details]] Inventory inventory enables you to scan nodes for the currently installed version of firmware, drivers, and hardware components. hpsum inventory [--nodes ] [--baselines ] Login The Login command enables you to set the credentials used for the cur- rent session. Authenticating with credentials for the first time: hpsum login [--username --password ] [--port ] [--ssl_port ] Authenticating with current credentials: hpsum login Schedule Enables you to schedule an installation for one or more nodes or update baselines. hpsum schedule [--nodes [nodelist] [--baselines [baselinelist]] date- timestring Setattributes setattributes enables you to change the attributes of an HP SUM node or session. This command might return an invalid parameter notice if the permissions are not correct, or if either the parameter is not part of the requested set or if the value is not allowed. You can set the following node attributes: force, rewrite, down- grade, action, delay, username, password, baseline, ignore_warn- ings, and message (reboot message). You can see the following session attribute: open_firewall You can set the following Superdome 2 attributes: update_all=[ALL/COMPLEX/PARTITIONS], ignore_warnings, device_list, reboot_list. hpsum setattributes [--nodes N1] attribute1=value1 attribute2=value2 ShutdownEngine shutdownengine enables you to terminate the HP SUM engine. If other sessions are active, this fails unless you use the --force option. CAUTION: Using --force can cause loss of information. hpsum shutdownengine [--force] Command Line Interface You can use the HP SUM command-line interface to script custom instal- lations. The general command-line syntax for HP SUM is as follows: hpsum [/s] [/h] [/f]:bundle] [/r]eboot NOTE: On a Windows system, use a slash before each argument. On a Linux system, 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 charac- ter set will not be displayed correctly DESCRIPTION HP Smart Update Manager recognizes the following command line argu- ments. These arguments pre-populate the GUI in the Select Items to be Installed screen. If /silent or /s command line arguments are apeci- fied, HPSUM runs in silent mode without any GUI or console messages. If no command line arguments are provided on the command line, the HP Smart Update Manager(HPSUM) GUI appears. OPTIONS To start HP SUM in interactive GUI mode: hpsum [--port <#>] [--ssl_port <#>] [--open_firewall] To use Interactive Command Line Interface: hpsum [--help | --h] For hpsum Interactive Command-Line Interface information: hpsum --help to access the built-in hpsum documentation. For hpsum CLI information: hpsum --s [--help | --h] /h[elp] or /? This argument displays command line Help information. /f[orce] This argument overrides or downgrades an existing component installation. This argument produces the same results as /f:software. /f[orce]:bundle This argument overrides or downgrades the existing installation of components in the selected bundle. /f[orce]:rom This argument enables you to override or downgrade the existing installation of the selected firmware components. (Applies to firmware only.) /f[orce]:software This argument enables you to override or downgrade the existing installation of the selected software components. (Applies to software only.) /f[orce]:all This argument enables you to override or downgrade the existing installation of the selected software components, firmware com- ponents, and bundles. /g or /downgrade This argument enables you to downgrade to an earlier version of firmware for multi-target devices such as hard drives and array controllers. (Applies to firmware only.) /e or /rewrite This argument enables you to rewrite the same version of firmware only for multi-target devices such as hard drives and array controllers. (Applies to firmware only.) /port Changes the port HP SUM uses for the internal HTTP server from 63001 to the selected port. /ssl_port Changes the port HP SUM uses for the internal HTTPS server from 63002 to the selected port. /open_firewall HP SUM uses the iptables command to open the HTTP and HTTPS ports used by HP SUM for external access. Open these ports for remote node functionality and for remote browser access. /offline_automatic This runs an HP SUM update automatically in offline mode. /offline_interactive This runs an HP SUM update in interactive GUI mode. /r[eboot] If the following conditions are met, then this argument causes the server (or host server in a remote installation) to reboot: * The /reboot option is selected or given as a command-line argument. * All components selected for installation are successfully installed. * At least one of the installed components requires a reboot to complete its installation. /reboot_message "reboot message" This argument displays the specified reboot message on remote consoles connected to the server you want to reboot. You must use this argument with the /reboot option or the argument is ignored. /reboot_delay timeout_in_secs This argument delays the reboot of the server for the length of time specified by the timeout_in_seconds variable.You must use this argument with the /reboot option, or the argument is ignored. Acceptable values are between 15 and 3600. * The default timeout value is 15 seconds for Microsoft Win- dows operating systems and 60 seconds for Linux. * 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 This argument forces the server to reboot if the following con- ditions are met: * The /reboot_always option is selected or given as a command line argument. * All components selected for installation were successfully installed. /s[ilent] This argument causes the installation to run silently with no GUI or console output. All data writes to the log file. Any gen- erated prompts use the default option and continue the installa- tion without user input. If a component requires input before installation (such as configuration information), then the com- ponent installation fails, and an error message writes to the log file. Failed dependencies are not reported to the user when using the /s[ilent]argument. To check for failed dependencies, remove the /s[ilent] argument, reissue the command line, and then the HP SUM GUI appears. /c[omponent] or This argument specifies components to install. Components to install can be specified with or without the /c[omponent] argu- ment. * If using the /c[omponent] argument, then only one component can be specified with the argument. However, multiple /c argu- ments and components can be specified on the same line. * If the /c[omponent] argument is not used,then multiple com- ponents 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. * The components are installed in the order provided unless dependencies between components require installation in a dif- ferent 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. * Multiple components and bundles can be specified on the same command line. When mixing components and bundles on the command line, the filter switches control what components and bundles are installed. * 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 check both the default repository and the directory provided. /group "group_name" This argument specifies an already defined group name in the HP Smart Update Manager graphical user interface. /b[undle] or This argument specifies bundles to install. Bundles to install can be specified with or without the /b[undle] argument. * If using the /b[undle] argument, then only one bundle can be specified with the argument. However, multiple /b arguments and bundles can be specified on the same line. *If the /b[undle] argument is not used, multiple bundles can be specified at the same time, but the bundles need to be sepa- rated by a blank and listed after all the arguments on the com- mand line. Multiple components and bundles can be specified on the same command line. When mixing components and bundles on the command line, the filter switches control what components and bundles are installed. /allow_update_to_bundle This argument is a filter switch and enables the user to install newer versions of components defined in an SPP, ISP, or firmware bundle. This argument enables these components to replace the older versions of the same component that might have shipped with the bundles. /allow_non_bundle_components This argument is a filter switch and enables the user to install components which are not included in the bundle but reside in the directory with the components in the bundle. /use_latest This argument is a filter switch for use with bundles. The argu- ment enables the latest version of the bundle to be used when multiple versions of bundles are listed 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 Smart Update Manager to use the bundle with the latest version for installation. /use_location "file_share" This argument specifies a directory or file share that contains the SPP, ISP and components for use with HP Smart Update Manager. The "file_share" format must be a mapped file share and not in Universal Naming Convention (UNC) format.If this argument is not specified, the directory containing hpsum.bat or HP Smart Update Manager is used by default. 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 arguments, HP SUM uses current credentials to access the share. /unc_username Specifies the username credentials to access the file share. /unc_password Specifies the password credentials to access the file share. /tpmbypass or /ignore_tpm These arguments specifies that if a Trusted Platform Module (TPM) is enabled, the warning message should be ignored and com- ponent installation will be allowed to continue. /ignore_warnings Allows the installation to proceed on a Linux or HP-UX node which is an 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. /use_snmp This argument specifies that components, which use SNMP protocol and the AMS components are available to be selected for instal- lation. These components are available for selection by default. When the /use_snmp argument is used, the AMS components are required, but /use_wmi argument is not, the WMI components are optional. This enable both components(SNMP&AMS) in HPSUM if they are present to install. /use_wmi This argument specifies that components, which use WMI protocol, are available to be selected for installation. These components are optional by default and are not installed unless this argu- ment is used. When the /use_wmi argument is used, and the /use_snmp & /use_ams arguments are not, the SNMP and AMS compo- nents are optional. This argument does not apply to HP Integrity Servers. /use_ams This argument specifies that components, which AMS components that available to be selected for installation along with SNMP components. These components(AMS and SNMP) are available for selection by default. When the /use_ams argument is used, and the SNMP components are required, but /use_wmi argument is not, the WMI components are optional. This enable both compo- nents(AMS and SNMP) in HPSUM if they are present to install. /romonly This argument is a filter switch and allows the user to only see the firmware components needed for installation. When using this filter switch, you must exit and restart HP Smart Update Manager if you wish to return to an unfiltered state. Do not use the /romonly argument with the /softwareonly argu- ment.(Applies to firmware only.) /softwareonly This argument is a filter switch and allows the user to only see the software components needed for installation. When using this filter switch, you must exit and restart HP Smart Update Manager if you wish to return to an unfiltered state. Do not use the /softwareonly argument with the /romonly argu- ment. /dryrun This argument simulates the installation for a test run. Nothing is installed. /continue_on_error This argument causes the installation to continue and ignore errors. Valid values are : * =ServerNotFound and * =BadPassword. * =FailedDependencies The ServerNotFound option can be used to bypass inactive or unavailable remote hosts when deploy- ing firmware or software to multiple remote hosts at the same time. /override_existing_connection This argument is used to define the behavior when a remote tar- get has an existing HP Smart Update Manager session in progress. It overrides the session in progress and reinitializes the installation framework on the remote host. /express_install Starts a Guided Update installation for the local host and cur- rent directory only. HP SUM launches the default browser, per- forms inventory on the current baseline directory and localhost, deploys, and exits without user interaction. No reboot is issued unless specifically requested by adding the /reboot parameter. /user or /username This argument enables you to log in to the remote node(except for the OA node) with the user ID. For the OA node, see /oa_username argument. /passwd This argument enables you to use this password for the user ID specified in the /user parameter (except for the OA node). The password is used to log in to remote targets. For the OA node, see /oa_password argument. /current_credential This argument enables the credential of the local host to be used as the credential to access the targets instead of provid- ing the username and password explicitly for each node. The assumption is that the current credential is valid for the tar- gets being accessed. (Applies to Windows® only) /su_username Use root (super user) username to start a session, and inventory and update components when the credentials specified in /user- name and /passwd do not have root privileges to update compo- nents. /su_username cannot be used with /use_sudo access level. Note: Specifying /targettype linux or hp-ux reduces inventory time for deployments. This is an optional command line argument. /su_password Use root (super user) password to start a session, and inventory and update components when the credentials specified in /user- name and /passwd do not have root privileges to update compo- nents. /su_password cannotb e used with /use_sudo access level. Note: Specifying /targettype linux or hp-ux reduces inventory time for deployments. This is an optional command line argument. /use_sudo Specifies that username and passwd are sudo user credentials. When you specify /use_sudo in the CLI along with username and password, then username and password are considered as sudo credentials. /use_sudo cannot be used with /su_username and /su_password access level. Note: Specifying /targettype linux or hp-ux reduces inventory time for deployments. This is an optional command line argument. /target "netAddress" This argument is the IP address or the DNS name of a remote host which can be remote server, remote iLO NIC port, Virtual Connect Ethernet or Fibre Channel Module for c-Class BladeSystem, or BladeSystem Onboard Administrator(OA). When two Onboard Admin- istrators are in an enclosure, this argument should be the active Onboard Administrator.When specifying the IP address, you can use either the IPv4 or IPv6 format. /targettype "type" REduces inventory time for scripted deployments. This is an optional command line argument. The following are valid node types: * Server * Windows * Linux * HPUX * EVA or Command View for EVA * FC Switch or Fibre Channel Switch * OA or Onboard Administrator * SUPERDOME 2, SUPERDOME2, OR SUPERDOME 2 Onboard Administrator * iLO * Moonshot * VC or Virtual Connect * HP SAS or HP SAS B/L Interconnect Switch * VMware or VMware Host * iPDU or Intelligent Power Distribution Unit /logdir "path" This argument enables you to redirect the output from HP Smart Update Manager or the HP BladeSystem c-Class Onboard Administra- tor flash utility to a different directory than the default location. * For Windows® components, the default location is %SYSTEM- DRIVE%\CPQSYSTEM\hp\log and the redirected location is \hp\log\. *For Linux components, the default location is /var/hp/log/ and the redirected location is /hp/log/. /v[erbose] or /veryv[erbose] These arguments enable you to set the verbosity level for the HP Smart Update Manager execution log file, hpsum_execu- tion_log__