IP transport configuration command descriptions
ip-transport
Syntax
ip-transport ipt-id [create]
no ip-transport ipt-id
Context
config>service>vprn
Description
This command creates an IP transport subservice within a VPRN service. An IP transport subservice can be used to transmit serial raw socket data to and from a local host and remote host. An IP transport subservice can also be used to transmit GNSS NMEA data from the GNSS receiver to one or more remote hosts.
All IP transport subservices must be explicitly created using the create keyword. An IP transport subservice is owned by the service within which it is created. An IP transport subservice can only be associated with a single service. The create keyword is not needed when editing parameters for an existing IP transport subservice. An IP transport subservice must first be shut down before changes can be made to the configured parameters.
The no form of this command deletes the IP transport subservice with the specified ipt-id. When an IP transport subservice is deleted, all configured parameters for the IP transport subservice are also deleted.
Default
no ip-transport
Parameters
- ipt-id
the physical port associated with the IP transport subservice
- create
creates this IP transport subservice
description
Syntax
description description string
no description
Context
config>service>vprn>ip-transport
config>service>vprn>ip-transport>remote-host
Description
This command creates a text description for a configuration context to help identify the content in the configuration file.
The no form of this command removes any description string from the context.
Default
no description
Parameters
- description-string
a description character string. Allowed values are any string up to 80 or 160 characters long (depending on the command, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, or spaces), the entire string must be enclosed within double quotes.
dscp
Syntax
dscp dscp-name
Context
config>service>vprn>ip-transport
Description
This command configures the DSCP name used to mark the DSCP field in IP transport packets originating from this node.
Default
ef
Parameters
- dscp-name
the DSCP name used to mark the DSCP field in IP transport packets. Valid DSCP names lists the valid DSCP names.
Table 1. Valid DSCP names dscp-name
be, ef, cp1, cp2, cp3, cp4, cp5, cp6, cp7, cp9, cs1, cs2, cs3, cs4, cs5, nc1, nc2, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cp11, cp13, cp15, cp17, cp19, cp21, cp23, cp25, cp27, cp29, cp31, cp33, cp35, cp37, cp39, cp41, cp42, cp43, cp44, cp45, cp47, cp49, cp50, cp51, cp52, cp53, cp54, cp55, cp57, cp58, cp59, cp60, cp61, cp62, cp63
filter-unknown-host
Syntax
[no] filter-unknown-host
Context
config>service>vprn>ip-transport
Description
This command filters connections from unknown hosts. An unknown host is any host that is not configured as a remote host.
The no form of this command disables the filter.
Default
no filter-unknown-host
local-host
Syntax
local-host ip-addr ip-addrport-num port-numprotocol {tcp | udp}
no local-host
Context
config>service>vprn>ip-transport
Description
This command creates the local host within the IP transport subservice.
The local host is required to accept TCP/UDP sessions initiated from far-end remote hosts, and for the node to initiate sessions toward the far-end remote hosts.
When the IP transport ID is configured as gnss, any packets sent from remote hosts to the local host are dropped.
The local host must be created before a remote host is created.
The no form of this command deletes the local host.
Default
no local-host
Parameters
- ip-addr
the IP address that is used for this local host. The IP address must be the same as a loopback or local interface IP address that is already configured within this service.
- port-num
the port number that is used by remote hosts to establish TCP/UDP sessions to this local host
- protocol {tcp | udp}
the protocol type that is used for all sessions to and from this local host, either tcp or udp
remote-host
Syntax
remote-host host-id ip-addr ip-addr] port-num port-num [create]
no remote-host host-id
Context
config>service>vprn>ip-transport
Description
This command creates a remote host within the IP transport subservice. Multiple remote hosts can be created in order to send serial raw socket data or GNSS NMEA data to remote destinations. The create keyword must be used for each remote host that is created.
The no form of this command deletes the remote host.
Default
no remote-host
Parameters
- host-id
the remote host identifier
- ip-addr
the IP address that is used to reach the remote host in order to route IP transport packets to that remote host
- port-num
the destination port number that is used to reach the serial port socket or the GNSS receiver on the remote host
- create
creates this remote host
name
Syntax
name host-name
no name
Context
config>service>vprn>ip-transport>remote-host
Description
This command configures a unique name for this remote host.
The no form of this command deletes the remote host name.
Default
n/a
Parameters
- host-name
a unique name for this remote host, up to 64 characters long
shutdown
Syntax
[no] shutdown
Context
config>service>vprn>ip-transport
Description
This command administratively disables an entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics.
The operational state of the entity is disabled as well as the operational state of any entities contained within. Many objects must be shut down before they can be deleted.
The no form of this command administratively enables an entity.
Default
no shutdown
Special Cases
- VPRN IP transport subservice
when an IP transport subservice within a VPRN service is shut down, all TCP/UDP packets received from remote hosts are dropped and any serial data received from the serial port is dropped. Any TCP connections that were up are closed and no new TCP connection requests are accepted.
It is not possible to make configuration changes to an IP transport subservice without performing a shutdown first.
The operational state of an IP transport subservice is relative to the operational state of the serial port or GNSS receiver for which the IP transport subservice is defined. When a serial port or GNSS receiver is shut down, the IP transport subservice associated with the serial port or GNSS receiver becomes operationally down.
When the no shutdown command is executed for an IP transport subservice, it becomes operationally up. Serial data from the serial port or NMEA sentence data from the GNSS receiver is encapsulated in TCP/UDP packets destined for remote hosts, and TCP/UDP packets can be received by the local host, where raw serial data is then sent out the serial port.
tcp
Syntax
tcp
Context
config>service>vprn>ip-transport
Description
This command creates the context to configure TCP parameters within this IP transport subservice.
Default
n/a
inactivity-timeout
Syntax
inactivity-timeout seconds
Context
config>service>vprn>ip-transport>tcp
Description
This command specifies how long to wait before disconnecting a TCP connection because of traffic inactivity over the connection.
Default
30 s
Parameters
- seconds
how long to wait, in seconds, before disconnecting a TCP connection
max-retries
Syntax
max-retries number
Context
config>service>vprn>ip-transport>tcp
Description
This command specifies the number of times that a remote host, acting as a client, tries to establish a TCP connection after the initial attempt fails.
Default
5
Parameters
- number
the number of attempts to establish a TCP connection after the initial attempt fails
retry-interval
Syntax
retry-interval seconds
Context
config>service>vprn>ip-transport>tcp
Description
This command specifies how long to wait before each TCP max-retries attempt.
Default
5 s
Parameters
- seconds
how long to wait, in seconds, before each TCP max-retries attempt