Home

NEC Express5800/R110f-1E User Guide

1. esmcli u Administrator p ENC c10f239c9f7d203fa4424bffb06b6713 When the log in is successful esmcli prompt is displayed gt 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 gt exit 1 4 1 3 Keyboard Shortcuts This section describes keyboard shortcuts list Table 1 1 Keyboard Shortcuts Keyboard Shortcuts Description Enter Decision BackSpace Erase one character Tab Autocompletes from the cursor position Moves the cursor backward one character gt Moves the cursor forward one character T Recalls the prior command y Recalls the next command Ctrl B Moves the cursor backward one character equivalent to the key Ctrl F Moves the cursor forward one character equivalent to the key gt Ctrl A Moves the cursor to the line start Ctrl E Moves the cursor to the line end Ctrl G Move the cursor to the top of the word before one Because there are space and hyphen and directory separator or Y the word is discerned Ctrl P Recalls the prior command equivalent to the key T Ctrl N Recalls the next command equivalent to the key J Ctrl 1 Autocompletes from the cursor position equivalent to the key Tab Ctrl V P
2. Property Access Description ExpUpStatus read Displays ExpressUpdate statuses Each status is listed in Table 5 2 NextUpdateDate read Displays time and date of the next update if the update is scheduled by the remote batch function RepositoryLocation read Displays a location of the repository local remote UpdatePkgLatestDownloaded read Displays the most recent time when the repository was updated If updating has never been executed it shows None NextDownloadDate read Displays time and date of the next repository update if it is scheduled Table 5 2 ExpressUpdate statuses Status Description NOT_LATEST The repository has update packages newer than current version UNDER_INSTALLATION An updating is in progress UNDER_UNINSTALLING An uninstallation is in progress A progress ratio is also shown REBOOTING The update which requires rebooting the system is executed and rebooting is in progress It is not possible to update a module under this status REBOOT_REQUIRED This status shows that the system has not been rebooted yet although the update requires rebooting In this status the update has not been completed yet This status is cleared by rebooting the system It is not possible to update a module under this status LATEST_CONDITION The repository has no update package newer than current version INSTALLATION_FATLED This status shows that the last update comma
3. 59 CHECK e In the case of the user authority is Operator Change Environment Setting of the user level must be enabled TIP 5 3 3 2 Removing the update package Removing update package is located at the following target repository uppkgs lt uppkg name gt Specific command of this target is as follow There is no property for this target Table 5 41 Specific command of repository uppkgs lt uppkg name gt Command Description delete Removes update package Specific option of this command is as follow Table 5 42 Specific option of repository uppkgs lt uppkg name gt Option Description f force Even if the repository is shared and the specified update package is referred to by other repository the update package is deleted Examples delete command enables you to remove the update package gt delete repository uppkgs System BIOS_Windows_4 0_02172011105550 COMMAND COMPLETED System BIOS_Windows_4 0_02172011105550 was deleted CHECK In the case of the user authority is Operator Change Environment Setting of the user level must be enabled 60 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 Table 5 43 Specific options of dump repository uppkgs Option Description destinatio
4. show grps grpset lt Group Name gt expup command enables you to view ExpressUpdate information of the group lt Group Name gt gt show grps grpset root expup ufip grps grpset root expup ufit expup Targets mods 1 modules Properties RepositoryLocation LOCAL ExpUpStatus NOT_LATEST UpdatePkgLatestDownloaded 2011 04 01 01 00 00 NextDownloadDate 201 1 04 02 01 00 00 Verbs cd exit help show load stop 1 mods element is deprecated Use grps grpset root expup modules supportedmods managedmods instead of this 5 1 2 Displaying a list of modules supporting automatic update 5 1 2 1 Information of components A list of modules supporting automatic update for the specified component is displayed at the below target cmps lt Component Name gt map expup modules supportedmods managedmods Property of this target is as follow There is no specified command for this target Table 5 6 Property of cmps lt Component Name gt map expup modules supportedmods mana gedmods Property Access Description EntryCount read Displays a number of modules managed by ExpressUpdate 37 Example show cmps lt Component Name gt map expup mods command enables you to view a list of modules for the specified component lt Component Name gt gt show cmps Server01 map expup modules supportedmods managedmods ufip cmps Server0 1 map expup modules supportedmods managedmods ufit managedmods Ta
5. ExpressUpdate Progress read If creating an update package archive is in execution its progress is displayed Table 5 24 Specific command of cmps lt Component Name gt map expup modules unsupporte dmods lt Module Name gt uppkgs Command Description dump Archives update packages related to the specified module into an update package archive stop Cancels creating an update package archive if it is in execution Table 5 25 Specific options of dump cmps lt Component Name gt map expup modules unsupp ortedmods lt Module Name gt uppkgs destination lt path gt 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 Example dump cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt command enables you to archive update packages into an update package archive If starting command succeeds update packages to be archived are listed gt dump destination C temp cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs COMMAND COMPLETED 3 0 4 0 5 0 The process to save update packages was started To confirm its progress execute show command on update packages element and refer to Progress property C temp UpdatePackageArchive_20120701 zip 51 5 2 5 2 For the specifi
6. lt help gt 2 2 3 6 load lt load gt lt source gt lt uri gt Full path of source of load lt uri gt lt source gt lt destination gt lt ufip gt Full path of destination of load lt ufjp gt lt destination gt lt load gt 27 2 2 3 7 set lt set gt lt instance gt lt ufip gt UFiP identifying target lt ufip gt lt properties gt lt propesty gt A modified property of Managed Element lt property gt lt properties gt lt instance gt lt set gt 2 2 3 8 Show lt show gt lt target gt lt instance gt lt ufip gt UFiP identifying target lt ufip gt lt properties gt lt property gt A property of Managed Element lt property gt lt properties gt lt verbs gt lt standardverbs gt Standard commands supported at the target lt standardverbs gt lt oemverbs gt OEM commands supported at the target lt oemverbs gt lt verbs gt lt instance gt lt target gt Recursive target elements representing Managed Elements contained in initial target lt target gt lt target gt lt show gt 2 2 3 9 stop lt stop gt lt ufip gt UFiP identifying target to stop lt ufip gt lt stop gt 28 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 specif
7. lt name gt they must be separated by comma and surrounded by parentheses grp lt name gt lt name gt lt name gt Specifies exceptional items using group names If there are some lt name gt they must be separated by comma and surrounded by parentheses ufit lt name gt lt name gt lt name gt Specifies exceptional items using UFiT If there are some lt name gt they must be separated by comma and surrounded by parentheses Wee spawn tetas on ke es Semele eee ss Segen m nn outputfile lt path gt Description Saves command result to a file of specified path When the file of specified path is not existing new file is created and output it When the file of specified path exists and the file is not an output file of esmcli the command result will be error This option is supported by all basic commands 15 1 6 Example of command output All commands shows results as following format gt lt CLI command gt lt status gt results gt Each status is listed in below table Status COMMAND COMPLETED Table 1 2 Statuses Description Command was successful Following commands skips to show this status cd exit e help how COMMAND PROCESSING FAILED Syntax error was occurred COMMAND EXECUTION FAILED Command was unsuccessful 16 1 7 Diagram of the entire address space A diagram of the entire address space is as follow
8. type ResetStartStopResponseType gt lt xsd element name oemverb type OemverbResponseType gt lt xsd choice gt lt xsd element name oemdata type OemdataCommonType minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt xsd element gt lt command input line gt lt xsd complexType name CommandInputline gt lt xsd sequence gt lt xsd element name inputline type xsd string gt lt xsd sequence gt lt xsd complexType gt lt command status gt lt xsd complexType name CommandStatus gt lt xsd sequence gt lt xsd element name status type xsd int gt lt xsd element name status_tag type xsd string gt lt xsd sequence minOccurs 0 gt lt xsd element name error type xsd int gt lt xsd element name error_tag type xsd string gt lt xsd sequence gt lt xsd sequence gt lt xsd complexType gt 74 lt cd command response type gt lt xsd complexType name CdResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name ufip type xsd string gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt create set command response type gt lt xsd complexType name CreateSetResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name instance type InstancePropertyType minOccurs 0 gt lt xsd element na
9. Name gt Command Description load Updates the specified module Refer to section 5 2 1 4 for more information Example show grps grpset lt Group Name gt expup modules supportedmods managedmods lt Module Name gt com mand enables you to view information about the module lt Module Name gt of the component lt Group Name gt gt show grps grpset root expup modules supportedmods managedmods NEC ExpressUpdate Agent ufip grps grpset root expup modules supportedmods managedmods NEC ExpressUpdate Agent ufit NEC ExpressUpdate Agent Targets uppkgs Properties Module NEC ExpressUpdate Agent ExpUpStatus NOT_LATEST Version 3 0 Severity HIGH LatestApplyResult 2011 04 01 12 00 00 Applying the update package has been completed successfully NEC ExpressUpdate Agent 1 0 gt 2 0 Verbs cd exit help show load delete 42 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 lt Component Name gt map expup modules unsupportedmod lt Module Name gt Properties and specific commands of this target are as follows Table 5 14 Properties of emps lt Component Name gt map expup modules unsupportedmod lt Module Name gt Property Access Description Module read Displays a name of this module ExpUpStatus read An ExpressUpdate status of the modul
10. bin java com nec jp dianascope CoreServer Chapter8 Terminology Table 8 1 Terminology Term Description CLI Command Line Interface BMC Baseboard Management Controller The management controller to manage the interface between system management software and platform hardware DMTF Distributed Management Task Force An industry standard body that defines WBEM standards for the industry SMASH Systems Management Architecture for Server Hardware A suite of specifications that deliver industry standard protocols to increase productivity of the management of a data center Address Space A set of instances that represent managed element or provided functions These instances are accessed using a unique path Managed Element An instance of managed element or provided function on NEC ESMPRO Manager It constructs the address space UFiT User Friendly instance Tag User friendly identifier for a specific instance of a CIM class UFiP User Friendly instance Path The unique path to an instance formed by concatenating the UFiTs of each instance from the root instance to the terminating instance Component An object that is managed by NEC ESMPRO Manager NEC ExpressUpdate The function that manages versions of modules like firmware and software on the managed server and that updates the modules Available since NEC ESMPRO Manager Ver5 1 NEC ExpressUpdate Agent Software that provides NEC ExpressUpdate
11. function It is installed on the managed component and communicates with NEC ESMPRO Manager Module The module like firmware and software Update package The package which the update tool of the module is included in Update package server The update package server from where the repository downloads update packages Repository The component of the NEC ESMPRO Manager for NEC ExpressUpdate that downloads update packages from the update package server and manages them Available since NEC ESMPRO Manager Ver5 1 Chapter9 Appendix 9 1 XML Schema 9 1 1 XML Schema for request file XML schema of the request XML is as below lt xml version 1 0 encoding UTF 8 gt lt xsd schema xmlns xsd http www w3 org 200 1 XMLSchema gt lt command request gt lt xsd element name request gt lt xsd complexType gt lt xsd choice minOccurs 0 maxOccurs unbounded gt lt xsd element name cd type CommonRequestType gt lt xsd element name create type CommonRequestType gt lt xsd element name delete type CommonRequestType gt lt xsd element name dump type CommonRequestType gt lt xsd element name exit type CommonRequestType gt lt xsd element name help type CommonRequestType gt lt xsd element name load type CommonRequestType gt lt xsd element name reset type CommonRequestType gt lt xsd element name set type CommonRequestType gt
12. is as follow There is no specified command for this target Table 5 8 Property of cmps lt Component Name gt map expup modules unsupportedmods Property Access Description EntryCount Displays a number of modules managed by ExpressUpdate Example show cmps lt Component Name gt map expup unsupportedmods command enables you to view a list of modules for the specified component lt Component Name gt gt show cmps Server01 map expup modules unsupportedmods ufip cmps Server01 map expup modules unsupportedmods ufit unsupportedmods Targets System BIOS BMC Firmware NEC ExpressUpdate Agent Properties EntryCount 3 Verbs cd exit help show 39 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 lt Group Name gt 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 lt Group Name gt expup modules unsupportedmods Property Description EntryCount read Displays a number of modules managed by ExpressUpdate Example show grps grpset lt Group Name gt expup modules unsupportedmods command enables you to view a list of modules for the specified group lt Group Name gt gt show grps grpset root expup modules unsupportedmods ufip grps grpset root expup modules unsupp
13. lt inputline gt lt command gt lt cmdstat gt lt status gt 3 lt status gt lt status_tag gt COMMAND EXECUTION FAILED lt status gt lt error gt 255 lt error gt lt error_tag gt COMMAND ERROR UNSPECIFIED lt error_tag gt lt cmdstat gt lt COMMAND gt lt COMMAND gt lt oemdata gt lt oemdata gt lt response gt 25 Name of element Table 2 2 Elements of response XML Description response A root element of response XML command An element holding information of the command inputline An element holding an input command line cmdstat An element grouping a status of command status An element holding a status code status_tag An element holding a status tag error An element holding a error code error_tag An element holding a status tag COMMAND An element specifying a basic command target An element holding a target of the command instance An element grouping a target options and properties ufit An element holding target s UFIT ufip An element holding target s UFiP properties An element grouping property elements property An element corresponding to property name An element holding a name of property value An element holding a val element val An element holding a value of property source An element holding source information of dump and load command destination An element holding dest
14. lt xsd sequence gt lt xsd complexType gt lt target reference type gt lt xsd complexType name TargetReferenceType gt lt xsd sequence gt lt xsd element name instance type InstanceReferenceType gt 76 lt xsd element name target type TargetReferenceType minOccurs 0 maxOccurs unbounded I gt lt xsd sequence gt lt xsd complexType gt lt instance full type gt lt xsd complexType name InstanceFullType gt lt xsd sequence gt lt xsd element name ufit type Ufit gt lt xsd element name ufip type xsd string gt lt xsd element name properties type PropertiesResponseType minOccurs 0 gt lt xsd element name verbs type Verbs minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt instance property type gt lt xsd complexType name InstancePropertyType gt lt xsd sequence gt lt xsd element name ufit type Ufit gt lt xsd element name ufip type xsd string gt lt xsd element name properties type PropertiesResponseType gt lt xsd sequence gt lt xsd complexType gt lt instance reference type gt lt xsd complexType name InstanceReferenceType gt lt xsd sequence gt lt xsd element name ufit type Ufit gt lt xsd element name ufip type xsd string gt lt xsd sequence gt lt xsd complexType gt lt properties response type gt lt xsd complexType name PropertiesResponseTy
15. request include info gt lt xsd complexType name Include gt 72 lt xsd sequence gt lt xsd element name file type xsd string gt lt xsd element name abort type xsd boolean minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt xsd schema gt 73 9 1 2 XML Schema for response file XML schema of the response XML is as below lt xml version 1 0 encoding UTF 8 gt lt xsd schema xmlns xsd http www w3 org 200 1 XMLSchema gt lt command response gt lt xsd element name response gt lt xsd complexType gt lt xsd sequence gt lt xsd element name command type CommandInputline gt lt xsd element name cmdstat type CommandStatus gt lt xsd choice minOccurs 0 gt lt xsd element name cd type CdResponseType gt lt xsd element name create type CreateSetResponseType gt lt xsd element name delete type DeleteResponseType gt lt xsd element name dump type DumpLoadResponseType gt lt xsd element name exit type ExitResponseType gt lt xsd element name help type HelpResponseType gt lt xsd element name load type DumpLoadResponseType gt lt xsd element name reset type ResetStartStopResponseType gt lt xsd element name set type CreateSetResponseType gt lt xsd element name show type ShowResponseType gt lt xsd element name start type ResetStartStopResponseType gt lt xsd element name stop
16. values are e INVALID e VALID the repository downloads update packages Updatelnterval read write Sets the schedule type when AutoUpdate is VALID The valid values are e DAILY e EVERY_SUNDAY e EVERY_MONDAY e EVERY_TUESDAY e EVERY_WEDNESDAY e EVERY_THURSDAY e EVERY_FRIDAY e EVERY SATURDAY UpdateStartTime read write Sets downloading time when AutoUpdate is VALID The valid ranges are e 00 00 23 50 Time must be set by the 10 minute Proxy Address read write Sets the IP address of the proxy server ProxyPort read write Sets the port number of the proxy server ProxyUser read write Sets the user name with which the repository connects to the proxy server ProxyPassword read write Sets the user password with which the repository connects to the proxy server This is displayed in a Ren ORT DefaultStatusIcon read write Sets the default status icon of a downloaded module which does not support the automatic update The valid ranges are 55 e BLUE e RED e BLACK Table 5 32 Specific commands of repository localsetting Command Description set Sets local repository settings properties Examples show command enables you to view local repository settings gt show repository localsetting ufip repository localsetting ufit localsetting Targets Properties RepositoryPassword AutoUpdate VALID Updatelnterval EVERY_SATURDAY Update
17. 0 cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent COMMAND COMPLETED Updating was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element and you can confirm this command s result from LatestApplyResult property cmps ServerO 1 map expup modules supportedmods managedmods NEC ExpressUpdate Agent 46 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 lt Group Name gt Refer to the section 5 1 4 1 for more information about this target grps grpset lt Group Name gt expup Specific option of this command is as follow Table 5 19 Specific options of grps grpset lt Group Name gt expup Option Description exclude Specifies components or groups that are not included in this operation reboot Enables ExpressUpdate to reboot the system if the update requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled A E RR RR A A IS A A A A A O E a Example load grps grpset lt Group Name gt expup command enables you to update all modules of components belonging to the specified group lt Group Name gt gt load exclude cmp Server02 grps grpset root expup COMMAND COMPLETED Updat
18. 34335370718834422 zip repository COMMAND COMPLETED Added specified update packages System BIOS_Windows_4 0_02172011105550 5 3 3 Removing update packages from repository 5 3 3 1 Removing all update packages Removing all update packages is located at the following target repository uppkgs Properties and specific commands of this target are as follows Table 5 38 Property of repository uppkgs Property Access Description EntryCount read Displays a number of update packages managed by repository Progress read If archiving update packages is in execution displays its progress Table 5 39 Specific command of repository uppkgs Command Description delete Removes all update packages dump Archives update packages related to the specified module into an update package archive stop Cancels creating an update package archive if it is in execution Specific option of this command is as follow Table 5 40 Specific option of repository uppkgs Description f force Even if the repository is shared and the specified update packages are referred to by other repository the update packages are deleted Examples delete command enables you to remove all update packages gt delete repository uppkgs COMMAND COMPLETED NEC ExpressUpdate Agent_Windows_3 00_03022011171440 was deleted NEC ExpressUpdate Agent_Linux_3 00_03102011100740 was deleted
19. D COMPLETED Updating was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element and you can confirm this command s result from LatestApplyResult property e UFiT of the update package that is referred by source option is shown in the resul t of show cmps lt Component Name gt map expup modules supportedmods managedmo ds lt Module Name gt uppkgs command 48 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 lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt Specific option of this command is as follow Table 5 22 Specific option of emps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt Option Description reboot Enables ExpressUpdate to reboot the system if the uninstallation requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled Example load cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command enables you to uninstall an module lt Module Name gt from the specified component lt Component Name gt gt delete cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate A
20. Date 2011 05 01 12 00 Verbs cd exit help show load stop 1 mods element is deprecated Use cmps Server01 map expup modules supportedmods managedmods instead of this 2 uninstalled element is deprecated Use cmps Server01 map expup modules supportedmods uninstal ledmods instead of this 5 1 1 2 Information of groups show command at the below target enables you to view ExpressUpdate information about the specified group grps grpset lt Group Name gt expup Properties and specific commands of this target are as follows Table 5 4 Properties of grps grpset lt Group Name gt expup Property Access Description ExpUpStatus read Displays ExpressUpdate statuses Each status is listed in Table 5 2 RepositoryLocation read Displays a location of the repository local remote UpdatePkgLatestDownloaded read Displays the most recent time when the repository was updated If updating has never been executed it shows None NextDownloadDate read Displays time and date of the next repository update if it is scheduled 36 Table 5 5 Specific commands of grps grpset lt Group Name gt expup Command Description load Updates all modules of components belonging to the specified group to the latest version Refer to section 5 2 1 3 for more information stop Cancels all update command to lt Group Name gt Refer to section 5 2 4 2 for more information Example
21. NEC User s Guide Express5800 Series NEC ESMPRO Manager Ver 6 Command Line Interface for NEC ExpressUpdate Chapter Chapter2 Chapter3 Chapter4 Chapter5 Chapter6 Chapter Chapter8 Chapter9 About Command Line Interface XML interface Component management Group management ExpressUpdate Log management Troubleshooting Terminology Appendix Ver 1 04 O NEC Corporation 2014 Contents Contents 3 73 o aa r e E a E ea E EE OOE E EE OE SE E E TEES 1 Trademarks uta ii AA 3 About This Document 2 22 42 a 4 Chapter About Command Line Interface 0 0 eee eceseeeeseceeseesecseesecseeeecsaeeceesecseesecneseesaeeeeeaecateaeenees 5 1 1 OVELVIEW 2g nes teb did R A ruRt Tree nee 5 1 2 System Requirements ars ninas 5 1 3 Configuring examples siiente eiere Eent esi iaa an 6 1 4 Using the commiand lines aii 7 1 42 Shellmode 22 see ias 7 14 2 One litier Mode 22er Herr tip ee 9 1 43 XMEscripting mode 10 1 4 4 Encrypting of the password cceccssseesseeseeseceeeceecesecseceaeceaecaeecaeeeneeeaeeaeeeaeeeeeseeeeereeeseeeenaes 11 1 5 Basic COMMON 12 ESA T tgeli ns NOS 14 1 5 2 Basic Opos ao ae ae E el ee ea ea aed we 14 1335 gt Specific Opuons ccs4 as ea ti Ad eee apes 15 1 6 Example of command output unssessionsnsenesonennnonsnenonennenssonensnonssnnnonennesssonsnsnonsnrnnorensnnronentn 16 1 7 Diagram of the entire address space ccesccesecsseesceesseeseeseceseeee
22. Name of element Description request A root element of request XML COMMAND An element specifying a basic command abort 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 instance An element grouping a target options and properties ufip An element specifying a target of the command options An element grouping option elements option An element corresponding to option properties An element grouping property elements property An element corresponding to property name An element holding a name of option or property value An element holding a val element val An element holding a value of option or property include An element specifying an included XML file file An element specifying a file 2 1 3 Examples Followings are typical command s input method using shell mode and XML interface Example Execute show command to gt show lt xml version 1 0 encoding UTF 8 gt lt request gt lt show gt lt instance gt lt ufip gt lt ufip gt lt instance gt lt show gt lt request gt 21 Example Execute dump command to logs and save logs to C temp gt dump destination C temp logs lt xml version 1 0 encoding UTF 8 gt lt request gt lt d
23. Server02 Express Update Agent_Windows_3 00_20110302171440 Examples show command with d euform cmp option enables you to view information about update packages by model gt show d euform model repository uppkgs Express5800 110Ge S Express Update Agent_Linux_3 00_20110310100740 Express5800 R120b 1 Express Update Agent_Windows_3 00_20110302171440 62 5 3 5 2 The update package information Information about the update package is located at the following target repository uppkgs lt uppkg name gt Property of this target is as follow There is no specified command for this target Table 5 46 Properties of repository uppkgs lt uppkg name gt Property Module Access read Description 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 Target read Displays the operating system name that the update package supports Model read Displays the model name of the component that the update package supports Estimated Time read Displays the estimate of the time to install the update package InstallEstimatedTime read Displays the estimate of the time to install when the module supports installation UninstallEstimatedTime read Displays the estimate of the time to uninstall when the module supports uninstallatio
24. StartTime 23 50 ProxyAddress ProxyPort 0 ProxyUser ProxyPassword DefaultStatusIcon BLUE Verbs cd exit help show set Examples set command enables you to set one or more local repository settings properties If there are multiple properties on the same command line they must be separated by a space When you enable automatic downloading run the following command set repository localsetting AutoUpdate VALID When you set the schedule type run the following command set repository localsetting Updatelnterval EVERY_SATURDAY When you set downloading time run the following command set repository localsetting UpdateStartTime 23 50 When you set the IP address and the port number of the proxy server on the same command line run the following command set repository localsetting ProxyAddress 192 168 0 200 ProxyPort 8080 CHECK In the case of the user authority is Operator Change Environment Setting of the user level must be enabled 56 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 Man
25. ad Displays a list of components belonging to the group Example show command shows information of the group More concrete examples are as follows gt show grps grpset root ufip grps grpset root ufit root Targets groupOl group02 expup Properties Name grpset Status NORMAL ExpUpStatus LATEST_CONDITION GroupCount 2 ComponentCount 3 Comment Components serverOl server02 server03 Verbs cd exit help show When show command is executed to groups grpall is able to specify as a lt type gt of display option If it is specified all groups are show as hierarchy style Following command shows all groups as hierarchy show display targets grpall 33 Followings are example of the below hierarchy diagram group02 group02 01 group02 01 01 gt show display targets grpall grps grpset root ufip grps grpset root ufit root Targets group01 group01 01 group01 02 group01 02 01 group02 group02 01 group02 01 01 expup 34 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 lt Component Name gt map expup Properties and specific commands of this target are as follows Table 5 1 Properties of cmps lt Component Name gt map expup
26. aea ee thas e ee N eea seve es beatae tee EaR e 35 5 1 1 Displaying ExpressUpdate information usesessessersensesnensesnensernnennnnenennsensennnnsonnnennennnn 35 5 1 2 Displaying a list of modules supporting automatic update neseseessesnensesnensersnesennnennennene 37 5 1 3 Displaying a list of modules not supporting automatic update nsessersessessensesseesennnennennen 39 5 1 4 Information of module supporting automatic update u zesesseensesnensesnensesnnesennnenennsnennnnanne 41 5 1 5 Information of module not supporting automatic update uensesnensesnersesnnesennensnnsennnennennnne 43 5 2 Update anstall and install seta earth share 45 5 2 1 Update modules supporting automatic update eensessessessesennesnensennenennsnensennnnsonnnennennnne 45 22 2 4 Inst llcommands 2 42 a di 48 9 23 Uninstall commands 2 ati ier see ee in ts ea 49 5 24 Cancelling update commands rissen a e a a 50 5 2 5 Update modules not supporting automatic update sseeeseeeiesessseseseereressrserrteressrsrereeeesses 51 5 3 Repository and Update package management ucrseeseseesnesnensesnensernennennnennnesnonsennonsennennnnennon 54 33 1 Repository Seting Sissies aa a kennt 54 5 3 2 Adding update packages to repoSitoty eeersesserseesnesennesnennesnensennonsonnnennnennensnnnonsennnnnenne en 58 5 3 3 Removing update packages from repository cooocoonccnonnonconcnnnononncanconononononononnon con
27. ager PC RemoteRepositoryPassword read write Sets password that is configured in RepositoryPassword on the other Manager PC Table 5 34 Specific commands of repository remotesetting Command Description set Sets remote repository settings properties Table 5 35 Specific option of repository remotesetting Option Description f force Even if it cannot be connected to the other Manager PC repository properties are set by force Examples show command enables you to view remote repository settings gt show repository remotesetting ufip repository remotesetting ufit remotesetting Targets Properties RemoteRepository Address 192 168 0 100 RemoteRepositoryPort 8080 RemoteRepositoryPassword Verbs cd exit help show set Examples set command enables you to set one or more remote repository settings properties If there are multiple properties on the same command line they must be separated by a space If you want to set repository location in remote it is necessary to set RemoteRepositoryAddress RemoteRepositoryPort and RemoteRepositoryPassword properties set repository remotesetting RemoteRepositoryAddress 192 168 0 100 RemoteRepositoryPort 8080 RemoteRepositoryPassword password When the correct value is set repository location is changed in remote CHECK e The following properties must be specified when repository location is set to remote e R
28. aste Supported only in Windows OS Ctrl J Decision equivalent to the key Enter Ctrl M Decision equivalent to the key Enter Ctrl H Erase one character equivalent to the key BackSpace Ctrl L Clear the screen Supported only in Linux OS Ctrl K Delete the line after the cursor position Ctrl U Delete the line before the cursor position Ctrl W Delete all the letters from the cursor to the directory separator before one Ctrl D When there is an input delete one character of the position of the cursor When there is not an input finish the shell mode Ctrl C Finish the shell mode 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 esmcli Option CLI Command esmcli Indicates the NEC ESMPRO Manager command line interface command Option Input an option There are following types of option h help Display the command syntax of the esmcli command When this option is appointed the shell mode does not start u user lt user name gt Input user name of NEC ESMPRO Manager At the time of login the input of the user name is omitted p p
29. c nono none ranannono 59 5 3 4 Saving update packages irens ed EEEN Ee EE EEE a eah oer aeaa 6l 53 3 Update packages InfoMine lat a EE p Eare Helene 62 Chapter6 Log management u eral tee ihe ie esas Mle eel eddie 66 6 1 TOSSING acd ent A AA Ad Ati 66 6 111 Application log listos ai ed 66 6 1 2 Application lO firana r a REE E E E 67 6 1 3 NEC ExpressUpdate Agent log oooccnonnnoninonononcnnnconononnnanonnonnncnnncnnoco nono nono nc rocio nn nono crac rnnnnnnons 68 Chapter TroublESHOOUOS it hd tdi 69 7 1 Error Message ia 69 Chapters LEMOA a r OLA A Naa ri a ar 70 Chapter9 Appendix eiie is RIM aie 71 9 1 XME Schema ista td ed 71 9 1 1 XML Schema for request file eee enra n a a Ea i ia a a eyin 71 9 1 2 XML Schema for response ll vate 74 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 1 Enterprise 64 bit Edition and Windows 8 1 Enterprise 32 bit Edition Windows 8 stands for Windows 8 Pro and Windows 8 Enterprise Windows 7 stands for Windows 7 Professional operat
30. cesecesecaecaeceaecasesaecnaecaeceeeeeeneees 17 Chapter2 XML interface voten 20 2 1 Execution Of XML 0 2 sete este bie er oe tia 20 QA LOVE A ee Ie A 20 21 2 XME elements soo scss cect cst oriet amp sev r a iii 20 2 1 37 Examples A RE ee sR ER 21 21 4 Qvernde process it ia aber 23 2515 Include process 2 4 2 BEHRENS En 24 2 2 Output XML Ast rgere Re oia 25 2 21 COVE seit ie ea ira 25 2 2 2 XMl elements NRO 25 2 2 3 XML format for each basic commands 22u2202242 204202 snensennonsernnesonnnesennsensennnnsennnennensnnne 26 Chapter3 Component management Reel ia 29 3 1 Component information ii ball an dh bidecl whgpereienes 29 3 1 1 Showing a list of componentS uunsessersessesersnesnensesnersesnnesennnenennsnonsensnnnonnenensnsnensensnsnonennn 29 3 1 2 Showing component information uunsessersersersersnesnnnennennsnensennenennnenenesnensennonsennennne nero 30 Chapter4 Gro p Management z s u0e sesrsriamn a Hrn eek use 31 4 1 Group information irte 31 4 1 1 Showing a hst f sroupset 22 22 ee ct ted gine es Bat ir 31 4 1 2 Showing information of groupset nuensesnensesnersessnesennennennsonsennnnnennnenenesnensnnnonnonnnennnne nn 32 4 1 3 Showing information Of gTOUP ueueesenesnensesnensesnnesennnennennsnonsennnnnonnnenensenensesnonsonsnennnne nn 33 Chapters ExpressUpd te n 2 220 u A ROA el as Se I ee eR ie 35 5 1 ExpressUpdate informatii es e
31. chived is liste d gt dump destination C temp repository uppkgs ExpressUpdate Agent_Windows_3 00_20110302171440 COMMAND COMPLETED ExpressUpdate Agent_Windows_3 00_20110302171440 The process to save update packages was started To confirm its progress execute show command on update package element and refer to Progress property C temp UpdatePackageArchive_20120701 zip 61 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 lt uppkg name gt Option Description d display euform cmp Displaying ExpressUpdate information by component d display euform model Displaying ExpressUpdate information by model Examples show command enables you to view information about update packages gt show repository uppkgs ufip repository uppkgs ufit uppkgs Targets NEC ExpressUpdate Agent_Linux_3 00_20110310100740 NEC ExpressUpdate Agent_Windows_3 00_20110302171440 Properties EntryCount 2 Verbs cd exit help show delete Examples show command with d euform cmp option enables you to view information about update packages by component gt show d euform cmp repository uppkgs Server01 Express Update Agent_Linux_3 00_20110310100740
32. ction gt lt xsd simpleType gt lt xsd attribute gt lt xsd extension gt lt xsd simpleContent gt lt xsd complexType gt lt xsd schema gt 79 Revision History 1 00 1 01 1 02 1 03 2011 05 11 2012 07 20 2013 02 13 2014 01 06 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 6 Command Line Interface User s Guide for NEC ExpressUpdate O NEC Corporation 2014 80
33. ed component lt Component Name gt gt load reboot cmps Server01 map expup COMMAND COMPLETED Updating was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element and you can confirm this command s result from LatestApplyResult property cmps Server0 1 map expup modules supportedmods managedmods NEC ExpressUpdate Agent If the update is in progress ExpUpStatus property of show cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command shows the progress gt show cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent ufip cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent ufit NEC ExpressUpdate Agent Targets uppkgs Properties Module NEC ExpressUpdate Agent ExpUpStatus UNDER_INSTALLATION 5 Version 2 0 Severity HIGH LatestApplyResult 2011 04 01 12 00 00 Applying the update package has been completed successfully NEC ExpressUpdate Agent 1 0 gt 2 0 Verbs cd exit help show load delete 45 e Ifthe update has been finished the result is shown in LatestApplyResult property of show cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command LatestApplyResult 2011 04 01 12 00 00 Applying the update packa
34. ed component and update package dump command at the below target enables you to copy update packages related to specified component and update package cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs lt P KG Version gt Table 5 26 Properties of emps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs lt PKG Version gt 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 Target read Displays the operating system name that the update package supports Model read Displays the model name of the component that the update package supports EstimatedTime read Displays the estimate of the time to install the update package Reboot read Displays whether that the selected update package requires a reboot after the installation e NECESSITY e UNNECESSITY Severity read Displays the severity of the update package e LOW e MIDIUM e HIGH ExpressUpdateS upported read Displays whether the update package supports automatic updating by NEC ExpressUpdate e SUPPORTED e UNSUPPORTED DowngradeSupported read Displays whether the update package supports downgrade e SUPPORTED e UNSUPPORTED MultipleModelSupported read Displays whether the update package supports multiple mode of compone
35. ement name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt reset start stop command response type gt lt xsd complexType name ResetStartStopResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name instance type InstanceReferenceType gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt show command response type gt lt xsd complexType name ShowResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name target type TargetFullType gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt oemverb command response type gt lt xsd complexType name OemverbResponseType gt lt xsd sequence gt lt xsd element name verbname type xsd string gt lt xsd choice minOccurs 0 gt lt xsd element name oemdata type OemdataOemverbType gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd sequence gt lt xsd complexType gt lt target full type gt lt xsd complexType name TargetFullType gt lt xsd sequence gt lt xsd element name instance type InstanceFullType gt lt xsd element name target type TargetFullType minOccurs 0 maxOccurs unbounded gt
36. emoteRepository Address e RemoteRepositoryPort 57 e 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 RemoteRepository Address 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 Table 5 36 Specific command of repository Command Description load Downloads update packages from update package server Adds update packages to repository Specific option of this command is as follow Table 5 37 Specific options of repository Option Description wait Watches it until the downloading of the update packages is completed This option is valid only when you download without adding source option source When you add the specified update package to repository you specify the update package file path f force Adds the update package specified by source option to the repository even if it is not necessary for the components Examples load command enables you to download update packages gt load repository COMMAND COMPLETED Downloading update packages Run the show command to the repository and you can c
37. fy the following items If there are multiple types they must be separated by commas targets lt name gt Shows the target When lt name gt is specified the target that matches lt name gt is displayed If there are multiple lt name gt they must be surrounded by parenthesis and separated by commas properties lt name gt Shows properties When lt name gt is specified the property that matches lt name gt is displayed If there are multiple lt name gt they must be surrounded by parenthesis and separated by commas verbs Shows supported commands 14 Examples 1 Shows only targets Show d Targets 2 Shows target whose name is server01 and supported commands show d targets serverOl verbs 3 Shows property whose name is Name or Status and shows supported commands show d properties Name Status verbs 0 output lt arg gt lt arg gt 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 3 Specific options This section describes NEC ESMPRO Manager specific options exclude lt arg gt lt arg gt Description Specifies exceptional items This option is effective when the target is group cmp lt name gt lt name gt lt name gt Specifies exceptional items using component names If there are some
38. g gt lt xsd element name options type Options minOccurs 0 gt lt xsd element name properties type PropertiesRequestType minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt properties request type gt lt xsd complexType name PropertiesRequestType gt lt xsd sequence gt lt xsd element name property type PropertyRequestType minOccurs 0 maxOccurs unbounded gt lt xsd sequence gt lt xsd complexType gt lt property request type gt lt xsd complexType name PropertyRequestType gt lt xsd sequence gt lt xsd element name name type xsd string gt lt xsd element name value type ValueRequestType gt lt xsd sequence gt lt xsd complexType gt lt command request options gt lt xsd complexType name Options gt lt xsd sequence gt lt xsd element name option type Option minOccurs 0 maxOccurs unbounded gt lt xsd sequence gt lt xsd complexType gt lt command request option gt lt xsd complexType name Option gt lt xsd sequence gt lt xsd element name name type xsd string gt lt xsd element name value type ValueRequestType minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt value request type gt lt xsd complexType name ValueRequestType gt lt xsd sequence gt lt xsd element name val type xsd string gt lt xsd sequence gt lt xsd complexType gt lt command
39. ge has been completed successfully NEC ExpressUpdate Agent 2 0 gt 3 0 5 2 1 2 For the specified component and module load command at the below target enables you to update the module lt Module Name gt of the component lt Component Name gt using the specified update package cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt Specific option of this command is as follow Table 5 18 Specific options of emps lt Component Name gt map expup modules supportedmod s managedmods lt Module Name gt Option Description source Specifies the update package f force Enables ExpressUpdate to update the module using an update package which is not latest reboot Enables ExpressUpdate to reboot the system if the update requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled m ER EI A A A A O A A en eet y e UFiT of the update package that is referred by source option is shown in the resu lt of show cmps lt Component Name gt map expup modules supportedmods managedmo ds lt Module Name gt uppkgs command Example load cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command enables you to update the module lt Module Name gt of the component lt Component Name gt using the specified update package gt load force source 2
40. gent COMMAND COMPLETED Uninstall was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element under the uninstalledmods element and you can confirm this command s result from LatestApplyResult property 49 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 lt Component Name gt map expup There is no specific option for this command CHECK e In the case of the user authority is Operator Install Update Packages of the user level must be enabled e This command effects only waiting tasks A task which has been started is unable to be cancelled Example stop cmps lt Component Name gt map expup command enables you to cancel updates of the specified component lt Component Name gt If this command is successful a list of cancelled tasks is shown gt stop cmps ServerO l map expup COMMAND COMPLETED cmps Server01 map expup mods NEC ExpressUpdate Agent Cancel of update process was executed 5 2 4 2 For groups stop command at below targets enables you to cancel updates Refer to the section 5 1 1 2 for more information about this target grps grpset lt Group Name gt expup There is no specific option for this command CHECK e In
41. he application log Examples show commands enable you to view the NEC ESMPRO Manager application log gt show logs log10 ufip logs log 10 ufit log 10 Targets Properties Type INFORMATION ComponentName Server01 IpAddress 192 168 0 2 BmelpAddress 192 168 0 3 Date 2011 03 01 12 00 00 User Contents The component was added Verbs cd exit help show 67 6 1 3 NEC ExpressUpdate Agent log Information of NEC ExpressUpdate Agent log is located at the following target cmps lt component name gt map agtlogs expupagtlog IMPORTANT In lt component name gt 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 Table 6 5 Specific commands of emps lt component name gt map agtlogs expupagtlog Command Description dump Saves NEC ExpressUpdate Agent log to the specified directory File is saved in zip format Table 6 6 Specific options of cmps lt component name gt map agtlogs expupagtlog Option Description destination Specifies the destination path of the directory or the file name Absolute path and relative path can be specified Required option f force When there is a same name file in the destination directory the file is overwritten Examples show commands e
42. ied command for this target Table 3 1 Properties of cmps Property Access Description EntryCount read Displays a number of registered components Status read Displays a representative status of all of the components ExpUpStatus read Displays a representative ExpressUpdate status of all of the components Refer to Table 5 2 ExpressUpdate statuses to get information about ExpressUpdate status Example show command shows a list of managed components More concrete examples are as follows gt show ufip cmps ufit cmps Targets Server01 Server02 Properties EntryCount 2 Status NORMAL ExpUpStatus LATEST_CONDITION Verbs cd exit help show A SEES EEE N EEE A EEE EEE EA S EIE ssa sews cbe castles buaeiateceetecaassy 29 3 1 2 Showing component information show command at following target shows information of managed component cmps lt Component Name gt Properties of this target are as follow There is no specified command for this target Table 3 2 Properties of cmps lt Component Name gt Property Access Description Name read Displays a name of the component Status read Displays a representative status of all of the components ExpUpStatus read Displays a representative ExpressUpdate status of all of the components Refer to Table 5 2 to get information about ExpressUpdate status Group read Displays a name of a group which
43. ies EntryCount 2 Verbs cd exit help show 31 4 1 2 Showing information of groupset show command at the following target shows information of groupset grps lt GroupSet Name gt Properties of this target are as follow There is no specified command for this target Table 4 2 Properties of grps lt GroupSet Name gt Property Access Description Name read Displays a name of groupset RootGroup read Displays root group s name Example show command shows information of a groupset More concrete examples are as follows gt show grps grpset ufip grps ufit grps Targets root Properties Name grpset RootGroup root Verbs cd exit help show 32 4 1 3 Showing information of group show command at the following target shows information of a group grps lt GroupSet Name gt lt Group Name gt Properties of this target are as follow There is no specified command for this target Table 4 3 Properties of grps lt GroupSet Name gt lt Group Name gt Property Access Description Name read Displays a name of the group Status read Displays a status of the group ExpUpStatus read Displays an ExpressUpdate status of the group GroupCount read Displays a number of groups belonging to the group ComponentCount read Displays a number of components belonging to the group Comment read Displays a comment of the group Components re
44. ination information of dump and load command uri An element holding a path of the file system help An element holding a help message text An element holding a text message examine An element holding a result of examination verbs An element holding a list of supported commands standardverbs An element holding standard verbs oemdata An element holding esmcli specific information exitcode An element holding an exit code result An element holding a result of the command 2 2 3 XML format for each basic commands Followings are XML format of each basic commands A XML schema of the XML is described 9 1 2XML Schema for response file 2 2 3 1 cd n lt cd gt lt ufip gt UFiP of the current default target lt ufip gt lt cd gt 26 2 2 3 2 delete lt delete gt lt target gt lt instance gt lt ufip gt UFiP identifying target lt ufip gt lt instance gt lt target gt Recursive target elements representing Managed Elements contained in the initial target lt target gt lt target gt lt delete gt 2 2 3 3 dump lt dump gt lt source gt lt ufip gt Full path of source of dump lt ufip gt lt source gt lt destination gt lt ufip gt Full path of destination of dump lt ufip gt lt destination gt lt dump gt 2 2 3 4 exit lt exit gt lt exit gt 2 2 3 5 help lt help gt lt text gt Free form text lt text gt
45. ing system and Windows 7 Ultimate operating system Windows Server 2012 R2 stands for Windows Server 2012 R2 Standard and Windows Server 2012 R2 Datacenter Windows Server 2012 stands for Windows Server 2012 Standard and Windows Server 2012 Datacenter Windows Server 2008 R2 stands for Windows Server 2008 R2 Standard operating system Windows Server 2008 R2 Enterprise operating system and Windows Server 2008 R2 Datacenter operating system Windows Server 2008 stands for Windows Server 2008 Standard operating system Windows Server 2008 Enterprise operating system Windows Server 2008 Datacenter operating system and Windows Server 2008 Foundation Windows Vista stands for Windows Vista Business operating system Windows Vista Enterprise operating system and Windows Vista Ultimate operating system Windows XP stands for Windows XP Professional operating system and Windows XP Professional x64 Edition operating system All names used in sample applications are fictitious They are unrelated to existing product organization or individual names m Notes 1 No part of this document may be reproduced in any form without the prior written permission of NEC Corporation 2 The contents of this document may be revised without prior notice 3 The contents of this document shall not be copied or altered without the prior written permission of NEC Corporation 4 All efforts have been made to ensure the accu
46. ing was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element and you can confirm this command s result from LatestApplyResult property 5 2 1 4 For the specified group and module load command at below targets enables you to update the specified module lt Module Name gt of components belonging to the specified group lt Group Name gt Refer to the section 5 1 1 2 for more information about this target grps grpset lt Group Name gt expup modules supportedmods managedmods lt Module Name gt Specific option of this command is as follow Table 5 20 Specific options of grps grpset lt Group Name gt expup modules supportedmods ma nagedmods lt Module Name gt Option Description exclude Specifies components or groups that are not included in this operation reboot Enables ExpressUpdate to reboot the system if the update requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled Example load grps grpset lt Group Name gt expup modules supportedmods managedmods lt Module Name gt command enables you to update the specified module lt Module Name gt of components belonging to the specified group lt Group Name gt gt load exclude cmp Server02 grps grpset root expup modules supportedmods managedmod
47. ive shell mode and non interactive one liner mode 1 4 1 Shell mode In this mode you can execute CLI commands interactively 1 4 1 1 Logging in to the shell mode To start the shell mode enter the following command from a command line Then input a user name and password of NEC ESMPRO Manager Please refer to 1 5Basic commands for information about CLI commands esmcli Option esmcli The NEC ESMPRO Manager command line interface command Option Input an option There are following options h help Display the syntax of esmcli commands When this option is specified the shell mode does not start u user lt user name gt Specifies an user name of NEC ESMPRO Manager At the time of login the input of the user name is omitted p pswd lt password gt Specifies an user password of NEC ESMPRO Manager At the time of login the input of the user password is omitted e The password at the time of the login can input the password that encrypted in 1 4 4Encrypting of the password Examples If username and password are not specified at command line options enter them at following prompts gt esmcli user passwd Examples When you specify the user name and the password at command line please input as follows esmcli u Administrator p password Examples When you specify the encrypted password please input as follows See 1 4 4Encrypting of the password
48. log5 log6 log7 log8 log9 log10 log74 Properties EntryCount 75 MaxEntryCount 2000 Verbs cd exit help show dump 66 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 gt 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 dump destination C temp application_log zip force logs 6 1 2 Application log Information of NEC ESMPRO Manager application log is located at the following target Nogs lt log gt Property of this target is as follow There is no specified command for this target Table 6 4 Properties of logs lt log gt Property Access Description Type read Displays the type of application log e INFORMATIOIN e WARNING e ERROR ComponentName read Displays the component name IpAddress read Displays the OS IP address of the component BmelpAddress read Displays the BMC IP address of the component Date read Displays the date when the application log was registered User read Displays the user who executed this operation Contents read Displays t
49. lt component name gt uninstalledmods lt module name gt unsupportedmods lt module name gt uppkgs lt uppkg name gt readme il 17 lt groupset name gt lt group name gt lt group name gt supportedmods unsupportedmods 18 localsetting remotesetting lt uppkg name gt 19 Chapter2 XML interface 2 1 Execution of XML 2 1 1 Overview This function enables you to write acommand 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 lt xml version 1 0 encoding UTF 8 gt lt request gt lt COMMAND gt lt abort gt true lt abort gt lt instance gt lt ufip gt Target of this COMMAND lt ufip gt lt options gt lt option gt lt name gt Name of option lt name gt lt value gt lt val gt Value of option lt val gt lt value gt lt option gt lt options gt lt properties gt lt property gt lt name gt Name of property lt name gt lt value gt lt val gt Value of property lt val gt lt value gt lt property gt lt properties gt lt instance gt lt COMMAND gt lt request gt 20 Table 2 1 Elements of request XML
50. lt xsd complexType name Verbs gt lt xsd sequence gt lt xsd element name standardverbs type xsd string minOccurs 0 gt lt xsd element name oemverbs type xsd string minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt OemData common type gt lt xsd complexType name OemdataCommonType gt lt xsd sequence gt lt xsd element name exitcode type xsd int minOccurs 0 gt lt xsd element name result type xsd string minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt OemData oemverb type gt lt xsd complexType name OemdataOemverbType gt lt xsd sequence gt lt xsd element name exitcode type xsd int minOccurs 0 gt 78 lt xsd element name result type xsd string minOccurs 0 gt lt xsd element name instance type InstancePropertyType minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt command response UFiT gt lt xsd complexType name Ufit gt lt xsd simpleContent gt lt xsd extension base xsd string gt lt xsd attribute name ufct use required gt lt xsd simpleType gt lt xsd restriction base xsd string gt lt xsd pattern value a z gt lt xsd restriction gt lt xsd simpleType gt lt xsd attribute gt lt xsd attribute name instance use required gt lt xsd simpleType gt lt xsd restriction base xsd string gt lt xsd pattern value 0 9 gt lt xsd restri
51. lt xsd element name show type CommonRequestType gt lt xsd element name start type CommonRequestType gt lt xsd element name stop type CommonRequestType gt lt xsd element name oemverb type OemverbRequestType gt lt xsd element name include type Include minOccurs 0 maxOccurs unbounded gt lt xsd choice gt lt xsd complexType gt lt xsd element gt lt command request common type gt lt xsd complexType name CommonRequestType gt lt xsd sequence gt lt xsd element name abort type xsd boolean minOccurs 0 gt lt xsd element name instance type InstanceRequestType maxOccurs unbounded gt lt xsd element name options type Options minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt command request oemverb type gt lt xsd complexType name OemverbRequestType gt lt xsd sequence gt lt xsd element name verbname type xsd string gt lt xsd element name abort type xsd boolean minOccurs 0 gt lt xsd element name instance type InstanceRequestType minOccurs 0 maxOccurs unbounded gt lt xsd element name options type Options minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt instance request type gt 71 lt xsd complexType name InstanceRequestType gt lt xsd sequence gt lt xsd element name abort type xsd boolean minOccurs 0 gt lt xsd element name ufip type xsd strin
52. me help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt delete command response type gt lt xsd complexType name DeleteResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name target type TargetReferenceType minOccurs 0 maxOccurs unbounded I gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt dump load command response type gt lt xsd complexType name DumpLoadResponseType gt lt xsd choice minOccurs 0 gt lt xsd sequence gt lt xsd element name source type Path minOccurs 0 gt lt xsd element name destiation type Path minOccurs 0 gt lt xsd sequence gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt exit command response type gt lt xsd complexType name ExitResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name help type Help gt lt xsd element name examine type Examine gt lt xsd choice gt lt xsd complexType gt lt help command response type gt 75 lt xsd complexType name HelpResponseType gt lt xsd choice minOccurs 0 gt lt xsd element name text type xsd string gt lt xsd element name help type Help gt lt xsd el
53. ment The following explains three symbols that are used in this document IMPORTANT Points that are mandatory or require attention when using the software or the component CHECK Points that are require confirmation when using the software or the component TIP Helpful and convenient piece of information About Font in This Document The talic font shows the option of command in this document E For other information about the NEC ESMPRO Manager See the documents below NEC ESMPRO Manager Ver 6 Installation Guide NEC ESMPRO Manager Ver 6 Setup Guide NEC ESMPRO Manager Ver 6 Command Line Interface Chapteri 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 e 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 e Incase of CLI following characters are not available in group name V lt gt amp Using NEC ExpressUpdate Updates via NEC ExpressUpdate Agent or Updates via Management controller of the component must be enabled 1 2 System Requirements esmcli command can be executed only on a management PC which NEC ESMPRO Manager Ver 5 4 or later is installed on NEC ESMPRO Manager command line interface requires following user level of operating s
54. n Reboot read Displays whether that the selected update package requires a reboot after the installation e NECESSITY e UNNECESSITY Severity read Displays the severity of the update package e LOW e MEDIUM e HIGH ExpressUpdateS upported read Displays whether the update package supports automatic updating by NEC ExpressUpdate e SUPPORTED e UNSUPPORTED DowngradeSupported read Displays whether the update package supports downgrade e SUPPORTED e UNSUPPORTED MultipleModelSupported read Displays whether the update package supports multiple mode of component e SUPPORTED e UNSUPPORTED OtherUsed read Displays whether the update package is in use by other NEC ESMPRO Manager e UNOCCUPIED e DURING _USE 63 Examples show command enables you to view information about the update package gt show repository uppkgs NEC ExpressUpdate Agent_Windows_3 00_2011030217 1440 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 00 Release 4 7 2011 20 27 25 Target Windows Server 2003 Enterprise Edition Windows Server 2003 Standard Edition Windows Server 2003 R2 Enterprise Edition Windows Server 2003 R2 Standard Edition Model Express5800 E120b 1 Express5800 T120a M EstimatedTime 180s InstallEs
55. n lt path gt 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 Example dump repository uppkgs command enables you to archive all update packages into an update pa ckage archive If starting command succeeds all update packages to be archived are listed gt dump destination C temp repository uppkgs COMMAND COMPLETED ExpressUpdate Agent_Linux_3 00_20110310100740 ExpressUpdate Agent_Windows_3 00_20110302171440 The process to save update packages was started To confirm its progress execute show command on update packages element and refer to Progress property C temp UpdatePackageArchive_20120701 zip 5 3 4 2 Saving an update package Saving an update packages is located at the following target repository uppkgs lt uppkg name gt Specific option of this command is as follow Table 5 44 Specific options of dump repository uppkgs lt uppkg name gt Option Description destination lt path gt 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 Example dump repository uppkgs lt uppkg name command enables you to archive an update package into an update package archive If starting command succeeds an update package to be ar
56. nable you to view NEC ExpressUpdate Agent log gt show cmps Server01 map agtlogs expupagtlog ufip cmps Server0 1 map agtlogs expupagtlog ufit expupagtlog Targets Properties Verbs cd exit help show dump Examples dump commands enable you to save NEC ExpressUpdate Agent log to the specified directory Add destination option and specify the directory path to save file gt dump destination C temp cmps Server01 map agtlogs expupagtlog COMMAND COMPLETED C temp eualog1 zip If you want to save NEC ExpressUpdate Agent log file any name specify the zip file name to the path and execute commands dump destination C temp eualog zip cmps Server01 map agtlogs expupagtlog When you add force option the zip file is overwritten dump destination C temp eualog zip force cmps Server01 map agtlogs expupagtlog 68 Chapter7 Troubleshooting This section describes the error message and the coping method for it 7 1 Error message Table 7 1 Error messages Error Message What to do User name or password is not correct Please confirm the user name and the password and please input again Failed to connect to NEC ESMPRO Manager EH Windows OS Please confirm that the NEC ESMPRO Manager service ESMPRO SM Common Component is running NW Linux OS Please confirm that the following process is running by ps aux command opt nec es_manager jre
57. name xml lt file gt lt abort gt true lt abort gt lt include gt lt request gt More than one element can be specified In the following case filenamel xml is executed and then filename2 xml is executed lt xml version 1 0 encoding UTF 8 gt lt request gt lt include gt lt file gt filenamel xml lt file gt lt abort gt true lt abort gt lt include gt lt include gt lt file gt filename2 xml lt file gt lt abort gt true lt abort gt lt include gt lt request gt 24 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 lt COMMAND gt element is different from each basic commands Details of other elements are described in Table 2 2 lt In the case of successful gt lt xml version 1 0 encoding UTF 8 gt lt response gt lt command gt lt inputline gt lt inputline gt lt command gt lt cmdstat gt lt status gt 0 lt status gt lt status_tag gt COMMAND COMPLETED lt status gt lt cmdstat gt lt COMMAND gt lt COMMAND gt lt oemdata gt lt oemdata gt lt response gt lt In case of error gt lt xml version 1 0 encoding UTF 8 gt lt response gt lt command gt lt inputline gt
58. nd was unsuccessful This status is cleared by rebooting the system A reason of the failure is shown in application logs Refer to section 6 1 1 and 6 1 2 to get more information about the application log It is not possible to update a module under this status ACCESS_FATLED There is no communication to NEC ExpressUpdate Agent UNKNOWN Failed to get version information because the repository has incompatible packages Updating ESMPRO ServerManager is required NO_PACKAGE The repository has no package INSTALLABLE The specified software is installable Table 5 3 Specific commands of cmps lt Component Name gt map expup Command Description load Updates all modules of lt Component Name gt to the latest version Refer to section 5 2 1 1 for more information stop Cancels all update command to lt Component Name gt Refer to section 5 2 4 1 for more information Example show cmps lt Component Name gt map expup command enables you to view ExpressUpdate information of the component lt Component Name gt gt show cmps Server01 map expup ufip cmps Server0 1 map expup ufit expup Targets mods 1 uninstalled 2 modules Properties RepositoryLocation LOCAL ExpUpStatus NOT_LATEST UpdatePkgLatestDownloaded 2011 04 01 01 00 00 NextDownloadDate 201 1 04 02 01 00 00 Model Express5800 110Ge S OsVersion Microsoft Windows Vista Business Service Pack 2 x64 NextUpdate
59. nformation Example show cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command enables you to view information about the module lt Module Name gt of the component lt Component Name gt gt show cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent ufip cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent ufit NEC ExpressUpdate Agent Targets uppkgs Properties Module NEC ExpressUpdate Agent ExpUpStatus NOT_LATEST Version 3 0 Severity HIGH LatestApplyResult 2011 04 01 12 00 00 Applying the update package has been completed successfully NEC ExpressUpdate Agent 1 0 gt 2 0 Verbs cd exit help show load delete 5 1 4 2 Information of groups Information about each module is displayed at the below target grps grpset lt Group Name gt expup modules supportedmods managedmods lt Module Name gt Properties and specific commands of this target are as follows Table 5 12 Properties of grps grpset lt Group Name gt expup modules supportedmods manage dmods lt Module Name gt Property Access Description Module read Displays a name of this module ExpUpStatus read Displays ExpressUpdate status of this module Each status is listed in Table 5 2 Table 5 13 Specific command of grps grpset lt Group Name gt expup modules supportedmods managedmods lt Module
60. not start u user lt user name gt Input user name of NEC ESMPRO Manager At the time of login the input of the user name is omitted p pswd lt password gt Input user password of NEC ESMPRO Manager At the time of login the input of the user password is omitted x examine Validate contents of XML file but not to execute it override lt Name gt lt Value gt Replaces the value of XML element whose name equals lt Name gt with lt Value gt To obtain more information refer to 2 1 4Override process e The password at the time of the login can input the password that encrypted in Ae Mena N ee ee ee ee Examples Following command enables you to execute sample xml esmcli f sample xml u Administrator p password Examples Using an encrypted password please input it as follows esmcli f sample xml u Administrator p ENC c10f239c9f7d203fa4424bffb06b6713 10 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 lt Password gt esmclipasswd Indicates the NEC ESMPRO Manager command line interface command Option 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 lt Passwo
61. nt e SUPPORTED e UNSUPPORTED OtherUsed read Displays whether the update package is in use by other NEC ESMPRO Manager e UNOCCUPIED e DURING USE Progress read If archiving update packages is in execution displays its progress Table 5 27 Specific command of cmps lt Component Name gt map expup modules unsupporte dmods lt Module Name gt uppkgs lt PKG Version gt Command Description dump Archives update packages related to the specified module into an update package archive stop Cancels creating an update package archive if it is in execution 52 Table 5 28 Specific options of dump cmps lt Component Name gt map expup modules unsup portedmods lt Module Name gt uppkgs lt PKG Version gt 5 Option Description destination lt path gt 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 Example dump cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs lt PK G Version gt command enables you to archive an update package into an update package archive If starting command succeeds an update package to be archived is listed gt dump destination C temp cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs 5 0 COMMAND COMPLETED 5 0 The process to sa
62. onfirm the command s result from UpdatePkgLatestDownloaded property The download process will start and return to the input prompt To confirm this command results run show command and confirm UpdatePkgLatestDownloded property This value is updated at the downloading end time UpdatePkgLatestDownloaded 2011 04 01 12 00 00 Examples load wait command enables you to watch it until downloading is completed gt load wait repository Downloading update packages Press Ctrl D to stop monitoring Downloading update packages was finished Please press Ctrl D The download process will start and progress will be displayed When downloading is finished an end message is displayed After the end message you need to press Ctrl D key and return to the input prompt 58 Examples When you stop monitoring during downloading press Ctrl D key and return to the input prompt gt 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 When you add source option you can add update package which is not necessary for components gt load source C temp package_6
63. ortedmods ufit unsupportedmods Targets System BIOS BMC Firmware NEC ExpressUpdate Agent Properties EntryCount 3 Verbs cd exit help show 40 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 lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt Properties and specific commands of this target are as follows Table 5 10 Properties of cmps lt Component Name gt map expup modules supportedmods man agedmods lt Module Name gt Property Access Description Module read Displays a name of this module ExpUpStatus read Displays ExpressUpdate status of this module Each status is listed in Table 5 2 Version read Displays current version of this module Severity read Displays a severity of the update Severities are as follows e HIGH e MEDIUM e LOW LatestApplyResult read Displays result of the most recent update If updates have never been executed it shows hyphen Table 5 11 Specific commands of emps lt Component Name gt map expup modules supported mods managedmods lt Module Name gt Command Description load Updates or installs the specified module Refer to section 5 2 1 2 and 5 2 2 for more information delete Uninstalls the specified module Refer to section 5 2 3 for more i
64. pdate Agent_Linux_3 00_20110310100740 readme COMMAND COMPLETED C temp readme_en txt When the command succeeds the readme file path is displayed C temp readme_en txt 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 Table 6 1 Properties of logs Property Access Description EntryCount read Displays the number of application log MaxEntryCount read Displays the maximum number of application log Table 6 2 Specific commands of logs Command Description dump Saves NEC ESMPRO Manager application log to the specified directory File is saved in zip format When a file name is not included in the path LOG zip file is saved Table 6 3 Specific option of logs Option Description destination Specifies the destination path of the directory or the file name Absolute path and relative path can be specified Required option f force When there is a same name file in the destination directory the file is overwritten Examples show commands enable you to view the list of NEC ESMPRO Manager application log gt show logs ufip logs ufit logs Targets log0 logl log2 log3 log4
65. pe gt lt xsd sequence gt lt xsd element name property type PropertyResponseType maxOccurs unbounded gt lt xsd sequence gt lt xsd complexType gt lt property response type gt lt xsd complexType name PropertyResponseType gt lt xsd sequence gt lt xsd element name name type xsd string gt lt xsd element name value type ValueResponseType gt lt xsd sequence gt lt xsd complexType gt lt value response type gt minOccurs 0 77 lt xsd complexType name ValueResponseType gt lt xsd sequence gt lt xsd element name val type xsd string gt lt xsd element name valstring type xsd string minOccurs 0 gt lt xsd sequence gt lt xsd complexType gt lt command response help gt lt xsd complexType name Help gt lt xsd sequence gt lt xsd element name text type xsd string gt lt xsd sequence gt lt xsd complexType gt lt command response examine gt lt xsd complexType name Examine gt lt xsd sequence gt lt xsd element name text type xsd string gt lt xsd sequence gt lt xsd complexType gt lt command response source or destination path gt lt xsd complexType name Path gt lt xsd choice gt lt xsd element name ufip type xsd string gt lt xsd element name uri type xsd string gt lt xsd choice gt lt xsd complexType gt lt command response support commands gt
66. racy of all information in this document If you notice any part unclear incorrect or omitted in the document contact your authorized NEC sales representative 5 NEC assumes no liability for damages arising from the use of this product nor any liability for incidental or consequential damages arising from the use of this document regardless of 4 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 EH 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 For operations and inquiries about the operating system see its online help information This document covers universal information about generally managed components The notes and restrictions on use of each product as a managed component are explained in the user s guide provided with the managed component Names used with screen images in this document are fictitious They are unrelated to existing product names names of organizations or individual names The setting values on the screen images are shown as examples so setting values such as IP addresses on screen images are not guaranteed for operation E About Symbols in This Docu
67. rd gt Input a password to encrypt Examples When you encrypt the password please input it as follows gt esmclipasswd password ENC c10f239c9f7d203fa4424bffb06b6713 The encrypted password is displayed on the screen 11 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 lt options gt of the command The argument placed between and is omissible e Inthe case of the user authority is Administrator the user can execute all basic commands In the case of the user authority is Operator the user can execute cd exit help and show commands Other commands become executable by setting of the user level The details please identify a chapter of each operation e help cd exit and show commands are supported at all of targets help Syntax help lt options gt lt target gt Description The help command is used to request information related to the use of the CLP When you omit lt target gt the help command will display information about the use of current target cd Syntax cd lt options gt lt target gt Description The cd command is used to change the current default target to the target specified by the lt target gt argument You can shorten a command by changing current target When
68. rgets System BIOS BMC Firmware NEC ExpressUpdate Agent Properties EntryCount 3 Verbs cd exit help show 5 1 2 2 Information of groups A list of modules supporting automatic update for components belongings to the specified group is displayed at the below target grps grpset lt Group Name gt expup modules supportedmods managedmods Property of this target is as follow There is no specified command for this target Table 5 7 Property of grps grpset lt Group Name gt expup modules supportedmods managed mods Property Access Description EntryCount read Displays a number of modules managed by ExpressUpdate Example show grpset lt Group Name gt expup modules supportedmods managedmods command enables you to view a list of modules for components belongings to the specified group lt Group Name gt gt show grps grpset root expup modules supportedmods managedmods ufip grps grpset root expup modules supportedmods managedmods ufit managedmods Targets System BIOS BMC Firmware NEC ExpressUpdate Agent Properties EntryCount 3 Verbs cd exit help show 38 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 lt Component Name gt map expup modules unsupportedmods Property of this target
69. s Statuses are as follows e BLUE e RED e BLACK Version read Displays current version of this module Severity read Displays a severity of the update Severities are as follows e HIGH e MEDIUM e LOW LatestApplyResult read Displays result of the most recent update If updates have never been executed it shows hyphen Table 5 15 Specific commands of cmps lt Component Name gt map expup modules unsupporte dmod lt Module Name gt Command Description set Changes ExpUpStatus of the module BLUE RED and BLACK are able to be specified Example show cmps lt Component Name gt map expup modules unsupportedmod lt Module Name gt command enables you to view information about the module lt Module Name gt of the component lt Component Name gt gt show cmps Server01 map expup modules unsupportedmod BMC Firmware ufip cmps Server01 map expup modules unsupportedmod BMC Firmware ufit BMC Firmware Targets uppkgs Properties Module BMC Firmware ExpUpStatus BLUE Version 3 0 Severity HIGH LatestApplyResult Verbs cd exit help show set 43 5 1 5 2 Information of groups Information about each module is displayed at the below target grps grpset lt Group Name gt expup modules unsupportedmods lt Module Name gt Properties and specific commands of this target are as follows Table 5 16 Properties of grps grpset lt Group Name gt expup modules s uns
70. s NEC ExpressUpdate Agent COMMAND COMPLETED Updating was started Run the show command to the each module element and you can confirm this command s progress from ExpUpStatus property Run the show command to the each module element and you can confirm this command s result from LatestApplyResult property cmps Server01 map expup modules supportedmods managedmods NEC ExpressUpdate Agent 47 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 lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt Specific option of this command is as follow Table 5 21 Specific options of emps lt Component Name gt map expup modules supportedmod s managedmods lt Module Name gt Option Description source Specifies the update package reboot Enables ExpressUpdate to reboot the system if the installation requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled Example load cmps lt Component Name gt map expup modules supportedmods managedmods lt Module Name gt command enables you to install an module lt Module Name gt to the specified component lt Component Name gt gt load source 4 4 1 cmps Server01 map expup modules supportedmods managedmods ES MPRO Ser verAgent Ver 4 4 COMMAN
71. setting remotesetting Properties RepositoryLocation LOCAL UpdatePackageServerAddress http expressupdate express nec co jp UpdatePkgLatestDownloaded 2011 04 01 12 00 00 TotalSizeOfUpdatePackage 34 2MB FreeSpace 100GB Verbs cd exit help show load set stop Examples set command enables you to modify 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 e When you set RepositoryLocation in REMOTE you should set remote repository settings beforehand See 5 3 1 2Remote repository settings e In the case of the user authority is Operator Change Environment Setting of the user level must be enabled 5 3 1 1 Local repository settings You can view and change Manager PC repository settings Local repository settings are located at the following target repository localsetting Properties and specific commands of this target are as follows Table 5 31 Properties of repository localsetting Property Access Description RepositoryPassword read write Sets the password to access repository This is displayed in eee AutoUpdate read write Sets the automatic updating of the repository The valid
72. specified by absolute path separated by To specify some elements describe them separated by esmcli f filename xml override request lt ElementName gt lt ElementName gt lt Value gt If there is more than one element corresponding to the specified path specify the order of the element by ElementName number If the number is not specified all elements corresponding to the path will be overridden In the following example e request show instance options option value val 1 matches 1 e request show instance options option value val 2 matches 2 e request show instance options option value val_ matches both 1 and 2 lt request gt lt show gt lt instance gt lt ufip gt lt ufip gt lt options gt lt option gt lt name gt name lt name gt lt value gt lt val gt val lt val gt lt 1 gt lt value gt lt option gt lt option gt lt name gt name lt name gt lt value gt lt val gt val lt val gt lt 2 gt lt value gt lt option gt lt options gt lt instance gt lt show gt lt request gt 23 2 1 5 Include process A request XML can include other request XML and execute its commands To use this function create an lt include gt element under lt request gt element and specify included file using lt file gt element lt xml version 1 0 encoding UTF 8 gt lt request gt lt include gt lt file gt file
73. stination lt path gt lt options gt lt target gt Description The dump command is used to take a binary image from the target and send it to a specific location 13 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 lt target gt following to each basic command If it is not specified commands functions to a current default target The current default target can be changed by the cd command The current default target is root when the command line interface session is started 1 5 2 Basic options This section describes basic options based on SMASH style h help Description Displays documentation about the command verb When this option is specified the command is not executed This option is supported by all basic commands x examine Description Checks the syntax of the command When this option is specified the command is not executed This option is supported by all basic commands d display lt type gt lt type gt Description Shows information of the selected lt type gt This option is supported by show command Type can speci
74. swd lt password gt Input user password of NEC ESMPRO Manager At the time of login the input of the user password is omitted CLI Command Surround the CLI command to execute with e The password at the time of the login can input the password that encrypted in 1 4 4Encrypting of the password Examples Following command enables you to execute show command esmcli u Administrator p password show Examples Using an encrypted password please input it as follows esmcli u Administrator p ENC c10f239c9f7d203fa4424bffb06b6713 show 1 4 2 1 Notes on executing one liner mode 1 When entering special characters When input double quotation in CLI command please set before double quotation The following shows examples esmcli show cmps server 01 map expup 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 1 XML Schema for request file esmcli f lt XML file name gt Option esmcli Indicates the NEC ESMPRO Manager command line interface command lt XML file name gt Specifies XML file in which esmcli commands are written Option Input an option There are following types of option h help Display the command syntax of the esmcli command When this option is appointed the shell mode does
75. the component belongs to IpAddress read Displays an IP address of the component BmelpAddress read Displays a BMC s IP address of the component Model read Displays a model name of the component SerialNumber read Displays a serial number of the component Guid read Displays a GUID of the component OsVersion read Displays an OS information of the component Example show command shows information of the component More concrete examples are as follows gt show cmps Server01 ufip cmps Server01 ufit Server01 Targets system map Properties Name Server01 Status NORMAL ExpUpStatus LATEST_CONDITION Group group01 IpAddress 192 168 14 18 BmelpAddress 192 168 14 19 Model Express5800 51Ma N8000 2001 SerialNumber 1234567 Guid AAAAAAAA 0000 BBBB 1111 CCCCCCCCCCCC OsVersion Microsoft Windows Vista Business Service Pack 2 Verbs cd exit help show 30 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 e grps Property of this target is as follow There is no specified command for this target Table 4 1 Properties of grps Property Access Description EntryCount read A number of registered groupset Example show command shows a list of groupset More concrete examples are as follows gt show grps ufip grps ufit grps Targets grpset chassisset Propert
76. the case of the user authority is Operator Install Update Packages of the user level must be enabled Example stop grps grpset lt Group Name gt expup command enables you to cancel updates of components belonging to the specified group lt Group Name gt If this command is successful a list of cancelled tasks is shown gt stop grps grpset root expup COMMAND COMPLETED cmps Server01 map expup mods BMC Firmware cmps Server01 map expup mods NEC ExpressUpdate Agent cmps Server02 map expup mods NEC ExpressUpdate Agent Cancel of update process was executed 50 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 1 For the specified component and module dump command at the below target enables you to copy update packages related to specified component and module cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs Table 5 23 Properties of cmps lt Component Name gt map expup modules unsupportedmods lt Module Name gt uppkgs Property Access Description EntryCount read Displays a number of modules managed by
77. timatedTime 120s UninstallEstimatedTime 300s Reboot UNNECESSITY Severity ExpressUpdateSupported SUPPORTED DowngradeSupported UNSUPPORTED MultipleModelSupported SUPPORTED OtherUsed UNOCCUPIED Verbs cd exit help show delete 64 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 lt uppkg name gt readme Specific command of this target is as follow There is no property for this target Table 5 47 Specific command of repository uppkgs lt uppkg name gt readme Command Description dump Saves the readme file to specified directory Table 5 48 Specific option of repository uppkgs lt uppkg name gt readme Option Description destination Specifies the directory to save the readme file Required option f force When there is a same name file in the directory of the destination the file is overwritten CHECK The readme file name depends on the update package You can t specify the readme file name when you save it A A o NS EEE Examples dump command enables you to save the readme file to specified directory Adds destination option and specifies the path of the directory When you add force option the readme file is overwritten gt dump destination C temp repository uppkgs NEC ExpressU
78. ump gt lt instance gt lt ufip gt logs lt ufip gt lt options gt lt option gt lt name gt destination lt name gt lt value gt lt val gt C temp lt val gt lt value gt lt option gt lt options gt lt instance gt lt dump gt lt request gt Example Execute set command to repository and change RepositoryLocation to LOCAL gt set repository RepositoryLocation LOCAL lt xml version 1 0 encoding UTF 8 gt lt request gt lt set gt lt instance gt lt ufip gt repository lt ufip gt lt properties gt lt property gt lt name gt RepositoryLocation lt name gt lt value gt lt val gt LOCAL lt val gt lt value gt lt property gt lt properties gt lt instance gt lt set gt lt request gt Example Execute load command to cmps lt Component Name gt map expup and applies latest update packages to lt Component Name gt gt load cmps lt Component Name gt map expup lt xml version 1 0 encoding UTF 8 gt lt request gt lt load gt lt instance gt lt ufip gt cmps lt Component Name gt map expup lt ufip gt lt instance gt lt load gt lt request gt 22 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
79. upportedmods lt M odule Name gt Property Access Description Module read Displays a name of this module ExpUpStatus read An ExpressUpdate status of the moduls Statuses are as follows BLUE e RED e BLACK Example show grps grpset lt Group Name gt expup modules unsupportedmods lt Module Name gt command enables you to view information about the module lt Module Name gt of the component lt Group Name gt gt show grps grpset root expup modules unsupportedmods BMC Firmware ufip grps grpset root expup modules unsupportedmods BMC Firmware ufit BMC Firmware Targets uppkgs Properties Module BMC Firmware ExpUpStatus BLUE Severity HIGH Verbs cd exit help show 44 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 lt Component Name gt map expup Specific option of this command is as follow Table 5 17 Specific option of cmps lt Component Name gt map expup Option Description reboot Enables ExpressUpdate to reboot the system if the update requires it CHECK In the case of the user authority is Operator Install Update Packages of the user level must be enabled Example load cmps lt Component Name gt map expup command enables you to update all modules of the specifi
80. ve update packages was started To confirm its progress execute show command on update packages element and refer to Progress property C temp UpdatePackageArchive_20120701 zip 53 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 Table 5 29 Properties of repository Property Access Description RepositoryLocation read write Displays and sets location of the repository The valid values are e LOCAL e REMOTE UpdatePackageServerAddress read Displays address of update package server UpdatePkgL atestDownloaded read Displays the date when the repository downloaded update packages last TotalSizeOfUpdatePackage read Displays total size of update packages The unit is MB FreeSpace read Displays free space of the disk which there is the preservation folder of the update packages Table 5 30 Specific commands of repository Command Description set Sets repository settings This command enables you to modify location of the repository load Downloads or adds update packages to repository stop Cancels downloading update packages from the update package server Examples show command enables you to view the repository settings gt show repository ufip repository ufit repository Targets uppkgs local
81. you omit lt target gt the cd command will display current target exit Syntax exit lt options gt Description The exit command terminates and logs out the user session show Syntax show lt options gt lt target gt Description The show command is used to display information about lt target gt When you omit lt target gt the show command will display information about current target create Syntax create lt options gt lt target gt Description The create command is used to create new target objects 12 delete Syntax delete lt options gt lt target gt Description The delete command is used to remove a target When you omit lt target gt the delete command will delete current target load Syntax load lt options gt lt target gt 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 lt options gt lt target gt Description The reset command resets the target s state set Syntax set lt options gt lt target gt lt propertyname gt lt value gt Description The set command is used to set the value of one or more of a target s properties start Syntax start lt options gt lt target gt Description The start command starts the target stop Syntax stop lt options gt lt target gt Description The stop command stops the target dump Syntax dump de
82. ystem On Windows Administrator On Linux root CHECK In case of Windows Vista Windows 7 Windows 8 Windows 8 1 Windows Server 2008 Windows Server 2008 R2 Windows Server 2012 and Windows Server 2012 R2 you need to set the permission to access to the directory including Command Line Interface execution file esmcli exe After setting the permission the standard user can also use Command Line Interface A ote o eat is e ds E E Fee ea Se ee Ai e A A A A A e See NEC ESMPRO Manager Ver 6 Installation Guide for information about system requirements of NEC ESMPRO Manager 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 Examples When NEC ESMPRO Manager is installed on Windows environments Client PC Management PC Managed Component TCP IP Examples When NEC ESMPRO Manager is installed on Linux environments Client PC Management PC Managed Component TCP IP Telnet SSH 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 a Windows OS C Program FilesXESMPROYESMMNGYbin This path is added to the system environment variable PATH a Linux OS opt nec es_manager bin A symbolic link to esmcli is created on usr bin directory esmcli has two mode interact

NEC Express5800/R110f-1E User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents