﻿                      HP Smart Update Tools OnDemand Help

Version 1.6.5.0 Windows and Linux

     ----------------------------------------------------------------------

   Copyright (c) 2015, 2016 Hewlett Packard Enterprise Development LP

   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.

     ----------------------------------------------------------------------

1 Overview

   This file is best viewed in a text browser, such as Notepad or vi.

   HP Smart Update Tools (HP SUT) runs on Windows and Linux and provides an
   online, non-disruptive mechanism to stage and deploy operating system
   drivers and firmware on the server hardware. HP SUT can be run as a
   service in three different Auto modes or in OnDemand mode from the
   command-line interface. The default mode is OnDemand.

   When running as a service from the host server, HP SUT polls HPE OneView
   every five minutes for new requests and processes those requests based on
   the mode.

   For more information on using HP SUT, see the HP Smart Update Tools Users
   Guide on the HP SUT Information Library at:
   http://www.hpe.com/info/hpsut/docs.

   For information on using the Hewlett Packard Enterprise SDR, go to
   http://www.hpe.com/info/sdr/.

2 Using OnDemand mode

2.1 Command-line interface

   When running in OnDemand mode, HP SUT waits for a user command from the
   command-line to execute requests, show the help, and check the status of
   updates.

  2.1.1 Command-line syntax

   The general command-line syntax for HP SUT is as follows:

   hpsut [/status]

      ---------------------------------------------------------------------   
    NOTE: On both Windows and Linux, use a slash or hyphen before each        
    argument.                                                                 
                                                                              
    For example:                                                              
                                                                              
    hpsut /status                                                             
                                                                              
    hpsut -status                                                             
      ---------------------------------------------------------------------   

  2.1.2 Command-line arguments

   HP SUT recognizes the following command-line arguments:

   +------------------------------------------------------------------------+
   | Option                   | Description                                 |
   |--------------------------+---------------------------------------------|
   |                          | Used to activate deployed components by     |
   |                          | rebooting the node if a reboot is required. |
   |                          | The command is allowed in the               |
   | /activate                | InstalledPendingReboot state. The command   |
   |                          | asks for user confirmation before           |
   |                          | rebooting. You can pass the optional        |
   |                          | parameter force to avoid this confirmation  |
   |                          | step.                                       |
   |--------------------------+---------------------------------------------|
   |                          | Clears the staging directory. This command  |
   | /clearstaging            | is allowed in the InstalledPendingReboot    |
   |                          | and Activated stages.                       |
   |--------------------------+---------------------------------------------|
   | /deploy                  | Deploys files.                              |
   |--------------------------+---------------------------------------------|
   |                          | Performs a reboot after deploying files     |
   | /deployreboot            | only if any of the components require a     |
   |                          | reboot.                                     |
   |--------------------------+---------------------------------------------|
   |                          | Uses the config file name as a parameter    |
   | /exportconfig            | and writes all HP SUT setting values to the |
   |                          | file. This command is allowed in all        |
   |                          | states.                                     |
   |--------------------------+---------------------------------------------|
   | /help-or-/?              | Displays command-line help information.     |
   |--------------------------+---------------------------------------------|
   |                          | Uses the config file name as a parameter    |
   |                          | and sets all settings per the config file.  |
   |                          | This command is allowed in the following    |
   |                          | states:                                     |
   |                          |                                             |
   |                          |   o StageFailed                             |
   | /importconfig            |                                             |
   |                          |   o InstallFailed                           |
   |                          |                                             |
   |                          |   o Activated                               |
   |                          |                                             |
   |                          |   o ActivatedFailed                         |
   |                          |                                             |
   |                          |   o InstalledPendingReboot                    |
   |--------------------------+---------------------------------------------|
   |                          | Imports HPE keys into HP SUT. This command  |
   |                          | can be used if there are new components     |
   | /importkeys              | released with new HPE signatures after HP   |
   |                          | SUT is released and staging fails with      |
   |                          | "Signature Validation Error."               |
   |--------------------------+---------------------------------------------|
   |                          | Allows you to make changes to different     |
   |                          | options in HP SUT. Possible values are:     |
   |                          |                                             |
   |                          |   o -set mode                               |
   |                          |                                             |
   |                          |   o -set pollingintervalinminutes           |
   | /set                     |                                             |
   |                          |   o -set rebootdelay                        |
   |                          |                                             |
   |                          |   o -set rebootmessage                      |
   |                          |                                             |
   |                          |   o -set stagingdirectory                   |
   |                          |                                             |
   |                          |   o -set tpmbypassflag                      |
   |--------------------------+---------------------------------------------|
   |                          | Sets the polling interval HP SUT uses for   |
   | /set                     | requests. The default is 5 minutes.         |
   | pollingintervalinminutes |                                             |
   |                          |   o -set pollingintervalinminutes=<VALUE>   |
   |--------------------------+---------------------------------------------|
   |                          | Allows you to specify if you want to save   |
   |                          | generated log files. When set to true, HP   |
   |                          | SUT stores the logs. The syntax for this    |
   | /set savelogs            | command is:                                 |
   |                          |                                             |
   |                          |   o -set savelogs=true                      |
   |                          |                                             |
   |                          |   o -set savelogs=false                     |
   |--------------------------+---------------------------------------------|
   |                          | Allows you to specify the directory in      |
   | /set stagingdirectory    | which components are staged.                |
   |                          |                                             |
   |                          |   o /set stagingdirectory=<dir_path>        |
   |--------------------------+---------------------------------------------|
   |                          | Allows you to stage or deploy when Trusted  |
   |                          | Platform Module(TPM) is enabled. When set   |
   |                          | to true, HP SUT will stage and deploy even  |
   |                          | if TPM is enabled. The syntax for this      |
   | /set tpmbypassflag       | command is:                                 |
   |                          |                                             |
   |                          |   o -set tpmbypassflag=true                 |
   |                          |                                             |
   |                          |   o -set tpmbypassflag=false                |
   |--------------------------+---------------------------------------------|
   |                          | Determines which components need to be      |
   | /stage                   | applied on the node and copies those        |
   |                          | components to the staging directory.        |
   |--------------------------+---------------------------------------------|
   | /start                   | Starts the HP SUT service if the mode is in |
   |                          | AutoStage, AutoDeploy, or AutoDeployReboot. |
   |--------------------------+---------------------------------------------|
   |                          | Provides the status of the HP SUT engine    |
   |                          | depending on the current state. It shows    |
   | /status                  | the status for BIOS and storage tasks       |
   |                          | separately. This command can be used by     |
   |                          | both HPE OneView and OS administrators from |
   |                          | the host system where HP SUT is installed.  |
   |--------------------------+---------------------------------------------|
   | /stop                    | Stops the HP SUT service if it is running.  |
   |--------------------------+---------------------------------------------|
   | /verify                  | Moves the state to Activated if a reboot    |
   |                          | has occurred after a deployment.            |
   |--------------------------+---------------------------------------------|
   | /version                 | Displays the HP SUT version.                |
   +------------------------------------------------------------------------+

  2.1.3 Command-line examples

   Example 1

   This command-line input determines which components need to be applied on
   the node.

   hpsut /stage

   Results: This command copies the applicable components and files from the
   SPP into the staging directory. It also copies the HP SUM files to the
   staging directory because files in the TEMP directory might be removed
   between reboots or RDP connections. By default, the staging directory
   should be under APPDATA.

   Other associated commands:

   hpsut /clearstaging

   Results: These commands allow you to specify a staging directory and clear
   the current staging directory, respectively.

   Example 2

   This command-line input queries HP SUT to determine what its current state
   is.

   hpsut /status

   Example 3

   This command-line input activates deployed components by rebooting the
   node if a reboot is required. This command is allowed in the
   InstalledPendingReboot state.

   hpsut /activate

   hpsut -activate force

   Other associated commands:

   hpsut /verify

   Results: This command allows you to move the state of the node to
   Activated after a server reboot.

   Example 4

   This command-line input sets the polling interval for how often HP SUT
   polls HPE OneView to check for new requests from the host server. The
   default is 5 minutes.

   hpsut /set pollingintervalinminutes=10

   Results: This command-line input changes the polling interval that HP SUT
   uses for requests from the default of 5 minutes to 10 minutes.

   Example 5

   This command-line input can be used if there are new components released
   with new HPE signatures after HP SUT is released and staging fails with
   "Signature Validation Error." The user must provide a directory location.
   This directory location can contain *.pub files that contain the public
   keys or a file in tar zipped format (*.tar.gz) that contains the *.pub
   files.

   hpsut /importkeys

   Results: This command-line input Imports HPE keys into HP SUT.

