NEC Express5800-R120f-2M, Express5800-R120d-1M, Express5800-R110f-1E, Express5800-R120f-1M, Express5800-R120d-2M Reference Guide

...

User's Guide

Express5800 Series



NEC ESMPRO Manager Ver.6

Command Line Interface

Chapter1 About Command Line Interface Chapter2 Command Summary

  

Ver.1.00

Contents............................................................................................................................................................. 1

Trademarks...................................................................................................................................................... 4

About This Document ....................................................................................................................................... 5

Chapter1 About Command Line Interface....................................................................................................6

1.1 System Requirements........................................................................................................................ 6

1.2 How to Execute Commands.............................................................................................................. 7

1.2.1 Notes on Entering Commands............................................................................................... 7

1.3 Execution Results..............................................................................................................................8

1.4 Example............................................................................................................................................. 8

1.5 Executing Command from Two or More NEC ESMPRO Manager.................................................. 8

Chapter2 Command Summary...................................................................................................................... 9

2.1 Group management Commands........................................................................................................ 9

2.1.1 getList.................................................................................................................................... 9

2.1.2 createGroup ..........................................................................................................................11

2.1.3 deleteGroup ..........................................................................................................................11

2.1.4 moveGroup...........................................................................................................................11

2.1.5 setGroupProperty................................................................................................................. 12

2.1.6 getGroupProperty ................................................................................................................12

2.1.7 getGroupStatus .................................................................................................................... 13

2.1.8 groupPowerOn..................................................................................................................... 14

2.1.9 groupPowerOff.................................................................................................................... 15

2.1.10 groupReset........................................................................................................................... 16

2.1.11 groupPowerCycle ................................................................................................................ 17

2.1.12 groupShutdownOs............................................................................................................... 18

2.1.13 groupSetPowerRestoreDelay............................................................................................... 19

2.1.14 getGroupRemoteKvmLicense ............................................................................................. 20

2.2 Component Management Commands..............................................................................................21

2.2.1 getServerList........................................................................................................................ 21

2.2.2 getServerNameByMacAddr ................................................................................................ 22

2.2.3 getServerNameByGuid........................................................................................................ 22

2.2.4 findNewServer..................................................................................................................... 23

2.2.5 findNewServerNetAddr....................................................................................................... 24

2.2.6 createServer.........................................................................................................................24

2.2.7 deleteServer.........................................................................................................................25

2.2.8 checkConnection .................................................................................................................25

2.2.9 setServerProperty................................................................................................................. 26

2.2.10 moveServer.......................................................................................................................... 27

2.2.11 getServerGroup.................................................................................................................... 28

2.2.12 setCurrentPort...................................................................................................................... 28

2.2.13 getServerProperty................................................................................................................ 29

2.2.14 getServerInfo....................................................................................................................... 29

2.2.15 getDeviceId.......................................................................................................................... 31

2.2.16 getGuid................................................................................................................................ 31

2.2.17 getProductName..................................................................................................................32

2.2.18 getSoftwareInfo...................................................................................................................32

2.2.19 setShutdownPolicy .............................................................................................................. 33

2.2.20 getShutdownPolicy.............................................................................................................. 34

2.2.21 setPowerRestoreDelay......................................................................................................... 35

2.2.22 getPowerRestoreDelay ........................................................................................................ 36

2.2.23 setBmcInfo .......................................................................................................................... 36

2.2.24 getBmcInfo.......................................................................................................................... 45

2.2.25 setAuthKey.......................................................................................................................... 46

setSensorLevel..................................................................................................................... 46

2.2.26

2.2.27 getSensorLevel.................................................................................................................... 51

2.2.28 getAgentExtensionLog........................................................................................................52

2.2.29 testAlert ............................................................................................................................... 53

2.2.30 getTestAlertStatus................................................................................................................ 54

2.2.31 getServerStatus.................................................................................................................... 54

2.2.32 getPowerStatus.................................................................................................................... 55

2.2.33 getStatusLamp..................................................................................................................... 55

2.2.34 getPanelInfo......................................................................................................................... 56

2.2.35 powerOn.............................................................................................................................. 57

2.2.36 powerOff.............................................................................................................................. 57

2.2.37 reset ..................................................................................................................................... 58

2.2.38 powerCycle.......................................................................................................................... 59

2.2.39 shutdownOs......................................................................................................................... 60

2.2.40 dumpSwitch......................................................................................................................... 60

2.2.41 clearSel................................................................................................................................ 61

2.2.42 identifyChassis .................................................................................................................... 61

2.2.43 getIpmiInfo.......................................................................................................................... 61

2.2.44 getSensorList....................................................................................................................... 62

2.2.45 getSensorStatus.................................................................................................................... 62

2.2.46 getConsoleLog..................................................................................................................... 63

2.2.47 setBmcIpSync...................................................................................................................... 64

2.2.48 getBmcIpSync ..................................................................................................................... 64

2.2.49 getBladeSlotId..................................................................................................................... 65

2.2.50 deleteBmcUser..................................................................................................................... 65

2.2.51 getBmcUserList................................................................................................................... 66

2.2.52 setBmcUserInfo................................................................................................................... 67

2.2.53 getBmcUserInfo................................................................................................................... 67

2.2.54 setPowerRestorePolicy........................................................................................................ 68

2.2.55 getPowerRestorePolicy........................................................................................................ 68

2.2.56 getSystemFtLamp................................................................................................................ 69

2.3 EM Card Management Commands ................................................................................................. 70

2.3.1 getEmCardList..................................................................................................................... 70

2.3.2 getEmActiveState................................................................................................................71

2.3.3 identifyEm...........................................................................................................................71

2.3.4 getEmStatusLamp................................................................................................................ 72

2.4 Chassis Management Commands.................................................................................................... 73

2.4.1 getBladeEnclosureList......................................................................................................... 73

2.4.2 getChassisSlotState.............................................................................................................. 73

2.4.3 getChassisInfo ..................................................................................................................... 74

2.4.4 setChassisProperty............................................................................................................... 75

2.4.5 getChassisProperty ..............................................................................................................75

2.4.6 setBladeAutoSetting............................................................................................................ 76

2.4.7 getBladeAutoSetting............................................................................................................ 77

2.5 Communication Management Commands.......................................................................................78

2.5.1 connect................................................................................................................................. 78

2.5.2 disconnect............................................................................................................................ 78

2.5.3 getConnectionStatus............................................................................................................ 78

2.6 Environment Setting Commands..................................................................................................... 79

2.6.1 setOption.............................................................................................................................. 79

2.6.2 getOption............................................................................................................................. 80

2.6.3 getPermitIpAddrList............................................................................................................ 80

2.6.4 isPermitIpAddr.................................................................................................................... 81

2.6.5 addPermitIpAddr.................................................................................................................81

2.6.6 removePermitIpAddr........................................................................................................... 81

clearPermitIpAddr...............................................................................................................82

2.6.7

2.7 User Management Commands......................................................................................................... 83

2.7.1 createUser............................................................................................................................ 83

2.7.2 deleteUser............................................................................................................................ 83

2.7.3 getUserList .......................................................................................................................... 83

2.7.4 setUserProperty ................................................................................................................... 84

2.7.5 getUserProperty................................................................................................................... 85

2.8 Other Commands............................................................................................................................. 86

2.8.1 getApplicationLog...............................................................................................................86

2.8.2 about....................................................................................................................................86

2.8.3 help...................................................................................................................................... 86

Trademarks

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 product, brand, or trade names used in this publication are the trademarks or registered trademarks of their respective trademark owners.

Windows Server 2012 R2 stands for Windows Server® 2012 R2 Stand ard, 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 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 operating system, Windows® 7 Ultimate operating system. 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.

 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 o f NEC

Corporation

(4) All efforts have been made to ensure the accuracy 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 the component management utility "NEC ESMPRO Manager". Before attempting to operate the command line interface, read this document so as to gain an adequate understanding of the contents.

 Attention

This document is intended for persons who are familiar with the operating system's functions and operations and the network's functions and setup. 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.

 About Symbols in This Document

The following explains three symbols that are used in this document:

IMPORTANT:

CHECK: TIP:

 About Font in This Document

The Italic font shows the option of command in this document.

 For other information about the NEC ESMPRO Manager

See the documents below.

NEC ESMPRO Manager Ver.6 Installation Guide (Windows)

NEC ESMPRO Manager Ver.6 Installation Gui de (Li n ux ) NEC ESMPRO Manager Ver.6 Setup Guide NEC ESMPRO Manager Ver.6 Command Line Interface User’ s Guide for NEC ExpressUpdate

Points that are mandatory or require attention when using the software or the component. Points that are require confirmation when using the software or the component. Helpful and convenient piece of information.

Chapter1 About Command Line Interface

The NEC ESMPRO Manager command line interface provides a set of commands that can control managed components through the command line from the management PC. The set of commands covers a part of functions that can be executed by using the web browser.

CHECK:

 The set of commands mainly enables to execute functions by communication with BMC or

NEC ESMPRO Agent Extension on the managed component. It does not support the functions that require NEC ESMPRO Agent on the managed component.

The following commands are available:

 Group management Commands

Use to operate a group due to operate more than one managed components through a single operation.

 Component Management Commands

Use to operate a managed component.

 EM Card Management Commands

Use to operate an EM card.

 Chassis Management Commands

Use to operate a chassis.

 Communication Management Commands

Use to change settings for connection to a managed component via modem or directly.

 Environment Setting Commands

Use to view and change the settings of NEC ESMPRO Manager.

 User Management Commands

Use to manage users who operate NEC ESMPRO Manager on web browser.

 Other Commands

1.1 System Requirements

The NEC ESMPRO Manager command line interface can be executed only on a management PC that is installed the NEC ESMPRO Manager.

The NEC ESMPRO Manager command line interface requires following user level of operating system:

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 (dscli.exe). After setting the permission to access the directory, the standard user can also use Command Line Interface.

TIP:

 See “NEC ESMPRO Manager Ver.6 Installation Guide” about the system requirement of

NEC ESMPRO Manager.

1.2 How to Execute Commands

To execute a command, enter the command following the command prompt as shown below.

dscli CommandName [Option, …]

dscli : CommandName : Option :

1.2.1 Notes on Entering Commands

This section explains notes on entering commands

(1) When entering special characters:

If you input null string or special characters as option , enclose the option parameter between double quotation marks. The following shows examples:

Example1: Input null string

dscli setGroupProperty MyGroup GROUP_COMMENT “”

Example 2: Input special characters

dscli setServerProperty MyServer CFG_SERIAL_INIT “ATE1Q0V1X4&D2&C1S0=0”

(2) When entering MAC address:

MAC address that can be specified in “Component” of command option is the MAC address of LAN that BMC uses on the managed component. Input MAC address as hexadecimal number that is delimited to octets by a colon. The following shows an example:

dscli getServerProperty 00:30:13:16:cd:fe SERVER_IP_1

(3) When entering GUID:

Input GUID as hexadecimal number that is delimited to sections by a colon. The following shows an example:

dscli getServerProperty 80c03228:35d8:d711:8001:003013f10072 SERVER_IP_1

CHECK:

 You can enter the command format that MAC address or GUID is specified as Server

option after the “Check Connection” is performed for the server.

Indicates the NEC ESMPRO Manager command line interface command Enter the name of the command you want to execute. Enter the option parameters defined for each command

1.3 Execution Results

All the commands return the end status. If an error has occurred, they return an error message. The end status of all the commands is as follows:

0 Normal end Non Zero value Error end

If a command error occurs, a non-zero value will be returned as the end status and the erro r message will be displayed. Some error messages are displayed followed by an error cause message

TIP:

 If a command is executed with a shell script, the end status can be confirmed with

"ERRORLEVEL" for Windows and "$?" for Linux.

1.4 Example

The procedure to manage a component via LAN is as follows:

(1) Creates a new component group using createGroup command. (2) Register a managed component using createServer command. (3) Perform a "Check Connection" for the managed component using checkConnection command.

You can manage the managed component after "Check Connection" is completed.

1.5 Executing Command from Two or More NEC ESMPRO Manager

As well as one component can be managed from two or more manager server, you can also execute command from two or more NEC ESMPRO Manager.

IMPORTANT:

 See “NEC ESMPRO Manager Ver.6 Installation Guide” about Notes.

Chapter2 Command Summary

2.1 Group management Commands

2.1.1 getList

Syntax:

dscli getList GroupName [/g] [/x]

Description:

Displays the list of groups and components registered under the specified group. If no appending option is specified, displays the groups and components just under the specified group.

Options:

GroupName

Specify the name of the group. If you want to display the groups and components under root, specif y “root”.

Display only groups.

Display the list under the specified group and its sub-groups.

Output:

Shows the example that the groups and components have following structure.

Displays the list of groups and components. The following shows an example.

>dscli getList root group1 <GROUP> group2 <GROUP> component1 group3 <GROUP> component2 component3

