﻿HP Smart Update Tools OnDemand Help
Copyright 2015 Hewlett-Packard Development Company, L.P.

Version 1.0.1

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

Chapter 1 Using the OnDemand Mode to stage and deploy updates

   To view this file use a text browser, such as Notepad or Vi.

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

   When running as a service from the host server, HP SUT polls HP 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 User's 
   Guide, HP SUT documentation website at:
   http://www.hp.com/go/hpsut/documentation


1.1 Command-line interface

   When running in On Demand mode, HP SUT waits for a user command from the
   command-line to execute requests.
   
  1.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 
                    


  1.1.2 Command-line arguments

   HP SUT recognizes the following command-line arguments:
                            
   +---------------------------------------------------------+
   |     Help      |               Description               |
   |---------------+-----------------------------------------|
   | /help or /? | Displays command line help information.   |
   +---------------------------------------------------------+

   +------------------------------------------------------------------------+
   |         Option          		   |          Description           |
   |---------------------------------------+--------------------------------|
   |                                       |Provides the status of the      |
   | /status                               |HP SUT engine depending on the  |
   |                                       |current state. This	command     |
   |                                       |can be used by both OV and OS   |
   |					   |administrators from the HOST    |
   |					   |system where HP SUT is          |
   |					   |installed.			    |	
   |---------------------------------------+--------------------------------|
   | /stage			           |Determines which components need|	
   |                                       |to be applied on the node and   |
   |					   |copies those components to the  |
   |					   |stage directory.		    |
   |---------------------------------------+--------------------------------|
   | /deploy		                   |Deploys files. 		    | 
   |---------------------------------------+--------------------------------|
   | /deployreboot                         |Performs a reboot after	    |
   |                                       |deploying files only if any of  |
   |					   |the components require a reboot.|
   |---------------------------------------+--------------------------------|
   | 		                           |Sets the polling interval HP SUT|								
   | /pollingintervalinminutes             |looks at for requests. The      |
   |					   |default is 5 minutes.           |
   |---------------------------------------+--------------------------------|
   | /set                        	   |Allows you to make changes to   |
   |					   |different options in HP SUT.    |
   |					   |Possble values are:		    |
   |					   |o -set mode			    |
   |					   |o -set stagingdirectory	    |
   |					   |o -set rebootmessage	    |
   |					   |o -set rebootdelay		    |
   |					   |o -set baselineuri		    |
   |---------------------------------------+--------------------------------|
   |                                       |Allows you to specify the 	    |
   | /set stagingdirectory=<dir_path>      |directory in which components   |
   | 					   |are staged.                     |
   |---------------------------------------+--------------------------------|
   |                                       |The command clears the staging  |
   |                                       |directory when it is executed.  |
   | /clearstaging      		   |This command is allowed in the  |
   |                                       |InstalledPendingReboot and      | 
   |                                       |Activated stages.               |
   |---------------------------------------+--------------------------------|
   |                                       |Takes the config file name as a |
   |                                       |parameter and sets all settings |
   |                                       |per the config file. This       | 
   |					   |command is allowed in the       |
   | /importconfig                         |following states:               |
   |                                       | 				    |
   |                                       |o StageFailed 		    |
   |                                       |o InstallFailed 		    |
   |                                       |o Activated 		    |
   |                                       |o ActivatedFailed 		    |
   | 		                           |o InstallPending Reboot 	    |
   |---------------------------------------+--------------------------------|
   |                                       |Takes the config file name as a |
   | /exportconfig                         |parameter and writes all HP SUT |
   |                                       |setting values to the file. This|
   |                                       |command is allowed in all       |
   |                                       |states.			    |
   |---------------------------------------+--------------------------------|
   |                                       |Allows you to specify if you    |
   | /set savelogs=<true|false>            |to save generated log files.    |
   |                                       |log files.When set to "true",   |
   |					   |HP SUT stores the logs. The     |
   |					   |syntax for this command is:     |
   |					   | -set savelogs=true		    |
   |					   | -set savelogs=false            |
   |---------------------------------------+--------------------------------|
   | /set tpmbypassflag=<true|false>       |Allows you to stage or deploy   |
   |					   |when Trusted Platform Module is |
   |					   |enabled. When set to "true",    |
   |					   |HP SUT will stage and deploy    |
   |				           |even if TPM is enabled. The     |
   |					   |syntax for this command is:     |
   |					   | -set tpmbypassflag=true        |
   |					   | -set tpmbypassflag=false       |
   |---------------------------------------+--------------------------------|	
   |                                       |Used to activate deployed       |
   | /activate		                   |components by rebooting the node|
   |                                       |if a reboot is required. The    |
   |					   |command is allowed in           |
   |                                       |"InstalledPendingReboot" state. |
   |					   |Command asks user confirmation, |
   |					   |before rebooting. User can pass |
   |					   |optional parameter "force" to   |
   |					   |avoid this confirmation step.   |
   |                                       |                                |
   |                                       |Command asks user confirmation  |
   |					   |before rebooting. User can pass |
   |					   |optional parameter "force"      |
   |					   |to avoid this confirmation step |
   |---------------------------------------+--------------------------------|
   |					   |				    |
   | /verify				   |Moves the state to "activated"  |
   |					   |if a reboot has happened after  |
   |					   |deployment.			    |
   |					   |				    |
   |---------------------------------------+--------------------------------|
   |					   |Starts the service if the mode  |
   | /start				   |is in AutoState, AutoDeploy,    |
   |					   |or AutoDeployReboot.	    |
   |---------------------------------------+--------------------------------| 
   |					   |				    |
   | /stop				   |Stops running the hpsut service.|
   |					   |				    |
   |---------------------------------------+--------------------------------|
   |					   |				    |
   | /version				   |Displays the hpsut version.     |
   |					   |				    |
   |---------------------------------------+--------------------------------| 

  
  1.1.3 Command-line examples

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

   hpsut /stage

   Results: Copy the files from the iso into the OS staging area i.e. "Staging Directory" 
   in HP SUT setting namespace and displays the report. Also, copies the HP SUM 
   files to the staging directory since the TEMP directory may be cleaned up between 
   reboots or RDP connections. By default the staging directory should be under APPDATA.

   Other associated commands:
   hpsut /set stagingdirectory
   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 "InstalledPendingReboot" state.

   hpsut /activate

   Other associated commands:
   hpsut /verify
   Results: These commands allow you to move the state of the node to activated after
   a server reboot.

   Example 4:

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

   hpsut /set pollingintervalinminutes=10

   
1.2 Download HP SUT and components from the SDR

   If you are using a Linux system, you can download HP SUT as an RPM from
   the HP SDR.

   For information on using the SDR, go to http://www.hp.com/go/sdr.


Chapter 2 Changing HP SUT mode

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

   The modes can be:
   AutoStage
   AutoDeploy
   AutoDeployReboot
   OnDemand

   When changing from OnDemand to Auto* modes, the hpsut service will be started. 
   When changing from Auto* to OnDemand mode, the hpsut service will be stopped.