This chapter provides information about the 3000 Series D voice configuration shell, including keyboard controls and functions, available menus, command syntax, and procedures targeted to configuration of specific features. The 3000 Series D voice configuration shell provides a means of configuring a 3000 Series D voice node and obtaining statistics through a set of menus. Each menu contains commands and submenus that pertain to a specific type of interface (for example ISDN), parameters of an interface (for example, signalling protocol), or a particular feature or application (for example, answer supervision). The Voice Menu Set summarizes the functions of each top level menu and lists the menu hierarchy. In addition to its own commands, every menu includes several commands that are common to all menus (see Global Commands).
This chapter contains the following sections:
The Voice Menu Set
Global Commands
Working in the Configuration Shell
Configuring the System
Configuring Accounting and Performance Monitoring
Managing and Updating Kernels
Configuring Interfaces
Quick Configuration
The Voice Menu Set
The top level voice menus are call_control, interfaces, metering, modules, system, and configuration.
To access the voice menu set, connect a PC or terminal to your 3000 Series D as described in chapter 3 of the 3000 Series D User Guide. You can then access the 3000 Series D command line interface using Telnet or a terminal emulation application.
Once you are connected to the command line interface, access the voice menu set as follows:
* prompt, enter config.
*config
Config>
Config> prompt, enter voice.
Config>voice
VOICE Config>
VOICE Config> prompt, enter config.
VOICE Config>config
incoming
outgoing
routing
ani_translation
answer_supervision
tones
call_blocking
The Interfaces Menu
The interfaces menu provides a means of configuring and viewing information about each type of interface on the 3000 Series D. The interfaces menu includes the following submenus:
cas_r2 cas_rbs ethernet e1 t1 ip routes nameservers isdn voip codec_profiles gatekeeper
The Metering Menu
The metering menu allows logging and listing of call detail records. The metering menu includes the following submenus:
cdrs performance
The Modules Menu
The modules menu has no submenus; it provides a means of managing and updating kernels for installed interfaces.
Managing and Updating Kernels provides more information on this menu.
The System Menu
The system menu allows an administrator to control various system parameters such as hostname, contact,
and location. It also provides commands for saving and deleting configurations, controlling access via SNMP to the 3000 Series D, and listing and clearing alarms. The commands in the system menu are hostname, contact, location, date, time, timezone. The system menu has three submenus:
alarms configuration snmp
Working in the Configuration Shell
This section provides instructions for starting and quitting the configuration shell, entering and editing commands, and navigating to menus and commands.
Entering Commands in the Configuration Shell
When the configuration shell is open, the command line prompt displays the host name of 3000 Series D from which the the command shell is being executed and the path from a top level menu to the current menu. The form of the prompt is:
<hostname>] /<menu> <submenu1> <submenu2> <submenu3>
At the prompt, you type commands in either upper case or lower case letters. Although commands appear in lower case letters in this manual, the system is not case sensitive. To execute a command, press the Return key at the end of the command line. When you are working in the configuration shell, try to be aware of the location of the current menu in the overall hierarchy of menus. Once you have entered a menu, you can execute the commands on that menu without specifying the path to the command. By the same rule, you cannot execute commands in a different menu without specifying the path. You can specify either the absolute path from the root directory or the path relative to your current location. Table 2 lists the command used to navigate through the menu hierarchy.1. These commands are instantaneous, no carriage return is required. The general syntax for commands is the following:
[<path>] <command> [<arg1> <arg2> <arg3>]
where <path> specifies the menu in which the command is available. A path takes the following form:[/][<submenu> <submenu2> <submenu3>]
and where the slash (/) specifies that the path starts from the root directory. Otherwise, the path is relative to the current menu. The path can contain as many submenus as required. When the command has executed, the configuration shell displays another prompt unless there is an error or output. If an error occurs or if output is expected (for example, in response to a list command), the configuration shell skips one line, prints either an error or the output, skips a line, displays a command prompt, and waits for user input. Error messages list the severity of the error, an error number and a description of the error. The severity is one of three possible values—info, warning, or error. The description tells what went wrong what the system did about it.
Configuring the System
Saving and Deleting the System Configuration
The 3000 Series D is shipped from the factory with a default system configuration, which is compiled in the code. The default system configuration remains in effect until you have configured the 3000 Series D and saved the configuration changes. After you have saved the configuration, you can delete the saved configuration and revert to the default system configuration.
The system configuration parameters that you configured and saved in the configuration shell (runtime configuration) are stored entirely in the host processor module's flash memory. The host processor module sends the relevant configuration information to the individual modules as needed. The system configuration menu includes two commands that manage the system configuration. Table 4 shows the command syntax, the path, and the action performed.
Setting System Parameters
You can define several system parameters for the 3000 Series D—the IP host name of the host processor module, an emergency contact person,
and the system location.
You can also view the system date, time, and time zone, which are derived from
the router.
The system host name is host processor module's IP host name. This name also appears in the command line prompt in telnet and console sessions, and in call detail records. Within a network, give each 3000 Series D a unique host name. The host name can be up to 64 characters and can include letters, numbers, and dashes (-). The host name can also include periods (.) if it is a fully qualified host name; for example, foo.bar.net as opposed to foo. No other special characters are valid. You can list or change the host name for the 3000 Series D. The system contact is the person to contact in case of a problem. The length of contact information is unrestricted and it can include letters, numbers, spaces, punctuation marks, carriage returns, and other special characters. This allows you to specify a name, company name, telephone number, email address, and other relevant information. The system location specifies the geographical or physical location of the 3000 Series D. The length of this information is unrestricted and it can include letters, numbers, spaces, and special characters. This might be an office, a city, an equipment rack and shelf number, or any other useful designation.The system date is in the format mm/dd/yyyy (2-digit month/2-digit day/4-digit year). The system time is in the format HH:MM:SS (2-digit hour:2-digit minutes:2-digit seconds) and uses military notation (the 24-hour clock) in Greenwich Mean Time (GMT). The system time zone is set in relation to GMT. Possible values and their associated locations are listed in the following table.
Table 6 shows the command syntax, the path, and the action performed for the commands that specify system parameters.
Configuring SNMP Access
You can enable and disable SNMP access to the 3000 Series D. SNMP access is either enabled or disabled, and the default setting is disabled.
When SNMP access is disabled, the 3000 Series D SNMP Agent will deny all SNMP requests. When SNMP access is enabled, the Agent will respond to SNMP requests.
Table 7 shows the command syntax, the path, and the action performed for the commands that manage SNMP access.
Configuring the SNMP Agent
The 3000 Series D's SNMP Agent is an application on the 3000 Series D that allows third-party SNMP managers to monitor the 3000 Series D using the Simple Network Management Protocol (SNMP).
The SNMP Agent on the 3000 Series D monitors status information, and places the information in a management information base (MIB). When the SNMP Agent detects status updates, it sends updates to the SNMP manager`s IP address. In accordance with SNMP standards, the SNMP Agent sends its traps to the well-known port 162 on the third-party SNMP manager. The 3000 Series D supports a subset of the MIB-II RFC 2233 generic interface MIB.
The third-party SNMP manager is an application, located on a foreign node, that polls the 3000 Series D for its status. The third-party SNMP manager connects to the 3000 Series D using internet protocol (IP). Regardless of how often the SNMP Agent sends a trap, the third-party SNMP manager can initiate an SNMP request to the SNMP Agent at any time to solicit status information.
SNMP is an application-level protocol that uses a connectionless transport protocol called User Datagram Protocol (UDP) to carry information to the third-party node. UDP is transported via IP. The IP datagram from the 3000 Series D traverses one or more links to the third-party SNMP manager.
SNMP is essentially a request-and-respond protocol. The third-party SNMP manager polls the 3000 Series D for information by sending SNMP requests to the 3000 Series D's IP address, and the 3000 Series D sends back the requested information via SNMP responses and SNMP traps. When the third-party SNMP manager wants a status update on a 3000 Series D node, it places an SNMP request for a status update from the SNMP Agent. The SNMP Agent draws the status information from its MIB and sends it to the third-party SNMP manager.
Figure 2-5 illustrates how an SNMP Agent works with the third-party SNMP manager to provide status information on Nx
Networks devices.
Configuring Faults and Alarms
The 3000 Series D keeps a log in buffer memory of system alarms and faults, which can be used for system diagnostics and debugging. Alarms represent conditions that affect the system as a whole. For example, if one of the T1 lines goes dead, or is unplugged; or if a power-supply dies; or if the system is over-loaded.
Alarms are numbered as they occur, abeginning at 001 and ending with 999. At that point new alarms start at 001 again. The system stores approximately 300 alarms. When alarm storage space reaches capacity, the system purges the oldest alarm record to allow space for the new record. Old alarms scroll off the beginning of the queue one by one as new alarms arrive at the end of the queue. Each alarm contains five fields of information, which are listed in
Table 9.
Using the commands in the system alarms menu, you can list all alarms, one specific alarm, a closed range of alarms, or an open range of alarms. You can also clear the alarm log.
Table 10 shows the command syntax, the path, and the action performed for the commands that manage system alarms and faults.
| Command Syntax | |
|---|---|
| Path | Action |
| list <range> | |
| system alarms | The system lists the specified range of the alarm log. Table 9 shows the type of information in the alarm log. For the range parameter, you can specify all alarms (all), a single alarm number (for example, 80), a closed range of alarm numbers (for example, 80-90), or an open range or alarm numbers (for example, 80-). |
| list | |
| system alarms | The system lists all alarms in the alarm log. . |
| clear | |
| system alarms | The system clears the alarm log. |
Configuring Accounting and Performance Monitoring
The 3000 Series D can log call detail records and monitor performance using commands in the metering/cdr menu and the metering/performance menu.
Call detail records supply detailed statistical information about calls from and to ports on the 3000 Series D. When you activate CDR monitoring, all CDRs are logged directly to the console as calls are completed. The 3000 Series D continues to log CDRs until you press the Return key.
Table 11 shows the type of information in a call detail record. By feeding the call detail records into a database and report generator, you can generate reports to suit a particular purpose.
Table 12 shows the command syntax, the path, and the action performed for the commands that manage call detail records.
Managing and Updating Kernels
The 3000 Series D can list kernel versions and the status of the installed modules.
Configuring Interfaces
The 3000 Series D supports T1, E1, Ethernet, ISDN PRI, CAS_R2, CAS_RBS, IP, and VoIP interfaces. The 3000 Series D automatically detects Ethernet, T1, and E1 interfaces and starts them in the down state until you configure and enable them. You must create all other interfaces using the commands and submenus available in the interfaces menu. When the 3000 Series D detects an interface or when you add an interface to the system, the 3000 Series D creates and assigns a unique name to the interface.
The assigned name for an interface is based on the interface type, the module number with which the physical interface or lower layer interface is associated, and the hardware port within the associated module. The interface name is of the following form:
<nn>.<XX>.<YY>
where <nn> is the interface type, <XX> is the lower layer interface hardware module number, and<YY> is the port number for the hardware module. Here are a few examples:| t1.1.1 | A T1 interface on module 4, port 1 |
| eth.1.1 | Ethernet interface 1 on module 2 |
| ip.1.1 | IP interface 1 on module 2 |
| voip.1.1 | Voice over IP interface 1 on module 2 |
All interfaces share a set of general properties which are summarized in Table 13. In addition to these properties, interfaces over which calls can be placed (VoIP, ISDN, CAS_R2, and CAS_RBS) share a property called answer_supersision. This property is either configured with a valid answer supervision profile or disabled.
The commands and submenus available in the interfaces menu provide the means to create and configure interfaces. This menu has a submenu for each type of interface as well as several commands that allow you to obtain detailed information about configured interfaces and their properties, and to start and stop interfaces. The commands in the interfaces menu are also available in the submenu for each type of interface.
Obtaining Information About Interfaces
To display status and configuration information for a specified interface or for all interfaces, use the list command in the interfaces menu or in any of the interfaces submenus. The listing includes administrative status and operational status. The administrative status corresponds to the current operational state into which the administrator has placed the interface; that is, the up state or down state. The operational status is the actual current state of the interface.
Figure 9 is an example of an interface listing.
Figure 9 Sample Interface Listing
To display the value of a specific property or of all properties, for a specified type of interface or all interfaces, use the show command in the interfaces menu or in any of the interface submenus.
Table 14 shows the command syntax, the path, and the action performed for the commands that display configuration and status information.
Starting and Stopping Interfaces
You can start or stop an interface, all of a type of interface, or all interfaces in the node using commands in the interfaces menu or in any of the interfaces submenus.
After the initial configuration of interfaces on a 3000 Series D, you need to start the interfaces. You also need to restart any interface that you have added or have stopped. Issuing the start command, starts the specified interfaces and all required parent interfaces, beginning with the parent.
When you wish to change the configuration of an interface, you need to stop the interface first. When you issue the stop command, you specify the interface and a stop method. You can specify an immediate stop, which drops all current calls, or you can drain the interface before stopping. Note:
This release does not support the drain method. If you specify a stop method of drain, an error message will inform you that this stop method is not yet supported.
| Command Syntax | |
|---|---|
| Path | Action |
| start <ifpattern> | |
interfacesand all interface submenus
| The system starts all interfaces or a specified type of interface. Table 14 describes the possible values of <ifpattern>. |
| stop <ifpattern> <method> | |
interfacesand all interface submenus
| The system immediately stops all interfaces or a specified type of interface using the specified stop method (now or drain). Table 14 describes the possible values of <ifpattern>. |
Adding and Removing a Virtual Interface
You can add a virtual interface on top of a physical T1, E1, or Ethernet and a virtual IP interface using the add command in the appropriate interface submenu. The virtual interface is sometimes called a child interface and the physical interface is called a parent interface.
A physical T1 or E1 interface can be a parent interface for a virtual ISDN, CAS_R2, and a T1 interface can be a parent for a CAS_RBS interface. A physical Ethernet interface can be a parent interface for a virtual IP interface, which in turn can be a parent for a virtual VoIP interface.
Use the remove command in the appropriate interface submenu to remove a virtual ISDN, CAS_R2, CAS_RBS, IP, or VoIP interface. You cannot remove a physical interface since it is automatically configured; however, you can stop it.
Table 16 shows the command syntax, the path, and the action performed for the commands that add and remove virtual interfaces.
Setting Property Values on an Interface
Each type of interface has a different set of properties that you can configure, but the command for configuring property values is the same for all interfaces—the set or reset command, which is available in all interface submenus.
To set a property (one property at a time) to a specified value, use the set command. To set a specified property to the default value, use the reset command. Table 17 shows the command syntax, the path, and the action performed for the commands that set property values on interfaces.
| Command Syntax | |
|---|---|
| Path | Action |
| set <ifpattern> <property name> <property value> | |
t1, e1, eth, ip, voip, isdn, cas_r2, and cas_rbs menus
| The system sets the specified property on the interface to the specified value. Table 14 describes the possible values of <ifpattern>. Property values are described in the sections on individual interfaces. |
| reset <ifpattern> <property name> | |
t1, e1, eth, ip, voip, isdn, cas_r2, and cas_rbs menus
| The system resets the specified property on the specified interface to its default value. |
Configuring T1 and E1 Interfaces
The 3000 Series D can connect to T1 and E1 lines from the telephone company or to T1 and E1 lines fed directly to PBX or other such devices. For a line from the telephone company, the telephone company provides information on configuration parameters. For a line to a PBX, the system administrator chooses parameters that are acceptable to the particular PBX.
T1 and E1 interfaces are physical interfaces, and therefore are created automatically by the 3000 Series D. The interfaces are numbered based on the port (for example, t1.1.1 is the T1 interface on port 1. Immediately after the 3000 Series D initializes, all interfaces have an administrative status of down (because you have not yet started them) and an operational status of down.
To activate physical T1 and E1 interfaces, you need to:
Configure the physical parameters for the interface as described in Setting Physical T1 or E1 Parameters.
Add a virtual ISDN, CAS_R2, or CAS_RBS (T1 only) interface as described in Adding and Removing a Virtual Interface.
Configure the virtual interface as described in Configuring an ISDN PRI Interface, Configuring a CAS_R2 Interface, or Configuring a CAS-RBS Interface.
Start the child interface as described in Starting and Stopping Interfaces.
set t1.1.1 line_length lb1
Configuring an ISDN PRI Interface
The ISDN PRI interface is a virtual interface that is layered on a physical T1 or E1 interface. Before configuring the interface, you must add the interface to a T1 or E1 physical interface, as described in
Adding and Removing a Virtual Interface. When you have configured the interface, be sure to start it as described in Starting and Stopping Interfaces.
The only property that you need to configure for an ISDN PRI interface is the signaling protocol. In future releases, the D-channel will also be configurable. To configure a property, execute the set command in the interfaces isdn menu, specifying the property name and value. Table 19 lists the properties and their possible values.
set isdn.1.1 signaling_protocol ni2_nt
Configuring a CAS_R2 Interface
The CAS_R2 interface, which provides R2MFC support, is a virtual interface that is layered on a physical T1 or E1 interface. Before configuring the interface, you must add the interface to a T1 or E1 physical interface, as described in
Adding and Removing a Virtual Interface. When you have configured the interface, be sure to start it as described in Starting and Stopping Interfaces.
Properties of a CAS_R2 are based on default values or, in some cases, values that you can specify. To configure a property, execute the set command in the interfaces cas_r2 menu, specifying the property name and value. Table 20 lists the properties and their possible values.
Note: Currently R2 support is for compelled, mf, digital only.
For example, to set the number of DNIS digits to expect on a CAS_R2 interface on t1.1.2 to 15, enter the following command in the interfaces cas_r2 menu of the configuration shell:
Configuring a CAS-RBS Interface
The CAS_RBS interface, which supports robbed bit signaling, is a virtual interface that is layered on a physical T1 interface. Before configuring the interface, you must add the interface to a T1 physical interface, as described in
Adding and Removing a Virtual Interface. When you have configured the interface, be sure to start it as described in Starting and Stopping Interfaces.
Properties of a CAS_RBS interface are based on default values or, in some cases, values that you can specify. To configure a property, execute the set command in the interfaces cas_rbs menu, specifying the property name and value. Table 21 lists the properties and their possible values.
For example, to set the number of milliseconds of silence between digits on a CAS_RBS interface on t1.1.2 to 100, enter the following command in the interfaces cas_rbs menu of the configuration shell:
set cas_rbs.1.2 interdigit_time 100
Configuring Ethernet Interfaces
The 3000 Series D can connect to a local area network (LAN) or wide area network (WAN) via Ethernet lines. Ethernet is a physical interface, and is therefore created automatically by the 3000 Series D.
You cannot configure an Ethernet interface using the set command; however, the set command can display the MAC address of an IP interface (see
Displaying the MAC address for an Ethernet Interface).
To activate the physical Ethernet interfaces, you need to:
Add a virtual IP interface and a voice over IP interface as described in Adding and Removing a Virtual Interface.
Configure the IP address and domain name as described in Configuring the IP Address and Domain Name on an IP Interface.
If calls from this IP interface will go through an external router to other IP networks, configure the main gateway and static routes as described in Configuring Gateways and Static IP Routes on an IP Interface.
If you wish, set up a nameserver for IP interfaces as described in Configuring a Nameserver for an IP Interface.
Configure the voice over IP interface as described in Configuring a Voice over IP Interface.
Start the voice over IP interface as described in Starting and Stopping Interfaces.
To configure a property, execute the set command in the interfaces ip menu or one of its submenus, specifying the property name and value. Table 22 lists the properties and their possible values.
set ip.1.1 domain_name hq.nxetworks.com
Configuring Gateways and Static IP Routes on an IP Interface
If calls on this IP interface will traverse a router to reach other nodes via the Internet, you must configure at least one gateway for the IP interface. Once a gateway is configured, you can set the default gateway for calls from a specific IP interface or from all IP interfaces on the node.
You can also assign a default gateway for a specific destination when called from a specified interface; this is called a static IP route. You can add up to 50 IP routes to an IP interface, remove static routes, and list static routes. The commands in the interfaces ip routes menu provide the means to configure the static routes and gateways. Note:
A static IP route is not the same thing as a static route configured in the call_control routing menu.
/interfaces ip routes set_default * 192.168.44.1
If you wish to assign different default gateways for specific IP interfaces, use the set_default command with the <ifpattern> and <gateway> parameters. By creating a static IP route, you can assign all IP traffic that is destined for a specific address or range of addresses to go through a different gateway than the configured default gateway. To create a static IP route, execute the add command with the <ifpattern>, <destination>, and <gateway> parameters. For example, if you want all traffic through ip.1.3 for hosts on a network named 192.168.45.0 to go through a gateway named 192.168.44.42, enter this command:/interfaces ip routes add ip.1.3 192.168.45.0 192.168.44.42
The remove command allows you to delete a static route that you've configured on an IP interface. To configure a property, execute the set command in the interfaces ip routes menu, specifying the property name and value. Table 23 lists the commands, their syntax, and the action performed.
Configuring a Nameserver for an IP Interface
The 3000 Series D supports definition of up to three nameservers using the commands in the interfaces ip nameservers menu.
The Domain Name System in an IP network is managed by nameservers, which translate domain names (for example hq.nxnetworks.com) for individual host systems to IP addresses. You can create a nameserver and add a nameserver to an IP interface or a group of IP interfaces. This allows you to use host names in place of IP addresses in some contexts.
To add a nameserver to an IP interface, execute the add command in the ip nameserver menu. For example, to add a nameserver with the address 192.165.44.170 to all IP interfaces, use this command:
interfaces ip nameserver add * 192.165.44.170
You can also list the nameservers for a specific interface or for all interfaces, and remove the nameserver for a specified interface by using commands in the interface ip nameserver menu. Table 23 lists the commands, their syntax, and the action performed.
Configuring a Voice over IP Interface
The Voice over IP interface is a virtual interface that is layered on a virtual IP interface. You add the interface to a virtual IP interface, as described in
Adding and Removing a Virtual Interface.
To configure a Voice over IP interface, you specify the IP address to register with an H.323 gatekeeper and other parameters related to the gatekeeper, Q.931 response and connection times, H.323 channel characteristics, whether answer supervision will be enabled, and a receive codec profile for the interface. All of these parameters are available in the set command in the interfaces ip voip menu. Configuring Call Routing describes this procedure.
If you wish to specify a customized set of codec configurations to be used during the negotiation phase of a VoIP call, you need to create a codec profile in the interfaces ip voip codec menu.
If you wish to register H.323 alias addresses and prefixes with a gatekeeper in the system, you need to create a list of associated aliases and a list of supported prefixes.
Configuring Call Routing
The Call Routing Table
The Call Routing Table consists of several static Call Routes. Each Call Route maps a phone number pattern to an interface gateway. The 3000 Series D performs multi-protocol signaling conversion to allow interoperability between all supported telephony protocols (ISDN
PRI and VoIP).
The call routing table allows call blocking based on ANI information. Configuring the call routing table involves adding entries of the form:
FQNP -> [Interface] [Gateway Address].
/interfaces list
A listing displays the installed interfaces, their administrative status, and operational status in table form as shown below:
Interface Admin Status Operational Status
---------------------- ------------ ------------------
t1.1.1 Down Dormant
eth.0.1 Down Dormant
Note: T1, E1, Ethernet, IP, and VoIP interfaces appear in the down state until you assign IP addresses to their IP interfaces.
/interfaces isdn add t1.1.1
/interfaces isdn set isdn.1.1 signaling ess4-cp
/interfaces isdn start *
/interfaces ip add eth.1.1 <IP addr> <netmask> <domain name>
/interfaces ip start *
/interfaces voip add ip.1.1
/interfaces voip codec_profiles new_profile basic
/interfaces voip codec_profiles new_config config1 g729a no 30 60
/interfaces voip codec_profiles new_config config2 g723.1_6.3k no 30 60
/interfaces voip codec_profiles insert_config basic config1 1
/interfaces voip codec_profiles insert_config basic config2 2
/interfaces voip set * receive_codec_profile basic
/interfaces voip start *
/call_control incoming add isdn.1.1 xxxxx isdn-xxxxx
Note: Inbound/Outbound Translation Table provides additional information about the translation tables.
/call_control routing add voip-xxxxx isdn.1.1
/call_control routing add isdn-xxxxx voip.1.1
/call_control routing set isdn-xxxxx codec_profile basic
Note: The Call Routing Table provides detailed information on call routing.
/call_control outgoing add isdn.1.1 voip-xxxxx xxxxx
/call_control outgoing add voip.1.1 isdn-xxxxx xxxxx