Configuring Raw Socket Protocol on the CGR 2010 Router

TCP Transport

TCP Raw Socket transport uses a client-server model. At most one server and multiple clients can be configured on a single asynchronous serial line. In client mode, the CGR 2010 can initiate up to 32 TCP sessions to Raw Socket servers, which can be other CGR 2010 routers or third-party devices.

Figure 1 shows a sample Raw Socket TCP configuration. In this example, serial data is transferred between RTUs and a utility management system across an IP network that includes several CGR 2010 routers. One CGR 2010 router acts as a Raw Socket server, listening for TCP connection requests from the other CGR 2010 routers, which are configured as Raw Socket clients.

A Raw Socket client receives streams of serial data from the RTUs and accumulates this data in its buffer, then places the data into packets, based on user-specified packetization criteria. The Raw Socket client initiates a TCP connection with the Raw Socket server and sends the packetized data across the IP network to the Raw Socket server, which retrieves the serial data from the packets and sends it to the serial interface, and on to the utility management system.

Figure 1 Raw Socket TCP Transport

---

Note When you configure the serial link interface on the router as a server, the interface’s peer is the serial link interface on the client router and vice versa.

UDP Transport

UDP transport uses a peer-to-peer model. Multiple UDP connections can be configured on an asynchronous serial line.

Figure 2 shows a sample Raw Socket UDP configuration. In this example, serial data is transferred between RTUs and a utility management system across an IP network that includes two CGR 2010 routers that are configured as Raw Socket UDP peers.

In this example, the Raw Socket UDP peer receives streams of serial data from the RTUs and accumulates this data in its buffer, then places the data into packets, based on user-specified packetization criteria. The Raw Socket UDP peer sends the packetized data across the IP network to the Raw Socket peer at the other end, which retrieves the serial data from the packets and sends it to the serial interface, and on to the utility management system.

Figure 2 Raw Socket UDP Transport

Serial Protocols

The CGR 2010 supports the following serial protocols for Raw Socket Transport:

• Asynchronous communication protocol—This is the default. When you use the default protocol, you can select processing options as described in the next section.
• Control Data Corporation Type 1 (CDC1) protocol—CDC1 is a bit-oriented SCADA protocol that is used for communication between control stations and RTUs or substations. When you select the CDC1 protocol option, the CGR 2010 packetizes the serial data but does not perform processing before transmitting the data using TCP or UDP.

See the Configuring Common Raw Socket Line Options for information about configuring the CDC1 option.

Serial Data Processing

When the default serial protocol, Asynchronous Communication Protocol, is used, the streams of serial data received by a Raw Socket peer can be packetized based on the following criteria:

• Packet length –You can specify a packet length that triggers the CGR 2010 to transmit the serial data to the peer. Once the CGR 2010 collects this much data in its buffer, it packetizes the accumulated data and forwards it to the Raw Socket peer.
• Packet-timer value –The packet timer specifies the amount of time the CGR 2010 waits to receive the next character in a stream. If a character is not received by the time the packet timer expires, the data the CGR 2010 has accumulated in its buffer is packetized and forwarded to the Raw Socket peer.
• Special character –You can specify a character that will trigger the CGR 2010 to packetize the data accumulated in its buffer and send it to the Raw Socket peer. When the special character (for example, a CR/LF) is received, the CGR 2010 packetizes the accumulated data and sends it to the Raw Socket peer.

In addition to the packetizing options, you can also select best-effort mode for faster processing. This mode trades reliability for speed. If the buffer is full, the CGR 2010 drops the older packets.

See the Configuring Common Raw Socket Line Options for information about configuring the processing options.

VRF-Aware Raw Socket

The VRF-aware Raw Socket Transport feature enables you to isolate Raw Socket traffic using a VRF for efficient management and control of serial data. After configuring a VRF, you can associate the serial interface configured for Raw Socket Transport with the VRF. See the “Raw Socket VRF” section for a configuration example.

Feature	Default Setting
Raw Socket Transport	Disabled.
Packet length	No packet length is configured.
Serial Protocol	Asynchronous Communication Protocol
Packet timeout	10 ms.
Special character	No special character is configured.
Raw Socket mode	Best-effort mode is off.
TCP idle timeout	5 minutes.

Enabling Raw Socket Transport on the Serial Interface