3 Changing the HP SUT mode

   The format of the set mode command is: hpsut -set mode=<MODE>

   The modes are:

   OnDemand - This is the default mode. Enables you to write requests as
   command-line arguments on the host server instead of letting HP SUT run as
   a service through HPE OneView. When changing HP SUT from Auto* to OnDemand
   mode, the HP SUT service is stopped.

   AutoStage - When a request is made by HPE OneView, HP SUT automatically
   stages the components on the host server in a temporary location. When
   changing from OnDemand to Auto* modes, the HPSUT service is started.

   AutoDeploy - When a request is made by HPE OneView, HP SUT stages and
   deploys the components, but does not activate them. Any further action
   requires that the user issue commands from the command line.

   AutoDeployReboot - When a request is made by HPE OneView, HP SUT
   automatically stages and deploys the components, and if one or more
   component requires a reboot, HP SUT reboots the server to activate them.
   When changing from OnDemand to Auto* modes, the HP SUT service is started.

4 Support and other resources

4.1 Documentation feedback

   Hewlett Packard Enterprise is committed to providing documentation that
   meets your needs. To help us improve the documentation, send any errors,
   suggestions, or comments to Documentation Feedback
   (<docsfeedback@hpe.com>). When submitting your feedback, include the
   document title, part number, edition, and publication date located on the
   front cover of the document. For online help content, include the product
   name, product version, help edition, and publication date located on the
   legal notices page.
