User's Guide Express5800 Series NEC ESMPRO Manager Ver.6 Command Line Interface for NEC ExpressUpdate Chapter1 About Command Line Interface Chapter2 XML interface Chapter3 Component management Chapter4 Group management Chapter5 ExpressUpdate Chapter6 Log management Chapter7 Troubleshooting Chapter8 Terminology Chapter9 Appendix Ver.1.
Contents Contents............................................................................................................................................................. 1 Trademarks ........................................................................................................................................................ 3 About This Document .......................................................................................................................................
5.3.1 Repository settings ................................................................................................................. 54 5.3.2 Adding update packages to repository.................................................................................... 58 5.3.3 Removing update packages from repository .......................................................................... 59 5.3.4 Saving update packages......................................................................................
Trademarks NEC EXPRESSBUILDER and NEC ESMPRO are registered trademarks of NEC Corporation. Microsoft, Windows, Windows Vista, Windows Server are registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. All other company, or product names used in this document are registered trademarks or trademarks of their respective trademark owners. Windows 8.1 stands for Windows® 8.1 Pro 64-bit Edition, Windows® 8.1 Pro 32-bit Edition, Windows® 8.
About This Document This document introduces command line interface of NEC ExpressUpdate. It is a function of the component management utility "NEC ESMPRO Manager". Before attempting to operate the command line interface, read this document so as to gain an adequate understanding of the contents. Attention This document is intended for persons who are familiar with the operating system's functions and operations and the network's functions and setup.
Chapter1 About Command Line Interface 1.1 Overview This document provides information about a Command Line Interface to NEC ExpressUpdate. This interface is executed by 'esmcli' command. IMPORTANT: 'esmcli' command does not have a function to registering a component to NEC ESMPRO Manager. In case of registering a component, please use NEC ESMPRO Manager's Web interface. In case of CLI, following characters are not available in group name.
1.3 Configuring examples When the client PC is different from the management PC, log in to the management PC using remote desktop, Telnet/SSH clients, etc.
1.4 Using the command line All commands in this document are executed by 'esmcli' command. When you install NEC ESMPRO Manager, 'esmcli' command is also installed on the following directories. Windows OS: C:¥Program Files¥ESMPRO¥ESMMNG¥bin This path is added to the system environment variable "PATH". CHECK: The Windows path varies if NEC ESMPRO Manager is not installed in the default location. Linux OS: /opt/nec/es_manager/bin A symbolic link to 'esmcli' is created on /usr/bin directory.
Examples When you specify the encrypted password, please input as follows. See 1.4.4Encrypting of the password. esmcli -u Administrator -p {ENC}c10f239c9f7d203fa4424bffb06b6713 When the log in is successful, 'esmcli' prompt is displayed. NEC ESMPRO Manager Version6 Copyright (C) 2004-2014 NEC Corporation. All Rights Reserved. -> 1.4.1.2 Logging out of the shell mode To exit the shell mode, enter the exit command or input Ctrl + C. -> exit 1.4.1.
1.4.2 One liner mode The one liner mode executes only specified CLI command without starting the shell function of esmcli. To execute the one liner mode, enter a CLI command following to a username and password from a command line as shown below. And please input user name and password of NEC ESMPRO Manager. Please refer to "1.5Basic commands" for the CLI command to execute.
1.4.3 XML scripting mode XML scripting mode enables you to write esmcli commands and some arguments in an XML file and execute it. To obtain the information of XML format, refer to "9.1.1XML Schema for request file". esmcli –f [Option] esmcli Option Indicates the NEC ESMPRO Manager command line interface command Specifies XML file in which esmcli commands are written. Input an option. There are following types of option.
1.4.4 Encrypting of the password The esmclipasswd command is used for encrypting of the password. To encrypt the password, enter the command following the command prompt as shown below. esmclipasswd [Option] esmclipasswd Option Indicates the NEC ESMPRO Manager command line interface command Input an option. There are following types of option. -h | -help Display the command syntax of the esmclipasswd command. When this option is appointed, the password doesn't encrypt.
1.5 Basic commands This section describes basic commands. These basic commands are based on SMASH style proposed by DMTF (Distributed Management Task Force). Help string, command syntax, of each command appears when "-h | -help" option is specified as the of the command. The argument placed between "[" and "]" is omissible. TIP: In the case of the user authority is Administrator, the user can execute all basic commands.
delete Syntax delete [] [] Description The delete command is used to remove a target. When you omit , the delete command will delete current target. load Syntax load [] [] Description The load command is used to take a binary image from a specific source location and place it at the specified target address. reset Syntax reset [] [] Description The reset command resets the target’s state.
1.5.1 Target Each basic command functions to a specified target. The target points the managed element by address path much like the path to a file in a file system. Both absolute path, which is started from "/", and relative path are available for pointing the target. Specifically, "." and ".." are supported. The "." means the current default target and the ".." means the parent target. Specifying the target, enter following to each basic command.
Examples (1) Shows only targets Show -d Targets (2) Shows target whose name is “server01” and supported commands. show -d targets=server01,verbs (3) Shows property whose name is “Name” or “Status”, and shows supported commands. show -d properties=(Name,Status),verbs -o | -output (,…) Description Specifies a format of output data. format=text | clpxm If set to "text", output is in text format. If set to "clpxml", output is in XML format. 1.5.
1.6 Example of command output All commands shows results as following format. -> results -> Each status is listed in below table. Status COMMAND COMPLETED COMMAND PROCESSING FAILED COMMAND EXECUTION FAILED Table 1-2 Statuses Description Command was successful. Following commands skips to show this status. cd exit help how Syntax error was occurred. Command was unsuccessful.
1.7 Diagram of the entire address space A diagram of the entire address space is as follow.
/ grps grpset expup modules supportedmods managedmods unsupportedmods 18
/ repository localsetting remotesetting uppkgs readme logs 19
Chapter2 XML interface 2.1 Execution of XML 2.1.1 Overview This function enables you to write a command and arguments into a request XML file and execute the file instead of "Shell mode" or "One liner mode". An XML schema of the request XML is described in "9.1.1XML Schema for request file". 2.1.2 XML elements Standard contents of the request XML are as below. Details of those elements are described in Table 2-1.
Name of element request COMMAND abort instance ufip options option properties property name value val include file Table 2-1 Elements of request XML Description A root element of request XML. An element specifying a basic command. An element specifying a behavior in case of error. If set to true, the process is stopped. If set to false, the process runs on. If this element does not exist, true is used. This setting is only used when multi commands are defined in a request XML.
Example Execute 'dump' command to /logs and save logs to C:¥temp. ->dump –destination C:¥temp /logs /logs Example Execute 'set' command to /repository and change RepositoryLocation to LOCAL. -> set /repository RepositoryLocation=LOCAL
2.1.4 Override process Specifying '-override' option with the esmcli, following elements of an XML file will be overridden. ・ ufip element ・ val element belonging to option element ・ val element belonging to property element The overridden element is specified by absolute path separated by '/'. To specify some elements, describe them separated by ','. ・ esmcli –f filename.
2.1.5 Include process A request XML can include other request XML and execute its commands. To use this function, create an element under element and specify included file using element. filename.xml true More than one element can be specified. In the following case, filename1.xml is executed and then filename2.xml is executed.
2.2 Output XML data 2.2.1 Overview If an argument "-o | -output format=clpxml" is specified, output is in XML format. An XML schema of the XML is described in "9.1.2XML Schema for response file". 2.2.2 XML elements Standard contents of the response XML are as below. A format of element is different from each basic commands. Details of other elements are described in Table 2-2.
Name of element response command inputline cmdstat status status_tag error error_tag COMMAND target instance ufit ufip properties property name value val source destination uri help text examine verbs standardverbs oemdata exitcode result Table 2-2 Elements of response XML Description A root element of response XML. An element holding information of the command. An element holding an input command line. An element grouping a status of command. An element holding a status code.
2.2.3.2 delete UFiP identifying target. Recursive target elements representing Managed Elements contained in the initial target. 2.2.3.3 dump Full path of source of dump Full path of destination of dump 2.2.3.4 exit 2.2.3.5 help Free-form text 2.2.3.
2.2.3.7 set UFiP identifying target A modified property of Managed Element. 2.2.3.8 show UFiP identifying target A property of Managed Element Standard commands supported at the target. OEM commands supported at the target.
Chapter3 Component management 3.1 Component information 3.1.1 Showing a list of components 'show' command at following target shows a list of all managed components. /cmps Properties of this target are as follow. There is no specified command for this target. Property EntryCount Status ExpUpStatus Table 3-1 Properties of '/cmps' Access Description read Displays a number of registered components. read Displays a representative status of all of the components.
3.1.2 Showing component information 'show' command at following target shows information of managed component. /cmps/ Properties of this target are as follow. There is no specified command for this target. Property Name Status ExpUpStatus Group IpAddress BmcIpAddress Model SerialNumber Guid OsVersion Table 3-2 Properties of '/cmps/' Access Description read Displays a name of the component. read Displays a representative status of all of the components.
Chapter4 Group management 4.1 Group information 4.1.1 Showing a list of groupset 'show' command at the following target shows a list of groupset. /grps Property of this target is as follow. There is no specified command for this target. Property EntryCount Table 4-1 Properties of '/grps' Access Description read A number of registered groupset. Example 'show' command shows a list of groupset. More concrete examples are as follows.
4.1.2 Showing information of groupset 'show' command at the following target shows information of groupset. /grps/ Properties of this target are as follow. There is no specified command for this target. Property Name RootGroup Table 4-2 Properties of '/grps/' Access Description read Displays a name of groupset. read Displays root group's name. Example 'show' command shows information of a groupset. More concrete examples are as follows.
4.1.3 Showing information of group 'show' command at the following target shows information of a group. /grps// Properties of this target are as follow. There is no specified command for this target. Table 4-3 Properties of '/grps//' Access Description read Displays a name of the group. read Displays a status of the group. read Displays an ExpressUpdate status of the group. read Displays a number of groups belonging to the group.
Followings are example of the below hierarchy diagram.
Chapter5 ExpressUpdate 5.1 ExpressUpdate information 5.1.1 Displaying ExpressUpdate information 5.1.1.1 Information of components 'show' command at the below target enables you to view ExpressUpdate information about the specified component. /cmps//map/expup Properties and specific commands of this target are as follows. Table 5-1 Properties of '/cmps//map/expup' Access Description read Displays ExpressUpdate statuses. Each status is listed in Table 5-2.
Command load stop Table 5-3 Specific commands of '/cmps//map/expup' Description Updates all modules of to the latest version. Refer to section 5.2.1.1 for more information. Cancels all update command to . Refer to section 5.2.4.1 for more information. Example `show /cmps//map/expup` command enables you to view ExpressUpdate information of the component .
Command load stop Table 5-5 Specific commands of '/grps/grpset//expup' Description Updates all modules of components belonging to the specified group to the latest version. Refer to section 5.2.1.3 for more information. Cancels all update command to . Refer to section 5.2.4.2 for more information. Example `show /grps/grpset//expup` command enables you to view ExpressUpdate information of the group.
Example `show /cmps/ /map/expup/mods` command enables you to view a list of modules for the specified component. -> show /cmps/Server01/map/expup/modules/supportedmods/managedmods ufip=/cmps/Server01/map/expup/modules/supportedmods/managedmods ufit=managedmods Targets: "System BIOS" "BMC Firmware" "NEC ExpressUpdate Agent" Properties: EntryCount=3 Verbs: cd exit help show 5.1.2.
5.1.3 Displaying a list of modules not supporting automatic update 5.1.3.1 Information of components A list of modules not supporting automatic update for the specified component is displayed at the below target. /cmps//map/expup/modules/unsupportedmods Property of this target is as follow. There is no specified command for this target.
5.1.3.2 Information of groups A list of modules not supporting automatic update for the specified group is displayed at the below target. /grps/grpset//expup/modules/unsupportedmods Property of this target is as follow. There is no specified command for this target. Table 5-9 Property of '/grps/grpset//expup/modules/unsupportedmods' Property Access Description EntryCount read Displays a number of modules managed by ExpressUpdate.
5.1.4 Information of module supporting automatic update 5.1.4.1 Information of components Information about each module supporting automatic update is displayed at the below target. /cmps//map/expup/modules/supportedmods/managedmods/ Properties and specific commands of this target are as follows. Table 5-10 Properties of '/cmps//map/expup/modules/supportedmods/man agedmods/' Property Access Description Module read Displays a name of this module.
5.1.4.2 Information of groups Information about each module is displayed at the below target. /grps/grpset//expup/modules/supportedmods/managedmods/ Properties and specific commands of this target are as follows. Table 5-12 Properties of '/grps/grpset//expup/modules/supportedmods/manage dmods/' Property Access Description Module read Displays a name of this module. ExpUpStatus read Displays ExpressUpdate status of this module.
5.1.5 Information of module not supporting automatic update 5.1.5.1 Information of components Information about each module not supporting automatic update is displayed at the below target. /cmps//map/expup/modules/unsupportedmod/ Properties and specific commands of this target are as follows. Table 5-14 Properties of '/cmps//map/expup/modules/unsupportedmod/< Module Name>' Property Access Description Module read Displays a name of this module.
5.1.5.2 Information of groups Information about each module is displayed at the below target. /grps/grpset//expup/modules/unsupportedmods/ Properties and specific commands of this target are as follows. Table 5-16 Properties of '/grps/grpset//expup/modules/s unsupportedmods/' Property Access Description Module read Displays a name of this module. ExpUpStatus read An ExpressUpdate status of the moduls.
5.2 Update, install and uninstall 5.2.1 Update modules supporting automatic update 5.2.1.1 For the specified component 'load' command at the below target enables you to update all modules to the latest version. /cmps//map/expup Specific option of this command is as follow. Option -reboot Table 5-17 Specific option of '/cmps/ /map/expup' Description Enables ExpressUpdate to reboot the system if the update requires it.
TIP: If the update has been finished, the result is shown in LatestApplyResult property of `show /cmps//map/expup/modules/supportedmods/managedmods/` command. LatestApplyResult=2011/04/01 12:00:00 Applying the update package has been completed successfully. (NEC ExpressUpdate Agent: 2.0 -> 3.0) 5.2.1.
5.2.1.3 For the specified group 'load' command at the below target enables you to update all modules of components belonging to the specified group. Refer to the section 5.1.4.1 for more information about this target. /grps/grpset//expup Specific option of this command is as follow. Option -exclude -reboot Table 5-19 Specific options of '/grps/grpset//expup' Description Specifies components or groups that are not included in this operation.
5.2.2 Install commands 'load' command at below target enables you to install a module. Refer to the section 5.1.4.1 for more information about this target. /cmps//map/expup/modules/supportedmods/managedmods/ Specific option of this command is as follow. Table 5-21 Specific options of '/cmps//map/expup/modules/supportedmod s/managedmods/' Option Description -source Specifies the update package.
5.2.3 Uninstall commands 'delete' command enables you to uninstall a module. Refer to the section 5.1.4.1 for more information about this target. /cmps//map/expup/modules/supportedmods/managedmods/ Specific option of this command is as follow. Table 5-22 Specific option of '/cmps//map/expup/modules/supportedmods/ managedmods/' Option Description -reboot Enables ExpressUpdate to reboot the system if the uninstallation requires it.
5.2.4 Cancelling update commands 5.2.4.1 For components 'stop' command at below targets enables you to cancel updates. Refer to the section 5.1.1.1 for more information about this target. /cmps//map/expup There is no specific option for this command. CHECK： In the case of the user authority is Operator, "Install Update Packages" of the user level must be enabled. TIP: This command effects only waiting tasks. A task which has been started is unable to be cancelled.
5.2.5 Update modules not supporting automatic update Procedures for applying update packages not supporting automatic update are as below. 1. Copy the update package to be applied as an update package archive on your client PC. 2. Pick up the update package from an update package archive and apply it. How to apply the update package is described in the readme file included in the update package. 5.2.5.
5.2.5.2 For the specified component and update package 'dump' command at the below target enables you to copy update packages related to specified component and update package. /cmps//map/expup/modules/unsupportedmods//uppkgs/ Table 5-26 Properties of '/cmps//map/expup/modules/unsupportedmods/< Module Name>/uppkgs/' Property Access Description Module read Displays the name of firmware or software.
Table 5-28 Specific options of ' dump /cmps//map/expup/modules/unsup portedmods//uppkgs/'5 Option Description -destination Specifies the path to the directory or zip file where the update package archive to be copy. -f | -force If an existing file path is specified, remove it and create new file.
5.3 Repository and Update package management 5.3.1 Repository settings Repository settings are located at the following target. /repository Properties and specific commands of this target are as follows. Property RepositoryLocation UpdatePackageServerAddress UpdatePkgLatestDownloaded TotalSizeOfUpdatePackage FreeSpace Command set load stop Table 5-29 Properties of '/repository' Access Description read/write Displays and sets location of the repository.
When you modify location of the repository in local, run the following command. set /repository RepositoryLocation=LOCAL Examples When you modify location of the repository in remote, run the following command in the remote repository settings have been set. set /repository RepositoryLocation=REMOTE CHECK： When you set RepositoryLocation in REMOTE, you should set remote repository settings beforehand. See 5.3.1.2Remote repository settings.
Command set BLUE RED BLACK Table 5-32 Specific commands of '/repository/localsetting' Description Sets local repository settings properties. Examples 'show' command enables you to view local repository settings.
5.3.1.2 Remote repository settings Remote repository settings are located at the following target. /repository/remotesetting Properties and specific commands of this target are as follows. Table 5-33 Properties of '/repository/remotesetting' Property Access Description RemoteRepositoryAddress read/write Sets OS IP address of the other Manager PC. RemoteRepositoryPort read/write Sets port number of the other Manager PC.
RemoteRepositoryPassword In the case of the user authority is Operator, "Change Environment Setting" of the user level must be enabled. Examples When you add -force option, properties are set by force. set -force /repository/remotesetting RemoteRepositoryAddress=192.168.0.111 5.3.2 Adding update packages to repository 'load' command at below targets enables you to add or download update packages. /repository Specific command of this target is as follow. There is no property for this target.
Examples When you stop monitoring during downloading, press "Ctrl + D" key and return to the input prompt. -> load -wait /repository Downloading update packages. Press Ctrl + D to stop monitoring. ... Monitoring was stopped. Run the show command to the repository and you can confirm the command's result from UpdatePkgLatestDownloaded property. Examples 'load -source' command enables you to add update packages to repository. Specify the path of the update package file.
CHECK： In the case of the user authority is Operator, "Change Environment Setting" of the user level must be enabled. TIP： When you delete by force, update packages in use by other Manager PC can be removed. 5.3.3.2 Removing the update package Removing update package is located at the following target. /repository/uppkgs/ Specific command of this target is as follow. There is no property for this target.
5.3.4 Saving update packages 5.3.4.1 Saving update packages all together Saving update packages all together is located at the following target. /repository/uppkgs Specific option of this command is as follow. Option -destination -f | -force Table 5-43 Specific options of 'dump /repository/uppkgs' Description Specifies the path to the directory or zip file where the update package archive to be copy. If an existing file path is specified, remove it and create new file.
5.3.5 Update packages information 5.3.5.1 Update packages informatioin Information about update packages is located at the following target. /repository/uppkgs Specific option of this command is as follow. Table 5-45 Specific options of 'dump /repository/uppkgs/' Option Description -d | -display euform=cmp Displaying ExpressUpdate information by component. -d | -display euform=model Displaying ExpressUpdate information by model.
5.3.5.2 The update package information Information about the update package is located at the following target. /repository/uppkgs/ Property of this target is as follow. There is no specified command for this target. Table 5-46 Properties of '/repository/uppkgs/' Property Access Description Module read Displays the name of firmware or software. Version read Displays the version of the update package. Release read Displays the release date of the update package.
Examples 'show' command enables you to view information about the update package. -> show /repository/uppkgs/"NEC ExpressUpdate Agent_Windows_3.00_20110302171440" ufip=/repository/uppkgs/ "NEC ExpressUpdate Agent_Windows_3.00_20110302171440" ufit="NEC ExpressUpdate Agent_Windows_3.00_20110302171440" Targets: readme Properties: Module=NEC ExpressUpdate Agent Version=3.
5.3.5.3 Readme file information After saving the readme file, you can view the readme file written notes about the update package. Information about the readme file in the update package is located at the following target. /repository/uppkgs//readme Specific command of this target is as follow. There is no property for this target. Table 5-47 Specific command of '/repository/uppkgs//readme' Command Description dump Saves the readme file to specified directory.
Chapter6 Log management 6.1 Logging You can get the following logs. NEC ESMPRO Manager application log NEC ExpressUpdate Agent log 6.1.1 Application log list Information of NEC ESMPRO Manager application logs is located at the following target. /logs Properties and specific commands of this target are as follows. Property EntryCount MaxEntryCount Command dump Option -destination Table 6-1 Properties of '/logs' Access Description read Displays the number of application log.
Examples 'dump' commands enable you to save application logs to the specified directory. Add -destination option, and specify the directory path to save file. The following shows an example. -> dump -destination C:¥temp COMMAND COMPLETED C:¥temp¥LOG.zip If you want to save the application log file any name, specify the zip file name to the path and execute commands. dump -destination C:¥temp¥application_log.zip /logs When you add -force option, the zip file is overwritten.
6.1.3 NEC ExpressUpdate Agent log Information of NEC ExpressUpdate Agent log is located at the following target. /cmps//map/agtlogs/expupagtlog IMPORTANT： In , specify the component that the update function via NEC ExpressUpdate Agent is effective. To get NEC ExpressUpdate Agent log, NEC ExpressUpdate Agent must be running. Specific command of this target is as follow. There is no property for this target.
Chapter7 Troubleshooting This section describes the error message and the coping method for it. 7.1 Error message Table 7-1 Error messages What to do Please confirm the user name and the password, and please input again. Failed to connect to NEC ESMPRO Windows OS: Manager. Please confirm that the NEC ESMPRO Manager service (ESMPRO/SM Common Component) is running. Error Message User name or password is not correct. Linux OS: Please confirm that the following process is running by `ps aux` command.
Chapter8 Terminology Term CLI BMC DMTF SMASH Address Space Managed Element UFiT UFiP Component NEC ExpressUpdate NEC ExpressUpdate Agent Module Update package Update package server Repository Table 8-1 Terminology Description Command Line Interface Baseboard Management Controller The management controller to manage the interface between system management software and platform hardware. Distributed Management Task Force An industry standard body that defines WBEM standards for the industry.
Chapter9 Appendix 9.1 XML Schema 9.1.1 XML Schema for request file XML schema of the request XML is as below. PAGE 73 PAGE 74
73
9.1.2 XML Schema for response file XML schema of the response XML is as below. PAGE 76
<
PAGE 81Revision History 1.00 1.01 2011/05/11 2012/07/20 1.02 1.03 2013/02/13 2014/01/06 1.04 2014/08/04 Initial edition. Added request/response XML function. Added descriptions for a management function of update packages that does not support automatic update. Added "FreeSpace" property to "Repository settings". Fixed a cross-reference link error. Added the Windows OS. Fixed NEC ESMPRO Manager’s version description. NEC ESMPRO Manager Ver.
