You are here: CSP Developer’s Guide: Internet Protocols > 3 IP Network Interface Series 2 Card > Startup Sequence/Basic Configuration
Startup Sequence/Basic Configuration
Overview
This section describes the startup sequence and basic configuration of the IP Network Interface Series 2 card. This card requires basic card configuration virtually identical to that of a VDAC-ONE card with two VoIP modules. The only additional steps are to first put the IP Network Interface Series 2 into the Normal Mode and adjust for the increase in channel density.
When a IP Network Interface Series 2 card is powered up, the card performs a "cold start" which requires the IP Network Interface Series 2 card to be completely reconfigured.
Important! The IP Network Interface Series 2 card system software running on the main circuit board and VoIP modules are stored in volatile memory and not maintained through power loss.
The exceptions are the IP network settings assigned to the main circuit board and VoIP modules. The network settings are stored in non-volatile flash memory and maintained through power loss.
When first applying power to the IP Network Interface Series 2 card, the following sequence occurs:
• The resident ROM code performs Power On Self Tests (POST) and requests a main circuit board image from the Matrix Controller Series 3 card.
• The Matrix Controller Series 3 card validates the board ID and retrieves the main circuit board image from either its local or remote store.
• Upon completing the image transfer, the ROM code validates the image and starts executing the system software.
• The system software proceeds through its startup logic which does the following:
• Clears the configuration data and initializes software services
• Confirms connection to I/O
• Establishes Ethernet connections
• Detects VoIP modules
• Downloads the software image that will run on the detected VoIP modules from the Matrix Controller Series 3 card based on the default IP resource profile assigned.
• Validates the VoIP module image and transfers it to each VoIP module. Each DSP processor on the VoIP module runs its internal diagnostics and notifies the main circuit board when the initialization is complete.
• After the main circuit board and VoIP modules complete their initialization sequences, a minimum set of diagnostics is run to verify that the IP Network Interface Series 2 card is operating correctly.
• The IP Network Interface Series 2 card signals to the Matrix Controller Series 3 card that it is ready and provides its card status information.
• The IP Network Interface Series 2 card starts up in the Gateway Mode, which indicates the Time Division Multiplexing (TDM) resources on the chassis midplane are not allocated.
• The Matrix Controller Series 3 card, upon receipt of the card status information, generates a Card Status Report message to the host, signaling that the IP Network Interface Series 2 card is in service and ready to be configured.
• Until a Card Status Report message is generated, communication between the host and IP Network Interface Series 2 card is not allowed.
Important Card Status Report Information
The Card Status Report (0x00A6) message provides the following information specific to the IP Network Interface Series 2 card.
Table 3-2 Card Status Report Information
Fields |
Description |
Card Type |
Identified with Card ID 0x65 |
Card Status |
It is important that the IP Network Interface Series 2 card contains the following card status: |
Card Information |
The card information contains current span assignments just like all line cards. |
Hardware Configuration |
Similar to VDAC-ONE card. The only difference is that the resource profile assigned to each module is provided. |
Example of Card Status Report Message
00 71 00 a6 00 0c ff ' Message Header
00 00 ' Status
00 01 01 01 03 ' Slot AIB
65 ' Card Type (IP Network Interface Series 2)
11 ' Card Status (Cold Start)
00 ' Confidence Test Results
58 05 ' PC Artwork and Function Revision (X05)
05 00 ' ROM Major.Minor Revision (5.0)
08 02 ' RAM Major.Minor Revision (8.2)
19 48 ' Serial Number (6472)
00 40 ' Ram Size (64 Megs)
' CARD INFORMATION
00 10 ' Number of spans (16)
0c 02 ff ff 0c 02 ff ff 0c 02 ff ff 0c 02 ff ff
0c 02 ff ff 0c 02 ff ff 0c 02 ff ff 0c 02 ff ff
0c 02 ff ff 0c 02 ff ff 0c 02 ff ff 0c 02 ff ff
0c 02 ff ff 0c 02 ff ff 0c 02 ff ff 0c 02 ff ff
' HARDWARE CONFIGURATION
02 ' Number of Modules
02 00 ' Number of Channels
03 ' Installed Module Bitmap
05 05 02 ' Module State
02 02 0f ' Assigned Resource Profile
01 ' Normal Mode
00 00 00 00 00 ' reserved
65 ' Board ID
0a ' Build #10
00 00 ' tag
08 ' cpu speed (200Mhz)
00 ' reset reason
IP Network Interface
Series 2 Card Configuration Data
Configuration data on the IP Network Interface Series 2 card is categorized by the following three types:
Type 1 – Non-volatile Configuration Data
Type 1 configuration data is stored in non-volatile flash memory. Once configured, Type 1 data is maintained through power loss.
Important! It is recommended that all Type 1 data be configured before configuring Type 2 and Type 3 configuration data.
The following configuration data is defined as Type 1 on the IP Network Interface Series 2 card:
The IP Network Interface Series 2 card’s main circuit board and VoIP modules all interface with the Ethernet network using Internet Protocol (IP). The IP Network Interface Series 2 card will not be operational until these network settings are configured. Note the following:
• Changing the main circuit board’s IP network setting causes the IP Network Interface Series 2 card to reset.
• Changing the VoIP module’s IP network settings cause only the impacted VoIP module(s) to reset.
Important! Type 1 configuration data is maintained through a cold start. The host reset of configuration data does NOT reset Type 1 configuration data.
• Changing Type 1 configuration data does not affect Type 2 and Type 3 configuration data.
• Changing Type 1 configuration data causes the Configuration Tag to be cleared.
Type 2 – Configuration Data Impacting TDM Resource Allocation
Typically, a line card requires a fixed number of TDM resources. For example, there are 8-span and 16-span T-ONE and E-ONE line cards. A single T-ONE line card cannot be configured both as an 8-span and 16-span line card.
The IP Network Interface Series 2 card is different in that, based on the host configuration, the required number of TDM resources changes. For example, assigning VoIP Resource Profile 2 to the VoIP modules configures the IP Network Interface Series 2 card as a 16 span line card. Assigning VoIP Resource Profile 1 to the VoIP modules configures the IP Network Interface Series 2 card as a 32-span line card. Because of this and the ability to support more profiles in the future, the IP Network Interface Series 2 card cold starts in Gateway Mode. This allows the host to assign the appropriate VoIP Resource Profiles to the VoIP modules before taking up TDM timeslots allocated for other line cards.
The following configuration data is defined as Type 2 on the IP Network Interface Series 2 card:
The IP Network Interface Series 2 card can be configured to either consume physical TDM timeslots or consume extended timeslots. Extended timeslots do not consume any of the chassis physical timeslots, but allow the IP Network Interface Series 2 to come in service. This mode is called Gateway Mode. The IP Network Interface Series 2 card defaults to Gateway Mode. Refer to Gateway Mode.
Both VoIP modules on the IP Network Interface Series 2 card are assigned the same VoIP Resource Profile, which defines the terminal capabilities of the module and the number of VoIP channels supported. The IP Network Interface Series 2 VoIP module defaults to VoIP Resource Profile 2, requiring 512 TDM timeslot resources.
Note the following:
• Changing any Type 2 configuration data causes the IP Network Interface Series 2 card to reset and clear all Type 3 configuration data, including the configuration tag.
• Type 2 configuration data is maintained through a push button reset (warm boot), but not a power up reset (cold boot).
The following conditions cause Type 2 configuration data to be reset:
• Host reset of configuration data using Reset Configuration (0x000B) message.
• Taking the card OOS using Service State Configure (0x000A) message.
• Pressing the Stop button on the IP Network Interface Series 2 card front panel.
Type 3 – Configuration Data Not Impacting TDM Resource Allocation
Type 3 configuration data is what is traditionally considered "battery backed" configuration data. The reset of Type 3 configuration data results in the "invalid battery-backed configuration data" bit to be set in the Card Status field of a Card Status Report/Query message.
The following configuration data is defined as Type 3 on IP Network Interface Series 2 card:
A VoIP module’s terminal capability consists of a set of VoIP Resource Attributes, of which most of them the host can configure default values. See detailed Resource Profile Terminal Capabilities in this chapter for default values.
Logical Span ID Assignments
All VoIP channels are divided into 32-channel spans. The host can assign Logical Span IDs to each VoIP span.
Once Logical Span IDs are assigned, the host can configure each span’s service state. The service state of each span can be changed between Out of Service (OOS) and In Service (INS).
Once spans are brought in service, the host can configure each channel’s service state. The service state of each channel can be changed between Out of Service (OOS) and In Service (INS).
Note the following:
• Changing Type 3 configuration data causes the Configuration Tag to be cleared.
• Type 3 configuration data is maintained through a push button reset (warm boot), but not a power up reset (cold boot).
The following conditions causes Type 3 configuration data to be reset:
• Host reset of configuration data using Reset Configuration (0x000B) message.
• Taking the card OOS using Service State Configure (0x000A) message.
• Pressing the Stop button on the IP Network Interface Series 2 front panel.
• Change in Type 2 configuration.
Important! Configuration of Type 2 data MUST be completed prior to configuration of Type 3 data.
Once the IP Network Interface Series 2 card is in service, it is ready to be configured. Follow the steps below to configure the card. The messages involved appear in parenthesis. Refer to the API Reference for additional information on the messages and TLVs mentioned.
1. Configure IP addresses, subnet masks, and gateway IP addresses (IP Address Configure (0x00E7).
• On a fully-populated IP Network Interface Series 2 card (with two VoIP modules) you assign three IP addresses/subnet masks (one to the main circuit board and one to each of the VoIP modules). See your IT/network administrator to ensure that you use the correct values for your network configuration.
2. Assign VoIP Resource Profiles and configure Gateway Mode (Resource Attribute Configure (0x00E3)
Important! Before any configuration can be performed, the host must first place the IP Network Interface Series 2 card into the Gateway Mode.
3. Configure Default VoIP - Resource Attribute Configure (0x00E3)
4. Assign Logical Span IDs - Assign Logical Span ID (0x00A8)
5. Bring spans in service - Service State Configure (0x000A)
6. Bring channels in service - Service State Configure (0x000A)
Configuring IP Address and Subnet Mask
The IP address is 32 bits. IP addresses and subnet masks can be assigned using the IP Address Configure (0x00E7) message.
If the host sends an IP Address Configure (0x00E7) message with an IP address and subnet mask that differ from the values stored in the Electronic Erasable Programmable Read Only Memory (EEPROM), the new values will overwrite the stored values.
If the host assigns the same IP address and subnet mask, the message is acknowledged and the card does not need to be reset, so the host can send the IP Address Configure message whenever it is necessary.
For the new IP address and subnet mask to take effect, you must reboot the card. You can perform this step by including the Engage IP TLV in the IP Address Configure message.
The subnet masks default to the values shown in the following table.
Table 3-3 Default Values
Class |
IP Address |
Subnet Mask |
A |
1.0.0.0 - 127.0.0.0 |
0xFF000000 |
B |
128.0.0.0 - 191.0.0.0 |
0xFFFF0000 |
C |
192.0.0.0 - 254.0.0.0 |
0xFFFFFF00 |
Assigning Dynamic IP Addresses
You can dynamically assign an IP address to a VoIP module without affecting the other modules on the IP Network Interface Series 2 card. You configure the IP address on a module by using the IP Address Configure message, with the IP Address/Subnet Mask TLV (0x0001).
To implement the new IP address at a later time, omit the Engage IP or Reset IP TLV and then send them separately when you want to reconfigure.
When IP addresses are re-assigned, the TCP/IP stack must be re-initialized. To properly re-initialize the stack, you must reboot the board or module using one of the following TLVs in the IP Address Configure message:
• Engage IP TLV (0x0002)
• Reset IP TLV (0x0003)
You can assign Gateway IP addresses to the IP Network Interface Series 2 card, the VoIP modules, or both. Use the IP Address Configure message to assign a Gateway IP address by using the Gateway IP (0x0005) TLV in the IP Address Configure message.
Example IP Address Configure (0x0005) message:
00 36 00 e7 00 00 ff ' Message Header
00 01 01 01 03 ' Slot AIB
00 05 ' Number of TLVs
01 09 FF 0a 0a 19 1E ff ff ff 00 ' Main Board IP/Subnet
01 09 00 0a 0a 19 1f ff ff ff 00 ' VoIP Module 0 IP/Subnet
01 09 01 0a 0a 19 20 ff ff ff 00 ' VoIP Module 1 IP/Subnet
05 05 05 0a 0a 19 01 ' Gateway Address - All
02 00 ' Engage
Assign IP Resource Profile and Configure Gateway Mode
Each VoIP module on the IP Network Interface Series 2 card defaults with the VoIP Resource Profile 2 assigned. Profile 2 is the most similar to the VDAC-ONE card in terms of terminal capabilities. Since each VoIP module supports multiple VoIP Resource Profiles, the IP Network Interface Series 2 card defaults to Gateway Mode. This allows the host to configure each VoIP module's resource profile before requesting physical TDM timeslot resource from the Matrix Controller Series 3 card.
Once the host decides which VoIP Resource Profile to assign to both VoIP modules, a single Resource Attribute Configure (0x00E3) message can be sent to assign the VoIP Resource Profile and the Gateway Mode. The IP Network Interface Series 2 card resets and the Matrix Controller Series 3 card allocates physical TDM timeslots.
Important! When sending down the Resource Attribute Configure message, the Address Element TLV (0x0009) must NOT be included in the TLV list. Leaving the Address Element TLV out of the TLV list indicates that the Resource Attributes be addressed to the IP Network Interface Series 2 card itself rather than to a VoIP module or
span/channel.
Example Resource Attribute Configure (0x00E3) message
00 18 00 e3 00 00 ff ' Message Header
00 01 01 01 03 ' Slot AIB
00 02 ' Number of TLVs
01 d0 00 01 02 ' Gateway Mode TLV - 0x01 Gateway, 0x02 Normal
01 e5 00 03 ff 02 00 ' VoIP Resource Profile TLV - Assign Profile 2 to all modules
Configure Default VoIP Resource Attributes
Once the configuration of the Type 2 data is complete, Type 3 data can start being configured. There are a number of VoIP Resource Attributes associated with each VoIP module in which the host can change their default values. Refer to each resource profile's detailed terminal capabilities later in this chapter. When VoIP connections are established using the Route Control (0x00E8) or Outseize Control (0x002C) messages, the host can specify values for each VoIP Attribute. For all attributes not specified in the Route Control message, the configured default values are used.
The default VoIP Resource Attributes on a VoIP module can be configured using the Resource Attribute Configure (0x00E3) message. Addressing the VoIP Resource Attributes to a specific module is done by including the Address Element TLV in the list of VoIP Attribute TLVs. The Address Element TLV is actually an AIB embedded into a TLV. The IP Address (0x3E) AIB is used to specify which VoIP module default attributes are to be updated.
Example Resource Attribute Configure (0x00E3) message
00 25 00 e3 00 00 ff ' Message Header
00 01 01 01 03 ' Slot AIB
00 04 ' Number of TLVs
00 09 00 06 3e 04 0a 0a 19 1F ' IP Address Element Block
01 03 00 01 00 ' Disable Echo Cancellation
01 c5 00 01 02 ' Enable FAX Bypass
01 c7 00 01 05 ' Bypass Coder - G.726@40kbps
There are no physical spans on a IP Network Interface Series 2 card. Instead, each module has a pooled resource of VoIP channels (the number of resources available is dependent on the resource profile assigned). A VoIP channel can dynamically bind to any TDM timeslot on the chassis and any remote RTP destination on the network. In order for the IP Network Interface Series 2 card to connect to a TDM timeslot, Logical Span IDs have to be assigned. The host can assign Logical Span IDs to cover all of the VoIP channels. To ease resource management, the channel densities of all VoIP modules, regardless of the resource profiles, are multiples of 32 channels.
For the default VoIP Resource Profile 2, a maximum of 16 logical span IDs can be assigned to the IP Network Interface Series 2 card. This is achieved using the Assign Logical Span (0x00A8) message.
Example Assign Logical Span (0x00A8) message
00 0d 00 a8 00 00 ff ' Message Header
00 01 11 04 ' Logical/Physical Span
00 A8 ' Logical Span ID
03 ' IP Network Interface Series 2 Slot
00 ' Physical Span 0
Once the logical span IDs have been configured, the spans need to be brought in service before they are integrated into the system to be used by call control. Bringing a IP Network Interface Series 2 card span in service is no different than bringing a span on any other line card in service. This is done using the Service State Configure (0x000A) message.
Example Service State Configure (0x000A) message.
00 0c 00 0a 00 00 ff ' Message Header
00 01 0c 02 ' Logical Span AIB (0x0c)
00 a8 ' Logical Span ID
f0 ' Action - Bring In Service
Each IP Network Interface Series 2 card logical span consists of 32 VoIP channels. Once the logical spans are in service, the channels can be brought in service. Bringing the channels in service completes the basic configuration of the IP Network Interface Series 2 card. The host can now use these VoIP channels using call control.
Bringing the channels in service is very similar to bringing spans in service. The Service State Configure (0x000A) message is used. The one difference is that all 32 channels can be brought in service at one time.
Example Service State Configure (0x000A) message.
00 13 00 0a 00 00 ff ' Message Header
01 02 ' Range of Channels AIB (0x0d)
0d 03 00 a8 00 ' Originating Channel (span 0xa8, channel 0)
0d 03 00 a8 1f ' Terminating Channel (span 0xa8, channel 31)
f0 ' Action - Bring In Service
Flexible RTCP and T.38 Port Selection
You can choose any port number for RTCP and T.38 connections. By using the RTCP or T.38 port TLVs, the host explicitly specifies port values at one of the following three points:
• Before the call is connected (with the Resource Attribute Configure (0x00E3) message and the IP Address AIB)
• During call setup (with the Route Control (0x00E8) and Outseize Control (0x002C) messages)
• During an active call (with the Resource Attribute Configure (0x00E3) message and the Span/Channel AIB)
This flexible port selection scheme reduces or eliminates interoperability issues with other gateways and IP-enabled switches. It also aligns with the requirements set forth by the ITU-T H.323 Annex D standards, as well as other protocols such as SIP.
The IP Network Interface Series 2 card does not automatically select the T.38 ports. Instead, the host must select the source and destination T.38 ports. The IP Network Interface Series 2 card is aware of a fax whenever the Fax Relay mode is enabled. The IP Network Interface Series 2 card detects the CED tone from the PSTN or T.38 packets from an IP network. The card then alerts the host with a PPL Event of a Fax Start. The channel then transitions from voice to fax mode and starts generating only T.38 packets. At this point, the host must select the T.38 port as quickly as possible. Otherwise, the IP Network Interface Series 2 card discards any T.38 packets. The fax machines at each endpoint will then stop because an appropriate response has not been received, and the fax transmission fails.
In Time Division Multiplex (TDM) networks, Plain Old Telephone Service (POTS), and cellular phones generate DTMF digits that are transmitted in-band by 64 kbps, dedicated-circuit switched ports. You can input DTMF digit responses, which are used for authentication and to branch through application prompts (for example, voice mail or prepaid applications). These DTMF digit responses are transmitted over the TDM network and presented to the Excel platform and host application in a prescribed format that is supported by the current applications.
The IP endpoints, whether SIP or H.323, must provide the same information through the IP network to the Excel platform and to the partner application. This way, the DTMF responses remain transparent to the host application, whether the user is using a POTS phone, cellular phone, or IP endpoint to interact with the voice mail system.
There are several methods of providing this DTMF capability in an IP network:
• In-Band
• Low bit-rate codecs with RFC 2833 (special RTP packets)
Refer to RFC 2833 Multi-Unicast.
• Out-of-Band using IP protocol signaling (SIP).
Refer to SUBSCRIBE and NOTIFY Method for DTMF Detection
In-Band IP-to-IP Digit Transmission
Regardless of the audio codec scheme, you can pass in-band digits from IP-to-IP (from the IP Network Interface Series 2 card to another IP Network Interface Series 2 card or another IP endpoint that supports RFC 2833).
IP Network Interface
Series 2 Card over the EXNET Ring
The IP Network Interface Series 2 card over the EXNET ring is similar to any other resource over the ring. Spans are assigned on the IP Network Interface Series 2 card and this span information is shared among all nodes. When the host sends a message to connect to a IP Network Interface Series 2 card span/channel on a remote node, the system makes the connection to the remote node.
Address Resolution Protocol (ARP)
The IP Network Interface Series 2 card supports the Address Resolution Protocol (ARP) of TCP/IP, which is used to obtain the physical address (Ethernet address) of an endpoint when only the logical address (IP Address) is known.
The Excel platform broadcasts an ARP Request message to the network with the known IP address. The corresponding endpoint responds with its Ethernet address and the connection is made.
The main circuit board on the IP Network Interface Series 2 card maintains an ARP Cache Table for each module. An ARP Cache entry contains the IP Address and Ethernet address of remote endpoints. These tables allow connections to be made to the remote endpoint without sending the ARP Request message each time. An IP Network Interface Series 2 card ARP Cache Table contains only a cache of Gateway Addresses.
You can query the content of a module’s ARP Cache Table by using the ARP Cache Query (0x00FC) message. The ARP Cache Table information is sent to the host in one or more ARP Cache Report (0x00FB) messages.
With the ARP Cache Aging feature, entries in the ARP cache are deleted after a preset interval. Each entry in the ARP cache has an associated time-to-live. The ARP Cache Aging timer is set to five minutes. The ARP Cache manager continually increments the time-to-live field, and discards the entry when the value reaches the aging timer value. Entries are removed based solely upon the time-to-live value, and not upon the frequency that the entry was used.
This feature allows the host to use the ARP Cache Query (0x00FC) message to query the ARP cache of any VoIP module. The Excel platform responds with one or more ARP Cache Report (0x00FB) messages that contain all existing ARP cache entries.
You can manually remove entries from an ARP Cache Entry Table by using the Flush ARP Cache Entry TLV in the ARP Cache Query (0x00FC) message.
Internet Control Message Protocol (ICMP) Message
The IP Network Interface Series 2 card supports the Internet Control Message Protocol (ICMP), which reports errors related to IP packet processing. If the IP Network Interface Series 2 card attempts to connect to a remote endpoint and receives the ICMP message Destination Unreachable, it flushes the entry for that IP address from the ARP Cache Table, and sends an ARP Request message to obtain a new Ethernet address for the entry. When the IP Network Interface Series 2 card receives the new Ethernet address, the connection is made and the ARP Cache Table is updated. This process occurs without host intervention or notification.
The IP Network Interface Series 2 can generate the following ICMP message types:
• Destination Unreachable
• Echo Request (Ping Request)
• Echo Reply (Ping Reply)
The IP Network Interface Series 2 can process the following incoming ICMP messages:
• Destination Unreachable
• Echo Request (Ping Request)
• Echo Reply (Ping Reply)