H3C XE 200 2000 IP PBX Command Manual(V3.01)

DownLoad Chapters Download(314 KB)

03-Location Server Configuration Command

Table of Contents

Chapter 1 Location Server Commands. 1-1

1.1 Location Server Commands. 1-1

1.1.1 authentication (LS-GW view) 1-1

1.1.2 bearer-capability (LS-GW view) 1-1

1.1.3 bearer-capability (LS-OFFICEGROUP-OFFICE view) 1-2

1.1.4 call-mode. 1-2

1.1.5 call-signal ip-address. 1-3

1.1.6 call-signal port 1-4

1.1.7 codec (LS-GW-PREFIX view) 1-5

1.1.8 codec (LS-GW-SUBSCRIBER view) 1-6

1.1.9 codec (LS-GW view) 1-7

1.1.10 codec (LS-OFFICEGROUP-OFFICE view) 1-8

1.1.11 codec (LS-OFFICEGROUP-PREFIX view) 1-9

1.1.12 debugging location-server 1-10

1.1.13 device-status (LS-GW view) 1-11

1.1.14 device-status (LS-OFFICEGROUP-OFFICE view) 1-12

1.1.15 device-type (LS-GW view) 1-13

1.1.16 device-type (LS-OFFICEGROUP-OFFICE view) 1-13

1.1.17 display debugging location-server 1-14

1.1.18 display location-server domain. 1-14

1.1.19 display location-server gateway. 1-15

1.1.20 display location-server office-group. 1-18

1.1.21 display location-server process-server 1-19

1.1.22 display location-server statistics. 1-21

1.1.23 display location-server tunnelpeer 1-23

1.1.24 dynamic-ip. 1-25

1.1.25 gateway (LS view) 1-25

1.1.26 heartbeat password (LS-PS view) 1-26

1.1.27 heartbeat-time-range. 1-27

1.1.28 ip-address (LS-GW view) 1-27

1.1.29 ip-address (LS-OFFICEGROUP-OFFICE view) 1-28

1.1.30 ls-config. 1-28

1.1.31 manufacturer 1-29

1.1.32 multiplex (LS-GW view) 1-30

1.1.33 multiplex (LS-OFFICEGROUP-OFFICE view) 1-30

1.1.34 multiplex (LS-PS view) 1-31

1.1.35 office. 1-31

1.1.36 office-group. 1-32

1.1.37 otapc. 1-33

1.1.38 password (LS-GW view) 1-33

1.1.39 policy random selection. 1-34

1.1.40 policy select-rule. 1-34

1.1.41 policy unknown-device-admission. 1-35

1.1.42 port (LS-GW view) 1-36

1.1.43 port (LS-OFFICEGROUP-OFFICE view) 1-36

1.1.44 prefix (LS-GW view) 1-37

1.1.45 prefix (LS-OFFICEGROUP view) 1-38

1.1.46 priority (LS-GW view) 1-38

1.1.47 priority (LS-OFFICEGROUP-OFFICE view) 1-39

1.1.48 priority (prefix view) 1-39

1.1.49 priority (subscriber view) 1-40

1.1.50 process-server 1-41

1.1.51 reset location-server statistics. 1-41

1.1.52 start 1-42

1.1.53 stop. 1-42

1.1.54 subscriber 1-43

1.1.55 transport (LS-GW view) 1-44

1.1.56 transport (LS-OFFICEGROUP-OFFICE view) 1-44

1.1.57 ttl 1-45

Chapter 2 NAT/FW Tunnel Traversal Configuration Commands. 2-1

2.1 NAT/FW Tunnel Traversal Configuration Commands. 2-1

2.1.1 attribute. 2-1

2.1.2 belongto. 2-1

2.1.3 device-status forever-up attachedps. 2-2

2.1.4 domain. 2-2

2.1.5 nat&fw. 2-3

2.1.6 tunnel 2-4

2.1.7 tunnelpeer 2-4

 


Chapter 1  Location Server Commands

1.1  Location Server Commands

1.1.1  authentication (LS-GW view)

Syntax

authentication { disable | enable }

undo authentication

View

LS-GW view

Parameter

disable: Disables the gateway from performing authentication.

enable: Enables the gateway to perform authentication.

Description

Use the authentication command to set the authentication mode of a gateway.

Use the undo authentication command to restore the default setting.

Authentication is disabled by default.

Example

# Enable the gateway gw01 to perform the authentication.

[XE-ls-gw-gw01] authentication enable

1.1.2  bearer-capability (LS-GW view)

Syntax

bearer-capability { audio | video }

undo bearer-capability

View

LS-GW view

Parameter

audio: Specifies audio type only.

video: Specifies video and audio types.

Description

Use the bearer-capability command to specify the bearer capability type for the gateway, that is, to specify the service type (bearer capability type) supported in the Q.931 header of setup messages sent to the terminating side.

By default, the video type is adopted.

Example

# Specify the bearer capability type for the gateway to audio.

[XE-ls-gw-gw001] bearer-capability audio

1.1.3  bearer-capability (LS-OFFICEGROUP-OFFICE view)

Syntax

bearer-capability{ audio | video }

undo bearer-capability

View

LS-OFFICEGROUP-OFFICE view

Parameter

audio: Specifies audio type only.

video: Specifies video and audio types.

Description

Use the bearer-capability command to specify the bearer capability type for the office device, that is, to specify the service type (bearer capability type) supported in the Q.931 header of setup messages sent to the terminating side.

By default, the video type is adopted.

Example

# Specify the bearer capability type for the office device to audio.

[XE-ls-og-og01 of01] bearer-capability audio

1.1.4  call-mode

Syntax

call-mode { h323 | sip } { redirect | routed }

undo call-mode { h323 | sip }

View

LS view

Parameter

h323: Sets the call mode to H.323.

sip: Sets the call mode to SIP.

redirect: Sets the call mode of LS to redirect.

routed: Sets the call mode of LS to routed.

Description

Use the call-mode command to set the call mode of LS.

Use the undo call-mode command to restore the default setting.

By default, routed mode is adopted for both H.323 and SIP.

Example

# Set the LS to work in redirect mode.

[XE-ls] call-mode h323 redirect

[XE-ls] call-mode sip redirect

1.1.5  call-signal ip-address

Syntax

call-signal ip-address ip-address

undo call-signal ip-address

View

LS-GW view

Parameter

ip-address: Sets the IP address of call signaling.

ip-address: IP address.

Description

Use the call-signal ip-address command to configure the call signaling of the gateways registered with the LS.

Use the undo call-signal ip-address command to restore the default call signaling setting.

If the gateway does not support dynamic IP address report function or the administrator has disabled the function using the dynamic-ip disable command in LS-GW view, and the gateway is in normal or forever-up status, you need to manually configure the call signaling address of the gateway on the XE IP PBX. Then during registration, the gateway reports its call signaling address to match the configured one.

By default, the IP address of call signaling is reported dynamically by the gateway.

Example

# Set the call signaling IP address of the gateway gw001 to 169.254.10.1.

[XE-ls-gw-gw001] call-signal ip-address 169.254.10.1

1.1.6  call-signal port

Syntax

call-signal port port

