Front Cover ....................................................................................................................................................... 1
About This Document ....................................................................................................................................... 6
Chapter1 About Command Line Interface.................................................................................................... 7
1.1 System Requirements........................................................................................................................ 7
1.2 How to Execute Commands.............................................................................................................. 8
1.2.1 Notes on Entering Commands...............................................................................................8
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.
NetWare is a registered trademark of Novell, Inc. of the United States.
All other company, or product names used in this document are registered trademarks or trademarks of their
respective trademark owners.
Windows 7 stands for Windows® 7 Professional operating system, Windows® 7 Ultimate 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 Server 2003 stands for Windows Server® 2003, Standard Edition operating system, Windows
Server® 2003, Enterprise Edition operating system, Windows Server® 200 3, Standard x64 Edition operating
system, and Windows Server® 2003, Enterprise x64 Edition operating system.
Windows Server 2003 R2 stands for Windows Server® 2003 R2, Standard Edition operating system,
Windows Server® 2003 R2, Enterprise Edition operating system, Windows Server® 2003 R2, Standard x64
Edition operating system, and Windows Server® 2003 R2, Enterprise x64 Edition operating system.
Windows XP stands for Windows® XP Professional operating system, and Windows® XP Professional x64
Edition operating system.
Windows 2000 stands for Windows® 2000 Profession al op er ating system, W indo ws® 2 000 Serv er oper atin g
system, and Windows® 2000 Advanced Server 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 docu ment 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 con tents of this document shall not be co pied or altered without the prior written p ermission of 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)
5
NEC ESMPRO Manager Ver.5 Command Line Interface
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.5 Installation Guide
NEC ESMPRO Manager Ver.5 Setup Guide
NEC ESMPRO Manager Ver.5 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.
6
NEC ESMPRO Manager Ver.5 Command Line Interface
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
o operate a group due to operate more than one managed components through a single operation.
Use t
Component Manageme
Use to operate a managed component.
EM Card Management Commands
o operate an EM card.
Use t
Chassis Management Com
Use to operate a chassis.
Communication Management Commands
o change settings for connection to a managed component via modem or directly.
Use t
Environment Setting Commands
o view and change the settings of NEC ESMPRO Manager.
Use t
User Management Commands
o manage users who operate NEC ESMPRO Manager on web browser.
Use t
Other Commands
1.1 System Requirements
The NEC ESMPRO Manager command line interface can be executed only on a PC (called a Manager
server) 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 and Windows Server 2008, 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.5 Installation Guide” about the system requirement of
NEC ESMPRO Manager.
nt Commands
mands
7
NEC ESMPRO Manager Ver.5 Command Line Interface
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:
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:
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
8
NEC ESMPRO Manager Ver.5 Command Line Interface
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.
Register a managed component using createServer command.
(2)
(3)
Perform a "Check Connection" for the managed component using checkConnection command.
Y
ou can manage the managed component after "Check Connection" is completed.
1.5 Executing Command from Two or More Manager Server
As well as one component can be managed from two or more manager server, you can also execute command
from two or more manager server.
IMPORTANT:
See “NEC ESMPRO Manager Ver.5 Installation Guide” about Notes.
9
NEC ESMPRO Manager Ver.5 Command Line Interface
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”.
/g
Display only groups.
/x
Display the list under the specified group or its sub-groups.
Output:
Shows the example that the groups and components have following structure.
root
group1 <GROUP>
group2 <GROUP>
component1
group3 <GROUP>
component2
component3
group11 <GROUP>
component111
component11
group31 <GROUP>
component311
component31
component32
group32 <GROUP>
component321
component322
10
NEC ESMPRO Manager Ver.5 Command Line Interface
Displays the list of groups and components. The following shows an example.
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.
12
NEC ESMPRO Manager Ver.5 Command Line Interface
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:
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)
(Blank)
Value
Specify a new value to be set.
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
mmand
co
Output:
Display the property of a group.
13
NEC ESMPRO Manager Ver.5 Command Line Interface
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
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”.
/p
Force boot from network after the power is turned on.
14
NEC ESMPRO Manager Ver.5 Command Line Interface
TIPS:
See 2.2.9 setServerProperty for server properties.
/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)
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.
15
NEC ESMPRO Manager Ver.5 Command Line Interface
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)
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
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.
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”.
/p
Force boot from network after reset.
TIP:
See 2.2.9 setServerProperty for server properties.
/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.
16
NEC ESMPRO Manager Ver.5 Command Line Interface
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)
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
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.
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”.
/p
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.
TIP:
See 2.2.9 setServerProperty for server properties.
17
NEC ESMPRO Manager Ver.5 Command Line Interface
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)
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)
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.
Options:
GroupName
Specify the name of group.
If you want to control all the components under root, specify “root”.
DelayTime
Specify delay time in the range 0-600 seconds. When -1 is specified, the delay time is not changed.
/x Policy
Sets AC-Link Policy. No change is made if omitted There are 3 types of the po licy.
STAY_OFF T he managed component remains OFF when AC power is restored.
LAST_STATEIf 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_ONThe 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
19
NEC ESMPRO Manager Ver.5 Command Line Interface
: 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.
Displays the name list of all managed components registered on NEC ESMPRO Manager.
Options:
/d
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.
Displays the name of the managed component. The following shows an example.
Component2
22
NEC ESMPRO Manager Ver.5 Command Line Interface
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
:
:
23
NEC ESMPRO Manager Ver.5 Command Line Interface
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
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.
24
Loading...
+ 55 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.