Displays the case specified “/g” option. The following shows an example.

>dscli getList root /g group1 <GROUP> group2 <GROUP> group3 <GROUP>

Displays the case specified “/x” option. The following shows an example.

>dscli getList root /x root group1 <GROUP> group11 <GROUP> component111 component11 group2 <GROUP> component1 group3 <GROUP> group31 <GROUP> component311 component31 component32 group32 <GROUP> component321 component322 component2 component3

Displays the case specified “/g” and “/x” option. The following shows an example.

>dscli getList root /g /x root group1 <GROUP> group11 <GROUP> group2 <GROUP> group3 <GROUP> group31 <GROUP> group32 <GROUP>

2.1.2 createGroup

Syntax:

dscli createGroup GroupName [ParentGroupName]

Description:

Creates a new component group.

Options:

GroupName

Specify the group name to create. You can input up to 63 characters.

ParentGroupName

Specify the name of the parent group when the group is made under the group. If you create a group under root, specify “root” or omit this option.

TIP:

 The name of group that is already registered cannot be specified to GroupName

2.1.3 deleteGroup

Syntax:

dscli deleteGroup GroupName

Description:

Deletes a specified group. All managed components and sub-groups in the group are also deleted.

Options:

GroupName

Specify the name of the group.

2.1.4 moveGroup

Syntax:

dscli moveGroup GroupName [ParentGroupName]

Description:

Move the specified group. All managed components and sub-groups in the group are also moved

Options:

GroupName

Specify the name of group.

ParentGroupName

Specify the name of the parent group to move to. If you move the group under root, specify “root” or omit this option.

2.1.5 setGroupProperty

Syntax:

dscli setGroupProperty GroupName PropertyName Value

Description:

Sets the property of a group.

Options:

GroupName

Specify the name of group.

PropertyName

Specify the name of the group property. The following is group property list:

Value

Specify a new value to be set. See the list below.

PropertyName Contents Value Default

GROUP_NAME

GROUP_COMMENT

Specify the name of the group. Up to 63

characters.

Enter the comments of the group. Up to 255

characters.

(None)

TIP:

 The name of group that is already registered cannot be specified to GROUP_NAME.

2.1.6 getGroupProperty

Syntax:

dscli getGroupProperty GroupName PropertyName

Description:

Displays the property of a group.

Options:

GroupName

Specify the name of group.

PropertyName

Specify the name of group property. For the list of group properties, see the 2.1.5 setGroupProperty command

Output:

Display the property of a group.

2.1.7 getGroupStatus

Syntax:

dscli getGroupStatus GroupName

Description:

Displays the status of a specified component group. Among all component condition under the group, displays the worst condition as a status of the group. Confirms the condition of component by component monitoring function.

Options:

GroupName

Specify the name of group.

Output:

Displays the status of the specified component group. There are following types of status.

ERROR Error WARNING Warning UNKNOWN Unknown or connection error DC-OFF DC-OFF NORMAL Normal NO_MONITORING Out of monitoring

2.1.8 groupPowerOn

Syntax:

dscli groupPowerOn GroupName [/p] [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Turns on all managed components in a specified group. The managed components in the sub-group are also controlled.

IMPORTANT:

 In case that the managed component does not sup port a force network-boo t function which

boots the component from network regardless of boot order, a force network-boot function cannot be executed. See “NEC ESMPRO Manager Managed Components Summary” whether the managed component supports function.

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

Force boot from network after the power is turned on.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the server could not be made. (Timeout)

Component2

: Connection to the server could not be made. (Authentication error)

2.1.9 groupPowerOff

Syntax:

dscli groupPowerOff GroupName [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Forcibly turns off all managed components in a specified group. The managed components in the sub-group are also controlled.

IMPORTANT:

 Since remote power control using NEC ESMPRO Manager is provided by hardware

regardless of the condition of operating system on the managed component, the system may be damaged. Be careful when you perform remote power control. Reconfirm the status of the managed component before power controls.

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the server could not be made. (Timeout)

Component2

: Connection to the server could not be made. (Authentication error)

2.1.10 groupReset

Syntax:

dscli groupReset GroupName [/p] [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Forcibly resets all managed components in a specified group. The managed components in the sub-group are also controlled.

IMPORTANT:

 Since remote power control using NEC ESMPRO Manager is provided by hardware

 In case that the managed component does not sup port a force network-boo t function which

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

Force boot from network after reset.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the server could not be made. (Timeout)

Component2

: Connection to the server could not be made. (Authentication error)

2.1.11 groupPowerCycle

Syntax:

dscli groupPowerCycle GroupName [/p] [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Forcibly turns off all managed components in a specified group and then turns them on. The managed components in the sub-group are also controlled.

IMPORTANT:

 Since remote power control using NEC ESMPRO Manager is provided by hardware

 In case that the managed component does not sup port a force network-boo t function which

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

Force boot from network after the power is turned on.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the server could not be made. (Timeout)

Component2

: Connection to the server could not be made. (Authentication error)

2.1.12 groupShutdownOs

Syntax:

dscli groupShutdownOs GroupName [/force] [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Shut downs operating systems on all managed components in a specified group. The managed components in the sub-group are also controlled. This command via LAN instructs the NEC ESMPRO Agent Extension service to shutdown the operating system. If you specify “/force” option, this command executes the forced shutdown OS function without communication to the NEC ESMPRO Agent Extension or the NEC ESMPRO Agent. You need to specify “/force” option if the connection is via LAN or direct.

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

/force

If you specify “/force” option, this command executes the forced shutdown OS function. This shutdown may not work depending on the kind of OS or the OS settings.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the component could not be made. (Timeout)

Component2

: Connection to the component could not be made. (Authentication error)

2.1.13 groupSetPowerRestoreDelay

Syntax:

dscli groupSetPowerRestoreDelay GroupName DelayTime [/x Policy] [/exs ComponentName1 ComponentName2 ... ComponentNameN] [/exg GroupName1 GroupName2 ... GroupNameN]

Description:

Changes the power option that specifies working of managed components in a specified group when they are turned AC ON. The managed components in the sub-group are also controlled. The power option includes AC-LINK policy and the time that delays Power ON (DC ON) when the managed component is set to be turned DC ON in time with AC ON.

IMPORTANT:

 In case that the managed component does not support a setting of power restore delay, this

command is invalid. See “NEC ESMPRO Manager Managed Components Summary” whether the managed component supports the function.

CHECK:

 This command is not executed for the PowerBay, the EM card, and the switch blade.  NEC ESMPRO Manager does not set the specified delay time to the blade server in which

EXPRESSSCOPE Engine 3 is integrated.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

DelayTime

AAA–600 Set the delay time from turning on AC to turning on DC.

* AAA is the minimum value of the delay time of the components.

-1 Set “-1” if you do not change the delay time from turning on AC to turning on DC. RANDOM Set “RANDOM” if you change the delay time from turning on AC to turning on DC to

random setting. * If the component supports random setting, the random setting can be specified.

/x Policy

Set AC-Link policy. There are 3 types of the policy.

STAY_OFF The managed component remains OFF when AC power is restored. LAST_STATE If the managed component is OFF when AC power is lost, the managed component

remains OFF when AC power is restored. If the managed component is ON, when AC power is lost, the managed component turns ON after the delay time when AC power is restored.

POWER_ON The managed component turns ON after the delay time when AC power is restored.

/exs

When you specify “/exs” option and the component name after it, the command is not executed on the specified component. You can specify plural component names.

/exg

When you specify “/exg” option and the group name after it, the command is not executed on the component under the specified group. You can specify plural group names.

Output:

If error has occurred, the name and the error message about each error-occurred managed component is displayed. The following shows an example.

Component1

: Connection to the component could not be made. (Timeout)

Component2

: Connection to the component could not be made. (Authentication error)

2.1.14 getGroupRemoteKvmLicense

Syntax:

dscli getGroupRemoteKvmLicense GroupName

Description:

Displays the state of “Remote KVM and Media License” for each managed components in a specified group. The managed components in the sub-group are also displayed.

Options:

GroupName

Specify the name of group. If you want to control all the components under root, specify “root”.

Output:

The following are states of “Remote KVM and Media License”.

Installed “Remote KVM and Media License” has been installed. Not Installed “Remote KVM and Media License” has not been installed. Unsupported “Remote KVM and Media License” is not supported for the component.

- The state of “Remote KVM and Media License” is unknown.

The following shows an example.

Component1 : Installed Component2 : Installed Component3 : Not Installed Component4 : Unsupported Component5 : : :

2.2 Component Management Commands

2.2.1 getServerList

Syntax:

dscli getServerList [/d]

Description:

Displays the name list of all managed components registered on NEC ESMPRO Manager.

Options:

If you specify “/d” option, the managed components list will indicate component name, GUID and

MAC address of LAN port that BMC uses of each component. Added information below is also indicated.

EXPRESSSCOPE Engine series BMC is EXPRESSSCOPE Engine series. ARMC : BMC is Advanced Remote Management Card. SWB : indicates that the managed component is a kind of switch blade.

Output:

Displays the name list of all managed components registered on NEC ESMPRO Manager. The following shows an example.

If “/d” option is not specified:

Component1 Component2 Component3 : :

If “/d” option is specified:

Component1 GUID 02010202:0000:0000:0000:000000000000 MAC1 00:30:13:f1:00:5a MAC2 00:30:13:f1:00:5b EXPRESSSCOPE Engine

Component2 GUID 00301316:cdfe:0180:0010:846e8062d906 MAC1 00:30:13:16:cd:fe SWB

Component3 GUID 00010203:0405:0607:0809:0a0b0c0d0e0f MAC1 00:00:4c:9f:13:cb ARMC :

2.2.2 getServerNameByMacAddr

Syntax:

dscli getServerNameByMacAddr MacAddress

Description:

Displays the name of the managed component that has the specified MAC address.

Options:

MacAddress

Specify a MAC address of LAN port that BMC uses on the managed component.

The following shows an example.

dscli getServerNameByMacAddr 00:30:13:f1:00:5a

Output:

Displays the name of the managed component. The following shows an example.

Component1

2.2.3 getServerNameByGuid

Syntax:

dscli getServerNameByGuid GUID

Description:

Displays the name of the managed component that has the specified GUID.

Options:

GUID

Specify a GUID.

The following shows an example.

dscli getServerNameByGuid 00301316:cdfe:0180:0010:846e8062d906

Output:

Displays the name of the managed component. The following shows an example.

Component2

2.2.4 findNewServer

Syntax:

dscli findNewServer StartIpAddr EndIpAddr

Description:

Finds BMC on managed components that are not registered on NEC ESMPRO Manager according to IP address range specification.

TIP:

 To register the managed component that is found using findNewServer command or

findNewServerNetAddr command, you can use createServer command. See 2.2.6 createServer.

Options:

StartIpAddr

Specify the start address of IP address range.

EndIpAddr

Specify the end address of IP address range.

Output:

Displays the list of the found managed components. The following shows an example.

Status: SUCCESS

No.1 1st IP Address : 192.168.14.18 2nd IP Address : 0.0.0.0 Current IP Address : 192.168.14.18 IPMI Version : 1.5 GUID : 84ee20b0:84a1:d511:0080:a0ff94470300

No.2 1st IP Address : 192.168.14.19 2nd IP Address : 0.0.0.0 Current IP Address : 192.168.14.19 IPMI Version : 1.5 GUID : 00004c79:45c0:0180:0010:f57f80d8cef8 : :

2.2.5 findNewServerNetAddr

Syntax:

dscli findNewServerNetAddr NetAddr NetMask

Description:

Finds BMC on managed components that are not registered on NEC ESMPRO Manager according to Network address specification.

TIP:

 To register the managed component that is found using findNewComponent command or

findNewServerNetAddr command, you can use createServer command. See 2.2.6 createServer.

Options:

NetAddr

Specify network address.

NetMask

Specify network mask.

Output:

Displays the list of the found managed components same as the output by “f indNewServer ” command. See

2.2.4 findNewServer.

2.2.6 createServer

Syntax:

dscli createServer ComponentName GroupName AuthKey [IpAddr1] [IpAddr2]

Description:

Newly registers a managed component on the NEC ESMPRO Manager.

Options:

ComponentName

Specify the name of the managed component. You can input up to 63 characters.

GroupName

Specify the name of group that the managed component belongs to.

AuthKey

Specify the authentication key that is configured on BMC. You can input up to 16 characters.

IpAddr1

IpAddr2

Specify the IP address of the managed component's BMC. This option is omissible if you control the managed component via modem or with direct connection.

Specify the extra IP address of the managed component's BMC. This option is omissible.

TIPS:

 The name of component that is already registered cannot be specified to ComponentName.  The IP address that is already registered cannot be specified to IpAddr1and IpAddr2.  Set other properties using 2.2.9 setServerProperty command.

2.2.7 deleteServer

Syntax:

dscli deleteServer Component [/force]

Description:

Deletes the specified managed component that is registered on the NEC ESMPRO Manager.

Options:

Component

Specify the name, the MAC address of LAN port that BMC uses, or the GUID of the managed component.

/force

When you delete the managed component that has been set schedule runn ing, the schedule is deleted from NEC ESMPRO Agent Extension. But if the schedule deletion is failed (such as NEC ESMPRO Agent Extension is uninstalled), the component cannot be deleted. In this case you can specify “/force ” option to delete component forcibly.

2.2.8 checkConnection

Syntax:

dscli checkConnection Component [/force]

Description:

Confirms connection with BMC on a managed component. This command also collects information for remote control of the managed component.

Options:

Component

Specify the name, the MAC address of LAN port that BMC uses, or the GUID of the managed component.

/force

Execute the command with "/force" option if the managed component is replaced.

TIP:

 If NEC ESMPRO Manager Ver.5 manage NEC ESMPRO Manager Ver.4, and the “/force”

option is specified, NEC ESMPRO Manager Ver.5 may connect with different component in communication with NEC ESMPRO Manager Ver.4 and BMC communicati on.

2.2.9 setServerProperty

Syntax:

dscli setComponentProperty Component PropertyName Value

Description:

Sets the property of a managed component.

Options:

Component

Specify the name, the MAC address of LAN port that BMC uses, or the GUID of the managed component.

PropertyName

Specify the name of the property. The following is property list:

Value

Specify new value to be set. See the list below.

PropertyName Contents Value Default

0: Disabled 1: Enabled

4 - 1000 64

0: Disabled 1: Enabled

Up to 20

characters Up to 63 characters. Up to 16 characters

0: LAN 1: Direct 2: Modem

IP address format IP address format IP address format

CONSOLE_LOG_ENABLE

CONSOLE_LOG_SIZE

CONSOLE_LOG_KEEP_CONN ECTION

CONSOLE_LOG_FAULT_MESS AGE_MONITORING

CONSOLE_LOG_FAULT_MESS AGE_IDENTIFIER

SERVER_NAME *1

SERVER_AUTHKEY *1

SERVER_CURRENT_PORT_T YPE

SERVER_IP_1 *1

SERVER_IP_2

SERVER_CURRENT_IP *1

Determine whether to enable/disable the get console log function to save the Remote Console screen data in text format. Specify the maximum size (in KB) of the console log. Determine whether to get console log even while remote console is not open on web browser. Determine whether to enable/disable the fault message monitoring function that set fault condition when a fault message string is found on head of each console log line. Specify the character string for the fault message monitoring function. Specify the name of the managed component. Specify the authentication key to communicate with BMC of the managed component. Specify the connection type between the NEC ESMPRO Manager component and the managed component. Only LAN can be specified for the EM card. Specify BMC IP address to communicate via LAN. Specify extra BMC IP address to communicate via LAN. Specify current BMC IP address to communicate via LAN.

</BP>

(None)

0.0.0.0

+ 60 hidden pages

NEC Express5800-R120f-2M, Express5800-R120d-1M, Express5800-R110f-1E, Express5800-R120f-1M, Express5800-R120d-2M Reference Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

About This Document

Chapter1 About Command Line Interface

1.1 System Requirements

1.2 How to Execute Commands

1.2.1 Notes on Entering Commands

1.3 Execution Results

1.4 Example

1.5 Executing Command from Two or More NEC ESMPRO Manager

Chapter2 Command Summary

2.1 Group management Commands

2.1.1 getList

2.1.2 createGroup

2.1.3 deleteGroup

2.1.4 moveGroup

2.1.5 setGroupProperty

2.1.6 getGroupProperty

2.1.7 getGroupStatus

2.1.8 groupPowerOn

2.1.9 groupPowerOff

2.1.10 groupReset

2.1.11 groupPowerCycle

2.1.12 groupShutdownOs

2.1.13 groupSetPowerRestoreDelay

2.1.14 getGroupRemoteKvmLicense

2.2 Component Management Commands

2.2.1 getServerList

2.2.2 getServerNameByMacAddr

2.2.3 getServerNameByGuid

2.2.4 findNewServer

2.2.5 findNewServerNetAddr

2.2.6 createServer

2.2.7 deleteServer

2.2.8 checkConnection

2.2.9 setServerProperty