undo call-signal port

View

LS-GW view

Parameter

port: Sets the port number of call signaling.

port: Port number, ranging from 1 to 65535.

Description

Use the call-signal port command to configure the call signaling of the gateways registered with the LS.

Use the undo call-signal port command to restore the default call signaling setting.

If the gateway does not support dynamic IP address report function or the administrator has disabled the function using the dynamic-ip disable command in LS-GW view, and the gateway is in normal or forever-up status, you need to manually configure the call signaling port number of the gateway on the XE IP PBX. Then during registration, the gateway reports its call signaling port number to match the configured one.

By default, the call signaling port number is reported dynamically by the gateway.

The port parameter is 1720 by default.

Example

# Set the call signaling port number of the gateway gw001 to 2000.

[XE-ls-gw-gw001] call-signal port 2000

1.1.7  codec (LS-GW-PREFIX view)

Syntax

codec { audio { g7231 | g729 | pcma | pcmu } [ packet-length packet-length ] } | { video { h261 | h263 } } | { data t38fax }

undo codec { audio | video | data }

View

LS-GW-PREFIX view

Parameter

audio: Sets the audio codec type.

g7231: Sets the audio codec type as G.723.1.

g729: Sets the audio codec type as G.729.

pcma: Sets the audio codec type as G.711 A-law 64K.

pcmu: Sets the audio codec type as G.711 u-law 64K.

packet-length: Packetization time length that ranges from 1 to 18 in units of 10 ms.

video: Sets the video codec type.

h263: Sets the video codec type as H263.

h261: Sets the video codec type as H261.

data: Sets the data codec type.

t38fax: Sets T38 faxing support.

Description

Use the codec command to configure the codec type when the gatekeeper initiates capability negotiation with a gateway device. If a number is not configured with a codec type, the codec type configured for the gateway will be used instead.

Use the undo codec command to restore the default codec type.

By default, the codec type configured on the gateway is adopted.

Example

# For subscriber 8801, set codec type to G.729 so that the gatekeeper uses it to initiate capability negotiation to a gateway device. Set the packetization time length as 40 ms and video codec type as H261.

[XE-ls-gw-gw000 8801]codec audio g729 packet-length 4

[XE-ls-gw-gw000 8801]codec video h261

1.1.8  codec (LS-GW-SUBSCRIBER view)

Syntax

codec { audio { g7231 | g729 | pcma | pcmu } [ packet-length packet-length ] } | { video { h261 | h263 } } | { data t38fax }

undo codec { audio | video | data }

View

LS-GW-SUBSCRIBER view

Parameter

audio: Sets the audio codec type.

g7231: Sets the audio codec type as G.723.1.

g729: Sets the audio codec type as G.729.

pcma: Sets the audio codec type as G.711 A-law 64K.

pcmu: Sets the audio codec type as G.711 u-law 64K.

packet-length: Packetization time length that ranges from 1 to 18 in units of 10 ms.

video: Sets the video codec type.

h263: Sets the video codec type as H263.

h261: Sets the video codec type as H261.

data: Sets the data codec type.

t38fax: Sets T38 faxing support.

Description

Use the codec command to configure the codec type used when the gatekeeper initiates capability negotiation to a gateway device. If a number is not configured with a codec type, the codec type configured for the gateway will be used instead.

Use the undo codec command to restore the default codec type.

By default, the codec type configured on the gateway is adopted.

Example

# For subscriber 8801, set codec type to G.729 so that the gatekeeper uses to initiate capability negotiation to a gateway device. Set the packetization time length as 40 ms and video codec type as H261.

