|
|
This feature module describes the Common Application Programming Interface (CAPI) and Remote Common Application Programming Interface (RCAPI) feature. It describes the benefits of the new feature, supported platforms, configuration, related documents, and provides command reference information.
This document includes the following sections:
The CAPI is an application programming interface standard used to access ISDN equipment connected to Basic Rate Interfaces (BRIs) and Primary Rate Interfaces (PRIs). RCAPI is the CAPI feature configured remotely from a PC client.
Figure 1 shows how CAPI connects applications, drivers, and controllers.
The framing protocols supported by CAPI include High-Level Data Link Control (HDLC), HDLC inverted, bit transparent (speech), and V.110 synchronous/asynchronous.
CAPI integrates the following data link and network layer protocols:
CAPI supports the following features:
Figure 2 shows the components of the RCAPI implementation.
Standardized Interface for ISDN Drivers and Controllers
CAPI provides a standardized interface through which application programs can use ISDN drivers and controllers. One application can use one or more controllers. Several applications can share one or more controllers.
Standardized Network Access
CAPI supplies a selection mechanism that supports applications that use protocols at different levels and standardized network access. An abstraction from different protocol variables is performed to provide this support. All connection-related data, such as connection state and display messages, is available to the applications at any time.
The RCAPI commands only work with the Net3 switch type, except for the command debug rcapi events, which works with all Net3 switch types. The Cisco 800 series routers support the following channel protocols.
The router provides two 64-kbps B channels to RCAPI clients. Each B channel can be configured separately to work in either HDLC mode or bit transparent mode. For CAPI support, layers B2 through B7 protocols are transparent to the applications using these B channels.
The ISDN Core Engine of RVS-COM supports the following B-channel protocols:
CAPI support is available only for the ISDN switch type Net3.
The router supports the ISDN Device Control Protocol (ISDN-DCP) from RVS-COM. ISDN-DCP allows a workstation on the LAN or router to use legacy dial computer telephony integration (CTI) applications. These applications include placing and receiving telephone calls and transmitting and receiving faxes.
Using ISDN-DCP, the router acts as a DCP server. By default, the router listens for DCP messages on TCP port number 2578 (the Internet-assigned number for RVS-COM DCP) on its LAN port.
When the router receives a DCP message from a DCP client (connected to the LAN port of the router), the router processes the message and acts on it; it can send confirmations to the DCP clients and ISDN packets through the BRI port of the router.
When the router receives packets destined for one of the DCP clients on its BRI port, the router formats the packet as a DCP message and sends it to the corresponding client. The router supports all the DCP messages specified in the ISDN-DCP specifications defined by RVS-COM.
ISDN-DCP supports CAPI and non-CAPI applications. Applications are supported that use one or two B channels for data transfer, different HDLC-based protocols, Euro File transfer, or G4 fax; also supported are applications that send bit-transparent data such as A/Mu law audio, G3 fax, analog modem, or analog telephones.
Before you can enable the RCAPI feature on the Cisco 800 series router, the following requirements must be met:
The following procedure provides step-by-step instructions for configuring RCAPI on the 800 series router:
| Command | Purpose | |
|---|---|---|
Step 1 | router# configure terminal router(config)# | At the router console, change to global configuration mode. |
Step 2 | router(config)# isdn switch-type basic-net3 | Set the switch type. In this example, the switch type is set to ETSI. |
Step 3 | router(config)# rcapi number number | Enter the RCAPI directory number assigned by the ISDN provider for the device. For example, rcapi number 12345. |
Step 4 | router(config)# rcapi server port port_number | Optional. Perform this step only if you wish to specify a port number for RCAPI functions. Otherwise, the default port 2578 is used. For example, rcapi server port 2000. Configure the same number on both the router and client PC. |
Step 5 | router(config)# int bri0 router# | Exit from global configuration mode to interface configuration mode. |
Step 6 | router(config-if)# isdn switch-type basic-net3 | Set the switch type for the bri0 interface. In this example, the switch type is set to ETSI. |
Step 7 | router(config-if)# isdn incoming-voice modem | Set the modem as the default handler for incoming voice calls. |
Step 8 | router(config-if)# exit | Change to privileged EXEC mode either by pressing Ctrl-Z or by entering exit twice, once at the interface mode prompt and again at the global configuration mode prompt. |
Step 9 | router# show rcapi status | Optional. Enter this command if you wish to display the RCAPI status. |
router# debug rcapi events | Optional. In privileged EXEC mode, start the debug program to run in the background. |
 |
