6.15 sctp
This command is used to provide a view of SCTP instance and association information.
Options
-a aname
This option is used to retrieve the measurements and information for a specific association.
-l
This option is used to display logging details for associations. The logging details are independent of the association state (close or open).
-p <port>
This option is used to retrieve the measurements for a specified SCTP port.
-r
This option is used to reset specified measurements. The associated report is not displayed.
-h
This option is used to display help information for the command. Either brief or full help reports can be generated.
-m
This option is used to display SCTP incoming/outgoing (IO) header audit reports for common and dedicated IO header pools. The IO header is a transmission sequence number (TSN) control block used in processing SCTP chunks. The report shows total, currently available, and minimum IO header counts for the IO header pool shared by all associations (common pool) and the IO header pool for each association (dedicated pool).
Example
pass:cmd="sctp -a aname":loc=1307pass:cmd="sctp -l":loc=1307
pass:cmd="sctp -l aname":loc=1307
pass:cmd="sctp -p port":loc=1307
pass:cmd="sctp -r -a aname":loc=1307
pass:cmd="sctp -r -l aname":loc=1307
pass:cmd="sctp -m"
pass:cmd="sctp"
Dependencies
The -r option can be specified in the same command as the -a, -p, or -l option. Otherwise, only one option can be specified at a time.
Notes
None
Output
Either brief or full help reports can be displayed. A full help report is generated by adding the -h full option to the command line.
This example shows a brief help report:
pass:loc=1305:cmd="sctp -h"
Usage: [ [[[-a aname] | [-p port] | [-l [aname]]] [-r [-s]]] | [-m] | [-h [full]] ]
Options:
(no parameters) display list of SCTP ports
-a aname display association report
-p port display SCTP port report
-r reset specified SCTP measurements
-m display IO header usage report
-l aname display association event log
-l display all event logs
-r -l reset all SCTP event logs
-r -s reset all SCTP measurements and pegs
-h displays command help (brief or full)
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
SCTP command complete
;This example shows a full help report:
pass:loc=1307:cmd="sctp -h full" Usage: sctp [[[[-a aname] | [-p port] | [-l [aname]]] [-r [-s]]] | [-m] | [-h [full]]]
Options:
(no parameters) display list of SCTP ports
-a aname display association report
-p port display SCTP port report
-r reset specified SCTP measurements
-m display IO header usage report
-l aname display association event log
-l display all event logs
-r -l reset all SCTP event logs
-r -s reset all SCTP measurements and pegs
-h displays command help (brief or full)
no parameters option
Summary list of all SCTP instances. To list all the SCTP
ports issue the following command:
sctp
-a aname option details
Retrieves detailed information and measurements for a specific
association. For example the following SCTP command will get the
measurements and detailed information for the association with
association name = assoc1.
sctp -a assoc1
In remote address field of output configured RHOST or ARHOST or both IP
address will be displayed based on the presence in association remote network
array
-p port option details
Retrieves detailed information for a specified SCTP port.
For example the following SCTP command will get the detailed
information for the SCTP port with a local port of 200.
sctp -p 200
In remote address field of output configured RHOST or ARHOST or both IP
address will be displayed based on the presence in association remote network
array
-r option details
Resets specified SCTP Measurements. See examples below.
Resets measurements for specified association:
sctp -r -a assoc
Resets measurements for all associations on port 2000:
sctp -r -p 2000
Resets measurements and event logs for all ports/associations:
sctp –r
Resets event logs for specified association:
sctp -r -l assoc
Resets event logs for all associations:
sctp -r -l
Resets measurements for all associations:
sctp -r -s
-m
This option displays SCTP IO header audit report for common and
dedicated IO header pools. The report shows total, currently
available and minimum (low water mark) IO header counts for common
and each association's dedicated pool.
IO header is a TSN control block used in processing SCTP chunks.
Common pool is IO header pool shared by all associations.
Dedicated pool is a per-association IO header pool.
sctp -m;
-l option details
This option displays logging details for associations. The logging
details are independent of the association state (close or open).
See examples below:
The following SCTP command will get the logging details
for all associations on the specified card.
sctp -l
The following SCTP command will get the logging
details for the association with association name = assoc1.
sctp -l assoc1
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
SCTP command complete
;This example shows a summary list of all SCTP ports. All SCTP ports and number of associations associated with each port is displayed.
pass:loc=1307:cmd="sctp"
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
Local Local IP Num of
Port Address Assoc
7001 192.168.110.35 1
2222 192.168.110.12 3
192.168.112.12
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
SCTP command complete
;This example shows specific SCTP association information and measurements:
pass:loc=1307:cmd="sctp –a assoc1" e1090203 10-11-01 12:52:56 EST EAGLE 43.0.0
Aname Local Local Remote Remote
Address Port Address Port
assoc1 192.168.110.12 2222 192.168.112.4 5555
192.168.112.12 192.168.110.2
Configuration State
Retransmission Mode = LIN State = OPEN
Min. Retransmission Timeout = 10000 ULP association id = 18
Max. Retransmission Timeout = 800000 Number of nets = 2
Max. Number of Retries = 10 Inbound Streams = 1
Min. Congestion Window = 3000 Outbound Streams = 2
Inbound Streams = 2
Outbound Streams = 2
Checksum Algorithm = crc32c
Send/Rcv Buffer Size = 204800
Nets Data
IP Address 192.168.112.4 State Reachable
Port 5555 Primary YES
MTU 1500 cwnd 16384
ssthresh 16384 RTO 120
IP Address 192.168.112.5 State Reachable
Port 5555 Primary NO
MTU 1500 cwnd 16384
ssthresh 16384 RTO 120
IP Address 192.168.110.2 State Reachable
Port 5555 Primary NO
MTU 1500 cwnd 16384
ssthresh 16384 RTO 120
Last Net Sent To = 192.168.112.4
Last Net Rcvd From = 192.168.112.4
Over All Eror Count = 0
Peers Rwnd = 13880
My Rwnd = 16384
Max Window = 16384
Initial Seq Number = 24130
Next Sending Seq Number = 124686
Last Acked Seq Number = 124669
Maximum Outbound Char Count = 16384
Current Outbound Char Count = 2112
Number Unsent Char Count = 0
Outbound Data Chunk Count = 16
Number Unsent = 0
Number To Retransmit = 0
ip datagrams rcvd = 155402
ip datagrams with data chunks rcvd = 120844
data chunks rcvd = 367908
data chunks read = 367900
dup tsns rcvd = 8
sacks rcvd = 38734
gap ack blocks rcvd = 3
heartbeat requests rcvd = 135
heartbeat acks rcvd = 52
heartbeat requests sent = 52
ip datagrams sent = 129254
ip datagrams with data chunks sent = 73084
data chunks sent = 396330
retransmit data chunks sent = 135
sacks sent = 64872
send failed = 0
retransmit timer count = 0
consecutive retransmit timeouts = 0
RTO between RMIN and RMAX inclusive = 6
RTT greater than RMAX = 0
fast retransmit count = 135
recv timer count = 0
heartbeat timer count = 244
none left tosend = 0
none left rwnd gate = 5
none left cwnd gate = 8
UNKNOWN = 0
;
e1090203 10-11-01 12:52:56 EST EAGLE 43.0.0
SCTP command complete
;Field Descriptions for sctp -a Output
- Local Address-IP Address of the near end. The address that the local SCTP endpoint should bind.
- Local Port-SCTP port number, if ULP wants it to be specified.
- Remote Address-IP Address of the far end/destination. Destination address for transporting DATA.
- Remote Port-Port number of the destination.
Configuration:[Following rows are SCTP configured values]
- Retransmission Mode-Configured retransmission mode. Values are “LIN” or “RFC”.
- Min. Retransmission Timeout-Minimum Retransmission Timeout value configured.
- Max. Number of Retries-Configured maximum number of retries.
- Min. Congestion Window-Minimum and initial congestion window.
- Inbound Streams-The maximum number of inbound streams this association allows the peer end to create. The value can not be 0.
- Outbound Streams-The maximum number of outbound streams this association allows the peer end to create. The value can not be 0.
State: [Following rows are association state values]
- State-State of the association.
- ULP association id-Upper Layer Protocol association id.
- Number of nets-Number of networks.
- Inbound Streams-Number of Inbound streams the far end can support. Min(requested,offered)
- Outbound Streams-Number of Outbound streams the far end can support. Min(requested,offered)
- Checksum Algorithm-32 bit checksum field that is included in the SCTP common header. The CRC32c checksum should be set by the sender of each SCTP packet to provide additional protection against data corruption in the network.
- Send/Rcv Buffer Size-The maximum size of data to be transmitted/received in bytes.
- Nets Data-All of the available remote IP addresses and if they are reachable or not.
- Last Net Sent To-IP address of the last network sent on.
- Last Net Rcvd From-IP address of the last network received on.
- Over All Error Count-Total error count on the association.
- Peers Rwnd-The peers receive window.
- My Rwnd-My receive window.
- Max Window-Maximum receive window (the peers receive window is set to this value until it is learned).
- Initial Seq Number-Initial sequence number started at.
- Next Sending Seq Number-Next Sending sequence number.
- Last Acked Seq Number-Highest consecutive TSN that has been Acked.
- Maximum Outbound Char Count-Maximum outbound byte count (high water mark).
- Current Outbound Char Count-Current outbound byte count.
- Number Unsent Char Count-Number of unsent bytes.
- Outbound Data Chunk Count-Number of data chunks that were sent.
- ip datagrams rcvd-Number of IP packets received.
- ip datagrams with data chunks rcvd-Number of IP packets containing SCTP data chunks received.
- data chunks rcvd-Number of SCTP data chunks received.
- data chunks read-Number of SCTP data chunks read.
- dup tsns rcvd-Number of duplicate data chunks received.
- sacks rcvd-Number of selective acknowledgements received.
- gap ack blocks rcvd-Indicates the number of GAP Ack Blocks included in a SACK. This value informs the peer endpoint of gaps in the received sequences of DATA chunks as represented by their TSNs.
- heartbeat requests rcvd-Number of heartbeat requests received.
- heartbeat acks rcvd-Number of heartbeat acknowledges received.
- heartbeat requests sent-Number of heartbeat requests sent.
- ip datagrams sent-Number of IP packets transmitted.
- ip datagrams with data chunks sent-Number of IP packets containing SCTP data transmitted.
- data chunks sent-Number of data chunks sent.
- retransmit data chunks sent-Number of retransmitted data chunks for this association.
- sacks sent-Number of selective acknowledgements sent.
- send failed-Number of selective acknowledgements failed.
- retransmit timer count-Reports the retransmit timer count. Number of times the transmit timer has expired.
- consecutive retransmit timeouts-Count of the number of times consecutive timeouts occurred.
- RTO between RMIN and RMAX inclusive-If the calculated RTO is between the configured RMIN value and the RMAX value inclusively, then increment this peg count. This peg serves as an indication that the RMIN value may be configured incorrectly and will possibly cause frequent retransmits to occur due to RTO fluctuations.
- RTT greater than RMAX-If the calculated RTT is above the configured RMAX value, then increment this peg count. This peg serves as an indication that the RMAX value is configured incorrectly and will possibly cause frequent retransmits to occur due to RTO fluctuations.
- fast retransmit count-Number of retransmits due to fast retransmit.
- recv timer count-Number of times the receive timer has expired.
- heartbeat timer count-Number of times the heartbeat timer has expired.
- none left tosend-Number of times a transmit is attempted and there is no data chunks to send.
- none left rwnd gate-Number of times a transmit is denied due to no receive window space at peer.
- none left cwnd gate-Number of times a transmit is denied due to exceeding the local congestion window.
- UNKNOWN-Number of retransmit Datagrams for this assoc for error monitoring.
This example shows SCTP port measurements:
pass:loc=1307:cmd="sctp –p 2222” rlghncxa03w 09-05-01 08:32:09 EST EAGLE5 41.0.0
Local Local IP Num of
Port Address Assoc
2222 192.168.110.12 3
192.168.112.12
Assoc Local Local Remote Remote
ID IP Address Port Address Port
1 192.168.110.12 2222 192.168.112.4 5555
192.168.112.12 192.168.110.2
2 192.168.110.12 2222 192.168.112.4 5555
192.168.112.12 192.168.110.3
3 192.168.110.12 2222 192.168.112.4 7777
192.168.112.12 192.168.110.4
no.of inqueued msgs = 0
max mtu = 1500
max init times = 8
max size reassembly = 1048576
default rwnd value = 16384
pre-open streams = 1
ip datagram counter = 2781
Timer Values: seconds millisecs
INIT 1 0
RECV 0 200
SEND 1 0
SHUTDOWN 0 300
HEARTBEAT 0 500
PMTU 600 0
;
rlghncxa03w 09-05-01 08:32:09 EST EAGLE5 41.0.0
SCTP command complete
;
This example shows all event logs for an association:
pass:loc=1307:cmd="sctp –l assoc1" rlghncxa03w 08-02-01 08:32:09 EST EAGLE 38.0.0
SCTP Event Log
Time Event Reason Ripaddr Rport
----------------------------------------------------------------------------
01:19:04.165 SACK send fail None 192.168.63.235 10001
01:19:04.175 Ck echo ack snd fail None 192.168.63.235 10001
01:19:04.180 Assoc UP Unknown 192.168.63.235 10001
01:19:04.180 Assoc Down Shutdown Rcv 192.168.63.235 10001
01:19:04.180 Shutdown ack send None 192.168.63.235 10001
01:19:06.425 INIT Rcv None 192.168.63.142 10002
01:19:06.425 Datagram Ignored No Assoc Found 192.168.63.142 10002
01:19:16.500 INIT tmr expr None 192.168.63.235 10001
01:19:16.500 SACK send fail None 192.168.63.235 10001
01:19:17.500 INIT tmr expr None 192.168.63.235 10001
01:19:17.500 SACK send fail None 192.168.63.235 10001
SCTP: command complete
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE 38.0.0
SCTP command complete
;This example shows event logs for all associations on a given card location:
pass:loc=1307:cmd="sctp –l" rlghncxa03w 08-02-01 08:32:09 EST EAGLE 38.0.0
SCTP Event Log
Time Event Reason Ripaddr Rport
----------------------------------------------------------------------------
01:19:04.165 SACK send fail None 192.168.63.235 10001
01:19:04.175 Ck echo ack snd fail None 192.168.63.235 10001
01:19:04.180 Assoc UP Unknown 192.168.63.235 10001
01:19:04.180 Assoc Down Shutdown Rcv 192.168.63.235 10001
01:19:04.180 Shutdown ack send None 192.168.63.235 10001
01:19:06.425 INIT Rcv None 192.168.63.142 10002
01:19:06.425 Datagram Ignored No Assoc Found 192.168.63.142 10002
01:19:16.500 INIT tmr expr None 192.168.63.235 10001
01:19:16.500 SACK send fail None 192.168.63.235 10001
01:19:17.500 INIT tmr expr None 192.168.63.235 10001
01:19:17.500 SACK send fail None 192.168.63.235 10001
SCTP: command complete
;Event descriptions for the sctp -l command
- Shutdwn ACK tmr expNo shutdown complete was received in response to the shutdown acknowledgement within the timer’s limits.
- PathMTU tmr expr-Indicates the PathMTU daemon timer has expired. At the expiration of this timer, path MTU for each path of each association that is not at the default of 1500 bytes is marked for retesting by raising that path’s MTU. The MTU will be adjusted accordingly when the next frame that exceeds the updated MTU occurs, thereby allowing the path MTU to reflect dynamic network conditions.
- INIT tmr expr-If the T1-initialized timer expires, the endpoint must retransmit INIT and restart the T1-init timer without changing state.
- RECV tmr expr-If the receive timer expires, then a stand alone SACK is sent to the peer and this timer is moved back to idle.
- Send tmr expr-This retransmission timer will expire when outstanding data sent to an address has not been acknowledged.
- Shutdwn tmr expr-No shutdown acknowledgement was received in response to the transmitted shutdown within the timer’s limits.
- HB tmr expr-No heartbeat acknowledgement was received in response to the transmitted heartbeat within the timer’s limits.
- Cookie tmr expr-No cookie acknowledgement was received in response to the transmitted cookie echo within the timer’s limits.
- New Cookie tmr expr-When this occurs, time to schedule another timer for the cookie change.
- Tx CHK tmr expr-Transmit check timer expired.
- Unknwn tmr expr-An unknown timer expired.
- INIT Rcv-An INIT was received for an association.
- Datagram Ignored-When an unrecognized chunk time is encountered.
- Assoc Down-An association is taken out of service.
- INTF Down-Interface on an association is down and out of consideration for selection.
- INTF Up-Interface on an association is up and now back in consideration for selection.
- Datagram Send Fail-IP Packet failed to send.
- Ignore Cookie-Happens when the cookie is not received first.
- Ignore INIT-If the INIT message is not received first, is not the only chunk, is received with a non-zero Verification tag, if the T bit value is 1 or if mandatory parameters are missing then the INIT message is discarded/ignored.
- Ignore INIT ACK-If the INIT ACK is not first, not the only chunk or too small (missing mandatory parameters), then the INIT ACK chunk is ignored.
- Ignore Shutdwn ACK-The SHUTDOWN Complete MUST be the only chunk, otherwise the packet is ignored.
- Ignore HB ACK-The received HB acknowledgement was ignored due to asymmetric routing (HBA not received on the same interface the original HB was transmitted on).
- Op Error Rcv-Occurs when the peer notifies that we are using an invalid stream or we received a Stale cookie.
- Assoc UP-Association up notification was generated for the upper layer.
- Assoc Restart-Association restart notification was generated for the upper layer.
- Shutdn ack send fail-Attempt to transmit a shutdown acknowledgement chunk failed.
- Shutdown ack send-A shutdown acknowledgement chunk was transmitted to the far end.
- Cookie ack send fail-An attempt to send a Cookie ACK to a specified address failed.
- Cookie ack send-A Cookie ACK was sent to a specified address.
- Stale Cookie send fail-Attempt to send a stale cookie error to the far end failed.
- Stale Cookie send-A stale cookie error was sent to the far end.
- HB req send fail-Attempt to send a HB to the far end failed.
- HB resp send fail-Attempt to send a HB acknowledgement to the far end failed.
- Shutdown send fail-The Shutdown chunk sent to a specified association failed.
- Shutdown send-A Shutdown chunk was sent to a specified association.
- Abort send fail-The Abort chunk sent to a specified association failed.
- Abort send-An Abort chunk was sent to a specified association.
- Abt W cause snd fail-The Abort chunk sent with the Cause parameter to a specified association failed.
- Abort wth cause send-An Abort chunk was sent to a specified association with the Cause parameter.
- SACK send fail-Attempt to send a SACK to the far end failed.
- Initiate send fail-An INIT chunk is used to initiate a SCTP association between two endpoints. This event occurs when an INIT send has failed.
- Initiate send-An INIT chunk is used to initiate a SCTP association between two endpoints. This event occurs when an INIT was successfully sent.
- OprErr send-An endpoint sends this chunk to its peer endpoint to notify it of certain error conditions. It contains one or more error causes. This event occurs when the OPPErr was successfully sent.
- OprErr send Fail-This event occurs when the OPPErr send failed.
- Init ack send fail-This event occurs when an INIT ACK send has failed.
- Init ack sent-This event occurs when an INIT ACK was successfully sent.
- Ck echo ack snd fail-An attempt to send a Cookie-Echo has failed.
- Cookie echo ack send-A cookie echo was sent to the far end in response to an accepted init-ack.
- Chunks send fail-This event occurs when a chunk that was sent has failed.
- Chunks send-This event occurs when a chunk has been successfully sent.
- Cookie send fail-Attempt to transmit a cookie to the far end during the four-way handshake failed.
- Init ack recv-Init acknowledgement chunk was received.
- Shutdown ack recv-Shutdown ack chunk was received.
- Shutdown ack sent-Shutdown ack chunk was transmitted to the far end in response to a received shutdown chunk.
- Abort sent-An Abort message was sent to ungracefully shutdown an association.
- Shutdn complete sent-Shutdown complete chunk was transmitted to the far end.
This example clears the logged events for an association:
pass:loc=1307:cmd="sctp –r –l assoc1" Command Accepted - Processing
rlghncxa03w 08-02-01 08:32:09 EST EAGLE 38.0.0
All event logs for specified association have been reset.
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE 38.0.0
SCTP command complete
;This example resets association measurements:
pass:loc=1307:cmd="sctp –r -a assoc1"
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
PASS: Command sent to card
Association measurements have been reset.
SCTP command complete
This example resets port measurements:
pass:loc=1307:cmd="sctp –r –p 4001"
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
PASS: Command sent to card
Port measurements have been reset.
SCTP command completeThis example resets all measurements and event logs:
pass:loc=1307:cmd="sctp –r"
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
PASS: Command sent to card
All measurements and logs have been reset.
SCTP command completeThis example resets measurements for all ports/associations:
pass:loc=1307:cmd="sctp –r -s" Command Accepted - Processing
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
All measurements have been reset.
;
rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
SCTP command complete
;This example shows an IO header audit report:
sctp -m rlghncxa03w 08-02-01 08:32:09 EST EAGLE5 38.0.0
IO Headers in Common Pool (Total/CurrentFree/Min): 20494/20494/20494
Inst ID Sock Idx Assoc ID IO Headers(Total/CurrentFree/Min)
2 0 1 400/400/398
;
None.