[XE-ls-gw-gw000 #1 8801]codec audio g729 packet-length 4

[XE-ls-gw-gw000 #1 8801]codec video h261

1.1.9  codec (LS-GW view)

Syntax

codec { audio { g7231 | g729 | pcma | pcmu } [ packet-length packet-length ] } | { video { h261 | h263 } } | { data t38fax }

undo codec { audio | video | data }

View

LS-GW view

Parameter

audio: Sets the audio codec type.

g7231: Sets the audio codec type as G.723.1.

g729: Sets the audio codec type as G.729.

pcma: Sets the audio codec type as G.711 A-law 64K.

pcmu: Sets the audio codec type as G.711 u-law 64K.

packet-length: Packetization time length that ranges from 1 to 18 in units of 10 ms.

video: Sets the video codec type.

h263: Sets the video codec type as H263.

h261: Sets the video codec type as H261.

data: Sets the data codec type.

t38fax: Sets T38 faxing support.

Description

Use the codec command to configure the codec type used when the gatekeeper initiates capability negotiation with a gateway device.

Use the undo codec command to restore the default codec type.

By default, G.729 is adopted for audio codec, the packetization time length is 30 ms, and video codec and data faxing is not supported.

Example

# Set the codec type to G.729 so that the gatekeeper uses to initiate capability negotiation with a gateway device. Set, the packetization time length to 40 ms and video codec to H261.

[XE-ls-gw-gw000]codec audio g729 packet-length 4

[XE-ls-gw-gw000]codec video h261

1.1.10  codec (LS-OFFICEGROUP-OFFICE view)

Syntax

codec { audio { g7231 | g729 | pcma | pcmu } [ packet-length packet-length ] } | { video { h261 | h263 } } | { data t38fax }

undo codec { audio | video | data }

View

LS-OFFICEGROUP-OFFICE view

Parameter

audio: Sets the audio codec type.

g7231: Sets the audio codec type as G.723.1.

g729: Sets the audio codec type as G.729.

pcma: Sets the audio codec type as G.711 A-law 64K.

pcmu: Sets the audio codec type as G.711 u-law 64K.

packet-length: Packetization time length that ranges from 1 to 18 in units of 10 ms.

video: Sets the video codec type.

h263: Sets the video codec type as H263.

h261: Sets the video codec type as H261.

data: Sets the data codec type.

t38fax: Sets T38 faxing support.

Description

Use the codec command to configure the codec type used when the gatekeeper initiates capability negotiation to an office device.

Use the undo codec command to restore the default codec type.

By default, G.729 is adopted for audio codec, the packetization time length is 30 ms, and video codec and data faxing is not supported.

Example

# Set the codec type to G.729 so that the gatekeeper uses to initiate capability negotiation to an office device to G.722. Set the packetization time length to 40 ms and video codec to H261.

[XE-ls-og-og01 off000]codec audio g729 packet-length 4

[XE-ls-og-og01 off000]codec video h261

1.1.11  codec (LS-OFFICEGROUP-PREFIX view)

Syntax

codec { audio { g7231 | g729 | pcma | pcmu } [ packet-length packet-length ] } | { video { h261 | h263 } } | { data t38fax }

undo codec { audio | video | data }

View

LS-OFFICEGROUP-PREFIX view

Parameter

audio: Sets the audio codec type.

g7231: Sets the audio codec type as G.723.1.

g729: Sets the audio codec type as G.729.

pcma: Sets the audio codec type as G.711 A-law 64K.

pcmu: Sets the audio codec type as G.711 u-law 64K.

packet-length: Packetization time length in 10 milliseconds, in the range of 1 to 18.

video: Sets the video codec type.

h263: Sets the video codec type as H263.

h261: Sets the video codec type as H261.

data: Sets the data codec type.

t38fax: Sets T38 faxing support.

Description

Use the codec command to configure the codec type used when the gatekeeper initiates capability negotiation to an office device.

Use the undo codec command to restore the default codec type.

By default, the codec type configured on the office device is adopted.

Example

# For subscriber 8801, set codec type to G.729 so that the gatekeeper uses to initiate capability negotiation to an office device to G.729. Set the packetization time length to 40 ms and video codec to H261.

[XE-ls-og-og01 8801]codec audio g729 packet-length 4

[XE-ls-og-og01 8801]codec video h261

1.1.12  debugging location-server

Syntax

debugging location-server { call | heartbeat | register |all } level level-number

undo debugging location-server { call | heartbeat | register |all }

View

User view

Parameter

call: Enables call debugging.

heartbeat: Enables heartbeat, backup management and tunnel debugging.

register: Enables registration debugging.

all: Enables all debugging options.

level level-number: Sets the debugging level of LS, ranging from 0 to 7. Debugging is disabled when the level is 0.

Description

Use the debugging location-server command to set the debugging level of LS.

Use the undo debugging location-server command to restore the default setting.

The call keyword refers to information about calls; the register keyword indicates information about registration; the heartbeat keyword indicates information about heartbeat; the all keyword indicates all debugging levels including call, register and heartbeat.

All debugging options are disabled by default. When set to 4, debugging of level 1 to 4 is enabled; and 0 means to disable the debugging, by which you can hide the debugging information.

About the levels:

Level 0: Disable the debugging.

Level 1: DEBUG_LEVEL_EMERGENCY

          Fail to allocate memory

          Fail to allocate timer

Level 2: DEBUG_LEVEL_ALERT

          Null pointer, invalid memory operation

          Switching information about the state of the connection between process server (PS) and LS

Level 3: DEBUG_LEVEL_ERROR

          Control block state incorrect/not matched

          Invalid/unexpected control block index

          Invalid/unexpected PID/Module ID

          Fail to return value, the functions of the main function affected.

          Invalid message type

Level 4: DEBUG_LEVEL_WARNING

          Fail to return value, but the functions of the main function not affected.

         Message head received

          Abnormal timer timeout message

          State transition message

Level 5: DEBUG_LEVEL_NOTIFICATION

          Operating properly, but the environment slightly abnormal

          Information about key service flow

          Message header of the transmitted message

Level 6: DEBUG_LEVEL_INFORMATIONAL

          Key processing flow of module/function

          Memory allocating/releasing

          Timeout message of normal timer

          Important information of MD5 algorithm

          Important information of Hash algorithm

Level 7: DEBUG_LEVEL_DEBUGGING

          General flow information

          Extraction/adding processing functions of optional IE

          IE list information of message/message content

          Calling instruction of function entry/instruction of returned value

Example

# Enable all debugging options and set the debugging level of LS to 5.

<XE> debugging location-server all level 5

1.1.13  device-status (LS-GW view)

Syntax

device-status { forever-up attachedps ps-id | normal | suspend }

undo device-status

View

LS-GW view

Parameter

forever-up: Sets a gateway to work in forever-up state.

attachedps: Specifies the PS that this forever-up device belongs to.

ps-id: ID of the PS that this forever-up device belongs to.

normal: Sets a gateway to work in normal state.

suspend: Sets a gateway to work in suspend state.

Description

Use the device-status command to set the state of a gateway.

Use the undo device-status command to restore the default gateway state.

The device state defaults to normal.

Example

# Set the device state of the gateway gw001 to forever-up and specify this gateway belong to the PS named default-ps.

[XE-ls-gw-gw001] device-status forever-up attachedps default-ps

1.1.14  device-status (LS-OFFICEGROUP-OFFICE view)

Syntax

device-status { forever | normal }

View

LS-OFFICEGROUP-OFFICE view

Parameter

forever: Sets the device status to forever-up.

normal: Sets the device status to normal.

Description

Use the device-status command to set the status of an office device.

By default, the status of an office device is forever.

Example

# Set the device status to normal

[XE-ls-og-og01 of1]device-status normal

1.1.15  device-type (LS-GW view)

Syntax

device-type { h323 | sip }

undo device-type

View

LS-GW view

Parameter

h323: Sets the gateway type to H.323.

sip: Sets the gateway type to SIP.

Description

Use the device-type command to specify the gateway type.

Use the undo device-type command to restore the default gateway type.

The type of a registered gateway defaults to SIP.

Example

# Set the gateway type to H.323.

[XE-ls-gw-gw001] device-type h323

1.1.16  device-type (LS-OFFICEGROUP-OFFICE view)

Syntax

device-type { h323-gk | h323-gw | sip }

undo device-type

View

LS-OFFICEGROUP-OFFICE view

Parameter

h323-gk: Sets the office device to H.323 gatekeeper.

h323-gw: Sets the office device to H.323 gateway.

sip: Sets the office device to SIP-grade device.

Description

Use the device-type command to specify the device type of an office device.

Use the undo device-type command to restore the default office device type.

The type of an office device defaults to SIP-grade device.

Example

# Set the office device of1 to H.323 gateway.

[XE-ls-og-og01 of1] device-type h323-gw

1.1.17  display debugging location-server

Syntax

display debugging location-server

View

Any view

Parameter

None

Description

Use the display debugging location-server command to display the debugging level of the LS.

Example

# Display the debugging level of the LS.

<XE> display debugging location-server

 CALL           debugging level          3

 REGISTER       debugging level          3

 HEARTBEAT      debugging level          3

1.1.18  display location-server domain

Syntax

display location-server domain { domain-id | all }

View

Any view

Parameter

domain-id: ID of the domain whose information is to be displayed.

All: Displays information about all domains.

Description

Use the display location-server domain command to display the information about one domain or all domains on an LS.

Example

# Display information about the PublicDomain domain.

[XE-ls] display location-server domain PublicDomain

-----------Domain Information -----------

 Domain Identifier:                     PublicDomain

 Domain Attribute:                      public

 process-server list:                   ps0

office-group list:

The result shows that the attribute of the PublicDomain domain is public and the PS belonging to it is ps0.

1.1.19  display location-server gateway

Syntax

display location-server gateway { device-id | all | h323 | sip | list }

View

Any view

Parameter

all: Displays information about all gateways.

device-id: The identifier of the gateway to be displayed.

h323: Displays information about H.323 gateways.

sip: Displays information about SIP user agents.

list: Lists the identifiers and device types of the gateways.

Description

Use the display location-server gateway command to display information about the gateways registered with the LS.

Example

# Display information about all gateways.

<XE> display location-server gateway all

 

------------ Gateway Information ------------

 Identifier:                    gw02

 LoadShare:                     Disable

 SubsLine:                      4

 PsGroupID:

----------Static Information:

 Device Type:                   SIP-UA

 Ip-address:                    0.0.0.0:5060

 Call Ip-address:               0.0.0.0:1720

 Device Status:                 normal

 Device Manufacturer:           H3C

 Transport:                     udp      

 Multiplex:                     disable

 DynamicIp:                     disable

 Subscriber count:              1

 Subscriber List:

                 #2 1002

 Static Alias Number:           0

 Device Priority:               10

 Registration Circle:           180 sec

 Authentication:                disable

 Password:                      GATEWAY

 Area Code Substitute:          enable   

 Nation Code:

 Region Code:

----------Dynamic Information:

 Registration Status:           offline

 Registration Transport:        auto

 Dynamic Alias Number:           0

 Dynamic Alias Check Sum:       0

 Resource Can Use:              Yes

 Registration Call Identifier:

 RM handle:                     ffffffff

 CAI handle:                    ffffffff

 Notification Bitmap: Confirm:   1 Reject:   1 Blankout:   1 Challenge:   0

 Indication Bitmap:   Confirm:   0 Reject:   0 Blankout:   0 Challenge:   0

 Attached Process Server:

Table 1-1 Description on the fields of the display location-server gateway all command

Field

Description

Identifier

Identifier of the gateway

LoadShare

Load sharing state

SubsLine

Capacity of voice subscriber lines

PsGroupID

Identifier of the PS group to which the gateway belongs

Device Type

Type of the gateway

Ip-address

IP address of the gateway

Call Ip-address

IP address of call signaling

Device Status

State of the gateway

Device Manufacturer

Information about the manufacturer

Transport

Transport mode of the gateway

Multiplex

Multiplexing mode

DynamicIp

Whether to enable dynamic IP

Subscriber count

Number of entries for subscriber line numbers

Subscriber List

List of entries for subscriber line numbers

  #

                  #2 1002

Short number and long number

Static Alias Number

Number of static number routes

Static Alias List

Routing table of static number

Device Priority

Device priority

Registration Circle

Registration circle

Authentication

Authentication mode

Password

Authentication password

Area Code Substitute

State of the location-based number substitute

Nation Code

Country code

Region Code

Area code

Registration Status

Registration status

Registration Transport

Registration transport mode

Dynamic Alias Number

Number of dynamic number routes

Dynamic Alias Check Sum

Check sum of dynamic number routes

Resource Can Use

Whether the gateway resource is available

Registration Call Identifier

Registration call identifier

RM handle

Registration module handle

CAI handle

CAI module handle

Notification Bitmap

Notification bitmap

Indication Bitmap

Indication bitmap

Attached Process Server

Attached PS (the gateway registers with the LS through this PS)

 

1.1.20  display location-server office-group

Syntax

display location-server office-group { all | officegroup-id | list }

View

Any view

Parameter

all: Displays all office group information.

officegroup-id: Identifier of the office group to be displayed.

list: Displays office group information in a list.

Description

Use the display location-server office-group command to display information about office devices configured on the LS.

Example

# Display information about all office groups.

[XE-ls-og-og01 off000]display location-serve office-group all

 

-------------- Office-group Information --------------

 Identifier:                    og01

 Nation Code:

 Region Code:

 Area Code Substitute:          disable

 Attached Domain Identifier:    default-domain

 Static Alias Number:           1

 Static Alias List:

  #

  prefix 1...

 Office Number:         1

 Office List:

  #

  office off000

   acct enable

[XE-ls-og-og01 off000]

Table 1-2 Description on the fields of the display location-server office-group all command

Field

Description

Identifier

Identifier of the office group

Nation Code

Country code

Region Code

Area code

Area Code Substitute

State (enabled/disabled) of the location-based number substitute function

Attached Domain Identifier

Domain that the office group belongs to

Static Alias Number

Number of static number routes

Static Alias List

Static route number list

Office Number

Number of office devices

Office List

Office device list

 

1.1.21  display location-server process-server

Syntax

display location-server process-server { all | device-id | list }

View

Any view

Parameter

all: Display information of all PSs registered with the LS.

device-id: The identifier of the PS to be displayed.

list: Lists the identifiers and IP addresses of the PSs.

Description

Use the display location-server process-server command to display information about the PSs registered with the LS.

Example

# Display information about the PS ps0.

[XE]display location-server process-server ps0

 

----------- Process Server Information -----------

 Identifier:                    ps0

 RelativeCapability:            1

 Attached SubsLineNumber:       4

----------Static Information:

 SIP port:                      5060

 RAS port:                      1719

 Process Server Group Identifier:       

 Attached Domain Identifier:    default-domain

 Tunnel function:               Disable

 HeartBeat Key:                 XEngine

 Transport:                     auto

----------Dynamic Information:

 Ip-address:                    172.31.3.24

 Status:                        Authorized

 Attaching Gateway List:

Table 1-3 Description on the fields of the display location-server process-server command

Field

Description

Identifier

Identifier of the PS

RelativeCapability

Relative capability of the PS

Attached SubsLineNumber

Number of the subscriber line the PS supports

SIP port

SIP port of the PS

RAS port

RAS port of the PSs

Process Server Group Identifier

Group identifier of the PS

Attached Domain Identifier

The domain the PS belongs to

Tunnel function

Whether the tunnel function is enabled

HeartBeat Key

Heartbeat key of the PS and LS

Transport

Transport method of the PS

Ip-address

IP address of the PS

Status

Status of the PS

Attaching Gateway List

List of gateways registered with a PS

 

# Display the identifier and IP address of the PS.

[XE-ls] display location-server process-server list 

 Identifier                       IP address           

--------------------------------------------------     

 gkserver                         192.168.80.50:13580        

1.1.22  display location-server statistics

Syntax

display location-server statistics

View

Any view

Parameter

None

Description

Use the display location-server statistics command to display statistics of the LS.

Example

# Display statistics of the LS.

<XE> display location-server statistics

CAI Message Statistics of LS:

   CAI Message                      total  rcv send  err dupr dups disc

--------------------------------------------------------------------

            Register Query Device:     0    0    0    0    0    0    0

         Register Response Device:     0    0    0    0    0    0    0

          Register Notify Confirm:     0    0    0    0    0    0    0

           Register Notify Reject:     0    0    0    0    0    0    0

        Register Notify Challenge:     0    0    0    0    0    0    0

Register Indication Device Status:     0    0    0    0    0    0    0

         Register Notify BlankOut:     0    0    0    0    0    0    0

Register Indication Device Update:     0    0    0    0    0    0    0

       Call Query Number Analysis:     0    0    0    0    0    0    0

    Call Response Number Analysis:     0    0    0    0    0    0    0

            Call Notify Ring Back:     0    0    0    0    0    0    0

             Call Notify Redirect:     0    0    0    0    0    0    0

             Call Notify Off Hook:     0    0    0    0    0    0    0

                 Call Notify Talk:     0    0    0    0    0    0    0

              Call Notify Release:     0    0    0    0    0    0    0

     Call Notify Release Complete:     0    0    0    0    0    0    0

            Call Indication Refer:     0    0    0    0    0    0    0

          Call Indication Release:     0    0    0    0    0    0    0

     Call Indication Call Forward:     0    0    0    0    0    0    0

         Connect Notify HeartBeat:     0    0    0    0    0    0    0

     Connect Indication HeartBeat:     0    0    0    0    0    0    0

             Call Query Admission:     0    0    0    0    0    0    0

          Call Response Admission:     0    0    0    0    0    0    0

     Call Notify BandWidth Change:     0    0    0    0    0    0    0

 Call Indication BandWidth Change:     0    0    0    0    0    0    0

                      Invalid CAI:     0    0    0    0    0    0    0

 

 CAI Distribute Message Statistics of LS:

 CAI Distribute Message               total  rcv send  err dupr dups disc

--------------------------------------------------------------------

CAI Distribute Message between PS and RM: 0    0    0    0    0    0    0

CAI Distribute Message between PS and CM: 0    0    0    0    0    0    0

            CAI Distribute Message of LS: 0    0    0    0    0    0    0

                             CAI Release: 0    0    0    0    0    0    0

                          CAI Invalid ID: 0    0    0    0    0    0    0

Table 1-4 Description on the fields of the display location-server statistics command

Field

Description

Register Query Device

Query device information

Register Response Device

The LS returns the information of the queried device

Register Notify Confirm

Notify the LS of successful registration

Register Notify Reject

Notify the LS of failed registration

Register Notify Challenge

Notify LS to send Challenge message

Register Indication DeviceStatus

The LS prompts the registration status (success, failure or redirect)

Register Notify BlankOut

Notify the LS of expired registration

Register Indication DeviceUpdate

The LS prompts the update of the device configuration

Call Query NumberAnalysis

The PS queries the LS about number analysis

Call Response NumberAnalysis

The LS returns the result of number analysis

Call Notify RingBack

The PS notifies the subscriber to ring back

Call Notify Redirect

The PS notifies the LS to redirect the call

Call Notify OffHook

The PS notifies that the called has picked up the phone

Call Notify Talk

The PS notifies that the subscriber is on the call

Call Notify Release

Notify that the LS is ready to release the call

Call Notify ReleaseComplete

Notify that the call release completes

Call Indication Refer

Information of the calling and called parties

Call Indication Release 

Indicate the PS to terminate the call

Call Indication CallForward

Indicate call forwarding

Connect Notify HeartBeat

The PS sends periodical heartbeat message to the LS

Connect Indication HeartBeat

The LS sends periodical heartbeat message to the PS.

Call Query Admission 

Admission of the called party

Call Response Admission

Response to the admission of the called party

Call Notify BandWidth Change

Notification of the bandwidth change request

Call Indication BandWidth Change

Indication of the bandwidth change request

 

1.1.23  display location-server tunnelpeer

Syntax

display location-server tunnelpeer { tunnelpeer-id  | all }

View

Any view

Parameter

tunnelpeer-id: ID of the tunnel end pair whose information is to be displayed.

All: Displays information about all tunnel end pairs.

Description

Use the display location-server tunnelpeer command to display the information about one or all tunnel end pairs (that is, one or all pairs of PSs) on an LS.

Example

# Display the information about all tunnel end pairs.

[XE-ls] display location-server tunnelpeer all

-------****------ TunnelPeer Information -------****------

 Tunnelpeer Identifier:                 tunnel01

 current state:                         initial

 

***Private Domain Process Server Information***

 belongto domain:                       PrivateDomain

 map to firewall IP:                    1.1.1.2

 map to firewall port:                  9600

 

***Public Domain Process Server Information***

 belongto domain:                       PublicDomain

 map to firewall IP:                    192.168.1.22

 map to firewall port:                  9600

Table 1-5 Description on the fields of the display location-server tunnelpeer command

Field

Description

Tunnelpeer Identifier

ID of the tunnel end pair.

current state

The status of the tunnel end pair.

Private Domain Process Server Information

belongto domain

The domain that the private network PS of this tunnel end pair belongs to.

map to firewall IP

The destination IP address that the public network PS uses to send IP packets to the private network PS. Usually it is the public IP address on the firewall that corresponds to the private network PS.

map to firewall port

The destination port that the public network PS uses to send IP packets to the private network PS.

Public Domain Process Server Information

belongto domain

The domain that the public network PS of this tunnel end pair belongs to.

map to firewall IP

The destination IP address that the private  network PS uses to send IP packets to the public network PS.

map to firewall port

The destination port that the private  network PS uses to send IP packets to the public network PS.

 

1.1.24  dynamic-ip

Syntax

dynamic-ip { disable | enable }

undo dynamic-ip

View

LS-GW view

Parameter

enable: Enables the dynamic update of the gateway’s IP address.

disable: Disables the dynamic update of the gateway’s IP address.

Description

Use the dynamic-ip command to enable or disable the dynamic update of the gateway’s IP address.

Use the undo dynamic-ip command to restore the default setting.

By default, the dynamic update of the gateway’s IP address is disabled.

 

&  Note:

l      If you use the manufacturer command to set the manufacturer of the gateway to other, the system will disable the dynamic update of the gateway’s IP address.

l      After enabling the dynamic update of the gateway’s IP address with the dynamic-ip command, you cannot use the manufacturer command to change the manufacturer setting of the gateway; in addition, the ip, port, call-signal ip, and call-signal port commands become invalid.

 

Example

# Enable the dynamic update of the gateway’s IP address.

[XE-ls-gw-gw001] dynamic-ip enable

1.1.25  gateway (LS view)

Syntax

gateway device-id

undo gateway { device-id | all }

View

LS view

Parameter

device-id: The identifier of the gateway. It is case sensitive.

all: Deletes all gateways.

Description

Use the gateway command to add a gateway or enter the device view of a gateway.

Use the undo gateway command to remove one or all gateways.

Example

# Add a gateway named gw001.

[XE-ls] gateway gw001

[XE-ls-gw-gw001]

1.1.26  heartbeat password (LS-PS view)

Syntax

heartbeat password password

undo heartbeat password

View

LS-PS view

Parameter

password: Heartbeat password that consists of 1 to 16 characters and is case-sensitive.

Description

Use the heartbeat password command to set the heartbeat password for a PS registered with the LS.

Use the undo heartbeat password command to restore the default password.

By default, the password is XEngine.

Example

# Set the heartbeat password for the PS ps0 to pass1.

[XE-ls-ps-ps0] heartbeat password pass1

1.1.27  heartbeat-time-range

Syntax

heartbeat-time-range time

undo heartbeat-time-range

View

LS view

Parameter

time: Allowed time difference between the LS and the PS/MS, in the range of 0 to 36000 seconds.

Description

Use the heartbeat-time-range command to set the allowed time difference between the LS and the PS/MS.

Use the undo heartbeat-time-range command to restore the default value.

By default, this value is 0, indicating the time difference is not limited.

Example

# Set the allowed time difference between the LS and the PS/MS to 3600 seconds.

[XE-ls] heartbeat-time-range 3600

1.1.28  ip-address (LS-GW view)

Syntax

ip-address ip-address

undo ip-address

View

LS-GW view

Parameter

ip-address: IP address.

Description

Use the ip-address command to set the IP address of a gateway registered with the LS.

Use the undo ip-address command to restore the default IP address.

By default, the IP address is 0.0.0.0.

Example

# Set the IP address of the gateway gw001 to 192.168.1.33.

[XE-ls-og-og01 of1] ip-address 192.168.1.33

1.1.29  ip-address (LS-OFFICEGROUP-OFFICE view)

Syntax

ip-address ip-address

undo ip-address

View

LS-OFFICEGROUP-OFFICE view

Parameter

ip-address: IP address.

Description

Use the ip-address command to set the IP address of an office device.

Use the undo ip-address command to restore the default IP address.

By default, the IP address is 0.0.0.0.

Example

# Set the IP address of the office device of1 to 192.168.1.33.

[XE-ls-office-of1] ip-address 192.168.1.33

1.1.30  ls-config

Syntax

ls-config interface interface-type slot-number [ port port ]

undo ls-config

View

LS view

Parameter

interface: Specifies the interface.

interface-type: Interface type.

slot-number: Interface number.

port: Specifies the port number, which ranges from 1 to 65535.

Description

Use the ls-config command to specify the interface and port number of the LS.

Use the undo ls-config command to restore the default interface and port number.

By default, the port number is 13579, the interface is Ethernet 0/0 for XE 200 IP PBX and GigabitEthernet 0/0 for XE 2000 IP PBX.

Example

# Specify the interface and port number of the LS.

[XE200-ls] ls-config interface ethernet 0/0 port 12345

1.1.31  manufacturer

Syntax

manufacturer { other | h3c }

undo manufacturer

View

LS-GW view

Parameter

other: Sets the manufacturer of a gateway to other.

h3c: Sets the manufacturer of a gateway to H3C.

Description

Use the manufacturer command to set the manufacturer for a gateway registered with the LS.

Use the undo manufacturer command to restore the default manufacturer.

By default, the manufacturer is h3c.

 

&  Note:

l      If you use the manufacturer command to set the manufacturer of the gateway to other, the system will disable the dynamic update of the gateway’s IP address.

l      If you use the dynamic-ip command to enable the dynamic update of the gateway’s IP address, you cannot use the manufacturer command to change the manufacturer setting of the gateway.

 

Example

# Set the manufacturer of the gateway gw001 to other.

[XE-ls-gw-gw001] manufacturer other

1.1.32  multiplex (LS-GW view)

Syntax

multiplex { disable | enable }

undo multiplex

View

LS-GW view

Parameter

disable: Disables multiplexing.

enable: Enables multiplexing.

Description

Use the multiplex command to specify the multiplexing mode of a gateway registered with the LS.

By default, multiplexing is disabled.

Example

# Enable multiplexing on the gateway gw001.

[XE-ls-gw-gw001] multiplex enable

1.1.33  multiplex (LS-OFFICEGROUP-OFFICE view)

Syntax

multiplex { disable | enable }

undo multiplex

View

LS-OFFICEGROUP-OFFICE view

Parameter

disable: Disables multiplexing.

enable: Enables multiplexing.

Description

Use the multiplex command to specify the multiplexing mode of an office device configured on the LS.

By default, multiplexing is disabled.

Example

# Enable multiplexing on the office device of1.

[XE-ls-og-og01 of1] multiplex enable

1.1.34  multiplex (LS-PS view)

Syntax

multiplex { disable | enable }

undo multiplex

View

LS-PS view

Parameter

disable: Disables multiplexing.

enable: Enables multiplexing.

Description

Use the multiplex command to specify the multiplexing mode of a PS registered with the LS.

By default, multiplexing is disabled.

Example

# Enable multiplexing on the PS ps0.

[XE-ls-ps-ps0] multiplex enable

1.1.35  office

Syntax

office device-id

undo office { device-id | all }

View

LS-OFFICEGROUP view

Parameter

device-id: The identifier of the office device. It is case sensitive.

all: Deletes all offices.

Description

If the office mapping device-id does not exist, use the office command to create a new office on the LS and enter the LS-OFFICEGROUP-OFFICE view.

If the office mapping device-id exists, use the office command to enter the LS-OFFICEGROUP-OFFICE view directly.

Use the undo office command to delete the office.

You need to enter the LS-OFFICE view first to configure an office.

Example

# Enter the view of the office of1.

[XE-ls-og-og01] office of1

[XE-ls-og-og01 of1]

1.1.36  office-group

Syntax

office-group office-group-id

undo office-group { office-group-id | all }

View

LS view

Parameter

office-group-id: Office group ID. It is case sensitive.

all: Deletes all office groups configured on the LS.

Description

Use the office-group command to create an office group and enter its LS-OFFICEGROUP view, or directly enter the LS-OFFICEGROUP view if an office group with the specified name exists.

Use the undo office-group command to delete the specified or all office groups.

Example

# Create an office group og01 and then enter its LS-OFFICEGROUP view.

[XE2000-ls]office-group og01

[XE2000-ls-og-og01]

1.1.37  otapc

Syntax

otapc

undo otapc { fxs | relay }

View

Prefix view

Parameter

fxs: Specifies the static route number to be the subscriber number.

relay: Specifies the static route number to be the relay number.

Description

Use the otapc command to configure the attribute of a static route number of a gateway.

Use the undo otapc command to restore the default attribute of a static route number.

By default, the static route number is the subscriber number.

Example

# Configure the static router number 9 to be the relay number on gateway gw01.

[XE-ls] gateway gw02

[XE-ls-gw-gw02] prefix 9...

[XE-ls-gw-gw02 9...] otapc relay

1.1.38  password (LS-GW view)

Syntax

password password

undo password

View

LS-GW view

Parameter

password: Authentication password consisting of 1 to 16 characters.

Description

Use the password command to set the authentication password for a gateway registered with the LS.

Use the undo password command to restore the default password.

By default, the authentication password for a gateway is GATEWAY.

Example

# Set the authentication password of the gateway gw001 to pass1.

[XE-ls-gw-gw001] password pass1

1.1.39  policy random selection

Syntax

policy random-selection { enable | disable }

View

LS view

Parameter

random-selection: Configures random selection of numbers.

enable: Enables random selection.

disable: Disables random selection.

Description

Use the policy random-selection enable command to enable random selection.

Use the policy random-selection disable command to disable random selection.

By default, the random selection is enabled.

Example

# Disable random selection.

[XE-LS] policy random-selection disable

1.1.40  policy select-rule

Syntax

policy select-rule {number-first | priority-first}

undo policy select-rule

View

LS view

Parameter

number-first: Configures the longest number at a higher priority.

priority-first: Configures the priority number at a higher priority.

Description

Use the policy select-rule command to configure the longest number or the priority number at a higher priority.

Use the undo policy select-rule command to restore the default call-matching criterion.

By default, the call-matching criterion sets the priority number at a higher priority.

Example

# Configure the longest number at a higher priority.

[XE-ls] policy select-rule number-first

[XE-ls]

1.1.41  policy unknown-device-admission

Syntax

policy unknown-device-admission {enable | disable}

undo policy unknown-device-admission

View

LS view

Parameter

Enable: Enables the XE IP PBX to accept requests from unknown devices.

Disable: Disables the XE IP PBX to accept requests from unknown devices.

Description

Use the policy unknown-device-admission command to enable or disable to accept requests for unknown devices.

Use the undo policy unknown-device-admission command to restore the default.

By default, accepting requests from unknown devices is enabled.

Example

# Disable to accept requests from unknown devices.

[XE-ls]policy unknown-device-admission disable

[XE-ls]

1.1.42  port (LS-GW view)

Syntax

port port

undo port

View

LS-GW view

Parameter

port: Port number, ranging from 1 to 65535. By default, it is 5060.

Description

Use the port command to set the port number of a gateway registered with the LS.

Use the undo port command to restore the default port.

By default:

For an H.323 device, port 1719 is used;

For a SIP device (User-Agent), port 5060 is used.

Example

# Set the port number of the gateway gw001 to 1234.

[XE-ls-gw-gw001] port 1234

1.1.43  port (LS-OFFICEGROUP-OFFICE view)

Syntax

port port

undo port

View

LS-OFFICEGROUP-OFFICE view

Parameter

port: Port number, ranging from 1 to 65535. By default, it is 5060.

Description

Use the port command to set the port number of an office device configured on the LS.

Use the undo port command to restore the default port.

By default, the port number of an office device is 5060.

 

&  Note:

By default, the port number is 5060. When the dynamic-ip disable command is used and the type of the gateway is SIP, you can keep this number unchanged; while if the type is h323-gw, you should use the port command to set the port number to 1720, and if the type is h323-gk, you should use the port command to set the port number to 1719.

 

Example

# Set office device of1 using port 1720.

[XE-ls-og-og01 of1] port 1720

1.1.44  prefix (LS-GW view)

Syntax

prefix number

undo prefix { number | all }

View

LS-GW view

Parameter

number: Static route number consisting of 1 to 31 characters, which can be numbers from 0 to 9, letters A, B, C, D or signs * and #.

all: Deletes all route numbers.

Description

Use the prefix command to configure a static route number for a gateway registered with the LS and enter the view of this number.

Use the undo prefix command to delete one or all of the static route numbers of a gateway.

Example

# Configure the static route number 8801 for the gateway gw01.

[XE-ls-gw-gw01]prefix 8801

[XE-ls-gw-gw01 8801]

1.1.45  prefix (LS-OFFICEGROUP view)

Syntax

prefix number

undo prefix { number | all }

View

LS-OFFICEGROUP view

Parameter

number: Static route number consisting of 1 to 31 characters, which can be numbers from 0 to 9, letters A, B, C, D or signs * and #.

all: Deletes all route numbers.

Description

Use the prefix command to configure a static route number for an office device configured on the LS and enter the view of this number.

Use the undo prefix command to delete one or all of the static route numbers of an office group.

Example

# Configure the static route number 8803 for office group og01.

[XE2000-ls-og-og01] prefix 8803

[XE2000-ls-og-og01 8803]

1.1.46  priority (LS-GW view)

Syntax

priority level

undo priority

View

LS-GW view

Parameter

level: Priority of a gateway, which ranges from 0 to 1000 and defaults to 10. The larger the value, the higher the priority.

Description

Use the priority command to set the priority of a gateway registered with the LS.

Use the undo priority command to restore the default priority.

The default priority is 10.

Example

# Set the priority of the gateway gw001 to 11.

[XE-ls-gw-gw001] priority 11

1.1.47  priority (LS-OFFICEGROUP-OFFICE view)

Syntax

priority priority-level

undo priority

View

LS-OFFICEGROUP-OFFICE view

Parameter

level: Priority of an office device, which ranges from 0 to 1000 and defaults to 10. The larger the value, the higher the priority.

Description

Use the priority command to set the priority of an office device configured on the LS.

Use the undo priority command to restore the default priority.

The default priority is 10.

Example

# Set the priority of the office device of1 to 11.

[XE-ls-og-og01 of1] priority 11

1.1.48  priority (prefix view)

Syntax

priority priority-level

undo priority

View

Prefix view

Parameter

level: Priority of a static route number, which ranges from 0 to 1000, and the default is the same as that of a gateway.

Description

Use the priority command to set the priority of a static route number registered with the LS.

Use the undo priority command to restore the default priority.

The default priority of a static route number is the same as that of a gateway or an office device, refer to priority (LS-GW view) for details.

Example

# Set the priority of the static route number 1101 to 11.

[XE-ls-gw-gw01] prefix 1101

[XE-ls-gw-gw01 1101] priority 11

1.1.49  priority (subscriber view)

Syntax

priority priority-level

undo priority

View

Subscriber view

Parameter

level: Priority of a voice subscriber line number entry, which ranges from 0 to 1000, and the default is the same as that of a gateway.

Description

Use the priority command to set the priority of a voice subscriber line number entry registered with the LS.

Use the undo priority command to restore the default priority.

The default priority of a voice subscriber line number is the same as that of a gateway, refer to priority (LS-GW view) for details.

Example

# Set the priority of the voice subscriber line number entry #01 9901 to 11.

[XE-ls-gw-gw01] subscriber #01 9901

[XE-ls-gw-gw01 #01 9901] priority 11

1.1.50  process-server

Syntax

process-server device-id

undo process-server { device-id | all }

View

LS view

Parameter

device-id: The identifier of a PS. It is case sensitive.

all: Deletes all PSs.

Description

Use the process-server command to add a PS and enter the LS-PS view of the LS. If this PS exists, this command brings you into the LS-PS view of the LS.

Use the undo process-server command to delete the PSs registered with the LS.

Before deleting a PS to which a permanently online gateway connects, you need to change the status of the gateway.

You need to enter LS-PS view first before configuring the PS.

Example

# Enter the view of the PS ps0.

[XE-ls] process-server ps0

[XE-ls-ps-ps0]

1.1.51  reset location-server statistics

Syntax

reset location-server statistics

View

User view

Parameter

None

Description

Use the reset location-server statistics command to clear the statistics about the LS, that is, to clear the information displayed by the display location-server statistics command.

Example

# Clear the statistics about the LS.

<XE> reset location-server statistics

1.1.52  start

Syntax

start

View

LS view

Parameter

None

Description

Use the start command to start the LS.

The LS is not started by default.

Example

# Start the LS.

[XE-ls] start

1.1.53  stop

Syntax

stop

View

LS view

Parameter

None

Description

Use the stop command to disable the LS.

Example

# Disable the LS.

[XE-ls] stop

1.1.54  subscriber

Syntax

subscriber short-number long-number

undo subscriber { short-number long-number | all }

View

LS-GW view

Parameter

short-number: Short number of a voice subscriber line number entry corresponding to a long number, which starts with a "#" and consists of two to three characters (including the "#"). The value of this number ranges from 0 to 31.

long-number: Long number, corresponding to the short number of the voice subscriber line number, which contains one to 31 digits. The long number can be numbers from 0 to 9, signs *, #, and letters A, B, C, or D.

all: Deletes all voice subscriber line number entry.

Description

Use the subscriber command to create a number entry for a voice subscriber line of a gateway registered with the LS.

Use the undo subscriber command to delete all subscriber line number entries of the gateway.

Example

# Create a number entry for a voice subscriber line of the gateway gw001, with #31 as the short number and 68835641 as the long number.

[XE-ls-gw-gw001] subscriber #31 68835641

[XE-ls-gw-gw01 #31 68835641]

# Create a number entry for a voice subscriber line of the subscriber whose long number is 68835641, with #11 as the short number.

[XE-ls-gw-gw01 #31 68835641] quit

[XE-ls-gw-gw01]subscriber #11 68835641

[XE-ls-gw-gw01 #11 68835641]

1.1.55  transport (LS-GW view)

Syntax

transport { auto | tcp | udp }

undo transport

View

LS-GW view

Parameter

auto: Specifies to select transport mode automatically.

tcp: Specifies to transport using TCP.

udp: Specifies to transport using UDP.

Description

Use the transport command to specify the transport mode of a gateway registered with the LS.

Use the undo transport command to restore the default transport mode.

By default, udp mode is selected.

Example

# Specify the gateway gw001 to transport using TCP.

[XE-ls-gw-gw001] transport tcp

1.1.56  transport (LS-OFFICEGROUP-OFFICE view)

Syntax

transport { auto | tcp | udp }

undo transport

View

LS-OFFICEGROUP-OFFICE view

Parameter

auto: Specifies to select transport mode automatically.

tcp: Specifies to transport using TCP.

udp: Specifies to transport using UDP.

Description

Use the transport command to specify the transport mode of an office device configured on the LS.

Use the undo transport command to restore the default transport mode.

By default, auto mode is selected.

Example

# Specify the office device of1 to transport using UDP.

[XE-ls-og-og01 of1] transport tcp

1.1.57  ttl

Syntax

ttl time-length

undo ttl

View

LS-GW view

Parameter

time-length: TTL time length in seconds, ranging from 10 to 65535. It defaults to 180 seconds.

Description

Use the ttl command to set the time-to-live value of the registration information of a gateway registered with the LS.

Use the undo ttl command to restore the default value.

Example

# Set the time-to-live value of the registration information of the gateway gw001 to 200 seconds.

[XE-ls-gw-gw001] ttl 200

 


Chapter 2  NAT/FW Tunnel Traversal Configuration Commands

2.1  NAT/FW Tunnel Traversal Configuration Commands

2.1.1  attribute

Syntax

attribute {private | public}

undo attribute

View

LS-domain view

Parameter

private: Specifies that the domain belongs to a private network.

public: Specifies that the domain belongs to a public network.

Description

Use the attribute command to configure the attribute of a domain to specify the type (public network or private network) of the domain.

Use the undo attribute command to cancel the attribute configuration of the domain.

Example

# Specify that domain001 belongs to a private network.

[XE-ls-domain-domain001] attribute private

2.1.2  belongto

Syntax

belongto domain-id

undo belongto

View

LS-OFFICEGROUP view

LS-office view

Parameter

domain-id: ID of the domain to which the PS or office group is to belong.

Description

Use the belongto command to specify the domain to which the PS or office group is to belong.

Use the undo belongto command to specify that the PS or office group belongs to the default-domain domain.

By default, a PS or an office group belongs to the default-domain domain.

Example

# Specify that ps0 belongs to domain001.

[XE-ls-ps-ps0] belongto domain001

2.1.3  device-status forever-up attachedps

Syntax

device-status forever-up attachedps ps-id

View

LS-GW view

Parameter

ps-id: ID of the PS to which the gateway device is to belong.

Description

Use the device-status forever-up attachedps ps-id command to specify the PS to which a forever-up gateway device is to belong.

Example

# Specify that gw01, a forever-up gateway device, belongs to ps01.

[XE-ls-gw-gw01] device-status forever-up attachedps ps01

2.1.4  domain

Syntax

domain domain-id

undo domain { domain-id | all } [ no-confirm ]

View

LS view

Parameter

domain-id: ID of the domain to be created, deleted , or ID of the domain whose view you want to enter. It is case sensitive.

all: Removes all domains.

no-confirm: Removes a domain without user confirmation.

Description

Use the domain command to create a domain (if the domain identified by the domain-id argument does not exist.) or enter the corresponding domain view (if the domain identified by the domain-id argument already exists).

Use the undo domain command to remove a specified domain or all domains as well as the office devices belonging to the domain.

Example

# Create a domain with an ID of domain001.

[XE-ls] domain domain001

# Delete a domain.

[XE-ls] undo domain domain001

NOTICE:This command will delete all offices belonged to the domain! Continue?[Y/N]:y

Delete Domain domain001

# Delete a domain directly without user confirmation.

[XE-ls]undo domain domain002 no-confirm

Delete Domain domain002

[XE-ls]

2.1.5  nat&fw

Syntax

nat&fw

View

LS view

Parameter

None

Description

Use the nat&fw command to enter LS-NAT&FW view.

Example

# Enter LS-NAT&FW view.

[XE-ls] nat&fw

2.1.6  tunnel

Syntax

tunnel { enable | disable }

undo tunnel

View

LS-PS view

Parameter

enable: Enables NAT/FW tunnel traversal on current PS.

disable: Disables NAT/FW tunnel traversal on current PS.

Description

Use the tunnel command to enable/disable NAT/FW (firewall) tunnel traversal on current PS.

By default, NAT/FW tunnel traversal is disabled on a PS.

Example

# Enable NAT/FW tunnel traversal on PS0.

[XE-ls-ps-ps0] tunnel enable

2.1.7  tunnelpeer

Syntax

tunnelpeer tunnelpeer-id private private-ps-id private-to-public-add port private-to-public-port public public-ps-id public-to-private-add  port public-to-private-port

undo tunnelpeer { tunnelpeer-id | all }

View

LS-NAT&FW view

Parameter

tunnelpeer-id: ID of the tunnel end pair to be created.

private-ps-id: ID of the specified PS in the private network.

private-to-public-add: Destination address of the IP packets sourced from the PS in the private network and destined for the PS in the public network.

private-to-public-port: Destination port number of the IP packets sourced from the PS in the private network and destined for the PS in the public network.

public-ps-id: ID of the specified PS in the public network.

public-to-private-add: Destination address of the IP packets sourced from the PS in the public network and destined for the PS in the private network. Normally, it is the public network IP address that the PS in the private network is mapped to on the NAT/FW.

public-to-private-port: Destination port number of the IP packets sourced from the PS in the public network and destined for the PS in the private network. Normally, it is the port number of the firewall used by the PS in the private network.

Description

Use the tunnelpeer command to configure a tunnel end pair (that is, a pair of PSs, with one in the private network and another in the public network, which will communicate with each other across the firewall).

Use the undo tunnelpeer command to delete all tunnel end pairs or a specified tunnel end pair.

Example

# PS0 resides in the private network and its IP address is 192.168.1.2. PS1 resides in the public network and its IP address is 220.10.10.2. NAT is enabled between the private and public networks, and the public network IP address is exposed to the private network. Specify PS0 and PS1 to be a tunnel end pair using port 11998 at both ends. PS0 uses the following IP address and port number of the firewall: 220.10.10.1 and 11998.

[XE-ls-nat&fw] tunnelpeer tunnelpeer01 private PS0 220.10.10.2 port 11998 public PS1 220.10.10.1 port 11998

 

 

H3C reserves the right to modify its collaterals without any prior notice. For the latest information of the collaterals, please consult H3C sales or call 400 hotline.