NEC Express5800-R120f-1M User Guide
EXPRESSBUILDER Command Line Interface
User's Guide
Chapter 1 Notations, Notes and Additions
Chapter 2 Usage
Chapter 3 Commands
Chapter 4 XML Interface
Chapter 5 Log Management
Chapter 6 Glossary
Rev. 1.00
August 2014
© NEC Corporation 2014
2
Contents
Contents ............................................................................................................... 2
Trademarks ........................................................................................................... 3
Chapter 1 Notations, Notes and Additions .............................................................. 4
Chapter 2 Usage ................................................................................................ 5
2.1 Overview .................................................................................................. 5
2.2 System Requirements ................................................................................ 5
2.3 Using the Command Line ............................................................................ 5
2.3.1 Shell mode ...................................................................................... 6
2.3.2 One liner mode ................................................................................ 7
2.3.3 XML scripting mode .......................................................................... 8
Chapter 3 Commands ......................................................................................... 9
3.1 Syntax of Commands ................................................................................. 9
3.1.1 Target ........................................................................................... 11
3.1.2 Basic options .................................................................................. 11
3.1.3 Specific options .............................................................................. 12
3.2 Summary of command output ................................................................... 13
3.3 Diagram of the entire address space .......................................................... 13
3.4 Example of command execution ................................................................ 14
3.4.1 Changing the current target ............................................................. 14
3.4.2 Creating the repository .................................................................... 14
3.4.3 Clearing the repository .................................................................... 14
3.4.4 Showing the application information ................................................. 15
3.4.5 Installing the application .................................................................. 16
3.4.6 Updating data in Internal Flash Memory ............................................ 16
3.4.7 Showing the repository path ............................................................ 16
Chapter 4 XML Interface ................................................................................... 18
4.1 XML interface .......................................................................................... 18
4.1.1 Overview ....................................................................................... 18
4.1.2 XML elements ................................................................................ 18
4.1.3 Examples of XML file ....................................................................... 19
Chapter 5 Log Management ............................................................................... 21
5.1 Logging specification ................................................................................ 21
5.1.1 Logging contents ............................................................................ 21
Chapter 6 Glossary ........................................................................................... 22
3
Trademarks
Microsoft, Windows, Windows Server are registered trademarks or trademarks of Microsoft
Corporation in the United States and other countries.
Linux is a trademark or registered trademark of Linus Torvalds in the United States and
other countries. Red Hat® and Red Hat Enterprise Linux are trademarks or registered
trademarks of Red Hat, Inc. in the United States and other countries.
All other company, brand, product, or trade names used in this document are the registered
trademarks or trademarks of their respective trademark owners.
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.
4
Chapter 1 Notations, Notes and Additions
IMPORTANT:
Points that are mandatory or require attention when using the software or the
hardware.
CHECK:
Points that are require confirmation when using the software or the hardware.
TIP:
Helpful and useful piece of information.
This document describes how to use EXPRESSBUILDER from the command line on the
operating system (OS) when EXPRESSBUILDER is stored in Internal Flash Memory.
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.
Notations in This Document
The following explains three notations that are used in this document:
Fonts and Marks in This Document
The Italic font shows the option of command in this document.
The character string surrounded by <> means a value specified by the character string in
this document except for XML tag. The character of <> is not contained in the value.
The character string surrounded by [] means the omissible argument.
Notes
(1) Unauthorized reproduction of the contents of this document, in part or in its entirety, is
prohibited.
(2) This document is subject to change at any time without notice.
(3) Do not make copies or alter the document content without permission from NEC
Corporation.
(4) If you have any concerns, or discover errors or omissions in this document, contact your
sales representative.
(5) Regardless of article 4, NEC Corporation assumes no responsibility for effects resulting
from your operations.
(6) The sample values used in this document are not actual values.
5
Chapter 2 Usage
2.1 Overview
This document describes the Command Line Interface (CLI) of EXPRESSBUILDER.
You can operate CLI by using eb_cli command.
eb_cli command has three modes, interactive "shell mode", non-interactive "one liner
mode" and batch format "XML scripting mode" which uses specified file.
2.2 System Requirements
eb_cli command can be executed only on a computer with Internal Flash Memory.
To execute CLI, administrator authority of operating system is required.
Windows OS: Administrator
Linux OS: root
CHECK:
In case of 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 folder including execution file (eb_cli.exe). After setting the
permission, the standard user can also use CLI.
2.3 Using the Command Line
All the operations in this document are executed from eb_cli command. eb_cli command is
created in the following folder when you install EXPRESSBUILDER.
Windows OS:
C:\Program Files\EXPRESSBUILDER\ar_menu
Linux OS:
Directly under the folder which is specified as installation folder
6
2.3.1 Shell mode
eb_cli [Option]
eb_cli
Indicates the EXPRESSBUILDER command line interface command.
Option
Specifies an option. The following option is selectable at this command.
-h | -help
Shows the syntax of eb_cli commands.
Shell mode does not start when this option is specified.
> eb_cli
EXPRESSBUILDER Version 1.0.0.0
->
-> exit
In shell mode, you can run CLI commands interactively by using proprietary shell function.
Starting shell mode
You can run CLI commands by shell mode when eb_cli command is started from command
line on OS.
See "Chapter 3 Commands" for detail of CLI commands.
Example
To start shell mode, type the following.
CLI command prompt appears when shell mode starts.
Exiting shell mode
To exit shell mode, type the exit command as follows or press <Ctrl> + <C> keys.
7
Key operations on shell mode
Key
Description
Enter
Runs a command.
BackSpace
Erases one character.
←
Moves the cursor backward one character.
→
Moves the cursor forward one character.
↑
Recalls the prior command.
↓
Recalls the next command.
Ctrl + M
Runs a command. (equivalent to the key "Enter")
Ctrl + H
Erases one character. (equivalent to the key "BackSpace")
Ctrl + C
Exits the shell mode.
eb_cli [Option] '<CLI Command>'
eb_cli
Indicates the EXPRESSBUILDER command line interface command.
Option
Specifies an option. The following option is selectable at this command.
-h | -help
Shows the command syntax of the eb_cli command.
CLI command is not run when this option is specified.
'<CLI Command>'
Specifies a CLI command by surrounding with single quotation mark.
eb_cli 'show /'
Key operations in shell mode are as follows.
Table 2-1 Key operations list
2.3.2 One liner mode
One liner mode runs only specified CLI command.
You can run a CLI command by one liner mode when you type as follows.
See "Chapter 3 Commands" for detail of CLI commands.
Example
To run a command in one liner mode, type the following.
Loading...