This topic describes the IP (Internet protocol) commands. The [ip] commands, with the exception of vsock, are also present in the [con] Standard commands. Refer to the Dialogic® NaturalAccess" Signaling Software Configuration Manual for information about IP control.
Sets the IP address of the TX board's redundant mate board using the following syntax:
mate [ IP address | NONE ]
where:
Value |
Description |
IP address |
IPv4 address in dot notation, for example 1.2.3.4. |
NONE |
No mate IP address (default). |
The following example indicates that the TX board's redundant mate is at address 10.1.1.2
mate 10.1.1.2
Use the mate command with no parameter to view the currently assigned mate address:
mate
Refer to the Dialogic® TX Series SS7 Boards Health Management Developer's Reference Manual for information about SS7 redundancy.
Shows information (optionally zeroing statistics) related to DHCP protocol handling. A DHCP interface is enabled for each Ethernet interface that is created as type DHCP [ifcreate <ethNum> DHCP].
dhcp [<interface number>|* [ZERO|LOG|PAUSE|RESUME]]
The following table describes the DHCP command options:
Option |
Description |
dhcp |
Shows a summary display for each DHCP interface. |
dhcp 1 |
Shows a full display for Ethernet number 1s DHCP. |
dhcp 1 zero |
Shows Ethernet 1 full display then zero Ethernet 1s statistics. |
dhcp * zero |
Shows a summary of each DHCP, then zero all DHCP statistics. |
dhcp 1 log |
Shows a full display, followed by the DHCP State/Event log. |
dhcp 1|* pause |
Pauses all DHCP processing for a specific Ethernet or all Ethernets. |
dhcp 1|* resume |
Resumes all DHCP processing for a specific Ethernet or all Ethernets. |
Shows a list of UDP ports or details for a specific port (optionally zeroing statistics immediately after they have been displayed) using the following syntax:
udp [<UDP port>|* [ZERO]]
Shows a list of IP protocols or details for a specific protocol (optionally zeroing statistics immediately after they have been displayed) using the following syntax:
proto [<protocol number>|* [ZERO]]
Specifies an IP interface configuration option using the following syntax:
ifopt [!]<optName>[ = <optValue>]
where bit options are specified as:
Value |
Description |
optName |
optName indicates that the option is enabled. !optName indicates that the option is disabled. |
optValue |
Value options are specified as: optName = optValue |
The following table describes the options that can be specified using the ifopt command:
Option |
Type |
Description |
PINGBLOCK |
BIT |
Indicates if automatic responses to PING messages are blocked. |
MTU |
VALUE |
Maximum transmission unit (in bytes). |
FRAGDROP |
SECS |
Partial fragment drop timeout. |
HOPLIMIT |
VALUE |
Not applicable in this release. |
ICMPRATE |
VALUE |
Not applicable in this release. |
IPV6 |
BIT |
Not applicable in this release. |
IPSEC |
BIT |
Not applicable in this release. |
NDATTEMPTS |
VALUE |
Specifies the neighbor discovery attempt (NDA) limit for the specified Ethernet interface. |
NDRETRAN |
SECS |
Neighbor discovery retransmission timeout. |
NDREACH |
SECS |
Not applicable in this release. |
ARPRETRY |
MSECS |
Amount of time to wait after issuing an ARP request before re-transmitting the same ARP request. |
ARPMAX |
VALUE |
Maximum number of times to retry an ARP request before terminating retry attempts, considering the remote entity is unreachable. |
ARPREACH |
MSECS |
Maximum amount of time without receiving any message from the remote IP address before probing to verify connectivity. |
ARPUNUSED |
MSECS |
Amount of time that an unused ARP entry remains in the ARP table. An ARP entry is used each time an outbound IP packet is sent to the remote entity for the given ARP entry. |
Enter the following command to block responses to received PING requests:
ifopt pingblock
Enter the following command to drop all fragments if incomplete after 10 seconds:
ifopt fragdrop 10
Defines an IP interface that uses either:
DHCP to determine IP address and mask, or
A fixed IP address and mask
An interface is created with default options unless options were set using a previous ifopt command.
The ifcreate command syntax using DHCP is:
ifcreate intfNum DHCP
where:
Value |
Description |
intfNum |
1-based Ethernet interface number. |
DHCP |
Obtains the IP address, network mask, and default gateway. |
The following example shows an interface that uses DHCP:
ifcreate 1 dhcp
The ifcreate command syntax when not using DHCP is:
ifcreate iftfNum IPaddr mask
where:
Value |
Description |
intfNum |
1-based Ethernet interface number. |
IPaddr |
IP address to assign to the interface. |
mask |
IP subnet mask. |
The following example shows an interface with a specific address and mask:
ifcreate 2 10.3.9.15 255.255.255.0
Shows a list of IP interfaces or details for a specific interface (optionally zeroing statistics immediately after they have been displayed) using the following syntax:
iface [<IP address>|<ifNum>|* [ZERO]]
Defines a gateway route using the following syntax:
gateway IPaddress mask gatewayAddress
where:
Value |
Description |
IPaddress |
IPv4 address in dot notation. For example, 1.2.3.4. |
mask |
Mask associated with IP address, in dot notation. |
gatewayAddress |
IPv4 address, in dot notation, of routing gateway. |
The following example sends all traffic not covered by a more specific route to the gateway at 10.1.0.1:
gateway 0.0.0.0 0.0.0.0 10.1.0.1
Manages the IP routing table using the following syntax:
route [<command> [<IP addr> <mask> <iface>|<GW addr>]]
where:
Value |
Description |
command |
Executes one of the following commands: add, delete, get, or table. The default value is table (or print), which shows the route table. |
IP addr |
IP address in dot notation. For example, 10.3.9.15. |
mask |
IP subnet mask associated with IP address, in dot notation. |
iface |
Interface number, for example (1..n). |
GW addr |
IP address, in dot notation, of routing gateway. For example, 10.3.9.1. |
The following example shows how to add an IP address to interface 1:
route add 10.3.9.15 255.255.255.0 1
The following example adds a gateway router:
route add 11.0.0.0 255.0.0.0 10.3.9.1
The following example displays the routing table:
route table
Shows information (optionally zeroing statistics) related to ARP protocol handling using the following syntax:
arp [<interface number (1-based)|*> [<remote IP>|*] [ZERO|LOG|DELETE]]
The ARP protocol translates from a destination IP address to a physical Ethernet address. An ARP entry is automatically created for each IP-to-Ethernet address pair being tracked by the ARP layer.
The following table describes the arp command options:
Option |
Description |
arp |
Shows top-level ARP statistics, followed by a summary for each ARP entry that exists in the ARP table. |
arp 1 |
Shows top-level statistics with a summary for Ethernet 1 ARP entries only. |
arp 1 1.2.3.4 |
Shows information about the ARP entry tracking remote IP address 1.2.3.4 over Ethernet 1. |
arp 1 1.2.3.4 log |
Show ARP entry information followed by a dump of the ARP entries state/event log. |
arp 1 1.2.3.4 zero |
Shows ARP entry information followed by zeroing the ARP entry statistics. |
arp 1 1.2.3.4 delete |
Immediately removes the ARP entry from the table. |
arp * * zero |
Shows top-level statistics with a summary for each ARP entry (zeroing all ARP entry statistics after display). |
arp * * delete |
Purges the ARP table (deletes current ARP entries). |
Shows summary information for each Ethernet or detailed information for a specific Ethernet (optionally zeroing statistics after display). The command can also be used to pause an Ethernet (treated as if a cable was pulled), and later resume that Ethernet as a diagnostic tool.
eth [<interface number (1-based)|*> [ZERO|PAUSE|RESUME]]
The following table describes the eth command options:
Option |
Description |
eth |
Displays a summary of each Ethernet interface. |
eth 1 |
Displays information about Ethernet 1. |
eth 1 zero |
Displays information about Ethernet 1 and then immediately zeroes Ethernet 1 statistics. |
eth 1 pause |
Pauses Ethernet 1 as if a cable was removed. Use for diagnostic purposes only. |
eth 1 resume |
Resumes a previous pause on Ethernet 1. Simulates replacing a cable. |
eth * zero |
Displays Ethernet summary information, and then immediately zeroes all Ethernet statistics. |
eth * pause |
Pauses all Ethernets as if a cable was removed. Use for diagnostic purposes only. |
eth * resume |
Resumes a previous pause on any Ethernet. Simulates replacing a cable. |
Ethernet interfaces can be configured using the following syntax:
ethcfg <Ethernet number> <speed> <duplex> [<mdix control>]
where:
Value |
Description |
Ethernet number |
1-based number of Ethernet interface. |
speed |
Interface speed in megabits/sec: 10 | 100 Deafult: Auto-negotiate up to maximum speed supported by all devices. |
duplex |
HALF | FULL |
mdix control |
NOMDIX | MDIX (Optional parameter) Controls swapping of transmit and receive pairs to avoid use of a crossover cable. Default: NOMDIX, No swapping of TX and RX pairs |
The default Ethernet configuration is to use auto-negotiation, negotiate for the fastest speed possible, and to perform pair swap detection. Certain TX board Ethernet interfaces support a maximum speed of 100 Mb/s while other Ethernet interfaces support up to 1 Gigabit/s. Do not specify the ETHCFG command for any interface where Gigabit speed is desired, allowing auto-negotiation to select the speed.
Manages the Ethernet packet log using the following syntax:
ethlog [<command> [<param(s)>]]
where <command> is one of the following:
Value |
Description |
Not specified |
Dumps the log entry header for each packet in the log. Enter the following command to display information and display log header lines: ethlog |
start |
Starts logging Ethernet packets. For example: ethlog start |
stop |
Stops logging Ethernet packets. |
info |
Displays top-level information [<param>=ZERO to clear stats]. Enter the following command to display information about the Ethernet log: ethlog info Enter the following command to display information and then clear the statistics: ethlog info zero |
dump |
Dumps each log entry. Use param to limit the dump size. Enter the following command to dump the entire log: ethlog dump Enter the following command to dump the entire log but limit each entry to 34 bytes: ethlog dump 34 |
Controls tracing of Ethernet packets sent and received to tracing applications (such as ss7trace or txalarm_) using the following syntax:
ethtrace [<interface number (1-based)|*> [ON [<host chan>]|OFF|INFO]]
The following table shows examples of ethtrace:
Command |
Description |
ethtrace ethtrace * info |
Shows how each Ethernet interface is configured for tracing. |
ethtrace 1 on |
Activates tracing on Ethernet interface number 1. Packets are traced to the default host channel [47 = ss7trace channel]. |
ethtrace * on |
Activates tracing on all Ethernet interfaces (tracing to default host channel). |
ethtrace 2 on 12 |
Activates tracing on Ethernet interface number 2 with all trace packets sent to host channel 12 (txalarm_). |
ethtrace * off |
Deactivates tracing on all Ethernet interfaces. |
Refer to Receiving data traces from TX based tasks: ss7trace and Receiving alarms from TX based tasks: txalarm for more information.
You can also use the txconfig host-based utility to control Ethernet tracing. Refer to the Dialogic® NaturalAccess™ Signaling Software Configuration Manual for more information.
Manages PINGs using the following syntax:
ping [<remote IP>|* [INFO|CLEAR|STOP|START] [-<option> [<param>]]
where:
remote IP is the remote IP address that uniquely identifies each ping.
The following table describes the ping commands:
Command |
Description |
INFO |
Show details about a specific ping or a summary indicated with an asterisk (*). |
CLEAR |
Clears a previous PING from memory, which implies STOP. |
STOP |
Stops the specific ping. An asterisk (*) stops all pings. |
START |
Starts sending pings to a given remote IP address. |
If you use ping without specifying any command, the resulting action depends on whether or not there is already a ping in progress for the specified remote IP address. If a ping for the specified remote IP address already exists, the ping is treated as an INFO command. If no ping exists for the specified remote IP address, the PING is treated as a START command.
The following table describes the START options:
Option |
Description |
-n count |
Stops issuing additional requests after sending and receiving count pings. The default value is an infinite count (send until stopped). |
-i interval |
Issues the next ping every interval ms. The default value is 1000 ms (one ping request per second). |
-w wait |
Expects ping reply within wait ms (else late). The default value is 30000 ms (wait 30 seconds). |
-z size |
Sets the number of data bytes in ping. The default value is 56. |
-p pattern |
Uses the provided pattern as a fill pattern. The default value is to fill with ASCII text message. |
-l ttl |
Sets the time-to-live. The default value is 60. |
-s tos |
Sets the type-of-service. The default value is 0. |
-m type |
Sends ICMP requests of a given message where type can be one of the following values: ECHO = Sends echo requests (expect ECHO replies). This is the default value. TIME = Sends timestamp requests (expect timestamp replies). INFO = Sends information requests (expect information replies). |
-d |
Sets the don't fragment flag. |
-r |
Use the IP option of RECORD ROUTE. |
-t |
Use the IP option of RECORD TIMESTAMPS. |
Displays control information for an IP VSOCK or set of VSOCKs using the following syntax:
vsock UDP|PROTO|IFACE [<ID number>]
vsock is the only [ip] command that is not present in the [con] -Standard commands since this command provides information that is targeted for low-level diagnostics.
Displays common communications statistics for IP layers (DHCP, UDP, PROTO, IFACE, ARP, and ETH) using the following syntax:
comm [DHCP|UDP|PROTO|IFACE|ARP|ETH|* ZERO]
Use the comm command with no parameters to display a summary of all statistics for each IP layer as shown in the following example:
===============================================================================
Layer Rx Frames Tx Frames | Rx Errors Rx Last | Tx Errors Tx Last
========= ========== ========== | ========== ========== | ========== ==========
DHCP 0 5128 | 0 0x00000000 | 0 0x00000000
-------------------------------------------------------------------------------
UDP 0 5128 | 5128 0x1C00001C | 0 0x00000000
-------------------------------------------------------------------------------
PROTOCOL 5128 5128 | 0 0x00000000 | 0 0x00000000
-------------------------------------------------------------------------------
INTERFACE 5128 5128 | 0 0x00000000 | 0 0x00000000
-------------------------------------------------------------------------------
ARP 0 0 | 0 0x00000000 | 0 0x00000000
-------------------------------------------------------------------------------
ETHERNET 5128 5128 | 0 0x00000000 | 0 0x00000000
-------------------------------------------------------------------------------
The example shows that 5128 DHCP packets were transmitted with no DHCP packets received. There were 5128 UDP packets transmitted (each DHCP packet is transmitted as a UDP packet). This example also shows that there were 5128 UDP receive errors. The last error code associated with a UDP receive error is listed in the RX Last column as 0x1C00001C. The RX Last and TX Last columns hold the last error code encountered by the given layer (either for receive or transmit handling). Use the txccode utility to obtain a text description of the error code.
In this case, txccode outputs the following information:
txccode 0x1c00001c
SCCIP_NO_PORT_RX_ROUTE - no route for received protocol-specific port number
Refer to Viewing completion code descriptions: txccode for more information.
The following comm command shows information about common communications statistics at the UDP layer:
comm udp
The following output displays:
===============================================================================
UDP:
COMM: Rx Frames : 0 | Tx Frames : 5128
Rx Bytes : 0 | Tx Bytes : 1436400
Rx Fails : 5128 | Tx Fails : 0
Rx LastReason : 0x1C00001C | Tx LastReason : 0x00000000
Rx LastInfo : 0x00000043 | Tx LastInfo : 0x00000000
Information similar to the statistical summary displays with the addition of RX LastInfo and TX LastInfo. These additional values provide information that is specific to the LastReason error code. For the SCCIP_NO_PORT_RX_ROUTE error code, RX LastInfo holds the specific UDP port number where the last received UDP packet was destined.
LastInfo is a hexadecimal value regardless of the meaning of the field. Since UDP port numbers are presented in decimal format, you must convert the LastInfo fields to decimal, for example, 0x43 = 67. Therefore, the last received unroutable UDP packet had a destination UDP port number of 67.
The following comm command displays UDP layer common communication statistics and then immediately zeroes the statistics:
comm udp zero
The following comm command displays a summary of all statistics for each IP layer and then immediately zeroes the communications statistics for all layers:
comm * zero