To enable Raw Socket Transport on the CGR 2010 router, you must first enable an asynchronous serial port and enable Raw Socket TCP or UDP encapsulation for that port.

BEFORE YOU BEGIN

Determine availability of the serial port on the CGR 2010.

DETAILED STEPS

EXAMPLE

This example shows how to enable serial port 0/0/0 and how to enable Raw Socket TCP encapsulation on that port.

This example shows how to enable serial port 0/0/1 and how to enable Raw Socket UDP encapsulation on that port.

Configuring Common Raw Socket Line Options

You can configure options common to all connections on a line. The common options apply to both TCP and UDP.

BEFORE YOU BEGIN

Enable Raw Socket Transport as described in Enabling Raw Socket Transport on the Serial Interface.

DETAILED STEPS

Use the no form of these commands to return to the default values.

EXAMPLE

Configuring Raw Socket TCP

After enabling Raw Socket TCP encapsulation, you configure the TCP server and/or clients.

Configuring the Raw Socket TCP Server

BEFORE YOU BEGIN

Enable a serial port and Raw Socket TCP encapsulation for that port, as described in “Enabling Raw Socket Transport on the Serial Interface” section.

DETAILED STEPS

To remove a Raw Socket TCP server, use the no raw-socket tcp server command.

EXAMPLE

This example shows how to configure a Raw Socket TCP server for an asynchronous serial line. The TCP server listens for TCP client connection requests on local port 4000 and local IP address 10.0.0.1. If no data is exchanged between the Raw Socket TCP server and one of the TCP clients for 10 minutes, then the TCP session closes, and the Raw Socket client attempts to reestablish the session with the Raw Socket server.

Configuring the Raw Socket TCP Client

BEFORE YOU BEGIN

Enable a serial port and Raw Socket TCP encapsulation for that port, as described in “Enabling Raw Socket Transport on the Serial Interface” section.

DETAILED STEPS

To remove a Raw Socket TCP client, use the no raw-socket tcp client command.

EXAMPLE

This example shows how to configure a Raw Socket TCP client for an asynchronous serial line. The CGR 2010 (router), serving as a Raw Socket client, initiates TCP sessions with a Raw Socket server and forwards packetized serial data to it. The router collects streams of serial data in its buffer; when it accumulates 827 bytes in its buffer, the router packetizes the data and forwards it to the Raw Socket server. If the router and the Raw Socket server do not exchange any data for 10 minutes, then the TCP session with the Raw Socket server closes, and the router attempts to reestablish the session with the Raw Socket server.

Configuring a Raw Socket UDP Peer-to-Peer Connection

After enabling Raw Socket UDP encapsulation and the common line options, you configure the Raw Socket UDP peer-to-peer connection. The local port on one end of the connection should be the destination port on the other end.

BEFORE YOU BEGIN

Enable a serial port and Raw Socket UDP encapsulation for that port, as described in “Enabling Raw Socket Transport on the Serial Interface” section.

DETAILED STEPS

To remove a Raw Socket UDP connection, use the no raw-socket udp connection command.

EXAMPLE

This example shows how to configure a Raw Socket UDP connection between router A (local IP address 192.168.0.8) and router B (local IP address 192.168.0.2).

Router A

Router B

Command	Purpose
show running-config	Shows the configuration of the CGR 2010, including those features that are active and their settings.
show raw-socket tcp detail	Displays information about Raw Socket Transport TCP activity.
show raw-socket tcp sessions	Displays information about Raw Socket Transport TCP sessions.
show raw-socket tcp statistics	Displays Raw Socket Transport TCP statistics for each asynchronous serial line.
show raw-socket udp detail	Displays information about Raw Socket Transport UDP activity.
show raw-socket udp sessions	Displays information about Raw Socket Transport UDP sessions.
show raw-socket udp statistics	Displays Raw Socket Transport UDP statistics for each asynchronous serial line.
clear raw-socket statistics	Clears Raw Socket Transport statistics for a specific TTY interface or for all asynchronous serial lines.

Raw Socket TCP

The following example shows a Raw Socket Transport configuration in which a CGR 2010 router acts as the server, and another CGR 2010 router acts as the client.

Figure 3 Raw Socket Transport Configuration Example

 

