SupportResource CenterH3C XE 200 2000 IP PBXCommand
Chapters Download(447 KB)
Table of Contents
Chapter 1 Terminal Service and User Interface Configuration Commands
1.1 User Interface Configuration Commands
1.1.9 history-command max-size
1.1.19 set authentication password
1.2 Telnet Terminal Service Configuration Commands
Chapter 2 GUI Server Configuration and Management Commands
2.1 GUI Server Configuration and Management Commands
2.1.9 access (LS-OFFICEGROUP view)
Chapter 3 System Maintenance and Management Commands
3.1 Network Diagnostic Commands
3.1.3 display diagnostic-information
3.2 Information Processing Commands
3.2.7 info-center console channel
3.2.11 info-center loghost source
3.2.12 info-center monitor channel
3.2.13 info-center snmp channel
3.3 Digital Label Information Commands
Chapter 4 File Management Commands
4.2 Configuration File Management Commands
4.2.1 display current-configuration
4.2.2 display saved-configuration
4.2.5 reset saved-configuration
4.2.8 startup saved-configuration
4.3 FTP Server Configuration Commands
4.3.6 local-user ftp-directory
4.4 FTP Client Configuration Commands
4.5 TFTP Configuration Commands
Chapter 5 User Management Commands
5.1 AAA Configuration Commands
Chapter 6 SNMP Configuration Commands
6.1 SNMP Configuration Commands
6.1.3 display snmp-agent community
6.1.4 display snmp-agent group
6.1.5 display snmp-agent mib-view
6.1.6 display snmp-agent statistics
6.1.7 display snmp-agent sys-info
6.1.8 display snmp-agent usm-user
6.1.12 snmp-agent local-engineid
6.1.14 snmp-agent packet max-size
6.1.19 snmp-agent trap queue-size
Chapter 7 Modem Management Configuration Commands
7.1 Modem Management Configuration Commands
Chapter 8 License Management Commands
8.1 License Management Commands
Syntax
authentication-mode { local | password | scheme { scheme-name | default } }
authentication-mode none
View
User interface view
Parameter
local: Specifies to perform local authentication.
password: Specifies to perform password authentication.
scheme: Specifies to perform AAA authorization and authentication.
default: Uses the default authentication scheme.
scheme-name: Specifies an authentication scheme.
none: No authentication.
Description
Use the authentication-mode command to set the mode used to authenticate users at login.
Use the authentication-mode none command to skip authentication at user login.
By default, the authentication mode is set to password for the VTY user interface and none for other user interfaces.
Related command: set authentication password.
Example
# Enable local password authentication.
[XE-ui0] authentication-mode password
Syntax
auto-execute command command
undo auto-execute command
View
User interface view
Parameter
command: The command to be automatically executed.
Description
Use the auto-execute command command to set a command to be automatically executed.
Use the undo auto-execute command command to disable the setting.
By default, the auto-execution command is disabled.
Note that the auto-execute command command can be configured on all interfaces except for the console port.
The system automatically executes the command specified by the auto-execute command command at each login on the terminal and disconnects the user connection upon completion of execution.
A common approach is to issue a Telnet command using the auto-execute command command on the terminal so that the user may automatically connect to the specified host.
Use this command with cautions as it may make you unable to use this user interface to configure the system.
Caution:
Before configuring the auto-execute command command and saving the configuration by executing the save command, make sure that you can access the system to remove the configuration by other means.
Example
# Execute the telnet 10.110.100.1 command automatically at login on the AUX interface.
[XE-ui-aux0] auto-execute command telnet 10.110.100.1
Syntax
databits { 5 | 6 | 7 | 8 }
undo databits
View
User interface view
Parameter
5: Data bits are 5.
6: Data bits are 6.
7: Data bits are 7.
8: Data bits are 8.
Description
Use the databits command to set data bits for the user interface.
Use the undo databits command to restore the default data bits, that is, eight.
The configuration takes effect only when the AUX interface works in asynchronous flow mode.
Example
# Set data bits to 5.
[XE-ui-aux0] databits 5
Syntax
debugging vty { fsm | negotiate }
undo debugging vty { fsm | negotiate }
View
User view
Parameter
fsm: Enables to debug Telnet state machine.
negotiate: Enables to debug VTY option negotiation.
Description
Use the debugging vty command to enable VTY debugging.
Use the undo debugging vty command to disable VTY debugging.
Example
# Enable VTY option negotiation debugging.
<XE> debugging vty negotiate
Syntax
display user-interface [ type-name ] [ number ]
View
Any view
Parameter
type-name: Specifies a user interface by its type.
number: Specifies a user interface by its number.
Description
Use the display user-interface command to view the details of one or all user interfaces.
Example
# Display information of user interface 0.
<XE> display user-interface 0
Idx Type Tx/Rx Modem Privi Auth
* 0 CON 0 9600 3 N
* : Current user-interface is active.
I : Current user-interface is active and work in async mode.
Idx : Absolute index of user-interface.
Type : Type and relative index of user-interface.
Privi: The privilege of user-interface.
Auth : The authentication mode of user-interface.
A: Authenticate use AAA.
L: Authenticate use local database.
N: Current user-interface need not authentication.
P: Authenticate use current UI's password.
Syntax
display users [ all ]
View
Any view
Parameter
all: Displays information on the users of all the user interfaces.
Description
Use the display users command to view the login information of all the user interface users.
Example
# Execute the display users command on the console, and you will get the following results:
<XE> display users
UI Delay Type Ipaddress Username
+ 0 CON 0 00:00:00
34 VTY 0 00:00:09 TEL 10.110.101.39 dd
Table 1-1 Description on the fields
|
Description |
|
|
+ |
The user interface in use. |
|
UI |
The first number and the second number are the absolute number and relative number of the user interface respectively. |
|
Delay |
The interval since the last input, in minutes. |
|
Type |
The type of the user using the user interface. |
|
IPaddress |
The starting connection location, namely, IP address of the connected host. |
|
Username |
Name of the user using this user-interface, namely the user’s login name. This field is void now, because AAA authentication is not required. |
Syntax
flow-control { hardware | software | none }
undo flow-control
View
User interface view
Parameter
none: No flow control.
software: Software flow control.
hardware: Hardware flow control , only applicable to the AUX port.
Description
Use the flow-control command to configure the flow control mode.
Use the undo flow-control command to restore the default, that is, none.
The configuration becomes effective only when the AUX interface works in the asynchronous flow mode.
When the system is producing information, press <Ctrl+S> to stop sending output to the screen or press <Ctrl+Q> to resume the sending of output.
Example
# Configure software flow control in user interface view.
[XE-ui-console0] flow-control software
Syntax
free user-interface [type-name] number
View
User view
Parameter
type-name: User interface type.
number: Absolute/relative user interface number.
Description
Use the free user-interface number command to clear the user interface with the number defined by the parameter number.
Use the free user-interface type-name number command to clear the user interface specified by number and by type-name.
Example
# Clear user-interface 0.
<XE> free user-interface 0
Syntax
history-command max-size size-value
undo history-command max-size
View
User interface view
Parameter
size-value: History command buffer size in the range of 0 to 256. It defaults to 10, meaning up to ten history commands can be stored.
Description
Use the history-command max-size command to set the size of the history command buffer.
Use the undo history-command max-size command to restore the default setting.
Example
# Set the size of the history command buffer to 20.
[XE-ui-console0] history-command max-size 20
Syntax
idle-timeout minutes [ seconds ]
undo idle-timeout
View
User interface view
Parameter
minutes: Number of minutes, in the range of 0 to 35791.
seconds: Number of seconds, in the range of 0 to 59.
Description
Use the idle-timeout command to set time interval for scheduled disconnection.
Use the undo idle-timeout command to restore the default setting.
The time interval for scheduled disconnection defaults to 10 minutes.
Setting the time value to 0 disables scheduled disconnection, that is, the connection is always up.
Example
# Set the timeout to one minute and thirty seconds.
[XE-ui-console0] idle-timeout 1 30
Syntax
local-user local-user level level
undo local-user local-user level
View
System view
Parameter
local-user: Name of a local user.
level: User priority in the range of 0 to 3.
Description
Use the local-user level command to assign a priority to a local user.
Use the undo local-user level command to restore the default setting.
This command can be used in combination with the local-user password command.
Related command: local-user password.
Example
# Add a local user, whose username is XE, password is h3c (displayed in cipher text), and priority is 2.
[XE] local-user XE password cipher h3c
[XE] local-user XE level 2
Syntax
modem [ call-in | both ]
undo modem [ call-in | both ]
View
User interface view
Parameter
call-in: Allows incoming calls.
both: Allows both incoming and outgoing calls.
Description
Use the modem command to set the incoming/outgoing call attributes of the modem.
Use the undo modem command to disable incoming and outgoing calls.
By default, both incoming and outgoing calls are allowed.
When executed without any parameters, the modem command enables both incoming and outgoing calls.
When executed without any parameters, the undo modem command disables both incoming and outgoing calls.
This command is only applicable to the AUX port, not to the CON port.
Example
# Set the incoming and outgoing attributes for the modem.
[XE-ui1] modem
Syntax
modem auto-answer
undo modem auto-answer
View
User interface view
Parameter
None
Description
Use the modem auto-answer command to set the answer mode to auto-answer.
Use the undo modem auto-answer command to restore the default answer mode, that is, manual answer.
This command is only applicable to the AUX port, not to the console port.
When using modem dial-up for connection, you must first set the modem parameters on the related user interface.
Example
# Set the answer mode to auto-answer.
[XE-ui-aux0] modem auto-answer
Syntax
modem timer answer seconds
undo modem timer answer
View
User interface view
Parameter
seconds: Timeout time in the range of 1 to 60 seconds.
Description
Use the modem timer answer command to set the timeout waiting for the carrier signal after off-hook when setting up an inbound connection.
Use the undo modem timer answer command to restore the default setting, that is, 30 seconds.
This command is only applicable to the AUX port, not to the console port.
Example
# Set timeout time to 40 seconds.
[XE-ui-aux0] modem timer answer 40
Syntax
parity { none | even | odd | mark | space }
undo parity
View
User interface view
Parameter
none: No parity check.
even: Even parity check.
odd: Odd parity check.
mark: Mark check.
space: Space check.
Description
Use the parity command to set the parity bit of the user interface.
Use the undo parity command to restore the default check mode, that is, none.
The configuration is effective only when the AUX interface works in asynchronous flow mode.
Example
# Set the transmission parity bit on the AUX interface to odd parity.
[XE-ui-aux0] parity odd
Syntax
redirect
undo redirect
View
User interface view
Parameter
None
Description
Use the redirect command to enable redirection on the asynchronous port.
Use the undo redirect command to disable redirection on the asynchronous port.
By default, redirection is disabled.
This command is only applicable to AUX user interfaces.
Related command: telnet, display tcp status.
Example
# Enable redirect on the user interface AUX0.
[XE-ui-aux0] redirect
Syntax
screen-length screen-length
undo screen-length
View
User interface view
Parameter
screen-length: Number of lines displayed on the screen, in the range of 0 to 512.
Description
Use the screen-length command to set the number of lines displayed on the terminal screen.
Use the undo screen-length command to restore the default 24 lines.
Setting the screen length to 0 disables multiple-screen output.
Example
# Set the number of lines on the terminal screen to 30.
[XE-ui-console0] screen-length 30
Syntax
send { number | all | type-name number }
View
User view
Parameter
all: Sends messages to all user interfaces.
type-name: Type of user interface.
number: Absolute/Relative user interface number.
Description
Use the send command to transfer messages between user interfaces.
Use the send all command to send messages to all user-interfaces.
Use the send number command to send messages to the user interface specified by the number argument.
Use the send type-name number command to send messages to the user interface specified by the type-name and number arguments.
Example
# Send messages to a user interface of the console type.
<XE> send con 0
Enter message, end with CTRL+Z or Enter; abort with CTRL+C:
Hello,good morning!
Send message? [Y/N]:y
Syntax
set authentication password { simple | cipher } password
undo set authentication password
View
User interface view
Parameter
simple: Plain text password.
cipher: Encrypted password.
password: If the password format is set to simple, the parameter password must be in plain text; if it is set to cipher, the password can be either in cipher text or in plain text depending on what has been input. A plain text password can be a string of no more than 16 consecutive characters, 1234567 for example. An encrypted password, however, must be of 24 characters in length and must be in cipher text, _(TT8F]Y\5SQ=^Q`MAF4<1!! for example.
Description
Use the set authentication password command to set a local authentication password.
Use the undo set authentication password command to remove the local authentication password.
Regardless of whether the password format is set to plain text or cipher text, you must input plain text password at authentication time.
When configuring a password, you must specify its format either to simple or to cipher. If the former is specified, the password is saved in plain text in the configuration file. If the latter is specified, however, the password is displayed in cipher text regardless of whether the password you enter is a plain text password of 1 to 16 characters or a cipher text password of 24 bytes.
By default, Telnet users are required to provide passwords at login, that is, the authentication-mode password command applies. If no password is configured, the following information appears:
password required, but none set
Related command: authentication-mode.
Example
# Set the local authentication password to “h3c” for the user interfaces VTYs 0 through 4.
[XE-ui-vty0-4] authentication-mode password
[XE-ui-vty0-4] set authentication password simple h3c
Syntax
shell
undo shell
View
User interface view
Parameter
None
Description
Use the shell command to enable terminal service on the user interface.
Use the undo shell command to remove the current setting.
By default, terminal service is enabled on all the user interfaces.
Console port does not support the undo shell command.
Example
# Disable terminal service on the virtual terminals (VTYs) 0 through 4.
[XE] user-interface vty 0 4
[XE-ui-vty0-4] undo shell
# When a Telnet terminal logs on, the following information is displayed:
% connection refused by remote host!
Syntax
speed speed-value
undo speed
View
User interface view
Parameter
speed-value: Transmission rate in bps.
Description
Use the speed command to set the transmission rate of the user interface.
Use the undo speed command to restore the default, that is, 9600 bps.
Only when the AUX interface works in asynchronous flow mode can the configuration take effect.
The transmission rates supported by the AUX port include:
l 300 bps
l 600 bps
l 1200 bps
l 4800 bps
l 9600 bps
l 19200 bps
l 38400 bps
l 57600 bps
l 115200 bps
Example
# Set the transmission rate of the user interface to 19200 bps.
[XE-ui-vty0] speed 19200
Syntax
stopbits { 1.5 | 1 | 2 }
undo stopbits
View
User interface view
Parameter
1.5: Stop bit is 1.5.
1: Stop bit is 1.
2: Stop bit is 2.
Description
Use the stopbits command to set the stop bits on the user interface.
Use the undo stopbits command to restore the default setting, that is, 1.
Only when the AUX interface works in asynchronous flow mode can the configuration take effect.
Example
# Set stop bit to 1.5.
[XE-ui-vty0] stopbits 1.5
Syntax
user privilege level level
undo user privilege level
View
User interface view
Parameter
level: Command level in the range of 0 to 3.
Description
Use the user privilege command to configure the command level that the login user on the current user interface can access.
Use the undo user privilege command to remove the current configuration. The configuration takes effect at next login.
By default, the default command level is set to 3 for console user interfaces and 0 for other user interfaces.
When the level of a user conflicts with the level of the user interface where the user logs in, the former overrides the latter. For example, the command level of VTY 0 user interface is 2; however, user 007 has the right to access command level 3. If 007 logs in from VTY 0 user interface, he can access commands at level 3 and lower.
Example
# Set the command level that the user logging in from the interface VTY 0 to 2.
[XE-ui-vty0] user privilege level 2
# After the user telnets to the H3C XE 200/2000 IP PBX (hereinafter referred to as XE IP PBX) from vty 0, the terminal displays:
<XE>
Syntax
user-interface [ type-keyword ] user-interface-number [ ending-user-interface-number ]
View
System view
Parameter
type-keyword : Type of a user interface.
user-interface-number: The first user interface to be configured.
ending-user-interface-number: The last user interface to be configured.
Description
Use the user-interface command to enter single-user interface view or multi-user interface view.
Example
# Enter the view of user interface console 0 to configure the interface.
[XE] user-interface console 0
[XE-ui-console0]
# Enter the view of user interface vty 0 to configure the interface.
[XE] user-interface vty 0
[XE-ui-vty0]
# Enter the user interface VTY view to configure VTYs 0 through 3.
[XE] user-interface vty 0 3
[XE-ui-vty0-3]
# Enter user interface view to configure user interfaces 0 through 4. The types of the interfaces include console, AUX and VTY. The actual user interface types however depend on the interfaces provided by the XE IP PBX.
The following example is specific for the case in which there are one console port user interface, one AUX port user interface and two VTY user interfaces.
[XE] user-interface 0 3
[XE-ui0-3]
Syntax
debugging telnet
undo debugging telnet
View
User view
Parameter
None
Description
Use the debugging telnet command to enable Telnet connection debugging.
Use the undo debugging telnet command to disable Telnet connection debugging.
By default, Telnet connection debugging is disabled.
Related command: telnet.
Example
# Enable Telnet connection debugging.
<XE> debugging telnet
Syntax
display tcp status
View
Any view
Parameter
None
Description
Use the display tcp status command to view information on all current TCP connections.
Compared with the display users command, the display tcp status command can display more information about Telnet clients and servers.
The information that this command can provide includes local address, local port number, external address, external port number, and connection status.
Related command: telnet.
Example
# Display information on TCP connections.
<XE> display tcp status
TCPCB Local Add:port Foreign Add:port State
028ca412 129.102.100.142:23 129.102.001:092 Established
028ca414 0.0.0.0:23 0.0.0.0:0 Listening
The above information indicates that one TCP connection is present, whose local IP address is 129.102.100.142, local port number is 23, and the remote IP address is 129.102.1.92. The information also indicates that a local server process is listening to port 23.
Syntax
telnet host-ip-address [ service-port ]
View
User view
Parameter
host-ip-address: Hostname or IP address of the remote XE IP PBX, in dotted decimal format.
service-port: ID of the TCP port through which the remote XE IP PBX provides Telnet services, in the range of 0 to 65535.
Description
Use the telnet command to Telnet to another device through the current XE IP PBX.
If the service-port argument is not specified, the Telnet port number defaults to 23.
With this command, you can easily telnet to another XE IP PBX from the current IP PBX for remote management.
Related command: display tcp status.
Example
# Telnet from the current IP PBX (that is, XE1) to another XE IP PBX (that is XE2) with an IP address of 129.102.0.1.
<XE> telnet 129.102.0.1
Trying 129.102.0.1...
Service port is 23
Connected to 129.102.0.1
<XE2>
Syntax
gui
View
System view
Parameter
None
Description
Use the gui command to enter GUI configuration view.
Example
# Enter GUI configuration view.
[XE2000] gui
[XE2000-gui]
Syntax
gui-config interface interface-type slot-number [ port port ]
undo gui-config
View
GUI configuration view
Parameter
interface-type: Interface type.
slot-number: Interface number.
Port: GUI service port number. It ranges from 1 to 65535 and defaults to 10999.
Description
Use the gui-config command to configure basic GUI server information.
Use the undo gui-config command to delete basic GUI server information.
By default no basic GUI server information is configured.
Example
# Configure basic GUI server information to use interface GigabitEthernet0/0 and service port 11000.
[XE2000-gui]gui-config interface GigabitEthernet 0/0 port 11000
Syntax
start
View
GUI configuration view
Parameter
None
Description
Use the start command to enable the GUI server.
By default, the GUI server is disabled.
Example
# Enable the GUI server.
[XE2000-gui]start
GUI Server is running now
Syntax
stop
View
GUI configuration view
Parameter
None
Description
Use the stop command to disable the GUI server.
Example
# Disable the GUI server.
[XE2000-gui]stop
GUI Server is stopped now
[XE2000-gui]
Syntax
reset-ual
View
GUI configuration view
Parameter
None
Description
Use the reset-ual command to restore the user information list to the initial state. That is, it is to delete all accounts created by the administrator so that only the default account is contained in the list. Note to disable the GUI server before you run this command.
Example
# Restore the user information list to the initial state.
[XE2000-gui]reset-ual
NOTICE:This command will reset the GUI User Accout List to its initial
status which contains only the default accout! Continue?[Y/N]:y
User Accout List has been reset.
[XE2000-gui]
Syntax
web { start | stop }
View
GUI configuration view
Parameter
start: Enable the Web service.
stop: Disable the Web service.
Description
Use the web command to enable/disable the Web service.
By default, the Web service is disabled.
Example
# Enable the Web service.
[XE2000-gui]web start
WEB Server is started!
[XE2000-gui]
Syntax
display gui-user { all | online }
View
Any view
Parameter
all: Displays all GUI administrators.
online: Displays the current login administrartors.
Description
Use the display gui-user command to display administrator information.
Example
# Display the current login administrators.
[XE2000-gui]display gui-user online
User Name User Level IP Address Port
===================================================
XEAdmin Super 192.168.1.88 1675
===================================================
User Number : 1
[XE2000-gui]
Table 2-1 Description on the fields of the display gui-user command
|
Item |
Description |
|
User Name |
User name |
|
User Level |
User level |
|
IP Address |
The IP address of the GUI client that the user uses. |
|
Port |
The port of the GUI client that the user uses. |
|
User Number |
User number |
Syntax
access { permit | prohibit }
View
LS-GW view
Parameter
permit: Permits normal administrators’ operations.
prohibit: Prohibits normal administrators’ operations.
Description
Use the access { permit | prohibit } command to permit/prohibit normal administrators’ operations on a specific gateway device.
By default, normal administrators can operate gateway devices.
Example
# Prohibit normal administrators’ operations on gateway GW0.
[XE2000-ls]gateway GW0
[XE2000-ls-gw-GW0]access prohibit
Syntax
access { permit | prohibit }
View
LS-OFFICEGROUP view
Parameter
permit: Permits normal administrators’ operations.
prohibit: Prohibits normal administrators’ operations.
Description
Use the access command to permit/prohibit normal administrators’ operations on a specific office device.
By default, normal administrators can operate office devices.
Example
# Prohibit normal administrators’ operations on office device og01.
[XE2000-ls-og-og01] access prohibit
Syntax
access list { gateway | office } { permit | prohibit }
View
LS view
Parameter
gateway: Gateway device.
office: Office device.
permit: Permits normal administrators’ operations.
prohibit: Prohibits normal administrators’ operations.
Description
Use the access list command to permit/prohibit normal administrators to add/delete gateway/office devices.
By default, normal administrators can add/delete gateway/office devices.
Example
# Prohibit normal administrators to add/delete office devices.
[XE2000-ls]access list office prohibit
Syntax
access command { gateway | gw:ip-address | office-group } { permit | prohibit }
View
LS view
Parameter
gateway: Permits/prohibits normal administrators’ right to run commands in gateway view.
gw:ip-address: Permits/prohibits normal administrators’ right to configure IP addresses (including dynamic IP addresses) for gateway devices.
office: Permits/prohibits normal administrators’ right to run commands in office group view.
permit: Permits normal administrators’ operations.
prohibit: Permits normal administrators’ operations.
Description
Use the access command command to permit/prohibit normal administrators to configure IP addresses (including dynamic IP addresses) for gateway devices, and permit/prohibit them to run commands in office group view.
By default, normal administrators can perform the above operations.
Example
# Prohibit normal administrators from running all commands in gateway view.
[XE2000-ls]access command gateway prohibit
Syntax
debugging { all | module-name [ debug-option1 ] [ debug-option2 ] …}
undo debugging { all | module-name [ debug-option1 ] [ debug-option2 ] … }
View
User view
Parameter
all: Enables/disables all the debugging.
module-name: Module name.
debug-option: Debugging option.
Description
Use the debug command to enable the debugging.
Use the undo debug command to disable the debugging.
XE IP PBX provides abundant debugging functions for troubleshooting.
It is recommended not to use the debugging all command, because large amount of debugging information reduces the system efficiency, or even causes collapse of the system when you use this command. However, the undo debugging all command offers you great convenience for disabling all the debugging at one time.
Related command: display debugging.
Example
# Enable the debugging for IP Packet information.
<XE> debugging ip packet
IP packet debugging switch is on.
Syntax
display debugging [ interface interface-type interface-number ] [ module-name ]
View
Any view
Parameter
module-name: Module name.
interface-type: Interface type.
interface-number: Interface number.
Description
Use the display debugging command to display the debugging that is already enabled.
By default, this command has no parameter and enables the debugging for all information.
Related command: debugging.
Example
# Display all enabled debugging.
<XE> display debugging
IP packet debugging switch is on.
Syntax
display diagnostic-information
View
Any view
Parameter
None
Description
Use the display diagnostic-information command to display the current system information of all the modules.
You can use the display diagnostic-information command to collect all of the running information on each active module, making it easy to locate problems.
Example
# Display the diagnostic information.
<XE> display diagnostic-information
Syntax
ping [ -a X.X.X.X | -c count | -d | -h ttl_value | -i { interface-type interface-number } | ip | -n | - p pattern | -q | -r | -s packetsize | -t timeout | -v | -tos value ] * host
View
Any view
Parameter
-a X.X.X.X: The Source IP address configured to send the ICMP ECHO-REQUEST packet.
-c count: Number of times an ICMP ECHO-REQUEST packet is sent, in the range of 1 to 4294967295.
-d: Sets DEBUG as the mode of socket.
-h ttl_value: TTL_value within the range of 1 to 255.
-i: Sets the interface that sends the ICMP ECHO-REQUEST packet and specifies the TTL value to 1, which is used for testing directly connected devices.
interface-type: Interface type.
interface-number: Interface number.
-n: Uses the host name directly as the IP address without domain name resolution.
-p: pattern: The padding byte of the ICMP ECHO-REQUEST packet in hex. It is in the range of 0 to FFFFFFFF, for example, -p ff means padding the packet all with ff.
-q: Displays the statistics only.
-r: Records routing.
-s packetsize: The size of ECHO-REQUEST packet (excluding IP and ICMP packet header) in byte, in the range of 20 to 8100.
-t timeout: Timeout time of waiting for ECHO-RESPONSE after sending ECHO-REQUEST in milliseconds, within the range of 0 to 65535.
-v: Non-ECHO-RESPONSE ICMP packet received.
-tos: Sets the TOS value of the ECHO-REQUEST packet.
host: Destination host field or IP address.
ip: IP protocol used.
Description
Use the ping command to check the connectivity with IP network and the reachability of the host.
The default settings of the above parameters are:
The number of times of sending ECHO-REQUEST packet is 5.
The mode of socket is non-DEBUG.
The system determines whether the host is an IP address; if not, domain name resolution will be performed.
Pad the packet from 0x01 to 0x09 and then repeat.
Display all the information including statistics.
No route is recorded.
The size of the ECHO-REQUEST packet is 56 bytes.
The timeout time for ECHO-RESPONSE packet is 2000 ms.
Non-ECHO-RESPONSE ICMP packets are not displayed.
The ping process is: a host sends ICMP ECHO-REQUEST packet to destination. If the connection works, the destination host receives the ICMP ECHO-REQUEST packet and responds to the source host with the ICMP ECHO-REPLY packet.
Use the ping command to test the network connectivity for troubleshooting. The output information includes:
l Response of a destination to every ECHO-REQUEST packet. Bytes of the reply packet, packet number, TTL, and the response time. The “Request time out” is displayed if no reply packet is received in timeout time.
l The final statistics includes number of the transmitted packets, number of the received packets, packet loss ratio, and minimum, average and maximum roundtrip times.
If the packet is transmitted at a slow rate, you can enlarge the timeout time for reply packets.
Related command: tracert.
Example
# Ping a host with an IP address of 202.38.160.244 to check the connectivity.
<XE> ping 202.38.160.244
ping 202.38.160.244 : 56 data bytes , press CTRL-C to break
Reply from 202.38.160.244 : bytes=56 sequence=1 ttl=255 time = 1ms
Reply from 202.38.160.244 : bytes=56 sequence=2 ttl=255 time = 2ms
Reply from 202.38.160.244 : bytes=56 sequence=3 ttl=255 time = 1ms
Reply from 202.38.160.244 : bytes=56 sequence=4 ttl=255 time = 3ms
Reply from 202.38.160.244 : bytes=56 sequence=5 ttl=255 time = 2ms
--202.38.160.244 ping statistics--
5 packets transmitted
5 packets received
0% packet loss
round-trip min/avg/max = 1/2/3 ms
Syntax
reboot
View
User view
Parameter
None
Description
Use the reboot command to restart your XE IP PBX.
Executing this command has the same effect with the action by powering off the XE IP PBX and powering it on. However, it provides users convenience to reboot the XE IP PBX from a remote site.
You are recommended not to use this command because rebooting the machine will cause transient network unavailability. Save the configuration file before rebooting the IP PBX, otherwise the configurations you just made cannot survive a reboot.
Example
# Reboot IP PBX.
<XE> reboot
This command will reboot the system. The current configuration has not been saved and will be lost if you continue. Continue? [Y/N]:y
Syntax
tracert [ -a X.X.X.X | -f first_TTL | -m max_TTL | -p port | -q nqueries | vpn-instance vpn-instance-name | -w timeout ] * host
View
Any view
Parameter
-a: Specifies the source address of the packet configured by the tracert command. X.X.X.X specifies the IP address of the tracert packet to be configured in the format of X.X.X.X. It must be an address of a local interface.
-f: Sets the initial TTL. first_TTL represents the initial TTL, ranging from 0 to the maximum TTL.
-m: Sets the maximum TTL. max_TTL represents the maximum TTL, which is larger than the initial TTL.
-p: Sets the UDP port number. port is an integer, which is the port number of the destination host. You do not need to change this argument.
-q: Sets the number of the query packets. nqueries is an integer, which is the number of the query packets sent every time. This number is greater than 0.
-w: Sets the timeout time. timeout is an integer, which represents the timeout time of the IP packet in seconds. The timeout time is greater than 0.
host: IP address of the destination host.
Description
Use the tracert command to test the gateways through which the packet travels from the sender host to destination. It is used to check the network connectivity and locate the network faults.
The default settings of the above parameter are:
–a is not selected.
first_TTL is 1.
max_TTL is 30.
port is 33434.
nqueries is 3.
timeout is 5 seconds.
The following is how a tracert operates:
1) Tracert sends a packet with TTL value of 1.
2) The fist hop sends back an ICMP TTL Expired message.
3) Tracert resends the packet with TTL value of 2.
4) The second hop sends back an ICMP TTL Expired message when the packet arrives.
This process continues till the packet reaches its destination. The route is determined by examining the ICMP Time Exceeded messages sent back by intermediate routers.
After you have executed the ping command to learn that there is a network problem, you can use the tracert command to locate the problem.
The output of the tracert command includes all the IP addresses of gateways through which the packet travels. If the gateway times out, then the output is “***”.
Example
# Trace the route.
<XE> tracert 18.26.0.115
tracert to allspice.lcs.mit.edu (18.26.0.115), 30 hops max
1 helios.ee.lbl.gov (128.3.112.1) 0 ms 0 ms 0 ms
2 lilac-dmc.Berkeley.EDU (128.32.216.1) 19 ms 19 ms 19 ms
3 lilac-dmc.Berkeley.EDU (128.32.216.1) 39 ms 19 ms 19 ms
4 ccngw-ner-cc.Berkeley.EDU (128.32.136.23) 19 ms 39 ms 39 ms
5 ccn-nerif22.Berkeley.EDU (128.32.168.22) 20 ms 39 ms 39 ms
6 128.32.197.4 (128.32.197.4) 59 ms 119 ms 39 ms
7 131.119.2.5 (131.119.2.5) 59 ms 59 ms 39 ms
8 129.140.70.13 (129.140.70.13) 80 ms 79 ms 99 ms
9 129.140.71.6 (129.140.71.6) 139 ms 139 ms 159 ms
10 129.140.81.7 (129.140.81.7) 199 ms 180 ms 300 ms
11 129.140.72.17 (129.140.72.17) 300 ms 239 ms 239 ms
12 * * *
13 128.121.54.72 (128.121.54.72) 259 ms 499 ms 279 ms
14 * * *
15 * * *
16 * * *
17 * * *
18 ALLSPICE.LCS.MIT.EDU (18.26.0.115) 339 ms 279 ms 279 ms
Syntax
display channel [ channel-number | channel-name ]
View
Any view
Parameter
channel-number: Channel number which can be from 0 to 9, that means the system can have 10 channels.
channel-name: Channel name.
Table 3-1 Channel names and their associated channel numbers
|
Channel name |
Channel number |
|
channel6 |
6 |
|
channel7 |
7 |
|
channel8 |
8 |
|
channel9 |
9 |
|
console |
0 |
|
logbuffer |
4 |
|
loghost |
2 |
|
monitor |
1 |
|
snmpagent |
5 |
|
trapbuffer |
3 |
Description
Use the display channel command to display channel information.
All the channel settings are displayed when you execute the display channel command without any parameter.
Example
# Display the information of channel 0.
<XE> display channel 0
channel number:0, channel name:console
MODU_ID NAME ENABLE LOG LEVEL ENABLE TRAP LEVEL ENABLE DEBUG LEVEL
ffff0000 all Y warning Y debugging Y debugging
Syntax
display info-center
View
Any view
Parameter
None
Description
Use the display info-center command to display the information recorded in the information center.
Related command: info-center enable, info-center loghost, info-center logbuffer, info-center trapbuffer, info-center console channel, info-center monitor channel.
Example
# Display the information recorded in the information center.
<XE> display info-center
Information Center: enabled
Log host:
Console:
channel number : 0, channel name : console
Monitor:
channel number : 1, channel name : monitor
SNMP Agent:
channel number : 5, channel name : snmpagent
Log buffer:
enabled,max buffer size 1024, current buffer size 256,
current messages 89, channel number : 4, channel name : logbuffer
dropped messages 0, overwrote messages 0
Trap buffer:
enabled,max buffer size 1024, current buffer size 256,
current messages 0, channel number:3, channel name:trapbuffer
dropped messages 0, overwrote messages 0
Information timestamp setting:
log - date, trap - date, debug - boot
Sent messages = 89, Received messages = 89
Syntax
display logbuffer [ size size-value | summary ] [ level level-number ] [ | [ begin | include | exclude ] string ]
View
Any view
Parameter
size: Specifies the number of information entries in log buffer.
size-value: Displays the number of information entries.
summary: Summary of the log buffer.
level: Displays the specified level of information only.
level-number: Specifies the level in the range of 1 to 8.
|: Uses the regular expression to filter the displayed information.
begin: Displays the information beginning with specific string.
include: Displays the information containing the string.
exclude: Displays the information without the string.
string: Regular expression.
Description
Use the display logbuffer command to display the log buffer information.
By default, the system displays all the log buffer information using the command without any parameter.
If the size of the current log buffer is smaller than the user-specified sizevalue, all of the current log will be displayed.
Related command: info-center enable, info-center logbuffer, display info-center.
Example
# Display the log buffer information.
<XE> display logbuffer
Logging buffer configuration and contents:enabled
Allowed max buffer size : 1024
Actual buffer size : 512
Channel number : 4 , Channel name : logbuffer
Dropped messages : 0
Overwritten messages : 0
Current messages : 18
%Apr 21 12:38:08 2006 H3C IC/7/SYS_RESTART:
System restarted --
H3C Comware Software
Copyright (c) 2004-2007 Hangzhou H3C Technology Co., Ltd.
%Apr 21 12:38:17 2006 H3C PHY/2/PHY: Ethernet0/0: change status to up
%Apr 21 12:39:57 2006 H3C SHELL/5/LOGIN: Console login from con0
%Apr 21 12:49:58 2006 H3C HWCM/5/EXIT: exit from configure mode
%Apr 21 12:49:58 2006 H3C SHELL/5/LOGOUT: Console logout from con0
%Apr 21 13:40:19 2006 H3C SHELL/5/LOGIN: Console login from con0
Syntax
display schedule reboot
View
Any view
Parameter
None
Description
Use the display schedule reboot command to view the parameters of the terminal service of schedule reboot.
Related command: reboot, schedule reboot at, schedule reboot delay, undo schedule reboot.
Example
# Display the parameters of schedule reboot set on XE IP PBX.
<XE> display schedule reboot
Reboot system at 16:00:00 2002/11/1 (in 2 hours and 5 minutes).
Syntax
display trapbuffer [ size sizeval ]
View
Any view
Parameter
size: Specifies the number of the information entries in the log buffer.
sizeval: Number of the information entries to be displayed.
Description
Use the display trapbuffer command to display the trap buffer information.
By default, the command without any parameter displays all the trap buffer information.
If the size of the current trap buffer is smaller than the user-specified sizeval, all of the current trap information will be displayed.
Related command: info-center enable, info-center trapbuffer, display info-center.
Example
# Display the trap buffer information.
<XE> display trapbuffer
Trapping Buffer Configuration and contents:
enabled
allowed max buffer size : 1024
actual buffer size : 256
channel number : 3 , channel name : trapbuf
dropped messages : 0
overwrote messages : 0
current messages : 0
# Display 23 entries of information in the trap buffer.
<XE> display trapbuffer size 23
Trapping Buffer Configuration and contents:
enabled
allowed max buffer size : 1024
actual buffer size : 256
channel number : 3 , channel name : trapbuf
dropped messages : 0
overwrote messages : 0
current messages : 0
Syntax
info-center channel channel-number name channel-name
View
System view
Parameter
channel-number: Channel number in the range of 0 to 9, which means the system can have 10 channels.
channel-name: Channel name up to 30 characters and it cannot be “-”, “/”, or “\” characters.
Description
Use the info-center channel command to name the channels.
Do not give channels the same name.
Example
# Name the channel 0 execconsole.
[XE] info-center channel 0 name execconsole
Syntax
info-center console channel { channel-number | channel-name }
undo info-center console channel
View
System view
Parameter
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
Description
Use the info-center console channel command to output information to console and specify the channel to be used.
Use the undo info-center console channel command to remove the current configuration.
By default, no log information is sent to the console.
The command is effective only after the system log function is enabled.
Related command: info-center enable, display info-center.
Example
# Send information to console and specify the channel to be used.
[XE] info-center console channel console
Syntax
info-center enable
undo info-center enable
View
System view
Parameter
None
Description
Use the info-center enable command to enable the information center.
Use the undo info-center enable command to disable the information center.
By default, the information center is enabled.
The system can send system information to log host and console after enabling the information center.
Related command: info-center loghost, info-center logbuffer, info-center trapbuffer, info-center console channel, info-center monitor channel, display info-center.
Example
# Enable the information center.
[XE] info-center enable
% information center is enabled
Syntax
info-center logbuffer [ channel { channel-number | channel-name } | size buffersize ] *
undo info-center logbuffer [ channel | size ]
View
System view
Parameter
channel: Specifies the channel through which the log buffer sends information.
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
size: Specifies the size of the log buffer.
buffersize: Size of the log buffer (the number of information entries to be stored).
Description
Use the info-center logbuffer command to enable the log buffer, set the channel number through which log information in output, and specify the size of the log buffer.
Use the undo info-center logbuffer command to remove the current configuration.
By default, information is sent to log buffer and the size of the log buffer is 512.
This command is effective only after the information center function is enabled.
You can enable the information to be output to a channel by specifying the channel number in log buffer.
Related command: info-center enable, display info-center, display info-center logbuffer.
Example
# Enable the XE IP PBX to send information to log buffer and set the size of the log buffer to 50.
[XE] info-center logbuffer size 50
Syntax
info-center loghost X.X.X.X [ channel { channel-number | channel-name } | facility local-number | language { chinese | english } ] *
undo info-center loghost X.X.X.X
View
System view
Parameter
X.X.X.X: IP address of the log host.
channel: Information channel of the log host.
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
facility: Recording facility of the log host.
local-number: Recording facility of the log host within the range of local0 to local7.
language: Language which is used by the log.
chinese, english: Log language. You can shift between Chinese and English.
Description
Use the info-center loghost command to configure the system to send output to log host.
Use the undo info-center loghost command to remove the current configuration.
By default, the system does not send output to log host.
If not specified, the channel of log host uses channel 2 which is named loghost. The local-number uses local7 and the language is english.
This command is effective only after the information center function is enabled.
By configuring the IP address of a log host, you can send information to this log host. Up to four log hosts can be configured..
Related command: info-center enable, display info-center.
Example
# Enable the XE IP PBX to send information to UNIX station with an IP address of 202.38.160.1.
[XE] info-center loghost 202.38.160.1
Syntax
info-center loghost source interface-type interface-number [ subinterface-type ]
undo info-center loghost source
View
System view
Parameter
interface-type: Interface type.
interface-number: Interface number.
subinterface-type: Subinterface type.
Description
Use the info-center loghost source command to specify the source address of the packet destined to log host.
Use the undo info-center loghost source to remove the current configuration.
The default address of log information from an XE IP PBX is the IP address of the interface that sends the log information. If you want to change the source address, use the info-center loghost source command. You can judge from which XE IP PBX the log information is sent by setting different source addresses for different XE IP PBXs, which is convenient for searching the received log information.
Example
# Use the IP address of the Loopback 0 interface as the source address of the log information packet.
[XE] interface loopback 0
[XE-LoopBack0] ip address 1.1.1.1 255.255.255.0
[XE-LoopBack0] quit
[XE] info-center loghost source loopback 0
Syntax
info-center monitor channel { channel-number | channel-name }
undo info-center monitor channel
View
System view
Parameter
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
Description
Use the info-center monitor channel command to configure the system to send information to the Telnet terminal or dumb terminal and specify the channel to be used.
Use the undo info-center monitor channel command to remove the current configuration.
By default, the system sends information to the Telnet terminal or dumb terminal.
This command is effective only after the information center function is enabled.
Related command: info-center enable, display info-center.
Example
# Configure the system to send information to the Telnet terminal or dumb terminal and specify the channel to be used.
[XE] info-center monitor channel monitor
Syntax
info-center snmp channel { channel-number | channel-name }
undo info-center snmp channel
View
System view
Parameter
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
Description
Use the info-center snmp channel command to configure the channel for SNMP.
Use the undo info-center snmp channel command to remove the current configuration.
By default, channel 5 is used.
Related command: display snmp-agent statistics.
Example
# Configure channel 6 to send SNMP information.
[XE] info-center snmp channel 6
Syntax
info-center source { module-name | default } { channel { channel-number | channel-name} } [ log { state { on | off } | level severity }* | trap { state { on | off } | level severity } * | debug { state { on | off } | level severity }* ]*
undo info-center source { module-name | default } { channel { channel-number | channel-name }
View
System view
Parameter
module-name: Module name.
default: Sets the default information records.
channel-number: Specifies the channel number.
channel-name: Specifies the channel name.
log: Log information.
trap: Trap information.
debug: Debugging information.
on: Enables the information output.
off: Disables the information output.
level: Specifies the level of the information. The information at a level greater than severity cannot be sent.
severity: Level of information which is grouped into 8 levels according to severity or emergency. As shown in the following table, a packet with a lower severity level is more urgent. Severity level 1 means emergency and level 8 means debugging.
Table 3-2 Severity levels defined in syslog
|
Severity |
Meaning |
|
emergencies |
The extremely emergent errors |
|
alerts |
The errors that need to be corrected immediately |
|
critical |
Critical errors |
|
errors |
The errors that need to be concerned but not critical |
|
warnings |
Warning, there might exist some kinds of errors |
|
notifications |
The information should be concerned |
|
informational |
Common prompt |
|
debugging |
Debugging information |
*: indicates multiple choices can be selected, ranging from one to all.
Description
Use the info-center source command to add information entries to a channel.
Use the undo info-center source command to delete the information entries in the channel.
By default, for a particular module:
The status of log information is on and the permitted information level is informational. The status of the trap information is on and the permitted information level is informational.
The state of debugging information is off.
At present, system allocates one channel for each output direction, as shown in the following table:
Output direction Channel number Default channel name
Console 0 console
Monitor terminal 1 monitor
Log host 2 loghost
Trap buffer 3 trapbuffer
Log buffer 4 logbuffer
snmp 5 snmpagent
Each channel has a default information entry for which the default name and number are default and 0xffff0000. The default setting log, trap and debugging information may vary with channels. If a module has no specific configuration entry in a channel, it uses this default configuration entry.
Example
# Enable the log information of IP module in SNMP channel and specify the permitted highest level of output information as emergence.
[XE] info-center source ip channel snmpagent log level emergencies
# Remove the settings of CMD module in SNMP channel.
[XE] undo info-center source cmd channel snmp
Syntax
info-center timestamp { trap | debugging | log } { boot | date | none }
undo info-center timestamp { trap | debugging | log }
View
System view
Parameter
trap: Trap information.
debugging: Debugging information.
log: Log information.
boot: Post-booting time that the system experiences. It is in the format of xxxxxx.yyyyyy, with xxxxxx being the high-order 32 bits and yyyyyy the low-order 32 bits of the passed milliseconds.
date: Current system date and time, in the format of yyyy/mm/dd-hh:mm:ss in Chinese and mm/dd/yyyy-hh:mm:ss in English.
none: No timestamp format.
Description
Use the info-center timestamp command to set the timestamp format of the output debugging/trap/log information.
Use the undo info-center timestamp command to remove the current configuration.
By default, the date timestamp is used in all types of information.
Example
# Set the timestamp of trap information to boot.
[XE] info-center timestamp trap boot
Syntax
info-center trapbuffer [ channel { channel-number | channel-name } | size buffersize ] *
undo info-center trapbuffer [ channel | size ]
View
System view
Parameter
channel: S Specifies the channel through which the trap buffer sends information.
channel-number: Channel number from 0 to 9, which means the system can have 10 channels.
channel-name: Channel name.
size: Size of the trap buffer.
buffersize: Size of the trap buffer (the number of information entries that can be stored).
Description
Use the info-center trapbuffer command to enable the trap buffer and set the channel number through which trap information in output and specify the size of the trap buffer.
Use the undo info-center trapbuffer command to remove the current configuration.
By default, it is allowed to send information to trap buffer and the size for trap buffer is 256.
This command is effective only after the information center function is enabled.
You can send information to trap buffer by specifying the size of the trap buffer.
Related command: info-center enable, display info-center, display info-center trapbuffer.
Example
# Enable the XE IP PBX to send information to trap buffer and set the size of trap buffer to 30.
[XE] info-center trapbuffer size 30
Syntax
reset logbuffer
View
User view
Parameter
None
Description
Use the reset logbuffer command to clear the information in log buffer.
Example
# Clear the information in log buffer.
<XE> reset logbuffer
Syntax
reset trapbuffer
View
User view
Parameter
None
Description
Use the reset trapbuffer command to clear the information in trap buffer.
Example
# Clear the information in trap buffer.
<XE> reset trapbuffer
Syntax
schedule reboot at hh:mm [ yyyy/mm/dd ]
View
User view
Parameter
hh:mm: Time when the XE IP PBX reboots. hh ranges from 0 to 23 and mm ranges from 0 to 59.
yyyy/mm/dd: Date when XE IP PBX reboots. yyyy ranges from 2000 to 2099, mm can be from 1 to 12, and dd relies on the exact month.
Description
Use the schedule reboot at command to schedule the reboot of the XE IP PBX and set the specific data and time.
By default, the reboot of the XE IP PBX is not scheduled.
If you set the specific date parameter which represents a future time using the schedule reboot at command, the XE IP PBX will reboot at the specified time within an error of one minute.
If no particular date is specified, two cases are involved:
l If the configured time is later than the current time, the XE IP PBX reboots at the time on that day.
l If the configured time is earlier than the current time, the XE IP PBX reboots at the time on the next day.
It should be noted that the configured date must not exceed the current date more than 30 days. Additionally, after you have configured the command, the system will prompt you to input the correct confirmation. The configuration is valid only after you enter Y or y. If you executed the command before, the new configuration overwrites the previous one.
Moreover, if you configure the clock command after you have configured the schedule reboot at command, the previous parameters of schedule reboot at are invalidated.
Related command: reboot, schedule reboot delay, undo schedule reboot, display schedule reboot.
Example
# Configure the XE IP PBX to reboot at 22:00 on the day when you perform the setting (the current time is 15:50).
<XE> schedule reboot at 22:00
Reboot scheduled for 22:00:00 UTC 2002/11/18 (in 6 hours and 10 minutes)
Proceed with reboot? [Y/N]:y
Syntax
schedule reboot delay { hhh:mm | mmm }
undo schedule reboot
View
User view
Parameter
hhh:mm: Time waiting for the XE IP PBX to reboot, in the format of hhh:mm. hhh ranges from 0 to 720 and mm ranges from 0 to 59.
mmm: Time waiting for the XE IP PBX to reboot, in the format of absolute value of minutes in the range of 0 to 43200.
Description
Use the schedule reboot delay command to schedule the reboot of the XE IP PBX and set the waiting delay.
Use the undo schedule reboot command to disable the function.
You can set the waiting delay of reboot for the XE IP PBX in two format: hhh:mm and absolute minutes. The total minutes should be less than 30 ×24 × 60, that is, 30 days.
After you configure the command, the system will prompt you to input the correct confirmation. The settings take effect only after you type in Y or y. If you executed the command before, the new configuration overwrites the previous one.
Moreover, if you configure the clock command after you have configured the schedule reboot delay command, the previous parameters of schedule reboot delay are invalidated.
Related command: reboot, schedule reboot at, undo schedule reboot, display schedule reboot.
Example
# Set the XE IP PBX to reboot in 88 minutes (the current time is 21:32).
<XE> schedule reboot delay 88
Reboot scheduled for 23:00:00 UTC 2002/11/1 (in 1 hours and 28 minutes)
Proceed with reboot? [Y/N]:y
Syntax
service modem-callback
undo service modem-callback
View
System view
Parameter
None
Description
Use the service modem-callback command to enable the callback function.
Use the undo service modem-callback command to disable the callback function.
By default, the callback function is disabled.
Example
# Enable the callback function.
[XE] service modem-callback
Syntax
terminal debugging
undo terminal debugging
View
User view
Parameter
None
Description
Use the terminal debugging command to enable debugging for terminal display.
Use the undo terminal debugging command to disable the debugging.
By default, the terminal display function is disabled.
Related command: debugging.
Example
# Enable the debugging for terminal display.
<XE> terminal debugging
Syntax
terminal logging
undo terminal logging
View
User view
Parameter
None
Description
Use the terminal logging command to enable the terminal to display log information.
Use the undo terminal logging command to disable the function.
By default, the system is configured to enable the terminal to display log information.
Example
# Disable the terminal from displaying log information.
<XE> undo terminal logging
Syntax
terminal monitor
undo terminal monitor
View
User view
Parameter
None
Description
Use the terminal monitor command to enable the terminal to display the debugging/log/trap information sent by information center.
Use the undo terminal monitor command to disable the function.
By default, the function is enabled for console users but disabled for the terminal users.
This command only affects the current terminal where the command is input. The undo terminal monitor command is equivalent to the combination of the undo terminal debugging, undo terminal logging, and undo terminal trapping commands. That means all the debugging/log/trap information is not displayed on the current terminal. In case of enabling the terminal monitor command, you can use the terminal debugging/undo terminal debugging, terminal logging/undo terminal logging, and terminal trapping/undo terminal trapping commands to enable/disable debugging/log/trap information.
Example
# Disable the terminal monitor.
<XE> undo terminal monitor
Syntax
terminal trapping
undo terminal trapping
View
User view
Parameter
None
Description
Use the terminal trapping command to enable the terminal to display trap information..
Use the undo terminal trapping command to disable the function.
By default, the system is configured to display the trap information.
Example
# Disable the terminal from displaying trap information.
<XE> undo terminal trapping
Syntax
upgrade bootrom [ full ]
View
User view
Parameter
full: Upgrades Boot ROM globally.
Description
Use the upgrade command to upgrade Boot ROM
Example
# Upgrade Boot ROM.
[XE] upgrade bootrom
Syntax
display device manuinfo
View
Any view
Parameter
None
Description
Use the display device manuinfo command to display the digital label information of a device. Refer to Table 3-3for description on the fields of digital label information.
Table 3-3 Description on the digital label information
|
Field |
Description |
|
DEVICE_NAME |
Device name |
|
DEVICE_SERIAL_NUMBER |
OEM serial number |
|
MAC_ADDRESS |
Starting MAC address |
|
MANUFACTURING_DATE |
Manufacturing date |
|
VENDOR_NAME |
Vendor name |
Example
# Display the digital label information of a device.
[XE]display device manuinfo
DEVICE_NAME: S3600-28P HI
DEVICE_SERIAL_NUMBER: 210235A045B05B004350
MAC_ADDRESS: 00e0-fc00-5600
MANUFACTURING_DATE: 2006-04-13
Syntax
bootfile backup { backup-bootfile-name }
View
System view
Parameter
backup-bootfile-name: Backup boot file for booting the XE IP PBX.
Description
Use the bootfile backup command to specify the backup boot file.
Three bootfiles are defined in the system by default: main boot file, backup boot file, and secure boot file. The system uses them in the following order:
l Main boot file, with the default name being main.bin and file type being M, is the default file for system boot.
l Backup boot file, with the default name being backup.bin and file type being B, is the boot file used in case of the boot failure using the main boot file.
l Secure boot file, with the default name being secure.bin and file type being S, is the boot file used in case of the boot failure using the backup boot file. If the boot attempts using all these files fail, the system prompts the boot failure.
This command is supported only by the XE200.
For the related commands, see dir, bootfile dir, and bootfile main.
Caution:
Only XE IP PBX 200 supports this command.
Example
# Specify the backup boot file.
[XE] bootfile backup router.bin
Set backup boot file successfully!
# Display information on the boot files in the Flash.
[XE] bootfile dir
Aviliable boot file(s):
'M' = MAIN, 'B' = BACKUP, 'S' = SECURE
-------------------------------------------------------------
[No.] [Type] [Date] [Time] [Size] [Name]
-------------------------------------------------------------
1 N/A Mar/15/2004 18:09:00 5556068 Main.bin
1 N/A Mar/15/2004 18:09:00 5556068 Backup.bin
1 S Mar/15/2004 18:09:00 5556068 Secure.bin
-------------------------------------------------------------
Syntax
bootfile dir
View
System view
Parameter
None
Description
Using the bootfile dir command, you can view the information about all the boot files in the Flash, including file type, date, time, file size, and file name.
This command is supported only by the XE200.
For the related commands, see dir, bootfile main, and bootfile backup.
Caution:
Only XE IP PBX 200 supports this command.
Example
# Display the information about all the boot files in the Flash.
[XE] bootfile dir
Aviliable boot file(s):
'M' = MAIN, 'B' = BACKUP, 'S' = SECURE
-------------------------------------------------------------
[No.] [Type] [Date] [Time] [Size] [Name]
-------------------------------------------------------------
1 M Mar/15/2004 18:09:00 5556068 Main.bin
1 B Mar/15/2004 18:09:00 5556068 Backup.bin
1 S Mar/15/2004 18:09:00 5556068 Secure.bin
-------------------------------------------------------------
Syntax
bootfile main { main-bootfile-name }
View
System view
Parameter
main-bootfile-name: Main boot file for booting the XE IP PBX.
Description
Using the bootfile main command, you can specify the main boot file.
Three bootfiles are defined in the system by default: main boot file, backup boot file, and secure boot file. The system uses them in the following order:
l Main boot file, with the default name being main.bin and file type being M, is the default file for system boot;
l Backup boot file, with the default name being backup.bin and file type being B, is the boot file used in case of the boot failure using the main boot file;
l Secure boot file, with the default name being secure.bin and file type being S, is the boot file used in case of the boot failure using the backup boot file. If the boot attempts using all these files fail, the system prompts the boot failure.
This command is only supported by the XE IP PBXs.
For the related commands, see dir, bootfile dir, and bootfile backup.
Caution:
Only XE IP PBX 200 supports this command.
Example
# Specify the backup boot file.
[XE] bootfile backup router.bin
Set backup boot file successfully!
# Display information on the boot files in the Flash.
[XE] bootfile dir
Aviliable boot file(s):
'M' = MAIN, 'B' = BACKUP, 'S' = SECURE
-------------------------------------------------------------
[No.] [Type] [Date] [Time] [Size] [Name]
-------------------------------------------------------------
1 N/A Mar/15/2004 18:09:00 5556068 Main.bin
1 B Mar/15/2004 18:09:00 5556068 Backup.bin
1 S Mar/15/2004 18:09:00 5556068 Secure.bin
-------------------------------------------------------------
Syntax
cd { directory | flash: }
View
User view
Parameter
directory: Name of the destination directory.
flash: Device name.
Description
Use the cd command to change the current operating directory of the XE IP PBX to a specified existing directory.
By default, it is “flash”.
Example
# Change the current operating directory of the XE IP PBX to test.
<XE> pwd
flash:
<XE> cd test
<XE> pwd
flash:/test
# Return the upper directory.
<XE> pwd
flash:
<XE> cd test
<XE> pwd
flash:/test
<XE> cd ..
<XE> pwd
flash:
Syntax
copy filename_source filename_dest
View
User view
Parameter
filename_source: Name of the source file.
filename_dest: Name of the destination file or directory.
Description
Use the copy command to copy a file.
If the name of destination file is same with that of an existing directory, the file will be copied to the directory. If the name of the destination file is the same with that of an existing file, a prompt will appear asking whether to overwrite the existing file.
Example
<XE> pwd
flash:
<XE> dir
Directory of flash:/
0 -rw- 8429335 Oct 10 2002 10:10:10 system
1 -rw- 4 Sep 11 2052 20:48:59 snmpboots
2 drw- - Sep 19 2052 11:38:56 anchun
3 -rw- 957 Nov 06 2052 14:04:08 config.cfg
4 drw- - Mar 17 2005 15:03:42 gg
5 drw- - Mar 17 2005 15:22:51 backup
15621 KB total (1611 KB free)
# Copy the config.cfg from Flash to backup.
<XE> copy config.cfg backup
Copy flash:/ config.cfg to flash:/backup?[Y/N]:y
100% complete
%Copy file flash:/ config.cfg to flash:/backup...Done.
<XE> cd backup
<XE> dir
Directory of flash:/backup/
0 -rw- 957 Mar 17 2005 16:15:40 config.cfg
15621 KB total (1610 KB free)
Syntax
delete /unreserved filename
View
User view
Parameter
/unreserved: Deletes the specified file permanently, and the deleted file can never be restored.
filename: Name of the file to be deleted.
Description
Use the delete command to delete the specified file restored in the storage device of the XE IP PBX.
The delete command supports the “*” wildcard.
Using the delete command without parameters is to removed a file to recycle bin and you can be restore it with the undelete command.
If you want to delete the file from the recycle bin, use reset recycle-bin filename command.
Note that if you delete two files with same name but under different directories, only the last file maintained in the recycle bin.
If the delete command is used with the parameter (/unreserved), the specified file will never be restored.
The dir command does not display the information of deleted files. However, by using the dir/all command, the information of all files, including the files in recycle bin, will be displayed.
Caution:
If there is only one application file (system file) in the system, you are not allowed to delete the file.
Example
# Delete the file flash:/test/test.txt.
<XE> delete flash:/test/test.txt
Delete flash:/test/test.txt?[Y/N]:y
<XE>
Syntax
dir [ / all | string | flash:]
View
User view
Parameter
/all: Displays all the files (including the ones deleted).
flash:: Device name.
string: The name of the file or directory to be displayed.
Description
Use the dir command to display the information about the specified file or directory in the storage device of the XE IP PBX.
By default, this command displays the file information under the current directory.
This command supports "*" wildcard.
Use the dir /all command to display the information about all the files, including the deleted files. The names of the deleted files are denoted with "[ ]", for instance, [temp.cfg]. Such deleted files can be restored by the undelete command.
Use the reset recycle-bin command to delete the file from the recycle bin permanently.
Example
# Display the information about the file flash:/backup/config.cfg.
<XE> dir flash:/backup/config.cfg
Directory of flash:/backup/
0 -rw- 957 Mar 17 2005 16:15:40 config.cfg
15621 KB total (1610 KB free)
Syntax
execute filename
View
System view
Parameter
filename: Name of the batch file, with a suffix of “.bat”, ranging from 1 to 256.
Description
Use the execute command to execute the specified batch file.
This command executes the command lines in the batch file one by one. Invisible characters are not allowed; otherwise the current batch process will be stopped. The execution process of the command can be regarded as the automatic process of manual execution line by line. The command does not guarantee the execution of each command, nor does it perform hot backup. The forms and contents of the commands are not restricted in the batch file.
Example
# Execute the batch file “test.bat” in the directory of “flash:/”.
[XE] execute test.bat
Syntax
file prompt { alert | quiet }
View
System view
Parameter
alert: Enables interactive acknowledgement in case of data loss or destruction due to user operation (e.g., deleting a file).
quiet: No prompt appears in case of data loss or destruction due to user operation (e.g., deleting a file).
Description
Use the file prompt command to modify the prompt mode of file operation.
By default, the prompt mode is alert. When the prompt mode of file operation is set to quiet, no prompt appears in case of risky operation (e.g., deleting a file), although such operation may cause data loss
Example
# Set the prompt mode of the file operation to quiet.
[XE] file prompt quiet
# Set the prompt mode of the file operation to alert.
[XE] file prompt alert
Syntax
format device-name
View
User view
Parameter
device-name: Name of the device.
Description
Use the format command to format the storage device.
Formatting will cause permanent loss of all the files on a specified storage device.
Example
# Format Flash.
<XE> format flash:
All sectors will be erased, proceed? [Y/N]:y
Format flash: completed
Syntax
mkdir directory
View
User view
Parameter
directory : Name of directory.
Description
Use the mkdir command to create a directory under the specified directory on the specified storage device.
The name of the directory to be created cannot be the same with that of any other directory or file under the specified directory.
Example
# Create a directory named dd.
<XE> mkdir dd
Created dir flash:/dd.
Syntax
more filename
View
User view
Parameter
filename :Name of the file.
Description
Uses the more command to display the contents of a specified file.
By default, the file system displays the file in the form of text, that is, the contents of the file.
Example
# Display the content of the file test.txt.
<XE> more test.txt
AppWizard has created this test application for you.
This file contains a summary of what you will find in each of the files that make up your test application.
Test.dsp
This file (the project file) contains information at the project level and is used to build a single project or subproject. Other users can share the project (.dsp) file, but they should export the makefiles locally.
Syntax
move filename_source filename_dest
View
User view
Parameter
filename_source: Name of the source file.
filename_dest: Name of the destination file.
Description
Use move command to move a file.
If the name of the destination file is the same with that of an existing directory, the file will be moved into the directory. If the name of the destination file is the same with that of an existing file, a prompt will appear asking whether to overwrite the existing file.
Example
# Move the file from flash:/test/sample.txt to flash:/sample.txt
<XE> move flash:/test/sample.txt flash:/sample.txt
Move flash:/test/sample.txt to flash:/sample.txt ?[Y/N]:y
% Moveded file flash:/test/sample.txt flash:/sample.txt
Syntax
pwd
View
User view
Parameter
None
Description
Use the pwd command to display the current directory.
If the current directory has not been set, the operation will fail.
Example
# Display the current directory.
<XE> pwd
flash:/test
Syntax
rename filename-source filename-dest
View
User view
Parameter
filename-source: Name of the source file.
file-dest: Name of the destination file.
Description
Use the rename command to rename a file.
If the name of the destination file is the same with that of an existing directory, the execution fails. If the name of the destination file is the same with that of an existing file, the operation fails.
Caution:
If there is only one application file (system file) in the system, you are not allowed to modify the file name. Otherwise, the system may break down when you upgrade the application of the XE IP PBX.
Example
# Rename the file sample.txt as sample.bak
<XE> rename sample.txt sample.bak
Rename flash:/sample.txt to flash:/sample.bak ?[Y/N]:y
% Renamed file flash:/sample.txt flash:/sample.bak
Syntax
reset recycle-bin filename
View
User view
Parameter
filename: Name of the file to be deleted.
Description
Use the reset recycle-bin command to delete a file from the recycle bin permanently.
This command supports "*" wildcard. The delete command only moves a file to the recycle bin directory. To delete a file permanently, use the reset recycle-bin command.
Example
# Delete the specified file from the recycle bin.
<XE> reset recycle-bin flash:/p1h_logic.out
reset flash:/plh_logic.out?[Y/N]:y
Syntax
rmdir directory
View
User view
Parameter
directory: Name of the directory.
Description
Use the rmdir command to delete a directory.
The directory to be deleted must be empty.
Example
# Delete the directory subdir.
<XE> rmdir subdir
Rmdir subdir?[Y/N]:y
% Removed directory subdir
Syntax
undelete filename
View
User view
Parameter
filename: Name of the file to be restored.
Description
Uses the undelete command to restore deleted files.
If the name of the file to be restored is the same with that of an existing directory, the execution fails. If the name of the file is the same with that of an existing file, a prompt will appear asking whether to overwrite the existing file.
Example
# Restores the deleted file sample.bak.
<XE> undelete sample.bak
Undelete flash:/test/sample.bak ?[Y/N]:y
% Undeleted file flash:/test/sample.bak
Syntax
display current-configuration [ interface interface-type [ interface-number ] | configuration [ gui | ls | ps | system | user-interface ] ] [ | { begin | include | exclude } string ]
View
Any view
Parameter
interface: Displays the configuration of the interface.
interface-type: Interface type.
interface-number: Interface number.
configuration: Displays the specified configuration.
gui: Displays the GUI configuration.
ls: Displays the configuration of Location Server.
ps: Displays the configuration of Process Server.
system: Displays the system configuration.
user-interface: Displays the configuration of user interface.
|: Uses the regular expression to filter and display the configuration of the XE IP PBX.
begin: Displays the configuration beginning with specified string.
include: Displays the configuration including specified string.
exclude: Displays the configuration without specified string.
string: Regular expression characters.
Description
Use the display current-configuration command to display the current configuration of the XE IP PBX.
Some parameters configured currently are not displayed when they are the same with default.
When a set of configuration is completed and requires verification, you can use the display current-configuration command to check the currently effective parameters. Some parameters are not displayed if the related functions are not available.
Related command: save, reset saved-configuration, display saved-configuration.
Example
# Display the currently effective PS configuration parameters of the XE IP PBX.
<XE> display current-configuration configuration ps
#
process-server
ps-config ps0 interface GigabitEthernet0/0
heartbeat password key
start
#
gatekeeper
start
#
sip
start
#
return
Syntax
display saved-configuration
View
Any view
Parameter
None
Description
Use display saved-configuration command to display the saved configuration of the XE IP PBX, that is, the configuration of the XE IP PBX for the next boot.
Related command: save, reset saved-configuration, display current-configuration.
Example
# Display the configuration file of XE IP PBX in storage device.
<XE> display saved-configuration
#
sysname XE
#
tcp window 8
#
undo multicast igmp-all-enable
#
interface Aux0
link-protocol ppp
#
interface Ethernet0/0/0
#
interface NULL0
#
user-interface con 0
user-interface aux 0
user-interface vty 0 4
#
return
Syntax
display startup
View
Any view
Parameter
None
Description
Use the display startup command to display the configuration file used for startup.
Example
# Display the configuration file used for startup.
<XE> display startup
Startup saved-configuration file: flash:/config.cfg
Next startup saved-configuration file: flash:/xhy.cfg
Syntax
display this
View
Any view
Parameter
None
Description
Use the display this command to display the current configuration of the current view.
Example
# Display the current configuration of the current view.
[XE] display this
#
sysname XE
#
tcp window 8
#
return
Syntax
reset saved-configuration
View
User view
Parameter
None
Description
Use reset saved-configuration command to erase the saved configuration of XE IP PBX.
Be careful when executing this command. It is recommended to use this command under the guide of technical staff.
Generally, the command is used under following cases:
l When a used XE IP PBX is applied in a new application environment.
l The old configuration files cannot fit the new environment.
Related command: save, display current-configuration, display saved-configuration.
Example
# Erase the configuration of the XE IP PBX.
<XE> reset saved-configuration
This will erase the configuration in the device.
The VPN GW configurations will be erased to reconfigure!
Are you sure?[Y/N]:y
Syntax
save [ file-name ] [ safely ]
View
User view
Parameter
file-name: File name. The extension must be cfg.
safely: If safely is not used, the system saves the configuration file quickly, and is not allowed to reboot or power off in the duration; otherwise, the configuration will be lost. If safely is used, the system will save the configuration file slowly, but the file will be saved in Flash if the device is rebooted or powered off.
Description
Use the save command to save the current configuration to the storage device. Confirmation is required when you use this command.
When a set of configuration completes and the functions are available, the current configuration file should be saved in the storage device.
By default, quick save mode is applied, which is recommended in a stable power condition. In an unstable power or remote maintenance condition, however, you are recommended to execute the command with the safely keyword.
Related command: reset saved-configuration, display current-configuration, display saved-configuration.
Example
# Save the current configuration files to the default storage device.
<XE> save
The configuration will be written to the device.
Are you sure?[Y/N]:y
Now saving current configuration to the device.
Saving configuration flash:/config.cfg. Please wait...
Current configuration has been saved to the device successfully.
Syntax
save-now
View
Any view
Parameter
None
Description
Use the save-now command to save the current configuration to the storage device without confirmation.
Related command: save.
Example
# Save the current configuration files to the default storage device.
<XE> save-now
Now saving current configuration to the device.
Saving configuration flash:/config.cfg. Please wait...
Current configuration has been saved to the device successfully.
Syntax
startup saved-configuration filename
View
User view
Parameter
filename: Name of the configuration file.
Parameter
Use the startup saved-configuration command to set the configuration file used for the next boot.
After the setting is complete, the system will use the configuration file as the boot file for the next startup.
& Note:
The configuration file is named as follows:
config.cfg: Default name of the configuration file, which is specified by the manufacturer, but the contents of this file can be changed by the user. There are three cases in which the system selects the configuration for startup.
l If you have set to boot with skipping the configuration file, the system starts with null configuration.
l If you have specified the start configuration file, the system selects the specified file as the start configuration file if the file exists; if the file does not exist, the system starts with null configuration.
l If you have not specified the start configuration file, the system searches for the config.cfg file and selects this file as the start configuration file if it exists; if the file does not exist, the system starts with null configuration.
Example
# Set the configuration file to be used for the next boot to master.cfg.
<XE> startup saved-configuration master.cfg
# Display the configuration file used for the next boot.
<XE> display startup
Startup saved-configuration file: flash:/config.cfg
Next startup saved-configuration file: flash:/master.cfg
The config.cfg file is the system default configuration file, and the master.cfg is the specified configuration file used for next startup.
Syntax
upgrade bootrom [ full ]
View
User view
Parameter
bootrom: Updates the Boot ROM program.
full: Updates all of the Boot ROM.
Description
Use the upgrade command to upgrade the Boot ROM program.
Boot ROM program of XE IP PBX supports online upgrade.
You can upgrade the Boot ROM online by extracting the Boot ROM program from the upgrade software package and writing it into the Boot ROM. When executing this command, make sure that the upgrade software package (named bootromfull) is in the root directory of the Flash.
Example
# Upgrade the Boot ROM program of R1760 XE IP PBX. Suppose the upgrade software package has been stored in the root directory of the Flash and the file name is “bootromfull”.
<XE> upgrade bootrom full
Syntax
display ftp-server
View
Any view
Parameter
None
Description
Use the display ftp-server command to display the parameters of the current FTP server.
After setting FTP parameters, use this command to display the configuration.
Example
# Display the configured parameters of FTP server.
<XE> display ftp-server
FTP server is running
Max user number 1
User count 0
Timeout value(in minute) 30
Put Method fast
The previous information indicates that the FTP server is started up and can support up to 1 logon users simultaneously. Now there are no logon user; the timeout of an FTP user is 30 minutes, and the file is transmitted in fast mode.
Syntax
display ftp-user
View
Any view
Parameter
None
Description
Use the display ftp-user command to display the parameters of the current FTP user.
Example
# Display the FTP user parameter configuration.
[XE] dis ftp-user
UserName HostIP Port Idle HomeDir
anchun 192.168.80.100 1029 2 flash:/backup
The previous information indicates that a connection between an FTP user named anchun and the FTP server has been established. The IP address of the remote host is 192.168.80.100; the remote port number is 1029; and the authorized directory is flash:/backup. So far the user has not sent any service request to the FTP server in two minutes.
Syntax
ftp server enable
View
System view
Parameter
None
Description
Use the ftp server enable command to enable the FTP server and allow the login of FTP users.
Use the undo ftp server command to disable the FTP server and disallow the login of FTP users.
By default, the FTP server is disabled.
Example
# Disable the FTP server.
[XE] undo ftp server
Syntax
ftp timeout minute
undo ftp timeout
View
System view
Parameter
minute: Connection timeout (in minutes) in the range of 1 to 35791. By default, it is 30 minutes.
Description
Use the ftp timeout command to set the connection timeout.
Use the undo ftp timeout command to restore the default connection timeout.
Once the user logs onto the FTP server, if an abnormal disconnection occurs or the user disrupts the connection abnormally, FTP server is not notified and thus the connection is still on. To avoid such a problem, you can set a connection timeout. If the connection is idle in a period of time, FTP server regards it as connection failure and terminate the connection.
Example
# Set the connection timeout to 36 minutes.
[XE] ftp timeout 36
Syntax
ftp update { fast | normal }
undo ftp update
View
System view
Parameter
fast: Fast update mode.
normal: Normal update mode.
Description
Use the ftp update command to set the update mode.
By default, the FTP update is in fast mode.
When a user logs onto FTP server to upload files using the put command, two modes for FTP server file update are available: fast update mode and normal update mode.
l In fast update mode, the FTP Server starts to write a user’s uploaded file into the Flash after the file has been uploaded and received by the server. The existing files in the XE IP PBX will not be damaged although the abnormal case (such as power off) happens during the transmission.
l In normal update mode, the FTP Server receives the user files and writes them in the Flash at the same time. The current XE IP PBX files might be damaged due to exceptions such as power off. Compared with fast update mode, the normal update mode needs less memory in the XE IP PBX.
Example
# Set the FTP update mode to normal.
[VPN GW] ftp update normal
Syntax
local-user local-user ftp-directory directory
undo local-user local-user ftp-directory
View
System view
Parameter
local-user: Username.
directory: Accessible directory.
Description
Use the local-user ftp-directory command to authorize FTP users to use the directory.
Use the undo local-user ftp-directory to remove the authorization.
By default, the system does not authorize FTP users to use the directory. The command can be used with the local-user password command.
Related command: local-user password.
Example
# Authorize a user XE whose password is h3c (in cipher text) to access the directory flash:/h3c/lst/.
[XE] local-user XE password cipher h3c
[XE] local-user XE ftp-directory flash:/h3c/lst/
Syntax
local-user local-user password { simple | cipher } password
undo local-user local-user
View
System view
Parameter
local-user and password: Username and the password. By default, no password is required. Username is up to 80 letters and case insensitive; the password is no more than 16 letters.
simple: Displays the password in simple text.
cipher: Displays the password in cipher text.
Description
Use the local-user password command to add a user and configure the user’s password.
Use the undo local-user command to delete a user.
By default, the user database of the system is empty.
The user database can be used for CHAP authentication and PAP authentication. It is recommended to display the password in cipher text. If only local-user local-user command is entered, there will be no respond, and the new user named local-user will not be generated, so the old user named local-user will not be affected.
Example
# Add a user whose name and password are both XE1; and the password is to be displayed in cipher text.
[XE] local-user XE1 password cipher XE1
Syntax
local-user local-user service-type { ftp | terminal | telnet }*
undo local-user local-user service-type
View
System view
Parameter
local-user: Username.
ftp: Authorizes the user to use FTP.
terminal: Authorizes the user to use terminal service (that is, logging on from the Console port).
telnet: Authorizes the user to use Telnet service.
Description
Use the local-user service-type command to set the terminal services available to the user.
Use the undo local-user service-type command to restore the default terminal services available to the user.
By default, all terminal services are available to the user. The command can be used together with the local-user local-user password command.
Related command: local-user password.
Example
# Authorize the user XE whose password is h3c to use the telnet service only.
[XE] local-user XE password cipher h3c
[XE] local-user XE service-type telnet
# Authorize the user XE whose password is h3c to use the FTP service only.
[XE] local-user XE password cipher h3c
[XE] local-user XE service-type ftp
Syntax
ascii
View
FTP client view
Parameter
None
Description
Use the ascii command to set the type of the transmitted data to ASCII format.
By default, the data type is ASCII format.
Example
# Set the data type to ASCII format.
[ftp] ascii
200 Type set to A.
Syntax
binary
View
FTP client view
Parameter
None
Description
Use the binary command to set the type of transmitted data to binary format.
Example
# Set the data type binary format.
[ftp] binary
200 Type set to B.
Syntax
bye
View
FTP client view
Parameter
None
Description
Use the bye command to terminate the connection to the remote FTP server and return to the user view.
Example
# Terminate the connection to the remote FTP server and return to the user view.
[ftp] bye
<XE>
Syntax
cd pathname
View
FTP client view
Parameter
pathname: Directory name.
Description
Use the cd command to change the operating path on the remote FTP server.
Example
# Change operating path to d:/temp.
[ftp] cd d:/temp
Syntax
cdup
View
FTP client view
Parameter
None
Description
Use the cdup command to change the operating path to an upper directory.
Example
# Change the operating path to an upper directory.
[ftp] cdup
Syntax
close
View
FTP client view
Parameter
None
Description
Use the close command to terminate the connection to the remote FTP server and remain in FTP client view.
The command terminates the control connection and data connection to the remote FTP server simultaneously.
Example
# Terminate the connection to the remote FTP server and remain in FTP client view.
[ftp] close
[ftp]
Syntax
debugging
undo debugging
View
FTP client view
Parameter
None
Description
Use the debugging command to enable the debugging.
Use the undo debugging to disable the debugging.
By default, the debugging of FTP client command is disabled.
Example
# Enable the debugging.
[ftp] debugging
Syntax
delete remotefile
View
FTP client view
Parameter
remotefile: File name.
Description
Use the delete command to delete a specified file.
Example
# Delete the file temp.c.
[ftp] delete temp.c
Syntax
dir [ filename ] [ localfile ]
View
FTP client view
Parameter
filename: Name of the file to be queried.
localfile: Name of the file to be saved locally.
Description
Use the dir command to query a specified file.
You can use this command to display all files under a directory or display the files to be queried.
Example
# Query the file temp.c and save the result in the file temp1.
[ftp] dir temp.c temp1
Syntax
disconnect
View
FTP client view
Parameter
None
Description
Use the disconnect command to terminate the connection to the remote FTP server and remain in the FTP client view.
The command terminates the control connection and data connection to FTP server simultaneously.
Example
# Terminate the connection to the remote FTP server and remain in FTP client view.
[ftp] disconnect
[ftp]
Syntax
ftp [ host [ port ] ] [-a ip-address]
View
User view
Parameter
host: IP address or host name of the remote FTP server.
port: Port number of the remote FTP server.
-a ip-address: Source address of the specified FTP client.
Description
Use the ftp command to establish the control connection to the remote FTP server and enter the FTP client view.
Example
# Connect to the remote FTP server with an IP address of 1.1.1.1
<XE> ftp 1.1.1.1
Syntax
get remotefile [ localfile ]
View
FTP client view
Parameter
localfile: Local file name.
remotefile: Name of the file on the remote FTP server.
Description
Use the get command to download the remote files and store them locally.
By default, if no local file name is specified, the downloaded file will have the same name with the one on the remote FTP server.
Example
# Download the file temp1.c and save it as temp.c.
[ftp] get temp1.c temp.c
Syntax
lcd
View
FTP client view
Parameter
None
Description
Use the Icd command to get the local operating directory of the FTP client.
Example
# Display the local operating directory.
[ftp] lcd
% Local directory now flash:.
Syntax
ls [ remotefile ] [ localfile ]
View
FTP client view
Parameter
remotefile: Name of the remote file to be queried.
localfile: Name of the file to be saved locally.
Description
Use the Is command to query a specified file.
By default, all files are displayed if the command has no parameters.
Example
# Query the file temp.c.
[ftp] ls temp.c
Syntax
mkdir pathname
View
FTP client view
Parameter
pathname: Directory name.
Description
Use the mkdir command to establish a directory on the remote FTP server.
Example
# Establish the directory named test on the remote FTP server.
[ftp] mkdir test
Syntax
open ipaddr [ port ] [-a ip-address]
View
FTP client view
Parameter
ipaddr: IP address of the remote FTP server.
port: Port number of the remote FTP server.
-a ip-address: Source address of the specified FTP client.
Description
Use the open command to establish the control connection to the remote FTP server.
Example
# Establish the control connection to FTP server 10.110.3.1.
[ftp] open 10.110.3.1
Syntax
passive
undo passive
View
FTP client view
Parameter
None
Description
Use the passive command to set the data transmission mode to passive mode.
Use the undo passive command to set the data transmission mode to active mode.
By default, the data transmission mode is passive.
Example
# Set the data transmission mode to passive mode.
[ftp] passive
Syntax
put localfile [ remotefile ]
View
FTP client view
Parameter
localfile: Name of the local file.
remotefile: Name of the file on the remote FTP server.
Description
Use the put command to upload the local files to the remote FTP server.
By default, if no remote file name is specified, the uploaded file will have the same name with the one of the local file.
Example
# Upload the local file temp.c to the remote FTP server and save it as temp1.c.
[ftp] put temp.c temp1.c
Syntax
pwd
View
FTP client view
Parameter
None
Description
Use the pwd command to display the operating directory on the remote FTP server.
Example
# Display the operating directory on the remote FTP server.
[ftp] pwd
"d:/temp" is current directory.
Syntax
quit
View
FTP client view
Parameter
None
Description
Use the quit command to terminate the connection to the remote FTP server, and return to user view.
Example
# Terminate the connection to the remote FTP server, and return to user view.
[ftp] quit
<XE>
Syntax
remotehelp [ protocol-command ]
View
FTP client view
Parameter
protocol-command: FTP protocol command.
Description
Use the remotehelp command to display the help of the FTP protocol command.
Example
# Display the syntax of the protocol command user.
[ftp] remotehelp user
214 Syntax: USER <sp> <username>
Syntax
rmdir pathname
View
FTP client view
Parameter
pathname: Name of the directory on the remote FTP server.
Description
Use the rmdir command to delete a specified directory on the FTP server.
Example
# Delete the directory d:/temp1 on the remote FTP server.
[ftp] rmdir d:/temp1
Syntax
user username [ password ]
View
FTP client view
Parameter
username: Name of a logon user.
password: Logon password.
Description
Use the user command to register with the FTP.
Example
# Log onto the FTP server with the username tom and password h3c.
[ftp] user tom h3c
Syntax
verbose
undo verbose
View
FTP client view
Parameter
None
Description
Use the verbose command to enable the verbose to display the return information of the FTP server.
Use the undo verbose command to disable the verbose from displaying the return information of the FTP server.
By default, the verbose is disabled.
Example
# Enable the verbose.
[ftp] verbose
Syntax
tftp ip-address { get | sget | put } source-filename [ destination-filename ] [-a ip-address]
View
User view
Parameter
ip-address: IP address of the TFTP server.
source-filename: Name of the source file.
destination-filename: Name of the destination file.
get: Indicates a normal downloading operation. In the get operation, the XE IP PBX receives a user file and writes it into Flash simultaneously. So when the destination-filename is system, the new system file will overwrite the old one in real time. When the downloading fails (e.g., the network is disconnected), the XE IP PBX cannot start up because the old file is overwritten. Therefore, it is not safe to use this command to upgrade files.
sget: Indicates a downloading operation with protection. In the sget operation, the XE IP PBX receives a user file and saves it into memory simultaneously. After the file is completely downloaded, the file is written into Flash. The old file is not overwritten when the system file downloading fails (e.g., the network is disconnected), therefore, it is relatively safe to use this command to upgrade files. However, this operation requires more memory space.
put: Uploads a file.
-a ip-address: Source address of a specified TFTP client.
Description
Use the tftp command to upload a file to TFTP server or download a file to the local hard disk.
Related command: tftp-server acl.
Example
# Download the file config.txt from the root directory of the TFTP server to the local hard disk. IP address of the TFTP server is 1.1.254.2. The file is saved as config.bak after downloading.
<XE> tftp 1.1.254.2 get config.txt flash:/config.bak
# Upload the text file config.txt from the root directory of the Flash to the default directory of the TFTP server. IP address of the TFTP server is 1.1.254.2. The file is saved as config.bak in the TFTP server.
<XE> tftp 1.1.254.2 put flash:/config.txt config.bak
Syntax
debugging aaa event
undo debugging aaa event
View
User view
Parameter
None
Description
Use the debugging aaa event command to enable debugging for AAA events.
Use the undo debugging aaa event command to disable debugging output.
By default, debugging for AAA events is disabled.
When debugging for AAA events is enabled, information about AAA events is displayed for technicians to debug.
The system displays the following message when you terminate the connection.
%May 6 16:37:05 2005 XE2000 SHELL/5/LOGOUT: anchun logout from 192.168.80.30
This indicates the user anchun terminates the connection.
Related command: display debugging.
Example
# Enable debugging for AAA events.
<XE> debugging aaa event
Syntax
debugging aaa primitive
undo debugging aaa primitive
View
User view
Parameter
None
Description
Use the debugging aaa primitive command to enable debugging for AAA primitives.
Use the undo debugging aaa primitive command to disable debugging for AAA primitives.
By default, debugging for AAA primitives is disabled.
The debugging output is mainly used by technicians.
Related command: display debugging.
Example
# Enable debugging for AAA primitives.
<XE> debugging aaa primitive
Syntax
debugging snmp-agent { header | packet | process | trap }
undo debugging snmp-agent { header | packet | process | trap }
View
User view
Parameter
header: Enables debugging for packet headers.
packet: Enables debugging for packets.
process: Enables debugging for SNMP packet processes.
trap: Enables debugging for trap packets.
Description
Use the debugging snmp-agent command to enable debugging for SNMP agents and specify the debugging output of the SNMP module.
Use the undo debugging snmp-agent command to disable the debugging output
By default, debugging for SNMP agents is disabled.
Example
# Enable debugging for packet headers of the SNMP agent module.
<XE> debugging snmp-agent header
Syntax
display snmp-agent { local-engineid }
View
Any view
Parameter
None
Description
Use the display snmp-agent command to display the engine ID of local SNMP devices.
The SNMP engine, the only identification of the SNMP management, uniquely identifies an SNMP entity in one management domain. The SNMP engine is an important component of the SNMP entity, completing the functions of SNMP messages such as message dispatching, message processing, security authentication and access control.
Example
# Display the engine ID of the local device.
<XE> display snmp-agent local-engineid
SNMP local EngineID: 000007DB7F0000013859
Here, SNMP local EngineID indicates the engine ID of the local SNMP entity.
Syntax
display snmp-agent community [ read | write ]
View
Any view
Parameter
read: Displays information of the community with the read-only authority.
write: Displays the information of the community with the read and write authorities.
Description
Use the display snmp-agent community command to display the current community information of SNMPv1 or SNMPv2c.
Example
# Display the current community information.
<XE> display snmp-agent community
Syntax
display snmp-agent group [ group-name ]
View
Any view
Parameter
group-name: Specifies the group name of the SNMP information to be displayed, ranging from 1 to 32 characters.
Description
Use the display snmp-agent group command to display the USM-based group information.
Without any parameter, the command displays the group information of all the specified group names, including group name, security mode, and storage type.
Example
# Display the group name of SNMP and security mode.
<XE> display snmp-agent group
Group name: v3r2
Security model: v3 noAuthnoPriv
Readview: ViewDefault
Writeview: <no specified>
Notifyview :<no specified>
Storage-type: nonvolatile
Table 6-1 Description on the fields of the display snmp-agent group command
|
Item |
Description |
|
Groupname |
SNMP group name corresponding to the user |
|
Readview |
Name of the MIB view with the read-only authority the SNMP group corresponds to |
|
Writeview |
Name of the MIB view with the write/read authority the SNMP group corresponds to |
|
Notifyview |
Name of the MIB view with the notify authority the SNMP group corresponds to |
|
storage-type |
Storage type |
Syntax
display snmp-agent mib-view [ exclude | include | viewname view-name ]
View
Any view
Parameter
exclude: Specifies not to display the specific SNMP MIB view attributes.
include: Specifies to display the specific SNMP MIB view attributes.
viewname: Specifies the view name to be displayed.
Description
Use the display snmp-agent mib-view command to display the information of the current MIB view.
Example
# Display the information of the current MIB view.
<XE> display snmp-agent mib-view
View name:ViewDefault
MIB Subtree:internet
Subtree mask:
Storage-type: nonVolatile
View Type:included
View status:active
View name:ViewDefault
MIB Subtree:snmpUsmMIB
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
View name:ViewDefault
MIB Subtree:snmpVacmMIB
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
View name:ViewDefault
MIB Subtree:snmpModules.18
Subtree mask:
Storage-type: nonVolatile
View Type:excluded
View status:active
Syntax
display snmp-agent statistics
View
Any view
Parameter
None
Description
Use the display snmp-agent statistics command to display the state and statistics of SNMP.
Example
# Display the statistics of SNMP communication.
<XE> display snmp-agent statistics
0 Messages delivered to the SNMP entity
0 Messages which were for an unsupported version
0 Messages which used a SNMP community name not known
0 Messages which represented an illegal operation for the community supplied
0 ASN.1 or BER errors in the process of decoding
0 Messages passed from the SNMP entity
0 SNMP PDUs which had badValue error-status
0 SNMP PDUs which had genErr error-status
0 SNMP PDUs which had noSuchName error-status
0 SNMP PDUs which had tooBig error-status (Maximum packet size 2000)
0 MIB objects retrieved successfully
0 MIB objects altered successfully
0 GetRequest-PDU accepted and processed
0 GetNextRequest-PDU accepted and processed
0 GetBulkRequest-PDU accepted and processed
0 GetResponse-PDU accepted and processed
0 SetRequest-PDU accepted and processed
0 Trap PDUs accepted and processed
Syntax
display snmp-agent sys-info [ contact | location | version ]*
View
Any view
Parameter
contact: Displays the contact information of local device node.
location: Displays the physical location of the local device node.
version: Displays the SNMP version running in the local agent.
Description
Use the display snmp-agent sys-info command to display the system information of the local SNMP device.
Example
# Display the system information of the device.
<XE> display snmp-agent sys-info
The contact person for this managed node:
R&D Hangzhou, H3C Technology Co., Ltd
The physical location of this node:
Hangzhou, China
SNMP version running in the system:
SNMPv3
Syntax
display snmp-agent usm-user [ engineid engineid | username user-name | group group-name ] *
View
Any view
Parameter
engineid: Displays the SNMPv3 user information of the specified engine ID.
engineid-string: Character string of the engine ID.
username: Displays the information of the specified SNMPv3 user.
user-name: User name, in the range of 1 to 32 characters.
group: Displays the user information belonging to the related SNMP group.
group-name: Group name, in the range of 1 to 32 characters.
Description
Use the display snmp-agent usm-user command to display the information of SNMP users.
An SNMP user is the remote user who executes SNMP management operation. Use the snmp-agent usm-user command to specify the SNMP user.
Example
# Display information about all the current users.
<XE> display snmp-agent usm-user
User name: authuser
Group name: group01
Engine ID: 800007DB7F00000100000026
Storage-type: nonVolatile
UserStatus: active
Caution:
When the SNMP agent is disabled, "Snmp Agent disabled" is displayed for all the above display commands.
Syntax
snmp-agent
undo snmp-agent
View
System view
Parameter
None
Description
Use the snmp-agent command to enable the SNMP agent and specify the SNMP configuration information.
Use the undo snmp-agent command to disable SNMP agent.
By default, the SNMP agent is disabled.
When the SNMP agent is disabled, you cannot execute the undo command. Otherwise, you can use the undo snmp-agent command to disable the SNMP agent.
Example
# Disable the active SNMP agent.
[XE] undo snmp-agent
Syntax
snmp-agent community { read | write } community-name [ mib-view view-name ] undo snmp-agent community community-name
View
System view
Parameter
read: Indicates that the community has the read-only authority in the specified view.
write: Indicates that the community has the read and write authorities in the specified view.
community-name: Character string of community name.
mib-view: Sets the name of the MIB view available for community name.
view-name: MIB view name.
Description
Use the snmp-agent community command to configure the read and write attribute of a certain community, corresponding MIB views.
Use the undo snmp-agent community command to remove the settings of community access name. If you perform configuration on a community repeatedly, the last configured attribute takes effect.
Related command: snmp-agent group, snmp-agent usm-user.
Example
# Set the community name to comaccess and allow the read-only access with this community.
[XE] snmp-agent community read comaccess
# Set the community name to mgr and enable the read and write access.
[XE] snmp-agent community write mgr
# Delete the community comaccess.
[XE] undo snmp-agent community comaccess
Syntax
snmp-agent group { v1 | v2c } group-name { [ read read-view ] | [ write write-view ] | [ notify notify-view ] }
undo snmp-agent group { v1 | v2c } group-name
snmp-agent group v3 group-name [ authentication | privacy ] { [ read read-view ] | [ write write-view ] | [ notify notify-view ] }
undo snmp-agent group v3 group-name [ authentication | privacy ]
View
System view
Parameter
v1: v1 security mode in use.
v2c: v2c security mode in use.
v3: v3 security mode in use.
group-name: Group name, in the range of 1 to 32 characters.
authentication: Specifies authentication of the packet without encryption.
privacy: Specifies authentication and encryption of the packet.
read: Enables the setting of read-only view.
read-view: Specifies name of the read-only view, in the range of 1 to 32 characters.
write: Enables the setting of read/write view.
write-view: Specifies name of the read/write view, in the range of 1 to 32 characters.
notify: Enables the setting of notify view.
notify-view: Specifies name of the notify view, in the range of 1 to 32 characters.
Description
Use the snmp-agent group command to configure a new SNMP group, that is, to specify the authorities for the group.
Use the undo snmp-agent group command to delete a specified SNMP group.
By default, the snmp-agent group group-name v3 command defines no authentication and no encryption.
Related command: snmp-agent mib-view, snmp-agent usm-user.
Example
# Create an SNMPv3 group known as Johngroup.
[XE] snmp-agent group v3 Johngroup
Syntax
snmp-agent local-engineid engineid
undo snmp-agent local-engineid
View
System view
Parameter
engineid: Character string of the engine ID. It must be a hexadecimal number within the length from 10 to 64.
Description
Use the snmp-agent local-engineid command to configure engine ID for the local SNMP entity.
Use the undo snmp-agent local-engineid command to remove the current settings and restore the default.
By default, the engine ID of the device is "enterprise number + device information" of the company. Each device determines the device information. It can be either the IP address, MAC address or the user-defined hexadecimal number string.
Related command: snmp-agent usm-user.
Example
# Configure the name of the local device to 12345.
[XE] snmp-agent local-engineid 12345
Syntax
snmp-agent mib-view { included | excluded } view-name oid-tree
undo snmp-agent mib-view view-name
View
System view
Parameter
view-name: Name of the view.
oid-tree: OID MIB subtree of the Mib object subtree, which can be a character string of the variable OID or of variable name. For example, it can be character strings such as 1.4.5.3.1 and “system”, or use "*" as wildcard, for example, 1.4.5.*.*.1.
included: Includes the MIB subtree.
excluded: Exclude the MIB subtree.
Description
Use the snmp-agent mib-view command to create or update the view information.
Use the undo snmp-agent mib-view command to delete the current settings.
By default, the view name is ViewDefault and the OID is 1.3.6.1.
Currently, this command supports the parameter input of both the character string of the variable OID and the node name.
Related command: snmp-agent group.
Example
# Create a view that includes all MIB-II objects.
[XE] snmp-agent mib-view included mib2 1.3.6.1
Syntax
snmp-agent packet max-size byte-count
undo snmp-agent packet max-size
View
System view
Parameter
byte-count: Maximum length of the SNMP packets that Agent can receive or send, in the range of 484 bytes to 17940 bytes. The default value is 2000.
Description
Use the snmp-agent packet max-size command to set the maximum length of the SNMP message packets that Agent can receive or send.
Use the undo snmp-agent packet max-size command to remove the current settings.
Example
# Set the maximum length of the SNMP packet that agent can receive or send to 1042 bytes.
[XE] snmp-agent packet max-size 1042
Syntax
snmp-agent sys-info { contact sysContact | location sysLocation | version { { v1 | v2c | v3 } * | all } }
undo snmp-agent sys-info { contact | location | version { { v1 | v2c | v3 } * | all } }
View
System view
Parameter
contact: Contact information of the system maintenance.
sysContact: Character string describing the system maintenance contact information.
location: Physical location of the device node.
sysLocation: Device location information.
version: Specifies the SNMP version number used by the system.
v1: SNMP v1.
v2c: SNMP v2c.
v3: SNMP v3.
*: Indicates selection of one to three items from the three options of v1, v2c and v3.
all: SNMP v1, SNMP v2c and SNMP v3.
Description
Use the snmp-agent sys-info command to set the system information, including the system maintenance information, physical location of the device and the SNMP version in use.
Use the undo snmp-agent sys-info command to remove the current settings.
By default, the contact information for system maintenance is "R&D Hangzhou, H3C Technology Co., Ltd.", the information of physical location is "Hangzhou, China" and the version is SNMPv3.
Related command: display snmp-agent sys-info.
Example
# Set the system maintenance information as call Operator at 010-82882488.
[XE] snmp-agent sys-info contact call Operator at 010-82882488
Syntax
snmp-agent target-host trap address udp-domain X.X.X.X [ udp-port port-number ] params securityname security-string [ v1 | v2c | v3 { authentication | privacy } ]
undo snmp-agent target-host X.X.X.X securityname security-string
View
System view
Parameter
trap: Specifies the host as the trap host.
address: Specifies the address of the target host to which the SNMP message transmits.
udp-domain: Specifies that the transmission domain of the target host is based on UDP.
X.X.X.X: IP address of the host.
udp-port: Specifies the port.
port-number: Specifies the number of the port that receives the trap packet.
params: Specifies the information of the logging host that generates SNMP messages.
securityname: Specifies the community name of SNMPv1, v2c or the username of SNMPv3.
security-string: Community name of SNMPv1, SNMPv2c or the username of SNMPv3, in the range of 1 to 32 characters
v1: SNMPv1.
v2c: SNMPv2c.
v3: SNMPv3.
authentication: Indicates authentication with the packet without encryption.
privacy: Indicates both authentication and encryption with the packet.
Description
Use the snmp-agent target-host command to set the target host that receives the SNMP notification.
Use the undo snmp-agent target-host command to remove the current settings.
l The snmp-agent target-host command is used in combination with the snmp-agent trap enable command.
l Use the snmp-agent trap enable command to enable devices to send trap packets. If one host is configured to send notification message, the host should be configured at least the snmp-agent target-host and snmp-agent trap enable commands.
Related command: snmp-agent trap enable, snmp-agent trap source, snmp-agent trap life.
Example
# Enable to send SNMP trap packets to 10.1.1.1 with the community name of comaccess.
[XE] snmp-agent trap enable standard
[XE] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname comaccess
# Enable to send SNMP trap packets to 10.1.1.1 with the community name of public.
[XE] snmp-agent trap enable standard
[XE] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname public
Syntax
snmp-agent trap enable [ trap-type [ trap-list ] ]
undo snmp-agent trap enable [ trap-type [ trap-list ] ]
View
System view
Parameter
trap-type: Enables the trap packet of trap-type.
trap-list: Parameter list corresponding to the trap packets of trap-type.
Description
Use the snmp-agent trap enable command to enable the device to send trap packets and set the trap or notification parameters.
Use the undo snmp-agent trap enable command to remove the current settings.
By default, sending trap packets is disabled.
The snmp-agent trap enable command without parameters indicates sending all types of SNMP trap packets of all the modules.
The snmp-agent trap enable command is used in combination with the snmp-agent target-host command. Use the snmp-agent target-host command to specify the hosts to which the trap packets are sent. To send trap packets, you must configure at least one snmp-agent target-host command.
The module trap-type sending the trap packets can be configuration, flash, standard and system.
Types of packets that standard modules can send include authentication, coldstart, linkdown, linkup and warmstart.
Related command: snmp-agent target-host and snmp-agent trap source.
Example
# Enable to send all types of BGP trap packets to 10.1.1.1 in the v3 packet format, with the "super" community name, and being authenticated but not encrypted.
[XE] snmp-agent trap enable bgp
[XE] snmp-agent target-host trap address udp-domain 10.1.1.1 params securityname super v3 authentication
Syntax
snmp-agent trap life seconds
undo snmp-agent trap life
View
System view
Parameter
seconds: Timeout time in seconds, ranging from 1 to 2,592,000 with the default value 120.
Description
Use the snmp-agent trap life command to set the hold time of the trap packet. Any trap packets exceeding the time are dropped.
Use the undo snmp-agent trap life command to remove the current settings.
The trap packets over the hold time, which is specified by the second parameter, are discarded without being resent or conserved.
Related command: snmp-agent trap enable, snmp-agent target-host.
Example
# Set the timeout time of the trap packet to 60 seconds.
[XE] snmp-agent trap life 60
Syntax
snmp-agent trap queue-size size
undo snmp-agent trap queue-size
View
System view
Parameter
size: Length of the message queue, ranging from 1 to 1000.
Description
Use the snmp-agent trap queue-size command to set the length of the message queue for the trap packet sent to the target host.
Use the undo snmp-agent trap queue-size command to cancel the current setting.
By default, the length is 100.
Related command: snmp-agent trap enable, snmp-agent target-host, snmp-agent trap life.
Example
# Set the length of the message queue for the trap packet to 200.
[XE] snmp-agent trap queue-size 200
Syntax
snmp-agent trap source interface-type interface-number [ subinterface-type ]
undo snmp-agent trap source
View
System view
Parameter
interface-type: Interface type.
interface-number: Interface number.
subinterface-type: Subinterface type.
Description
Use the snmp-agent trap source command to specify the source address from which trap packets are sent.
Use the undo snmp-agent trap source command to cancel the current settings.
There is always a trap address when the SNMP trap packet is being sent from a server, no matter from which interface it is sent. This command can be used to trace a specific event.
Related command: snmp-agent trap enable, snmp-agent target-host.
Example
# Specify the IP address of the Ethernet interface 1/0 as the source address of trap packet.
[XE] snmp-agent trap source ethernet 1/0
Syntax
snmp-agent usm-user { v1 | v2c } user-name group-name
undo snmp-agent usm-user { v1 | v2c } user-name group-name
snmp-agent usm-user v3 user-name group-name [ [ authentication-mode { md5 | sha } auth-password ] [ privacy des56 priv-password ] ]
undo snmp-agent usm-user v3 user-name group-name { local | engineid engineid-string }
View
System view
Parameter
v1: Security mode of v1 in use.
v2c: Security mode of v2c in use.
v3: Security mode of v3 in use.
user-name: User name, in the range of 1 to 32 characters.
group-name: Group name the user corresponds to, in the range of 1 to 32 characters.
authentication-mode: Specifies to use authentication for the security level.
md5: Specifies the authentication protocol as HMAC-MD5-96.
sha: Specifies the authentication protocol as HMAC-SHA-96.
auth-password: Authentication password, which is a character string in the range of 1 to 64 characters.
privacy: Specifies the security level as encrypted.
des56: Specifies the encryption protocol as DES.
priv-password: Encryption password, which is a character string in the range of 1 to 64 characters.
local: Indicates the local entity user.
engineid: Specifies the engine ID associated with the user.
engineid-string: Character string of engine ID.
Description
Use the snmp-agent usm-user command to add a new user to an SNMP group.
Use the undo snmp-agent usm-user command to delete an SNMP group user.
When you configure a remote user for a certain agent, the engine ID is needed for authentication. If the engine ID changes after you configure the user, the user corresponding to the former engine ID will be ineffective.
For SNMPv1 and SNMPv2c, this command adds a new community name. For SNMPv3, it adds a new user to an SNMP group.
Related command: snmp-agent group, snmp-agent community, snmp-agent local-engineid.
Example
# Add a user "John" to the SNMP group "Johngroup", with the security level of requiring authentication, the specified authentication protocol as HMAC-MD5-96 and the password as "hello".
[XE] snmp-agent usm-user v3 John Johngroup authentication-mode md5 hello
Syntax
debugging modem
View
User view
Parameter
None
Description
Use the debugging modem command to enable debugging for the Modem.
Through the output of this command, you can check whether a proper Modem script is specified for a particular event.
Example
None
Syntax
modem [ both | call-in ]
undo modem [ both | call-in ]
View
User-interface view
Parameter
both: Specifies both incoming and outgoing calls of the Modem.
call-in: Specifies only incoming calls of the Modem.
Description
Use the modem command to allow only incoming calls or both incoming and outgoing calls of the Modem.
Use the undo modem command to inhibit incoming calls and outgoing calls of the Modem.
By default, both incoming and outgoing calls of the Modem are inhibited.
You can use the commands here to configure the incoming and outgoing access of the Modem connected with the AUX port.
Example
# Enable only the AUX port to receive incoming calls.
[XE-ui-aux0] modem call-in
Syntax
modem auto-answer
undo modem auto-answer
View
User-interface view
Parameter
None
Description
Use the modem auto-answer command to configure the answer mode for the Modem connected with the AUX port to auto.
Use the undo modem auto-answer command to configure the answer mode for the Modem to non-auto.
By default, the answer mode on the system for the Modem is non-auto.
You should perform this configuration based on the answer mode state of the connected Modem. If the Modem is in auto-answer mode (AA LED of the Modem lights), you should execute the modem auto-answer command before dial up.
The commands cannot change the state of the Modem; they are only used to reflect the answer mode state of the Modem. So, whether to execute the modem auto-answer command depends on the answer mode state (state of the AA LED) of the Modem.
Related command: modem.
Example
# Configure the answer mode for the mode connected with the AUX port to auto.
[XE-ui-aux0] modem auto-answer
Syntax
script trigger connect script-name
undo script trigger connect
View
User-interface view
Parameter
script-name: Name of a script in the script set.
Description
Use the script trigger connect command to specify the automatically executed Modem script when an incoming call connection is set up successfully.
By default, no script is specified.
Use the undo script trigger connect command to cancel the specification.
The system executes the specified script when an incoming call connection of the Modem is set up.
Related command: script-string, script trigger login, script trigger logout, script trigger dial, script trigger init.
Example
# Specify "example" as the automatically executed Modem script when an incoming connection is set up successfully.
[XE-ui1] script trigger connect example
Syntax
script trigger dial script-name
undo script trigger dial
View
User-interface view
Parameter
script-name: Name of a script in the script set.
Description
Use the script trigger dial command to specify the automatically executed Modem script when a DCC dialup is made.
Use the undo script trigger dial command to cancel the specification.
By default, no script is specified.
The system executes the specified script when a DCC dialup is made.
Related command: script-string, script trigger login, script trigger connect, script trigger logout, script trigger init.
Example
# Specify "example" as the automatically executed Modem script when a DCC dialup is made.
[XE-ui1] script trigger dial example
Syntax
script trigger init script-name
undo script trigger init
View
User-interface view
Parameter
script-name: Name of a script in the script set.
Description
Use the script trigger init command to specify the automatically executed Modem script when the system is powered on or rebooted.
Use the undo script trigger init command to cancel the specification.
The system executes the specified script when the system is powered on or rebooted.
By default, no script is specified.
Related command: script-string, script trigger login, script trigger connect, script trigger dial, script trigger logout.
Example
# Specify "example" as the automatically executed Modem script when the system is powered on or rebooted.
[XE-ui1] script trigger init example
Syntax
script trigger login script-name
undo script trigger login
View
User-interface view
Parameter
script-name: Name of a script in the script set.
Description
Use the script trigger login command to specify the automatically executed Modem script when an outgoing call connection is set up successfully.
Use the undo script trigger login command to cancel the specification.
By default, no script is specified.
The system executes the specified script when an outgoing call connection is set up successfully. You can define a script, for example, with the login strings and password to log into a remote UNIX server, then use this command to enable the successful connection between this system and the remote system to trigger the execution of this script to log into the remote system.
Related command: script-string, script trigger connect, script trigger logout, script trigger dial, script trigger init.
Example
# Specify "example" as the automatically executed Modem script when an outgoing call connection is set up successfully.
[XE-ui1] script trigger login example
Syntax
script trigger logout script-name
undo script trigger logout
View
User-interface view
Parameter
script-name: Name of a script in the script set.
Description
Use the script trigger logout command to specify the automatically executed Modem script when a line is reset.
By default, no script is specified.
Use the undo script trigger logout command to cancel the specification.
The system executes the specified script when a line is reset. For example, you can use the command to specify a script to reset the Modem when a call is dropped.
Related command: script-string, script trigger login, script trigger connect, script trigger dial, script trigger init.
Example
# Specify "example" as the automatically executed Modem script when a line is reset.
[XE] script-string drop-line "" +++ OK ATH OK "ATS0=1" OK
[XE-ui1] script trigger logout drop-line
Syntax
script-string script-name script-content
undo script-string script-name
View
System view
Parameter
script-name: Script name.
script-content: Script content.
Description
Use the script-string command to define a Modem script.
Use the undo script-string command to delete a Modem script.
By default, no Modem script is defined.
Using the Modem scripts written with the script language provided by the XE IP PBX, you can make the system:
l Flexibly control different models of Modems. Through executing different initialization AT command set, the XE IP PBX can well cooperate with a variety of Modems produced by different manufacturers with different models.
l Log into a remote system in interactive mode. Interactive negotiation of script can turn the system into different connection states. For example, after the AUX port on the XE IP PBX set up a connection with the remote device through the Modem, it negotiates the protocol to be encapsulated on the physical link and the operating parameters of the protocol with the remote device.
The general format for Modem script is as follow:
send-string1 receive-string1 send-string2 receive-string2 ......
Where:
l send-string represents to send character string.
l receive-string represents to receive character string.
l send-string and receive-string appear in pairs; a script must begin with a send-string. For example, “send-string1 receive-string1 ......” represents this execution flow: First, the system sends send-string1 to the Modem and expects to receive receive-string1. If it receives a string matching receive-string1 before timing out, it continues the execution of subsequent script contents; otherwise, it terminates the execution of this script.
l If the last string is a send-string, it indicates that, once this string is sent, the execution of the script is terminated without waiting for any other receive-string.
l If it is unnecessary to send a string at the beginning of a script, and the system directly waits for a receive-string, you can set the first send-string to "", which will be explained later.
l Except for ended with “\c”, the send-string will be automatically appended with a carriage return when it is sent.
l The received content needs not exactly match the receive-string. That is, the match is considered successful as long as the received content contains the expected string.
l One receive-string can includes many character strings separated by "“-“". The match is considered successful as long as the received content contains one of these character strings.
l By default, the timer times out five seconds later after waiting for a receive-string. You can insert the TIMEOUT seconds anywhere in a script to adjust the timeout time waiting for receive-string, which is valid till a new TIMEOUT is set in the same script. For detailed description, seeTable 7-1:
|
Keyword |
Description |
|
ABORT receive-string |
The string following ABORT will be compared with the strings sent from the Modem or remote DTE device in exact matching mode. One script can includes multiple ABORT settings, and all of them take effect in the whole script execution process. |
|
TIMEOUT seconds |
The digit following TIMEOUT is used to set the timeout time that allows the system to wait for a receive-string. If no expected string is received within this time, the execution of the script fails. Once set, the settings will be valid till a new TIMEOUT is configured. |
l All the strings and keywords in a script are case sensitive.
l Between strings or keywords, you should use spaces as separators. So a space contained in a string must be enclosed in a pair of double quotation marks (" "). A pair of empty quotation marks (that is, "") has two meanings: Being a leading "" in a script, it means that no string needs to be sent and the system directly waits for a receive-string. If "" locates in any other locations in the script, it is regarded as the content of a string.
l You can insert ABORT receive-string anywhere in a script to change the execution flow of this script. Its presence in the script indicates that the script execution will be terminated if a received string exactly matches the receive-string set by ABORT receive-string. You can set more than one ABORT receive-string in a script, all of they will take effect; that is, once a received string matches any one of them, the script execution is terminated. Wherever an ABORT receive-string is placed, it takes effect in the whole script execution process.
l You can insert escape characters in a script to further control the script and increase its flexibility. In addition, all the escape characters also play the role of delimiters in strings as well.
Table 7-2 Escape characters used in script
|
Escape character |
Description |
|
\c |
Represents that the system does not automatically append a carriage return to the string; it sends only the specified characters in the string. The "\c" character is valid only when it is located at the end of the send-string. |
|
\d |
Represents a two-second pause. |
|
\n |
Represents the new line character. |
|
\r |
Represents the carriage return character. |
|
\s |
Represents the space character. |
|
\t |
Represents the tabulation (Tab) character. |
|
\\ |
Represents the backslash ("\") character. |
|
\T |
Represents telephone number. |
Example
[XE] script-string example "" AT OK ATS0=1 OK
Syntax
start-script script-name number
View
User view
Parameter
script-name: Name of a script in the script set.
number: Number of the interface on which the script is run.
Description
Use the start-script command to execute a specific script.
You can use this command to immediately execute a Modem script. But if there is already a script running on the interface, the system will not execute this command and will report an error.
Related command: script-string.
Example
# Execute the Modem script "example" on interface 1.
<XE> start-script example 1
Syntax
xe-license string
undo xe-license { string | all }
View
System view
Parameter
string: The license string that contains 36 valid characters, divided into six groups by separators. Each group consists of six bits, forming the sting in the format of xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxxxx, where each x is a valid character and can be any character in the following set:
{ *, #, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z }
-: Separator.
all: Deletes all license stings.
Description
Use the xe-license command to add service of a license to the current service data. Up to 128 licenses can be added. If continuous ten invalid licenses are inputted, the system will forbid any license input unless you restart it.
Use the undo xe-license command to delete the service of an added license from the service data, or to delete all service data.
Example
# Add service in the license string 123456-899909-123456-789456-369852-258147 to the current service data.
[XE]xe-license 123456-899909-123456-789456-369852-258147
Syntax
display xe-service
View
Any view
Parameter
None
Description
Use the display xe-service command to display all services loaded on the XE IP PBX.
Example
# Display all services loaded on the XE IP PBX.
[XE-ls]display xe-service
Current supported service by XEngine
ID Service Name Status
------------------------------------------------------
No service
------------------------------------------------------
Total 0
Table 8-1 Description on the fields of the display xe-service command
|
Item |
Description |
|
ID |
Service ID |
|
Service Name |
Service name |
|
Status |
Service status |