Note If required, at each remote device console change to global configuration mode, using the command configure terminal, and repeat Step 2 through Step 10 to configure that device. |
Router1# show running-config Building configuration... Current configuration: ! version 12.0 service timestamps debug uptime service timestamps log uptime no service password-encryption ! hostname local ! ip subnet-zero ! isdn switch-type basic-net3 isdn voice-call-failure 0 ! interface Ethernet0 ip address 192.168.2.1 255.255.255.0 no ip directed-broadcast ! interface BRI0 no ip address no ip directed-broadcast isdn switch-type basic-net3 isdn incoming-voice modem ! no ip http server ip classless ! line con 0 transport input none stopbits 1 line vty 0 4 ! rcapi server port 2578 ! rcapi number 5551000 rcapi number 5553000 ! end Router1#Router 2
Router2# show running-config Building configuration... Current configuration: ! version 12.0 service timestamps debug uptime service timestamps log uptime no service password-encryption ! hostname local ! ip subnet-zero ! isdn switch-type basic-net3 isdn voice-call-failure 0 ! interface Ethernet0 ip address 192.168.1.1 255.255.255.0 no ip directed-broadcast ! interface BRI0 no ip address no ip directed-broadcast isdn switch-type basic-net3 isdn incoming-voice modem ! no ip http server ip classless ! line con 0 transport input none stopbits 1 line vty 0 4 ! rcapi server port 2578 ! rcapi number 5552000 rcapi number 5554000 ! end Router2#
Also see the "Examples" sections in the "Command Reference" section for examples of each command.
This section documents new commands. All other commands used with this feature are documented in the Cisco IOS Release 12.0 command reference publications.
This section describes in detail the Cisco IOS commands for configuring RCAPI on the 800 series routers. These commands are applicable only for ISDN Net3 switch types.
To enable the Cisco 800 series router to distinguish between incoming CAPI calls and incoming non-CAPI calls such as POTS, PPP, and X.25, use the rcapi number command. This command allows the Cisco 800 series router to reserve directory numbers exclusively for incoming calls.
rcapi number directory number[:subaddress]The no rcapi number directory number[:subaddress] command releases the specified directory number from the RCAPI interface. By default, no directory number is set for the RCAPI interface.
Syntax Description
The directory number is the number assigned by the ISDN provider for the PC on which RCAPI is configured. This number should not be set to any other interface.
| Command Elements | Description |
|---|---|
number directory number | ISDN directory number. Default is none. |
[:subaddress] | Optional subaddress of router preceded by a colon (:). |
Defaults
The default is no directory number is set for the RCAPI interface.
Command Modes
Global configuration.
Command History
| Release | Modification |
|---|---|
Cisco IOS Release 12.0(7)XV | The commands rcapi number and no rcapi number were introduced on the Cisco 800 series router. |
Usage Guidelines
The directory number should not be set to any other interfaces such as POTS and DOV. This command works only with the Net3 switch type.
Examples
Enter the global configuration mode before configuring the RCAPI number.
router(config)# rcapi number 12345
Related Commands
| Command | Description |
|---|---|
Enables RCAPI on the 800 series router. | |
Displays the status of RCAPI and, if enabled, the details of the application. | |
Displays diagnostic DCP and driver messages. |
To enable the RCAPI server on the 800 series router or to set the TCP port number, use the rcapi server global configuration command.
rcapi server [port number]The no rcapi server command disables the RCAPI server on the 800 series router.
Syntax Description
| Command Elements | Description |
|---|---|
[port number] | TCP port number. Default is 2578. |
Defaults
If the router is configured for basic Net3 IDSN switch type, by default RCAPI is enabled, and the port number is set to 2578.
Command Modes
Global configuration.
Command History
| Release | Modification |
|---|---|
Cisco IOS Release 12.0(7)XV | The commands rcapi server and no rcapi server were introduced on the Cisco 800 series router. |
Usage Guidelines
This command works only with the Net3 switch type. The same port number must be configured on both the router and client PC.
Examples
Enter the global configuration mode before configuring the RCAPI port number:
router(config)# rcapi server port 2000
Related Commands
| Command | Description |
|---|---|
Sets the directory number and the subaddress of the router. | |
Displays the status of RCAPI and, if enabled, the details of the application. | |
Displays diagnostic DCP and driver messages. |
Use the show rcapi command to display:
Syntax Description
This command contains no arguments or keywords.
Command Modes
Privileged EXEC.
Command History
| Release | Modification |
|---|---|
Cisco IOS Release 12.0(7)XV | The command show rcapi status was introduced on the Cisco 800 series router. |
Usage Guidelines
This command works only with the Net3 switch type.
Examples
The following is an example of the output from the show rcapi status command.
router# show rcapi status RCAPI SERVER ON RCAPI SERVER PORT 2578 RCAPI NUMBER 5553000 5553100
CLIENT | SESSION ID | LISTEN | CONNECTION ID | TYPE | CALL STATUS |
912.168.100.3 | 16777212 | ON | |||
192.168.100.5 | 16777218 | OFF | 50333953 | Bit Transparent | Connected |
192.168.100.6 | 16777227 | OFF | 50333962 | HDLC | Connected |
Related Commands
| Command | Description |
|---|---|
Sets the directory number and the subaddress of the router. | |
Enables RCAPI on the 800 series router. | |
Displays diagnostic DCP and driver messages. |
To display diagnostic DCP and driver messages to help in troubleshooting, use the debug rcapi events command.
debug rcapi eventsThe no debug rcapi events command disables debugging.
Syntax Description
This command contains no arguments or keywords.
Defaults
By default, debugging is set to off.
Command Modes
Privileged EXEC.
Command History
| Release | Modification |
|---|---|
Cisco IOS Release 12.0(7)XV | The command debug rcapi events was introduced on the Cisco 800 series router. |
Usage Guidelines
This command works for all switch types.
Related Commands
| Command | Description |
|---|---|
Sets the directory number and the subaddress of the router. | |
Enables RCAPI on the 800 series router. | |
Displays the status of RCAPI and, if enabled, the details of the application. |
Posted: Tue Jan 11 13:09:33 PST 2000
Copyright 1989-2000©Cisco Systems Inc.