The following table displays the configuration of the server and client CGR 2010s highlighted in Figure 3:

Configuration on the Server Side

This example shows the Raw Socket Transport configuration on the TCP server side.

Configuration on the Client Side

This example shows the Raw Socket Transport configuration on the TCP client side.

Raw Socket UDP

This example shows the configuration for a Raw Socket UDP connection between two CGR 2010 routers:

From Router1

From Router2

Raw Socket VRF

The following example shows a Raw Socket VRF configuration in which two CGR 2010 routers, configured for Raw Socket Transport, connect through a VRF. CGR1 serves as the Raw Socket TCP server, and CGR2 serves as the Raw Socket TCP client.

Figure 4 Raw Socket Transport VRF Configuration Example

 

Following are the configurations of CGR1 and CGR2 as shown in Figure 4:

CGR1 Configuration

Defining VRF on the router:

Applying VRF configuration on the interface:

Applying raw-tcp on the serial interface:

Applying raw-tcp on the line:

CGR2 Configuration

Defining VRF on the router:

Applying VRF configuration on the interface:

Applying raw-tcp on the serial interface:

Applying raw-tcp on line:

Feature Name	Release	Feature Information
Raw Socket Transport	15.2(4)M	Initial support of the feature on the CGR 2010.
	15.3(3)M	Addition of VRF awareness for TCP Raw Socket.
	15.4(1)T	Addition of UDP as transport protocol.
	15.4(2)T	Addition of support for Control Data Corporation Type 1 (CDC1), a bit-oriented SCADA communication protocol.

 

Syntax Description

 

Usage Guidelines

After running this command, run the show raw-socket tcp statistics or show raw-socket udp statistics command to verify that the raw statistics have been cleared.

Examples

This is an example of the clear raw-socket statistics command:

 

Usage Guidelines

Issues you can debug with this command include actions related to:

• Packet timer
• Packet length

---

To turn this debug command off, run one of these commands:

• no debug raw-socket driver event
• no debug all

Examples

This example shows the output of the debug raw-socket driver event command:

 

Usage Guidelines

Issues related to Raw Socket Transport driver packets include packetizing actions based on some or all of the following:

• Packet length
• Packet timer
• Special character

---

To turn this debug command off, run one of these commands:

• no debug raw-socket driver packet
• no debug all

Examples

This example shows the output of the debug raw-socket driver packet command:

 

Usage Guidelines

Issues that you can debug with this command include:

• Interface and connection registration
• TCP socket establish/release information
• Configuration event
• Retry information

---

To turn this debug command off, run one of these commands:

• no debug raw-socket tcp event
• no debug all

Examples

This example shows the output of the debug raw-socket tcp event command:

 

 

Usage Guidelines

In the output of this command:

---

To turn this debug command off, run one of these commands:

• no debug raw-socket tcp packet
• no debug all

Examples

This example shows the output of the debug raw-socket tcp packet command:

 

Usage Guidelines

To use this command, switch to the Interface Configuration mode (config-if).

Examples

This example shows how to use the encapsulation raw-tcp command:

 

 

Usage Guidelines

To use this command, switch to the Interface Configuration mode (config-if).

Examples

This example shows how to use the encapsulation raw-udp command:

 

Usage Guidelines

Use best-effort mode for faster transmission of serial data to the Raw Socket peer. Older packets are dropped from the head of the queue when the queue is full.

To use this command, switch to the Line Configuration mode (config-line).

Examples

 

 

Syntax Description

 

Usage Guidelines

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket packet-length command:

 

Syntax Description

 

Usage Guidelines

By default, the serial interface packetizes the serial received bytes in its buffer every 10 ms. However, you can change this value using this command. After creating the packet, the interface sends the packet to the peer serial interface on the server side through the Raw Socket Transport tunnel.

On the utility RTU server side, you can set this value to 3 ms to flush polling requests out as soon as possible. The shorter the timer, the sooner the polling data is sent to the RTU client.

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket packet-timer command:

 

 

Usage Guidelines

When you select the CDC1 protocol, the CGR 2010 packetizes and transports the serial data using TCP or UDP but does not perform processing of the data.

To use this command, switch to the Line Configuration mode (config-line).

The following line option commands have no effect when you use CDC1:

