|
Among the command sets supported by the Command Line Interface (CLI), the dial plan management commands are the most sophisticated. Some of the dial plan management commands are only allowed when the Elite Gateway* is in the atpm table update state. The dial plan management command set is further categorized into several sub command sets.
| Database update control |
Purposes |
Commands |
atpm table update state required? |
| Database update control |
- Instruct the Elite Gateway to start or stop atpm table update state.
- Store/restore atpm tables to/from non-volatile storage.
- Purge atpm tables.
- Erase dial plan database from non-volatile storage.
|
atpm req
atpm done
atpm restore
atpm store
atpm purge
atpm erase |
No
No
Yes
No
Yes
No |
| Destination table management |
Manage atpm destination table |
atpm dadd
atpm ddel
atpm dfind
atpm dlist |
Yes
Yes
No
No |
| Hunt group table management |
Manage atpm hunt group table |
atpm hadd
atpm hdel
atpm hfind
atpm hlist |
Yes
Yes
No
No |
| Address table management |
Manage atpm address table |
atpm aadd
atpm adel
atpm afind
atpm alist |
Yes
Yes
No
No |
| System |
Manage atpm system configuration |
atpm slist
atpm sys |
No
Yes | |
The following sections describe each sub command set and the commands.
Database Update Control Commands
atpm done
The atpm done command ends the atpm table update session and re-enables the address translation.
Syntax description
This command has no arguments or keywords. atpm erase
The atpm erase command erases the dial plan database from the non-volatile memory.
Syntax description
This command has no arguments or keywords. atpm purge {all|addr|dest|hunt}
Use the atpm purge command to delete all entries from the atpm tables.
Syntax description
| all |
Delete all entries from atpm addresses, destination and hunt group tables. |
| addr |
Delete all entries from atpm address table. |
| dest |
Delete all entries from atpm destination table. |
| hunt |
Delete all entries from atpm hunt group table. | | atpm req
The atpm req command starts the atpm table update session. Upon starting the atpm table update session, the ATPM address translation is disabled, hence no phone call can be made, until an atpm done command is issued.
Syntax description
This command has no arguments or keywords. atpm restore
The atpm restore command restores the whole dial plan from non-volatile storage to the atpm address, destination and hung group tables.
Syntax description
This command has no arguments or keywords. atpm store [erase]
The atpm store command stores all atpm tables into non-volatile memory.
Syntax description
| erase |
(Optional) Erase the non-volatile memory before storing the dial plan database. This option is not recommended except for the first time the atpm store command is used. | | Destination Table Management Commands
atpm dadd dest_id port port#
The atpm dadd dest_id port command adds a local destination entry into the atpm destination table. A local destination entry is one of the telephony ports on the Elite Gateway.
Syntax description
| dest_id |
Destination ID. Each destination needs to be assigned a unique identifier between 1 and 65536. |
| port# |
The number of the telephony port. | |
Example
The following example shows how to assign ID 1 to the first telephone port on TIM slot A and add an entry in the destination table designating it:
Console>atpm dadd 1 port 0 <Enter> atpm dadd dest_id h323 dest_ip_addr [ip_port]
The atpm dadd dest_id h323 command adds a h323 type remote destination entry into the atpm destination table. A remote destination entry is typically another Elite Gateway or H323 gateway. Syntax description
| dest_id |
Destination ID. Each destination needs to be assigned a unique identifier between 1 and 65536. |
| dest_ip_addr |
The IP address of the remote destination. |
| ip_port |
(Optional) Base port number that the Elite Gateway uses to establish voice with that remote destination. | |
Example
The following example shows how to add a remote destination IP address to the destination table and assign an ID 200 to that destination:
Console>atpm dadd 200 h323 192.168.0.3 <Enter> atpm ddel dest_id
The atpm ddel command deletes an entry from the atpm destination table.
Syntax description
| dest_id |
ID of a previously added destination entry to be deleted from destination table. | | atpm dfind dest_id
The atpm dfind finds and displays an entry in the destination table.
Syntax description
| dest_id |
ID of a previously added destination entry to be displayed. | |
Example
The following example shows how to display a destination whose ID is 200:
Console>atpm dfine 200
Dest id Mode Destination
--------------------------------------------------
200 H.323 Dest = 192.168.0.3/1720 TCP
OK
Console> | | atpm dlist
The atpm dlist displays all entries in the destination table.
Syntax description
This command has no arguments or keywords.
Example
Console>atpm dlist
Dest id Mode Destination
--------------------------------------------------
1 Local PORT = 0
2 Local PORT = 1
3 Local PORT = 2
4 Local PORT = 3
5 Local PORT = 4
6 Local PORT = 5
7 Local PORT = 6
8 Local PORT = 7
11 H.323 Dest = 210.243.230.167/1720 TCP
OK
Console> | | Hunt Group Table Management Commands
atpm hadd hunt_group_id {1|2} dest_id [desi_id2]...
Use the atpm hadd command to add an entry into the atpm hunt group table.
Syntax description
| hunt_group_id |
Hunt group ID. Each hunt group needs to be assigned a unique identifier between 1 and 65536. |
| 1 |
Hunt type 1. Hunt type 1 hunts destination within a hunt group starting from the destination member just after the last used member. |
| 2 |
Hunt type 2. Hunt type 2 hunts destination within a hunt group starting from the first destination member. |
| dest_id1 |
ID of the first destination member in the hunt group. |
dest_id2
dest_id3... |
(Optional) List of IDs of additional destination members in the hunt group. | |
Example
The following example shows how to group destination 1, 2, 3 and 4 into a hunt group, assign it hunt group ID 10, and specify hunt type 2 for this hunt group:
Console>atpm hadd 10 2 1 2 3 4<Enter> atpm hdel hunt_group_id
The atpm hdel command deletes an entry from the atpm hunt group table.
Syntax description
| hunt_group_id |
ID of the hunt group to be deleted from the hunt group table. | | atpm hfind hunt_group_id
The atpm hfind finds and display an entry in the hunt group table.
Syntax description
| hunt_group_id |
ID of the hunt group to be displayed. | | atpm hlist
The atpm hlist displays all entries in the hunt group table.
Syntax description
This command has no arguments or keywords.
Example
Console>atpm hlist
Group id Type #Members Member ids
--------------------------------------------------
1 2 1 1
2 2 1 2
3 2 1 3
4 2 1 4
5 2 1 5
6 2 1 6
7 2 1 7
8 2 1 8
11 2 1 11
OK
Console> | | Address Table Management Commands
atpm aadd tel# min_digits max_digits hunt_group_id prefix_strip_len [prefix#]
Use the atpm aadd command to add an entry into the atpm address table.
Syntax description
| tel# |
Telephone number to match. This is only part of the total dialed string. |
| min_digits |
Minimum number of digits to be collected before the ATPM starts matching the dialed string with entries in the address table. |
| max_digits |
Maximum number of digits to be collected before the ATPM starts matching the dialed string with entries in the address table. |
| hunt_group_id |
Hung group ID for this telephone number. |
| prefix_strip_len |
The number of digits to be stripped at the beginning of the collected dial string before forwarding the string to the destination. |
| prefix# |
(Optional) Digit to be added before the beginning of the collected dial string before forwarding it to the destination. | | atpm adel tel#
The atpm adel command deletes an entry from the atpm address table.
Syntax description
| tel# |
Number of a previously added entry to be deleted from the atpm address table. | | atpm afind tel#
The atpm afind finds and displays an entry in the address table.
Syntax description
| tel# |
Number of a previously added entry in the atpm table to be displayed. | | atpm alist
The atpm alist displays all entries in the address table.
Syntax description
This command has no arguments or keywords.
Example
Console>atpm alist
Address Hunt Min Max Prefix Prefix
Entry Grp_Id Digits Digits strip Address
103 3 0 16 0 None
104 4 0 16 0 None
201 1 1 3 3 None
202 2 1 3 3 None
203 3 1 3 3 None
204 4 1 3 3 None
205 5 1 3 3 None
206 6 1 3 3 None
207 7 1 3 3 None
208 8 1 3 3 None
666 11 3 3 0 None
OK
Console>atpm done
OK
Console> | | System Commands
atpm slist
The atpm slist displays the atpm system table.
Syntax description
This command has no arguments or keywords.
Example
Console>atpm slist
System Info: Total dial time = 30000ms, First digit wait = 10000ms,
Interdigit wait = 5000ms, Dial term digit = None
OK
Console> | | atpm sys dial_time 1st_digit_wait inter_digit_wait [dial_term_digit]
Use the atpm sys command to set the time constraints for collection of dial digits.
Syntax description
| dial_time |
The maximum time, in milliseconds, allowed for entry of the entire string of dial digits. At expiration, ATPM starts address lookup. |
| 1st_digit_wait |
The maximum time, in milliseconds, allowed between off-hook and when the first dial digit is entered. At expiration, ATPM considers address lookup to fail. |
| inter_digit_wait |
The maximum time allowed between entry of each digit after the previous digit. At expiration, ATPM starts address lookup. |
| dial_term_digitr |
(Optional) End of the dial string is declared when the digit is entered. | | atpm dadd dest_id dns host_name[tcp_port]
Use the atpm dadd command to assign call signaling port for DNS type destination.
Syntax description
| dest_id |
Destination ID. Each destination needs to be assigned a unique identifier between 0 and 65536. |
| host_name |
The host name of the remote destination. |
| tcp_port |
The destination TCP port number, which the H.225 Setup request sends to. If not specified, a default value of 1720 is assumed. | | For information on how to connect and use the CLI, see the Using the Command Line Interface document.
This applies to:
| 