• raw-socket packet-length
• raw-socket packet-timer
• raw-socket spec-char
• raw-socket mode best-effort

Examples

This example shows how to use the raw-socket protocol cdc1 command:

 

Syntax Description

 

Usage Guidelines

When the serial interface detects this special character, the interface packetizes the received bytes into a TCP or UDP frame and sends it to the peer through the Raw Socket Transport tunnel.

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket special-char command:

 

Syntax Description

 

Usage Guidelines

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket tcp client command:

 

Syntax Description

 

Usage Guidelines

This timeout setting applies to all Raw Socket Transport TCP sessions under this particular asynchronous line. By default, the session idle timeout is 5 minutes.

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket tcp idle-timeout command:

 

Syntax Description

 

Usage Guidelines

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket tcp server command:

 

Syntax Description

 

Usage Guidelines

To use this command, switch to the Line Configuration mode (config-line).

Examples

This example shows how to use the raw-socket udp connection command:

 

 

Usage Guidelines

This command displays:

• Line Registration and Connections

– Current status for each virtual line (up to 32 lines), including the asynchronous interface and VRF currently registered with this line.

– Server status. If the status is on, this line accepts call-in sessions.

– Server master socket (listening socket).

– Server listening port.

– Total number of Raw Socket Transport TCP sessions currently running for this asynchronous interface.

Under each line there can be up to 32 sessions. For each session, this command displays the following:

– [out]—Indicates that the session was initiated by this line interface (referred to as caller).

– [in]—Indicates that the session was initiated by the remote peer (referred to as called).

– l_ip—Local IP address for this session.

– l_port—Local port number.

– d_ip—Destination IP address.

– d_port—Destination port number.

– w_err—Number of socket write errors.

• Socket Mapping

Displays information about each socket and its connection details.

• Configuration Event List

Displays all the Raw Socket Transport TCP configurations and retry information.

Examples

This example shows the output of the show raw-socket tcp detail command:

 

Usage Guidelines

The returned raw TCP session details include this information

After the session idle time reaches the specified idle timeout, the session is removed. The client reconnects to the server based on the retry mechanism.

Examples

This example shows the output of the show raw-socket tcp sessions command:

 

Usage Guidelines

The displayed statistics include:

• Interface TTY number.
• VRF name.
• Total Raw Socket TCP sessions currently running for this interface.
• Total bytes received from remote peers to this interface.
• Total output bytes from this interface to remote peers.
• Total packetized frames from remote peers to this interface.
• Total packetized frames from this interface to remote peers.

Examples

This example shows the output of the show raw-socket tcp statistics command:

 

Usage Guidelines

This command displays:

• Line Registration and Connections

– Current status for each virtual line (up to 32 lines), including the asynchronous interface currently registered with this line.

– Server status. The status is always off for UDP.

– Server master socket (listening socket).

– Server listening port.

– Total number of Raw Socket Transport UDP sessions currently running for this asynchronous interface.

Under each line there can be up to 32 sessions. For each session, this command displays the following:

– [out]—Indicates that the session was initiated by this line interface (referred to as caller).

– [in]—Indicates that the session was initiated by the remote peer (referred to as called).

– l_ip—Local IP address for this session.

– l_port—Local port number.

– d_ip—Destination IP address.

– d_port—Destination port number.

– w_err—Number of socket write errors.

• Socket Mapping

Displays information about each socket and its connection details.

• Configuration Event List

Displays all the Raw Socket Transport UDP configurations and retry information.

Examples

This example shows the output of the show raw-socket udp detail command:

 

Usage Guidelines

The returned raw UDP session details include this information:

After the session idle time reaches the specified idle timeout, the session is removed. The client reconnects to the server based on the retry mechanism.

Examples

This example shows the output of the show raw-socket udp sessions command:

 

Usage Guidelines

The displayed statistics include:

• Interface TTY number.
• VRF name.
• Total Raw Socket UDP sessions currently running for this interface.
• Total bytes received from remote peers to this interface.
• Total output bytes from this interface to remote peers.
• Total packetized frames from remote peers to this interface.
• Total packetized frames from this interface to remote peers.

Examples

This example shows the output of the show raw-socket udp statistics command:

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

No combinations are authorized or intended under this document.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2012–2017 Cisco Systems, Inc. All rights reserved.