Time at which the initial sync operation was started (in seconds since 1st Jan 1970 00:00:00)
- nsr-down-time-down-stream: integer
-
Time at which NSR went down
- is-only-receive-path-replication: boolean
-
Is replication limited to receive-path only
- fssn-offset: integer
-
Offset of FSSN in input stream
- address-family: string internetwork, ip-version6
-
Address family
- init-sync-error: string
-
Initial sync failure reason, if any
- is-admin-configured-up: boolean
-
Is NSR administratively configured?
- fist-standby-sequence-number-up-stream: integer
-
FSSN for the upstream partner
- nsr-down-time: integer
-
Time at which NSR went down
- packet-hold-queue: TCP-NSR-HOLD-QUEUE-NODE
-
Sequence Number and datalength of each node in hold_pakqueue
-
TCP-NSR-HOLD-QUEUE-NODE - max-number-of-held-internal-ack: string
-
Max number of internal acks have been held
- init-sync-start-time: integer
-
Time at which the initial sync operation was started (in seconds since 1st Jan 1970 00:00:00)
- nsr-down-time-up-stream: integer
-
Time at which NSR went down
- cookie: integer
-
Cookie provided by active APP
- init-sync-end-time-down-stream: integer
-
Time at which the initial sync operation was ended (in seconds since 1st Jan 1970 00:00:00)
- is-init-sync-in-progress: boolean
-
Is initial-sync currently in progress?
Example
{
"max-number-of-held-packet-reach-time": "integer",
"init-sync-end-time": "integer",
"is-session-replicated": "boolean",
"vrf-id": "integer",
"peer-endp-hdl-down-stream": "integer",
"max-number-of-held-packet": "string",
"init-sync-start-time-down-stream": "integer",
"peer-endp-hdl-up-stream": "integer",
"foreign-address": [
{
"entry": "string"
}
],
"internal-ack-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"init-sync-flags": "integer",
"foreign-port": "integer",
"set-information": {
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
},
"is-session-synced": "boolean",
"nsr-down-reason-up-stream": "string",
"init-sync-end-time-up-stream": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"fist-standby-sequence-number-down-stream": "integer",
"pcb": "integer",
"sequence-number-of-init-sync-up-stream": "integer",
"nsr-down-reason": "string",
"max-number-of-held-internal-ack-reach-time": "integer",
"sequence-number-of-init-sync": "integer",
"local-address": [
{
"entry": "string"
}
],
"local-port": "integer",
"fist-standby-sequence-number": "integer",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-ds-operational-up": "string",
"nsr-down-reason-down-stream": "string",
"sequence-number-of-init-sync-down-stream": "integer",
"init-sync-start-time-up-stream": "integer",
"nsr-down-time-down-stream": "integer",
"is-only-receive-path-replication": "boolean",
"fssn-offset": "integer",
"address-family": "string",
"init-sync-error": "string",
"is-admin-configured-up": "boolean",
"fist-standby-sequence-number-up-stream": "integer",
"nsr-down-time": "integer",
"packet-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"max-number-of-held-internal-ack": "string",
"init-sync-start-time": "integer",
"nsr-down-time-up-stream": "integer",
"cookie": "integer",
"init-sync-end-time-down-stream": "integer",
"is-init-sync-in-progress": "boolean"
}
TCP-CONN-STATES-BAG:
TCP Connection states
- nagle-wait: boolean
-
Nagle has delayed output
- fin-sent: boolean
-
FIN has been sent
- ack-needed: boolean
-
Send an ACK
- path-mtu-ager: boolean
-
Path MTU aging timer is running
- pushed: boolean
-
A segment is pushed due to MSG_PUSH
- in-syn-cache: boolean
-
Connection is in SYN cache
- probing: boolean
-
Probing a closed window
- need-push: boolean
-
Need to push data out
Example
{
"nagle-wait": "boolean",
"fin-sent": "boolean",
"ack-needed": "boolean",
"path-mtu-ager": "boolean",
"pushed": "boolean",
"in-syn-cache": "boolean",
"probing": "boolean",
"need-push": "boolean"
}
TCP-ADDRESS-TYPE:
TCP ADDRESS TYPE
- af-name: string ipv4, ipv6
-
AFName
- ipv6-address: string
-
IPv6 Address
- ipv4-address: string
-
IPv4 Address
Example
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TCP-NSR-AUDIT-COUNTERS-AGGR-NODE:
Aggregate counters for NSR audit
- aggr-only: TCP-NSR-AUDIT-COUNTERS-AGGR-ONLY-NODE
-
Aggregate only audit counters
- common: TCP-NSR-AUDIT-COUNTERS-NODE
-
Common audit counters
Example
{
"aggr-only": {
"mark-session-set-nack-rcv-drop-aggr": "integer",
"mark-session-set-ack-rcv-drop-aggr": "integer",
"mark-session-set-rcv-drop-aggr": "integer",
"sweep-session-set-rcv-drop-aggr": "integer",
"session-rcv-drop-aggr": "integer",
"session-set-response-rcv-drop-aggr": "integer"
},
"common": {
"mark-session-set-ack-rcv-drop": "integer",
"session-send-drop": "integer",
"sweep-session-set-send": "integer",
"mark-session-set-ack-send-drop": "integer",
"session-set-response-send-drop": "integer",
"sweep-session-set-rcv-drop": "integer",
"abort": "integer",
"mark-session-set-ack-send": "integer",
"mark-session-set-rcv-drop": "integer",
"sweep-session-set-rcv": "integer",
"session-rcv": "integer",
"mark-session-set-nack-send": "integer",
"session-send": "integer",
"mark-session-set-nack-rcv": "integer",
"session-set-response-rcv-drop": "integer",
"session-set-response-rcv": "integer",
"mark-session-set-send-drop": "integer",
"mark-session-set-ack-rcv": "integer",
"mark-session-set-rcv": "integer",
"mark-session-set-send": "integer",
"session-set-response-send": "integer",
"mark-session-set-nack-rcv-drop": "integer",
"mark-session-set-nack-send-drop": "integer",
"session-rcv-drop": "integer",
"sweep-session-set-send-drop": "integer"
}
}
TCP-TIMER-BAG:
TCP Timer Info
- timer-expirations: integer
-
Count of timer expirations
- timer-activations: integer
-
Count of timer activations
- timer-type: string retransmission-timer, window-probe-timer, timewait-state-timer, ack-hold-timer, keep-alive-timer, pmtu-ager-timer, retransmission-giveup-timer, throttle-timer
-
Timer Type
- timer-next-activation: integer
-
Timer next activation (msec)
Example
{
"timer-expirations": "integer",
"timer-activations": "integer",
"timer-type": "string",
"timer-next-activation": "integer"
}
TCP-SH-KEY-BAG:
Detailed information about a TCP AO key
- overlapping-key-available: boolean
-
Is overlapping key available?
- is-valid: boolean
-
Is key valid
- crypt-algo: string not-configured, aes-128-cmac-96, hmac-sha1-12, md5-16, sha1-20, hmac-md5-16, hmac-sha1-20, aes-128-cmac, aes-256-cmac, hmac-sha1-96, hmac-sha-256
-
Cryptography algorithm associated with the key
- is-configured: boolean
-
Is key configured?
- reason: string none, incomplete, lifetime-not-same, send-id-invalid, recv-id-invalid
-
Key invalid reason
- invalidated-key: TCP-SH-KEY-ID-BAG
-
List of keys invalidated
-
TCP-SH-KEY-ID-BAG - overlapping-key: integer
-
Overlapping key identifier
- recv-id: integer
-
Receive ID
- is-active: boolean
-
Is key active
- send-id: integer
-
Send ID
- is-expired: boolean
-
Is key expired
- key-id: integer
-
Key identifier
Example
{
"overlapping-key-available": "boolean",
"is-valid": "boolean",
"crypt-algo": "string",
"is-configured": "boolean",
"reason": "string",
"invalidated-key": [
{
"key-id": "integer"
}
],
"overlapping-key": "integer",
"recv-id": "integer",
"is-active": "boolean",
"send-id": "integer",
"is-expired": "boolean",
"key-id": "integer"
}
TCP-NSR-SSCB-BRIEF-BAG:
Summary Information about an SSO/NSR Session-set
- well-known-port: integer
-
Well Known Port of the client
- client-instance: integer
-
Instance of the Client that owns this Session-set
- number-of-sessions: integer
-
Number of Sessions in the set
- local-instance: integer
-
Instance of the client application on the local node
- set-id: integer
-
ID of this Session-set
- pid: integer
-
PID of the Client that owns this Session-set
- protect-node: string
-
The node protecting this set
- protect-instance: integer
-
Instance of the client application on the protection node
- client-name: string
-
the name of Clinet that owns this Session-set
- number-of-synced-sessions-down-stream: integer
-
How many sessions are synced with downstream partner
- local-node: string
-
Local node of this set
- sscb: integer
-
Address of the Session Set Control Block
- mode: integer
-
Session-set mode
- sso-role: integer
-
TCP role for this set?
- number-of-synced-sessions-up-stream: integer
-
How many sessions are synced with upstream partner
- address-family: string internetwork, ip-version6
-
Address Family of the sessions in this set
- is-sscb-init-sync-ready: boolean
-
Is the SSCB ready for another initial sync?
- is-init-sync-in-progress: boolean
-
Is an initial sync in progress currently?
Example
{
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
TRANSP-CLIENT-STATS-BAG:
Aggregated statistics of a transport client
- ipv6-received-packets: integer
-
Total IPv6 packets received from app
- ipv4-received-packets: integer
-
Total IPv4 packets received from client
- ipv6-sent-packets: integer
-
Total IPv6 packets sent to app
- client-name: string
-
Transport client name
- ipv4-sent-packets: integer
-
Total IPv4 packets sent to client
- client-jid: string
-
Job ID of the transport client
Example
{
"ipv6-received-packets": "integer",
"ipv4-received-packets": "integer",
"ipv6-sent-packets": "integer",
"client-name": "string",
"ipv4-sent-packets": "integer",
"client-jid": "string"
}
TCP-NSR-SSCB-STATS-BAG:
SSO/NSR statistics of a Session Set
- set-id: integer
-
ID of this Session-set
- number-of-nsr-resets: integer
-
Number of times NSR was reset for the session
- number-of-failed-init-sync: integer
-
no. of initial-sync failures
- sscb: integer
-
SSCB Address
- number-of-succeeded-init-sync: integer
-
no. of initial-sync successes
- number-of-failover: integer
-
Number of Switch-overs
- number-of-attempted-init-sync: integer
-
no. of initial-sync attempts
- last-cleared-time: integer
-
Time of last clear (in seconds since 1st Jan 1970 00:00:00)
Example
{
"set-id": "integer",
"number-of-nsr-resets": "integer",
"number-of-failed-init-sync": "integer",
"sscb": "integer",
"number-of-succeeded-init-sync": "integer",
"number-of-failover": "integer",
"number-of-attempted-init-sync": "integer",
"last-cleared-time": "integer"
}
TCP-SH-PCB-STATS-BAG:
TCP PCB Statistics
- send-window-shrink-ignored: integer
-
No. of times send window shrinkage by peer was ignored
- send-queue-failed: integer
-
Packets failed to be queued to v4/v6 IO
- write-io-counts: TCP-IO-COUNTS-BAG
-
Write I/O counts
- received-packets-queued: integer
-
Received packets queued to application
- send-packets-queued: integer
-
Packets queued to v4/v6 IO
- segment-instruction-received: integer
-
Segment Instruction received from partner node
- is-paw-socket: boolean
-
PAW or non-PAW socket?
- send-packets-queued-net-io: integer
-
Packets queued to NetIO
- vrf-id: integer
-
VRF Id
- packets-received: integer
-
Packets received from network
- packets-sent: integer
-
Packets received from application
- read-io-time: integer
-
Time at which receive buffer was last read from
- write-io-time: integer
-
Time at which send buffer was last written to
- receive-queue-failed: integer
-
Received packets failed to be queued to application
- pcb: integer
-
PCB Address
- read-io-counts: TCP-IO-COUNTS-BAG
-
Read I/O counts
- async-session-stats: TCP-ASYNC-SESSION-STATS-BAG
-
Statistics of Async TCP Sessions
- xipc-pulse-received: integer
-
XIPC pulses received from application
- send-queue-net-io-failed: integer
-
Packets failed to be queued to NetIO
Example
{
"send-window-shrink-ignored": "integer",
"send-queue-failed": "integer",
"write-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"received-packets-queued": "integer",
"send-packets-queued": "integer",
"segment-instruction-received": "integer",
"is-paw-socket": "boolean",
"send-packets-queued-net-io": "integer",
"vrf-id": "integer",
"packets-received": "integer",
"packets-sent": "integer",
"read-io-time": "integer",
"write-io-time": "integer",
"receive-queue-failed": "integer",
"pcb": "integer",
"read-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"async-session-stats": {
"data-write-error-num": [
{
"entry": "integer"
}
],
"data-write-byte": [
{
"entry": "integer"
}
],
"control-write-error-num": [
{
"entry": "integer"
}
],
"async-session": "boolean",
"data-read-byte": [
{
"entry": "integer"
}
],
"control-read-error-num": [
{
"entry": "integer"
}
],
"data-read-success-num": [
{
"entry": "integer"
}
],
"data-read-error-num": [
{
"entry": "integer"
}
],
"data-write-success-num": [
{
"entry": "integer"
}
],
"control-write-success-num": [
{
"entry": "integer"
}
],
"control-read-success-num": [
{
"entry": "integer"
}
]
},
"xipc-pulse-received": "integer",
"send-queue-net-io-failed": "integer"
}
TCP-SH-TABLE-BAG:
Detailed information about a TCP connection
- rqst-send-wnd-scale: integer
-
Requested send window scale
- established-time: integer
-
Time at which connection is established
- send-sack-hole: SACKHOLE-BAG
-
Sorted list of sack holes
-
SACKHOLE-BAG - recvbuf-hiwat: integer
-
Receive buffer's high water mark
- pcb: integer
-
PCB Address
- local-address: TCP-ADDRESS-TYPE
-
Local address
- retries: integer
-
Number of retries
- max-mss: integer
-
Highest MSS ever used
- receive-buf-state-flags: TCP-SOCKBUF-STATES-BAG
-
Receive buffer state flags
- send-max-sequence-num: integer
-
Highest sequence number sent
- socket-option-flags: TCP-SOCK-OPTIONS-BAG
-
Socket option flags
- tcpcb: integer
-
TCPCB Address
- srtv: integer
-
Smoothed round trip time variance * 4 (msec)
- last-ack-sent: integer
-
ACK number of a sent segment
- srtt: integer
-
Smoothed round trip time * 8 (msec)
- packet-priority: string unspecified-packet, normal-packet, medium-packet, high-packet, crucial-packet
-
Priority given to packets on this socket
- sack-blk: SACKBLK-BAG
-
Seq nos. of sack blocks
-
SACKBLK-BAG - krtt: integer
-
Round trip time (karn algorithm) (msec)
- local-pid: integer
-
Id of the local process
- request-receive-window-scale: integer
-
Requested receive window scale
- min-rtt: integer
-
Min RTT (msec)
- is-retrans-forever: boolean
-
Retransimit forever?
- receive-adv-window-size: integer
-
Receive advertised window size in bytes
- foreign-address: TCP-ADDRESS-TYPE
-
Foreign address
- peer-mss: integer
-
Max segment size offered by the peer in bytes
- keep-alive-time: integer
-
Keepalive time (msec)
- fib-pd-ctx: object[]
-
Cached fib pd context
-
object - entry: integer
-
Cached fib pd context
- local-port: integer
-
Local port
- foreign-port: integer
-
Foreign port
- rxsy-naclname: string
-
RX Syn acl name
- socket-state-flags: TCP-SOCK-STATES-BAG
-
Socket state flags
- packet-ttl: integer
-
TTL to be applied to transmited packets
- save-queue-size: integer
-
Save queue (out-of seq data) size in bytes
- connect-retries: integer
-
Number of times connect will be retried?
- num-labels: integer
-
Number of labels returned by fib lookup
- recvbuf-lowwat: integer
-
Receive buffer's low water mark
- output-ifhandle: integer
-
Cached Outgoing interface handle
- receive-next-sequence-num: integer
-
Next sequence number expected
- sock-error: string
-
Socket error code
- giveup-time: integer
-
Giveup time (msec)
- queue-length: integer
-
Incoming connection queue size
- address-family: string ipv4, ipv6
-
Address Family
- rtto: integer
-
Round trip timeout (msec)
- syn-wait-time: integer
-
SYN wait time (msec)
- ack-hold-time: integer
-
ACK hold time (msec)
- timer: TCP-TIMER-BAG
-
Timers
-
TCP-TIMER-BAG - current-receive-queue-size: integer
-
Current receive queue size in bytes
- connection-state: string closed, listen, syn-sent, syn-received, established, close-wait, fin-wait1, closing, last-ack, fin-wait2, time-wait
-
Connection state
- fib-pd-ctx-size: integer
-
Cached fib pd context size
- vrf-id: integer
-
VRF Id
- max-receive-queue-size: integer
-
Max receive queue size in bytes
- send-buf-state-flags: TCP-SOCKBUF-STATES-BAG
-
Send buffer state flags
- current-receive-queue-packet-size: integer
-
Current receive queue size in packets
- mss: integer
-
Max segment size calculated in bytes
- receive-initial-sequence-num: integer
-
Initial receive sequence number
- request-flags: TCP-CONN-FEATURES-BAG
-
Connection request flags
- local-app-instance: integer
-
Instance number of the local process
- send-pdu-count: integer
-
of PDU's in Send Buffer
- soft-error: string
-
Error code from ICMP Notify
- socket-error: integer
-
Socket error status
- connect-retry-interval: integer
-
Connect retry interval in seconds
- send-next-sequence-num: integer
-
Sequence number of next data to be sent
- time-stamp-recent-age: integer
-
Timestamp when last updated
- sendbuf-hiwat: integer
-
Send buffer's high water mark
- max-rtt: integer
-
Max RTT (msec)
- feature-flags: TCP-CONN-FEATURES-BAG
-
Connection feature flags
- send-unack-sequence-num: integer
-
Sequence number of unacked data
- time-stamp-recent: integer
-
Timestamp from remote host
- packet-tos: integer
-
Type of Service value to be applied to transmistted packets
- send-congestion-window-size: integer
-
Send congestion window size in bytes
- recvbuf-datasize: integer
-
Receive buffer's data size
- max-send-queue-size: integer
-
Max send queue size in bytes
- queue-zero-length: integer
-
Incoming half-connection queue size
- fib-label-output: object[]
-
Cached Label stack
-
object - entry: integer
-
Cached Label stack
- min-mss: integer
-
Lowest MSS ever used
- current-send-queue-size: integer
-
Current send queue size in bytes
- sendbuf-notify-thresh: integer
-
Send buffer's notify threshold
- send-window-size: integer
-
Send window size in bytes
- receive-window-size: integer
-
Receive window size in bytes
- send-initial-sequence-num: integer
-
Initial send sequence number
- hash-index: integer
-
Index of the Hash Bucket
- state-flags: TCP-CONN-STATES-BAG
-
Connection state flags
- send-window-scale: integer
-
Window scaling for send window
- max-receive-queue-packet-size: integer
-
Max receive queue size in packets
- sendbuf-lowwat: integer
-
Send buffer's low water mark
- so: integer
-
Socket Address
- auto-rearm: integer
-
Socket auto rearm state
- queue-limit: integer
-
Incoming connection queue limit
- receive-window-scale: integer
-
Window scaling for receive window
Example
{
"rqst-send-wnd-scale": "integer",
"established-time": "integer",
"send-sack-hole": [
{
"start": "integer",
"retransmitted": "integer",
"end": "integer",
"duplicated-ack": "integer"
}
],
"recvbuf-hiwat": "integer",
"pcb": "integer",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"retries": "integer",
"max-mss": "integer",
"receive-buf-state-flags": {
"async-io": "boolean",
"locked": "boolean",
"output-select": "boolean",
"waiting-for-data": "boolean",
"io-timer-set": "boolean",
"out-of-band-select": "boolean",
"not-interruptible": "boolean",
"delayed-wakeup": "boolean",
"input-select": "boolean",
"wakeup": "boolean",
"connect-wakeup": "boolean",
"waiting-for-lock": "boolean"
},
"send-max-sequence-num": "integer",
"socket-option-flags": {
"linger": "boolean",
"reuse-address": "boolean",
"keep-alive": "boolean",
"out-of-band-inline": "boolean",
"broadcast": "boolean",
"dont-route": "boolean",
"debug": "boolean",
"reuse-port": "boolean",
"accept-connection": "boolean",
"use-loopback": "boolean",
"nonblocking-io": "boolean"
},
"tcpcb": "integer",
"srtv": "integer",
"last-ack-sent": "integer",
"srtt": "integer",
"packet-priority": "string",
"sack-blk": [
{
"start": "integer",
"end": "integer"
}
],
"krtt": "integer",
"local-pid": "integer",
"request-receive-window-scale": "integer",
"min-rtt": "integer",
"is-retrans-forever": "boolean",
"receive-adv-window-size": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"peer-mss": "integer",
"keep-alive-time": "integer",
"fib-pd-ctx": [
{
"entry": "integer"
}
],
"local-port": "integer",
"foreign-port": "integer",
"rxsy-naclname": "string",
"socket-state-flags": {
"is-confirming": "boolean",
"cant-receive-more": "boolean",
"block-close": "boolean",
"received-at-mark": "boolean",
"is-connected": "boolean",
"cant-send-more": "boolean",
"privileged": "boolean",
"is-detached": "boolean",
"is-solock": "boolean",
"block-send": "boolean",
"no-file-descriptor-reference": "boolean",
"is-disconnecting": "boolean",
"async-io-notify": "boolean",
"is-connecting": "boolean",
"block-receive": "boolean"
},
"packet-ttl": "integer",
"save-queue-size": "integer",
"connect-retries": "integer",
"num-labels": "integer",
"recvbuf-lowwat": "integer",
"output-ifhandle": "integer",
"receive-next-sequence-num": "integer"
}
LPTS-RX-FILTER:
LPTS Interface Filter
- local-address: IP-ADDR
-
Local address
- interface-name: string
-
Interface name
- packet-type: PKT-TYPE
-
Protocol-specific packet type
- local-length: integer
-
Local address length
- priority: integer
-
Priority
- flow-types-info: integer
-
flow information
- receive-remote-port: integer
-
Receive Remote port
- ttl: integer
-
Minimum TTL
- remote-address: IP-ADDR
-
Remote address
- receive-local-port: integer
-
Receive Local port
- remote-length: integer
-
Remote address length
Example
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
TCP-NSR-PCB-STATS-BAG:
SSO/NSR statistics of a TCP connection
- internal-ack-drops-stale: integer
-
Number of stale iACKs dropped
- snd-counters: TCP-NSR-SND-COUNTERS-NODE
-
Send path counters for the PCB
- internal-ack-drops-not-replicated: integer
-
Number of iACKs dropped because session is not replicated
- number-of-times-nsr-up: integer
-
no. of times nsr went up
- number-of-times-nsr-disabled: integer
-
no. of times nsr was disabled
- internal-ack-drops-initsync-first-phase: integer
-
Number of iACKs dropped because 1st phase of init-sync is in progress
- internal-ack-drops-immediate-match: integer
-
Number of iACKs not held because of an immediate match
- number-of-timers-nsr-down: integer
-
no. of times nsr went down
- pcb: integer
-
PCB Address
- number-of-times-nsr-fail-over: integer
-
no. of times fail-over occured
- last-cleared-time: integer
-
Time of last clear (in seconds since 1st Jan 1970 00:00:00)
Example
{
"internal-ack-drops-stale": "integer",
"snd-counters": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
},
"internal-ack-drops-not-replicated": "integer",
"number-of-times-nsr-up": "integer",
"number-of-times-nsr-disabled": "integer",
"internal-ack-drops-initsync-first-phase": "integer",
"internal-ack-drops-immediate-match": "integer",
"number-of-timers-nsr-down": "integer",
"pcb": "integer",
"number-of-times-nsr-fail-over": "integer",
"last-cleared-time": "integer"
}
PKT-TYPE:
PKT TYPE
- message-id: string
-
Message type in number
- icm-pv6-message-type: string
-
ICMPv6 message type
- icmp-message-type: string
-
ICMP message type
- type: string icmp, icm-pv6, igmp, unknown
-
Type
- igmp-message-type: string
-
IGMP message type
Example
{
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
}
TCP-SH-STATS-BAG:
TCP Statistics
- embryonic-connection-dropped: integer
-
Embryonic connections dropped
- socket-layer-packets: integer
-
Packets owned by the socket layer
- high-water-mark-throttle: integer
-
Number of times high water mark throttle was on
- data-bytes-sent: integer
-
Data bytes sent
- syn-cache-duplicate-sy-ns: integer
-
SYN Cache duplicate SYNs received
- after-window-packets-received: integer
-
After-window packets received
- total-pakets-sent: integer
-
Total packets sent
- keep-alive-timeouts: integer
-
Keepalive timeouts
- synacl-match-pkts-dropped: integer
-
Received packets dropped due to ACL DENY on SYN pkts
- retransmit-timeouts: integer
-
Retransmit timeouts (incl. data packets)
- connections-dropped: integer
-
connections dropped
- data-bytes-received-in-sequence: integer
-
Data bytes received in sequence
- syn-cache-added: integer
-
SYN Cache entries added
- urgent-only-packets-sent: integer
-
Urgent only packets sent
- try-lock-dropped: integer
-
Segments dropped due to trylock fail
- iq-sock-writes: integer
-
Number of write attempts from socket-lib into an IQ
- iq-sock-aborts: integer
-
Number of aborted socket-lib writes
- packets-received-after-close-packet: integer
-
Packets received after close
- packet-failures: integer
-
Packet allocation errors
- low-water-mark-throttle: integer
-
Number of times low water mark throttle was on
- ack-packets-received: integer
-
Ack packets received
- no-throttle: integer
-
Number of times throttle mode was off
- syn-cache-overflow: integer
-
SYN Cache entries dropped due to overflow
- connections-requested: integer
-
Connection requests sent
- keep-alive-dropped: integer
-
Connection drops due to keepalive timeouts
- partial-duplicate-ack-received: integer
-
Packets with partial dup data
- after-window-bytes-received: integer
-
After-window bytes received
- connection-rate-limited: integer
-
Connections rate-limited
- stalled-timer-tickle-count: integer
-
Number of times a stalled tcp timer was tickled
- connections-established: integer
-
Connections established
- duplicate-packets-received: integer
-
Duplicate packets received
- connections-forcibly-closed: integer
-
Connections forcibly closed
- packets-retransmitted: integer
-
Data packets retransmitted
- iq-sock-retries: integer
-
Number of retried write attempts
- reassembly-packets: integer
-
Packets owned by TCP reassembly
- total-packets-received: integer
-
Total packets received
- established-connections-reset: integer
-
Established connections reset
- out-of-order-bytes-received: integer
-
Out-of-order bytes received
- pulse-errors: integer
-
Punt (down to ip) failures
- syn-cache-count: integer
-
Current number of SYN cache entries
- num-open-sockets: integer
-
Number of Open sockets
- iq-ingress-drops: integer
-
Number of total ingress dropped packets
- total-i-qs: integer
-
Number of TCP internal queues in use
- stalled-timer-tickle-time: integer
-
Last timestamp when a stalled tcp timer was tickled
- syn-cache-timed-out: integer
-
SYN Cache entries timed out
- syn-cache-dropped: integer
-
SYN Cache entries dropped (no route/mem)
- persist-dropped: integer
-
Segments dropped due to window probe
- syn-cache-unreach: integer
-
SYN Cache entries dropped due to ICMP unreach
- syn-cache-reset: integer
-
SYN Cache entries dropped due to RST
- malformed-packets-received: integer
-
Packets received with malformed header
- window-probe-packets-sent: integer
-
Window probe packets sent
- send-auth-packets-dropped: integer
-
Total transmit packets dropped due to authentication failures
- ack-packets-for-unsent-received: integer
-
Ack packets for unsent data
- iqs-total-ingpacket: object[]
-
Total Number of Ingress packets on TCP iqs
-
object - entry: integer
-
Total Number of Ingress packets on TCP iqs
- received-packets-dropped-stale-c-hdr: integer
-
Received packets dropped due to stale cached header
- control-packets-sent: integer
-
Control (SYN|FIN|RST) packets sent
- delay-ack-packets-sent: integer
-
Delay ack packets sent
- data-packets-received-in-sequence: integer
-
Data packets received in sequence
- ack-only-packets-sent: integer
-
Ack only packets sent (incl. delay)
- received-auth-packets-dropped: integer
-
Received packets dropped due to authentication failures
- paws-dropped: integer
-
Segments dropped due to PAWS
- window-update-packets-received: integer
-
Window update packets received
- bad-checksum-packets-received: integer
-
Packets received with bad checksum
- connections-accepted: integer
-
Connection requests accepted
- duplicated-ack-packets-received: integer
-
Duplicate ack packets
- connections-closed: integer
-
connections closed (incl. drops)
- bytes-retransmitted: integer
-
Data bytes retransmitted
- truncated-write-iov: integer
-
Segments truncated due to insufficient Write I/O vectors
- syn-cache-aborted: integer
-
SYN Cache entries aborted (no mem)
- mss-down: integer
-
Number of times MSS was decreased
- keep-alive-probes: integer
-
Keepalive probes sent
- no-port-packets-received: integer
-
Packets rcceived with no wild listener
- send-packets-dropped: integer
-
Total transmit packets dropped due to general failures
- too-short-packets-received: integer
-
Packets received with too short size
- received-packets-dropped: integer
-
Received packets dropped due to general failures
- syn-cache-completed: integer
-
SYN Cache connections completed
- syn-cache-bucket-oflow: integer
-
SYN Cache entries dropped due to bucket overflow
- mss-up: integer
-
Number of times MSS was increased
- rst-packets-sent: integer
-
RST packets sent
- retransmit-dropped: integer
-
Connection drops during retransmit timeouts
- ackbytes-received: integer
-
Bytes acked by ack packets
- recovered-packets: integer
-
Packets freed after starvation
- duplicate-bytes-received: integer
-
Duplicate bytes received
- data-pakets-sent: integer
-
Data packets sent
- partial-duplicate-bytes-received: integer
-
Bytes with partial dup data
- connections-failed: integer
-
Connections failed
- iqs-total-egpacket: object[]
-
Total Number of Egress packets on TCP iqs
-
object - entry: integer
-
Total Number of Egress packets on TCP iqs
- out-of-order-packets-received: integer
-
Out-of-order packets received
- window-update-packets-sent: integer
-
Window update packets sent
- window-probe-packets-received: integer
-
Window probe packets received
Example
{
"embryonic-connection-dropped": "integer",
"socket-layer-packets": "integer",
"high-water-mark-throttle": "integer",
"data-bytes-sent": "integer",
"syn-cache-duplicate-sy-ns": "integer",
"after-window-packets-received": "integer",
"total-pakets-sent": "integer",
"keep-alive-timeouts": "integer",
"synacl-match-pkts-dropped": "integer",
"retransmit-timeouts": "integer",
"connections-dropped": "integer",
"data-bytes-received-in-sequence": "integer",
"syn-cache-added": "integer",
"urgent-only-packets-sent": "integer",
"try-lock-dropped": "integer",
"iq-sock-writes": "integer",
"iq-sock-aborts": "integer",
"packets-received-after-close-packet": "integer",
"packet-failures": "integer",
"low-water-mark-throttle": "integer",
"ack-packets-received": "integer",
"no-throttle": "integer",
"syn-cache-overflow": "integer",
"connections-requested": "integer",
"keep-alive-dropped": "integer",
"partial-duplicate-ack-received": "integer",
"after-window-bytes-received": "integer",
"connection-rate-limited": "integer",
"stalled-timer-tickle-count": "integer",
"connections-established": "integer",
"duplicate-packets-received": "integer",
"connections-forcibly-closed": "integer",
"packets-retransmitted": "integer",
"iq-sock-retries": "integer",
"reassembly-packets": "integer",
"total-packets-received": "integer",
"established-connections-reset": "integer",
"out-of-order-bytes-received": "integer",
"pulse-errors": "integer",
"syn-cache-count": "integer",
"num-open-sockets": "integer",
"iq-ingress-drops": "integer",
"total-i-qs": "integer",
"stalled-timer-tickle-time": "integer",
"syn-cache-timed-out": "integer",
"syn-cache-dropped": "integer",
"persist-dropped": "integer",
"syn-cache-unreach": "integer",
"syn-cache-reset": "integer",
"malformed-packets-received": "integer",
"window-probe-packets-sent": "integer",
"send-auth-packets-dropped": "integer",
"ack-packets-for-unsent-received": "integer",
"iqs-total-ingpacket": [
{
"entry": "integer"
}
],
"received-packets-dropped-stale-c-hdr": "integer",
"control-packets-sent": "integer",
"delay-ack-packets-sent": "integer",
"data-packets-received-in-sequence": "integer",
"ack-only-packets-sent": "integer",
"received-auth-packets-dropped": "integer",
"paws-dropped": "integer",
"window-update-packets-received": "integer",
"bad-checksum-packets-received": "integer",
"connections-accepted": "integer",
"duplicated-ack-packets-received": "integer",
"connections-closed": "integer",
"bytes-retransmitted": "integer",
"truncated-write-iov": "integer",
"syn-cache-aborted": "integer",
"mss-down": "integer",
"keep-alive-probes": "integer",
"no-port-packets-received": "integer",
"send-packets-dropped": "integer",
"too-short-packets-received": "integer",
"received-packets-dropped": "integer",
"syn-cache-completed": "integer",
"syn-cache-bucket-oflow": "integer",
"mss-up": "integer",
"rst-packets-sent": "integer",
"retransmit-dropped": "integer",
"ackbytes-received": "integer",
"recovered-packets": "integer",
"duplicate-bytes-received": "integer",
"data-pakets-sent": "integer",
"partial-duplicate-bytes-received": "integer",
"connections-failed": "integer",
"iqs-total-egpacket": [
{
"entry": "integer"
}
],
"out-of-order-packets-received": "integer",
"window-update-packets-sent": "integer",
"window-probe-packets-received": "integer"
}
LPTS-ACCEPT-MASK:
LPTS accept mask
- is-interface: boolean
-
Set interface
- is-remote-port: boolean
-
Set Remote Port
- is-packet-type: boolean
-
Set packet type
- is-remote-address: boolean
-
Set Remote address
- is-local-port: boolean
-
Set Local Port
- is-local-address: boolean
-
Set Local Address
Example
{
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
}
TSS-NOTIF-STATS:
notif stats structure used in ccb stats bag
- failed-count: integer
-
Errors while queuing the notifs
- dropped-count: integer
-
How many were dropped because of timeout
- queued-count: integer
-
how many were queued
- delivered-count: integer
-
How many were picked up by app?
Example
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
TCP-NSR-SND-COUNTERS-NODE:
Send path counters
- seg-instr-send: integer
-
Number of successful Segmentation instruction messages
- seg-instr-rcv: integer
-
Number of received Segmentation instruction messages
- seg-instr-rcv-fail-buffer-trim: integer
-
Number of received Segmentation instructions that had buffer trim failures
- nack-rcv-success: integer
-
Number of successfully received NACK messages
- seg-instr-rcv-fail-tcp-process: integer
-
Number of received Segmentation instructions that had failures during TCP processing
- data-xfer-rcv-fail-buffer-trim: integer
-
Number of received DATA transfers that had buffer trim failures
- data-xfer-send-iov-alloc: integer
-
Number of data transfer msgs., that required new IOV's to be allocated
- cleanup-send-drop: integer
-
Number of failed Cleanup messages
- data-xfer-rcv-success: integer
-
Number of successfully received DATA transfers
- data-xfer-rcv-fail-snd-una-out-of-sync: integer
-
Number of received DATA transfers that had failures because the send path was out of sync
- data-xfer-send-total: integer
-
Amount of data transferred
- seg-instr-send-units: integer
-
Number of segement units transferred via the successful Segmentation instruction messages
- cleanup-rcv: integer
-
Number of received Cleanup messages
- data-xfer-send-drop: integer
-
Number of failed DATA transfers
- nack-rcv: integer
-
Number of received NACK messages
- nack-send-drop: integer
-
Number of failed NACK messages
- cleanup-send: integer
-
Number of successful Cleanup messages
- nack-rcv-fail-data-send: integer
-
Number of received NACK messages that had failures when sending data in response to the NACK
- cleanup-rcv-fail-buffer-trim: integer
-
Number of Cleanup messages that had trim failures
- cleanup-rcv-success: integer
-
Number of successfully received Cleanup messages
- seg-instr-rcv-success: integer
-
Number of successfully received Segmentation instruction messages
- data-xfer-rcv: integer
-
Number of received DATA transfers
- data-xfer-send: integer
-
Number of successful DATA transfers
- nack-send: integer
-
Number of successful NACK messages
- seg-instr-send-drop: integer
-
Number of failed Segmentation instruction messages
Example
{
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
}
TCP-NSR-PCB-BRIEF-BAG:
Summary NSR information about a TCP connection
- foreign-address: object[]
-
Foreign address
-
object - entry: string
-
Foreign address
- local-address: object[]
-
Local address
-
object - entry: string
-
Local address
- foreign-port: integer
-
Foreign port
- local-port: integer
-
Local port
- is-ds-operational-up: string down, up, na
-
Is Downstream NSR operational?
- vrf-id: integer
-
VRF Id
- is-us-operational-up: string down, up, na
-
Is Upstream NSR operational?
- sscb: integer
-
SSCB Address
- is-only-receive-path-replication: boolean
-
Is replication limited to receive-path only
- pcb: integer
-
PCB Address
- address-family: string internetwork, ip-version6
-
Address family
- is-admin-configured-up: boolean
-
Is NSR administratively configured?
Example
{
"foreign-address": [
{
"entry": "string"
}
],
"local-address": [
{
"entry": "string"
}
],
"foreign-port": "integer",
"local-port": "integer",
"is-ds-operational-up": "string",
"vrf-id": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"is-only-receive-path-replication": "boolean",
"pcb": "integer",
"address-family": "string",
"is-admin-configured-up": "boolean"
}
TCP-SH-KEY-ID-BAG:
Information about a TCP AO active key
- key-id: integer
-
Key identifier
Example
{
"key-id": "integer"
}
TCP-ASYNC-SESSION-STATS-BAG:
TCP Async Session Statistic
- data-write-error-num: object[]
-
Number of failed data write to XIPC
-
object - entry: integer
-
Number of failed data write to XIPC
- data-write-byte: object[]
-
Number of bytes data has been written
-
object - entry: integer
-
Number of bytes data has been written
- control-write-error-num: object[]
-
Number of failed control write to XIPC
-
object - entry: integer
-
Number of failed control write to XIPC
- async-session: boolean
-
Flag of async session
- data-read-byte: object[]
-
Number of bytes data has been read
-
object - entry: integer
-
Number of bytes data has been read
- control-read-error-num: object[]
-
Number of failed control read from XIPC
-
object - entry: integer
-
Number of failed control read from XIPC
- data-read-success-num: object[]
-
Number of successful data read from XIPC
-
object - entry: integer
-
Number of successful data read from XIPC
- data-read-error-num: object[]
-
Number of failed data read from XIPC
-
object - entry: integer
-
Number of failed data read from XIPC
- data-write-success-num: object[]
-
Number of successful data write to XIPC
-
object - entry: integer
-
Number of successful data write to XIPC
- control-write-success-num: object[]
-
Number of successful control write to XIPC
-
object - entry: integer
-
Number of successful control write to XIPC
- control-read-success-num: object[]
-
Number of successful control read to XIPC
-
object - entry: integer
-
Number of successful control read to XIPC
Example
{
"data-write-error-num": [
{
"entry": "integer"
}
],
"data-write-byte": [
{
"entry": "integer"
}
],
"control-write-error-num": [
{
"entry": "integer"
}
],
"async-session": "boolean",
"data-read-byte": [
{
"entry": "integer"
}
],
"control-read-error-num": [
{
"entry": "integer"
}
],
"data-read-success-num": [
{
"entry": "integer"
}
],
"data-read-error-num": [
{
"entry": "integer"
}
],
"data-write-success-num": [
{
"entry": "integer"
}
],
"control-write-success-num": [
{
"entry": "integer"
}
],
"control-read-success-num": [
{
"entry": "integer"
}
]
}
TCP-SH-KEYCHAIN-BAG:
Detailed information about a TCP AO keychain
- desired-key-available: boolean
-
Is desired key available?
- chain-name: string
-
Keychain name
- is-configured: boolean
-
Is keychain configured?
- desired-key-id: integer
-
Desired key identifier
- keys: TCP-SH-KEY-BAG
-
Keys under this keychain
-
TCP-SH-KEY-BAG - send-id: TCP-SH-ID-BAG
-
Send IDs under this keychain
-
TCP-SH-ID-BAG - receive-id: TCP-SH-ID-BAG
-
Receive IDs under this keychain
-
TCP-SH-ID-BAG - active-key: TCP-SH-KEY-ID-BAG
-
List of active keys
-
TCP-SH-KEY-ID-BAG
Example
{
"desired-key-available": "boolean",
"chain-name": "string",
"is-configured": "boolean",
"desired-key-id": "integer",
"keys": [
{
"overlapping-key-available": "boolean",
"is-valid": "boolean",
"crypt-algo": "string",
"is-configured": "boolean",
"reason": "string",
"invalidated-key": [
{
"key-id": "integer"
}
],
"overlapping-key": "integer",
"recv-id": "integer",
"is-active": "boolean",
"send-id": "integer",
"is-expired": "boolean",
"key-id": "integer"
}
],
"send-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"receive-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"active-key": [
{
"key-id": "integer"
}
]
}
TCP-NSR-CCB-BRIEF-BAG:
Summary Information about an SSO/NSR Client
- number-of-up-sessions: integer
-
Number of sessions with NSR up
- number-of-sessions: integer
-
Number of sessions owned by this client
- pid: integer
-
PID of the Client
- process-name: string
-
Proc name of Clinet
- instance: integer
-
Instance of the Client
- numberof-sets: integer
-
Number of Sets owned by this client
- job-id: string
-
JOb ID of Client
- ccb: integer
-
Address of the Client Control Block
Example
{
"number-of-up-sessions": "integer",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
SACKBLK-BAG:
Sack block entry
- start: integer
-
Start seq no. of sack block
- end: integer
-
End seq no. of sack block
Example
{
"start": "integer",
"end": "integer"
}
TCP-SH-ID-BAG:
Detailed information about a TCP AO ID under a keychain
- keys: TCP-SH-KEY-ID-BAG
-
List of keys having this id
-
TCP-SH-KEY-ID-BAG - id: integer
-
Identifier
Example
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
TCP-NSR-SSCB-DETAILED-BAG:
Detailed Information about an SSO/NSR Session-set
- total-number-of-init-sync-sessions: integer
-
Number of sessions being synced as part of the current initial sync operation
- init-sync-end-time: integer
-
Time at which the last initial sync operation was ended (in seconds since 1st Jan 1970 00:00 :00)
- audit-end-time: integer
-
Time at which the last audit operation was ended (in seconds since 1st Jan 1970 00:00:00)
- protect-node: string
-
The node protecting this set
- protect-instance: integer
-
Instance of the client application on the protection node
- pid: integer
-
PID of the Client that owns this Session-set
- is-audit-in-progress: boolean
-
Is an audit in progress currently?
- sso-role: integer
-
TCP role for this set?
- audit-start-time: integer
-
Time at which last or current audit operation was started (in seconds since 1st Jan 1970 00:00 :00)
- number-of-sessions: integer
-
Number of Sessions in the set
- sscb: integer
-
Address of the Session Set Control Block
- audit-seq-number: integer
-
ID of the current or the last audit operation
- init-sync-ready-start-time: integer
-
Time at which the session was ready for initial sync last (in seconds since 1st Jan 1970 00:00 :00)
- local-node: string
-
Local node of this set
- local-instance: integer
-
Instance of the client application on the local node
- sequence-number-of-init-sync: integer
-
ID of the current or the last initial sync operation
- number-of-init-synced-sessions: integer
-
Number of sessions that are synced as part of the current initial sync operation
- nsr-reset-time: integer
-
Time at which NSR was last reset on the session set (in seconds since 1st Jan 1970 00:00:00)
- is-sscb-init-sync-ready: boolean
-
Is the SSCB ready for another initial sync?
- is-init-sync-second-phase: boolean
-
Is initial sync in the second phase?
- is-init-sync-error-local: boolean
-
Initial sync failed due to a local error or remote stack
- is-init-sync-in-progress: boolean
-
Is an initial sync in progress currently?
- number-of-synced-sessions-up-stream: integer
-
How many sessions are synced with upstream partner
- address-family: string internetwork, ip-version6
-
Address Family of the sessions in this set
- init-sync-error: string
-
Initial sync failure reason, if any
- number-of-sessions-init-sync-failed: integer
-
Number of sessions that failed to sync as part of the current initial sync operation
- well-known-port: integer
-
Well Known Port of the client
- set-id: integer
-
ID of this Session-set
- init-sync-start-time: integer
-
Time at which last or current initial sync operation was started (in seconds since 1st Jan 1970 00:00:00)
- number-of-synced-sessions-down-stream: integer
-
How many sessions are synced with downstream partner
- init-sync-timer: integer
-
Time left on the initial sync timer
- mode: integer
-
Session-set mode
- init-sync-ready-end-time: integer
-
Time at which the session set last went not-ready for initial sync (in seconds since 1st Jan 1970 00:00:00)
Example
{
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
TCP-SOCKBUF-STATES-BAG:
TCP Socket Buffer State Flags
- async-io: boolean
-
Async I/O
- locked: boolean
-
Lock on data queue (so_rcv only)
- output-select: boolean
-
Buffer is selected for OUTPUT
- waiting-for-data: boolean
-
Someone is waiting for data/space
- io-timer-set: boolean
-
Read/write timer set
- out-of-band-select: boolean
-
Buffer is selected for OBAND
- not-interruptible: boolean
-
Not interruptible
- delayed-wakeup: boolean
-
Want delayed wakeups
- input-select: boolean
-
Buffer is selected for INPUT
- wakeup: boolean
-
Read/write wakeup pending
- connect-wakeup: boolean
-
Connect wakeup pending
- waiting-for-lock: boolean
-
Someone is waiting to lock
Example
{
"async-io": "boolean",
"locked": "boolean",
"output-select": "boolean",
"waiting-for-data": "boolean",
"io-timer-set": "boolean",
"out-of-band-select": "boolean",
"not-interruptible": "boolean",
"delayed-wakeup": "boolean",
"input-select": "boolean",
"wakeup": "boolean",
"connect-wakeup": "boolean",
"waiting-for-lock": "boolean"
}
TCP-NSR-HOLD-QUEUE-NODE:
Info about the Packet or iACK held
- acknoledgement-number: integer
-
Ack Number
- sequence-number: integer
-
Sequence Number
- data-length: integer
-
Data Length
Example
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
LPTS-FLAGS:
LPTS flags
- is-ignore-vrf-filter: boolean
-
Ignore VRF Filter
- is-pcb-bound: boolean
-
PCB bound
- is-local-address-ignore: boolean
-
Sent drop packets
Example
{
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
}
TCP-NSR-SND-COUNTERS-AGGR-NODE:
Send path aggregate counters
- aggr-only: TCP-NSR-SND-COUNTERS-AGGR-ONLY-NODE
-
Aggregate only send path counters
- common: TCP-NSR-SND-COUNTERS-NODE
-
Common send path counters
Example
{
"aggr-only": {
"cleanup-rcv-drop-no-scb-dp": "integer",
"seg-instr-rcv-drop-no-scb-dp": "integer",
"nack-rcv-drop-no-pcb": "integer",
"cleanup-rcv-drop-no-pcb": "integer",
"data-xfer-rcv-drop-no-scb-dp": "integer",
"seg-instr-rcv-drop-no-pcb": "integer",
"data-xfer-rcv-drop-no-pcb": "integer",
"nack-rcv-drop-no-scb-dp": "integer"
},
"common": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
}
}
TCP-NSR-SUMMARY-STATS-BAG:
Summary SSO/NSR statistics
- number-of-held-but-dropped-internal-acks: integer
-
Number of held Internal Acks dropped by Active TCP
- number-of-held-internal-acks: integer
-
Number of Internal Acks held by Active TCP
- number-of-added-sessions: integer
-
Number of added sessions
- internal-ack-drops-not-replicated: integer
-
Number of iACKs dropped because session is not replicated
- number-of-held-packets: integer
-
Number of Packets held by Active TCP
- last-cleared-time: integer
-
Time of last clear (in seconds since 1st Jan 1970 00:00:00)
- number-of-qad-transfer-message-sent: integer
-
Number of messages sent to partner TCP stack(s)
- number-of-received-internal-acks: integer
-
Number of Internal Acks received by Active TCP
- number-of-disconnected-clients: integer
-
Number of disconnected clients
- notification-statistic: TSS-NOTIF-STATS
-
Various types of notification stats
-
TSS-NOTIF-STATS - number-of-created-session-sets: integer
-
Number of created session sets
- number-of-sent-internal-acks: integer
-
Number of Internal Acks sent to Active TCP by Standby TCP
- number-of-destroyed-session-sets: integer
-
Number of destroyed session sets
- number-of-connected-clients: integer
-
Number of disconnected clients
- number-of-qad-transfer-message-drops: integer
-
Number of messages failed to be sent to partner TCP stack(s)
- internal-ack-drops-stale: integer
-
Number of stale iACKs dropped
- number-of-held-but-dropped-packets: integer
-
Number of held packets dropped by Active TCP
- internal-ack-drops-initsync-first-phase: integer
-
Number of iACKs dropped because init-sync is in 1st phase
- number-of-qad-receive-messages-unknowns: integer
-
Number of unknown messages from partner TCP stack(s)
- number-of-deleted-sessions: integer
-
Number of deleted sessions
- number-of-partner-node: integer
-
Number of Parner Nodes
- held-packet-drops: integer
-
Number of held packets dropped because of errors
- number-of-current-sessions: integer
-
Number of current sessions
- number-of-internal-ack-drops-no-pcb: integer
-
Number of iACKs dropped because there is no PCB
- snd-counters: TCP-NSR-SND-COUNTERS-AGGR-NODE
-
Aggregate Send path counters
- number-of-internal-ack-drops-no-scbdp: integer
-
Number of iACKs dropped because there is no datapath SCB
- number-of-qad-stale-receive-messages-drops: integer
-
Number of dropped messages from partner TCP stack(s) because they were out-of-order
- number-of-failed-init-sync: integer
-
no. of initial-sync fails
- internal-ack-drops-immediate-match: integer
-
Number of iACKs not held because of an immediate match
- number-of-qad-receive-messages-accepts: integer
-
Number of messages accepted from partner TCP stack(s)
- number-of-succeeded-init-sync: integer
-
no. of initial-sync successes
- number-of-current-clients: integer
-
Number of current clients
- number-of-attempted-init-sync: integer
-
no. of initial-sync attempts
- audit-counters: TCP-NSR-AUDIT-COUNTERS-AGGR-NODE
-
Aggregate Audit counters
- number-of-current-session-sets: integer
-
Number of current session sets
- number-of-qad-receive-messages-drops: integer
-
Number of dropped messages from partner TCP stack(s)
Example
{
"number-of-held-but-dropped-internal-acks": "integer",
"number-of-held-internal-acks": "integer",
"number-of-added-sessions": "integer",
"internal-ack-drops-not-replicated": "integer",
"number-of-held-packets": "integer",
"last-cleared-time": "integer",
"number-of-qad-transfer-message-sent": "integer",
"number-of-received-internal-acks": "integer",
"number-of-disconnected-clients": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"number-of-created-session-sets": "integer",
"number-of-sent-internal-acks": "integer",
"number-of-destroyed-session-sets": "integer",
"number-of-connected-clients": "integer",
"number-of-qad-transfer-message-drops": "integer",
"internal-ack-drops-stale": "integer",
"number-of-held-but-dropped-packets": "integer",
"internal-ack-drops-initsync-first-phase": "integer",
"number-of-qad-receive-messages-unknowns": "integer",
"number-of-deleted-sessions": "integer",
"number-of-partner-node": "integer",
"held-packet-drops": "integer",
"number-of-current-sessions": "integer",
"number-of-internal-ack-drops-no-pcb": "integer",
"snd-counters": {
"aggr-only": {
"cleanup-rcv-drop-no-scb-dp": "integer",
"seg-instr-rcv-drop-no-scb-dp": "integer",
"nack-rcv-drop-no-pcb": "integer",
"cleanup-rcv-drop-no-pcb": "integer",
"data-xfer-rcv-drop-no-scb-dp": "integer",
"seg-instr-rcv-drop-no-pcb": "integer",
"data-xfer-rcv-drop-no-pcb": "integer",
"nack-rcv-drop-no-scb-dp": "integer"
},
"common": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
}
},
"number-of-internal-ack-drops-no-scbdp": "integer",
"number-of-qad-stale-receive-messages-drops": "integer",
"number-of-failed-init-sync": "integer",
"internal-ack-drops-immediate-match": "integer",
"number-of-qad-receive-messages-accepts": "integer",
"number-of-succeeded-init-sync": "integer",
"number-of-current-clients": "integer",
"number-of-attempted-init-sync": "integer",
"audit-counters": {
"aggr-only": {
"mark-session-set-nack-rcv-drop-aggr": "integer",
"mark-session-set-ack-rcv-drop-aggr": "integer",
"mark-session-set-rcv-drop-aggr": "integer",
"sweep-session-set-rcv-drop-aggr": "integer",
"session-rcv-drop-aggr": "integer",
"session-set-response-rcv-drop-aggr": "integer"
},
"common": {
"mark-session-set-ack-rcv-drop": "integer",
"session-send-drop": "integer",
"sweep-session-set-send": "integer",
"mark-session-set-ack-send-drop": "integer",
"session-set-response-send-drop": "integer",
"sweep-session-set-rcv-drop": "integer",
"abort": "integer",
"mark-session-set-ack-send": "integer",
"mark-session-set-rcv-drop": "integer",
"sweep-session-set-rcv": "integer"
}
}
}
tcp-connection_schema:
TCP connection operational data
- nodes: object
-
Table of information about all nodes present on the system
-
- node: object[]
-
Information about a single node
-
object - extended-information: object
-
Extended Filter related Information
-
- display-types: object
-
Table listing display types
-
- display-type: object[]
-
Describing particular display type
-
object - disp-type: string all, static-policy, interface-filter, packet-filter
-
Specifying display type
- connection-id: object[]
-
Describing connection ID
-
- pcb-id: string
-
Displaying inforamtion based on selected display type associatedwith a particular PCB
- statistics: object
-
Statistics of all TCP connections
-
- clients: object
-
Table listing clients
-
- client: object[]
-
Describing Client ID
-
- client-id: integer
-
Displaying client's aggregated statistics
- pcbs: object
-
Table listing the TCP connections for which statistics are provided
-
- pcb: object[]
-
Protocol Control Block ID
-
- id: string
-
Displaying statistics associated with a particular PCB
- summary: TCP-SH-STATS-BAG
-
Summary statistics across all TCP connections
- brief-informations: object
-
Table listing connections for which brief information is provided.Note that not all connections are listed in the brief table.
-
- brief-information: object[]
-
Brief information about a TCP connection
-
- pcb-id: string
-
Protocol Control Block ID
- detail-informations: object
-
Table listing TCP connections for which detailed information is provided
-
- detail-information: object[]
-
Protocol Control Block ID
-
- pcb-id: string
-
Detail information about TCP connection, put null for all
- keychains: object
-
Table listing keychains configured for TCP-AO.
-
- keychain: object[]
-
Details of a keychain
-
- keychain-name: string
-
Keychain name
- id: string
-
Describing a location
Example
{
"nodes": {
"node": [
{
"extended-information": {
"display-types": {
"display-type": [
{
"disp-type": "string",
"connection-id": [
{
"pcb-id": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"l4-protocol": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"common": {
"af-name": "string",
"lpts-pcb": {
"accept-mask": {
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
},
"lpts-flags": {
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
},
"filter": [
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
],
"flow-types-info": "integer",
"ttl": "integer",
"options": {
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
}
}
}
]
}
]
}
},
"statistics": {
"clients": {
"client": [
{
"client-id": "integer",
"ipv6-received-packets": "integer",
"ipv4-received-packets": "integer",
"ipv6-sent-packets": "integer",
"client-name": "string",
"ipv4-sent-packets": "integer",
"client-jid": "string"
}
]
},
"pcbs": {
"pcb": [
{
"send-window-shrink-ignored": "integer"
}
]
}
}
}
]
}
}
nodes_schema:
Table of information about all nodes present on the system
- node: object[]
-
Information about a single node
-
object - session-set: object
-
Information about TCP NSR Session Sets
-
- brief-sets: object
-
Information about TCP NSR Session Sets
-
- brief-set: object[]
-
Brief information about NSR Session Sets
-
- id: string
-
ID of NSR Session Set
- detail-sets: object
-
Table about TCP NSR Session Sets details
-
- detail-set: object[]
-
showing detailed information of NSR Session Sets
-
- id: string
-
ID of NSR Sesison Set
- statistics: object
-
Statis Information about TCP NSR connections
-
- statistic-clients: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-client: object[]
-
showing statistic information of NSR Clients
-
- id: string
-
ID of NSR Client
- statistic-sessions: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-session: object[]
-
showing statistic information of TCP connections
-
- id: string
-
ID of TCP connection
- statistic-sets: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-set: object[]
-
showing statistic information of NSR Session Set
-
- id: string
-
ID of NSR Session Set
- summary: TCP-NSR-SUMMARY-STATS-BAG
-
Summary statistics across all NSR connections
- id: string
-
Describing a location
- session: object
-
Information about TCP NSR Sessions
-
- detail-sessions: object
-
Table about TCP NSR Sessions details
-
- detail-session: object[]
-
showing detailed information of NSR Sessions
-
- id: string
-
ID of NSR Sesison
- brief-sessions: object
-
Information about TCP NSR Sessions
-
- brief-session: object[]
-
Brief information about NSR Sessions
-
- id: string
-
ID of NSR Sesison
- client: object
-
Information about TCP NSR Client
-
- brief-clients: object
-
Information about TCP NSR Client
-
- brief-client: object[]
-
Brief information about NSR Client
-
- id: string
-
ID of NSR client
- detail-clients: object
-
Table about TCP NSR Client details
-
- detail-client: object[]
-
showing detailed information of NSR Clients
-
- id: string
-
ID of NSR client
Example
{
"node": [
{
"session-set": {
"brief-sets": {
"brief-set": [
{
"id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
]
},
"detail-sets": {
"detail-set": [
{
"id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
]
}
},
"statistics": {
"statistic-clients": {
"statistic-client": [
{
"id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
]
},
"statistic-sessions": {
"statistic-session": [
{
"internal-ack-drops-stale": "integer"
}
]
}
}
}
]
}
node_schema:
- session-set: object
-
Information about TCP NSR Session Sets
-
- brief-sets: object
-
Information about TCP NSR Session Sets
-
- brief-set: object[]
-
Brief information about NSR Session Sets
-
- id: string
-
ID of NSR Session Set
- detail-sets: object
-
Table about TCP NSR Session Sets details
-
- detail-set: object[]
-
showing detailed information of NSR Session Sets
-
- id: string
-
ID of NSR Sesison Set
- statistics: object
-
Statis Information about TCP NSR connections
-
- statistic-clients: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-client: object[]
-
showing statistic information of NSR Clients
-
- id: string
-
ID of NSR Client
- statistic-sessions: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-session: object[]
-
showing statistic information of TCP connections
-
- id: string
-
ID of TCP connection
- statistic-sets: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-set: object[]
-
showing statistic information of NSR Session Set
-
- id: string
-
ID of NSR Session Set
- summary: TCP-NSR-SUMMARY-STATS-BAG
-
Summary statistics across all NSR connections
- id: string
-
Describing a location
- session: object
-
Information about TCP NSR Sessions
-
- detail-sessions: object
-
Table about TCP NSR Sessions details
-
- detail-session: object[]
-
showing detailed information of NSR Sessions
-
- id: string
-
ID of NSR Sesison
- brief-sessions: object
-
Information about TCP NSR Sessions
-
- brief-session: object[]
-
Brief information about NSR Sessions
-
- id: string
-
ID of NSR Sesison
- client: object
-
Information about TCP NSR Client
-
- brief-clients: object
-
Information about TCP NSR Client
-
- brief-client: object[]
-
Brief information about NSR Client
-
- id: string
-
ID of NSR client
- detail-clients: object
-
Table about TCP NSR Client details
-
- detail-client: object[]
-
showing detailed information of NSR Clients
-
- id: string
-
ID of NSR client
Example
{
"session-set": {
"brief-sets": {
"brief-set": [
{
"id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
]
},
"detail-sets": {
"detail-set": [
{
"id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
]
}
},
"statistics": {
"statistic-clients": {
"statistic-client": [
{
"id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
]
},
"statistic-sessions": {
"statistic-session": [
{
"internal-ack-drops-stale": "integer",
"snd-counters": {
"seg-instr-send": "integer"
}
}
]
}
}
}
statistics_schema:
Statis Information about TCP NSR connections
- statistic-clients: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-client: object[]
-
showing statistic information of NSR Clients
-
- id: string
-
ID of NSR Client
- statistic-sessions: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-session: object[]
-
showing statistic information of TCP connections
-
- id: string
-
ID of TCP connection
- statistic-sets: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-set: object[]
-
showing statistic information of NSR Session Set
-
- id: string
-
ID of NSR Session Set
- summary: TCP-NSR-SUMMARY-STATS-BAG
-
Summary statistics across all NSR connections
Example
{
"statistic-clients": {
"statistic-client": [
{
"id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
]
},
"statistic-sessions": {
"statistic-session": [
{
"id": "string",
"internal-ack-drops-stale": "integer",
"snd-counters": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
},
"internal-ack-drops-not-replicated": "integer",
"number-of-times-nsr-up": "integer",
"number-of-times-nsr-disabled": "integer",
"internal-ack-drops-initsync-first-phase": "integer",
"internal-ack-drops-immediate-match": "integer",
"number-of-timers-nsr-down": "integer",
"pcb": "integer",
"number-of-times-nsr-fail-over": "integer",
"last-cleared-time": "integer"
}
]
},
"statistic-sets": {
"statistic-set": [
{
"id": "string",
"set-id": "integer",
"number-of-nsr-resets": "integer",
"number-of-failed-init-sync": "integer",
"sscb": "integer",
"number-of-succeeded-init-sync": "integer",
"number-of-failover": "integer",
"number-of-attempted-init-sync": "integer",
"last-cleared-time": "integer"
}
]
},
"summary": {
"number-of-held-but-dropped-internal-acks": "integer",
"number-of-held-internal-acks": "integer",
"number-of-added-sessions": "integer",
"internal-ack-drops-not-replicated": "integer",
"number-of-held-packets": "integer",
"last-cleared-time": "integer",
"number-of-qad-transfer-message-sent": "integer",
"number-of-received-internal-acks": "integer",
"number-of-disconnected-clients": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer"
}
]
}
}
clients_schema:
Table listing clients
- client: object[]
-
Describing Client ID
-
- client-id: integer
-
Displaying client's aggregated statistics
Example
{
"client": [
{
"client-id": "integer",
"ipv6-received-packets": "integer",
"ipv4-received-packets": "integer",
"ipv6-sent-packets": "integer",
"client-name": "string",
"ipv4-sent-packets": "integer",
"client-jid": "string"
}
]
}
client_schema:
Information about TCP NSR Client
- brief-clients: object
-
Information about TCP NSR Client
-
- brief-client: object[]
-
Brief information about NSR Client
-
- id: string
-
ID of NSR client
- detail-clients: object
-
Table about TCP NSR Client details
-
- detail-client: object[]
-
showing detailed information of NSR Clients
-
- id: string
-
ID of NSR client
Example
{
"brief-clients": {
"brief-client": [
{
"id": "string",
"number-of-up-sessions": "integer",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
]
},
"detail-clients": {
"detail-client": [
{
"id": "string",
"number-of-up-sessions": "integer",
"is-notification-registered": "boolean",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
]
}
}
pcbs_schema:
Table listing the TCP connections for which statistics are provided
- pcb: object[]
-
Protocol Control Block ID
-
- id: string
-
Displaying statistics associated with a particular PCB
Example
{
"pcb": [
{
"id": "string",
"send-window-shrink-ignored": "integer",
"send-queue-failed": "integer",
"write-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"received-packets-queued": "integer",
"send-packets-queued": "integer",
"segment-instruction-received": "integer",
"is-paw-socket": "boolean",
"send-packets-queued-net-io": "integer",
"vrf-id": "integer",
"packets-received": "integer",
"packets-sent": "integer",
"read-io-time": "integer",
"write-io-time": "integer",
"receive-queue-failed": "integer",
"pcb": "integer",
"read-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"async-session-stats": {
"data-write-error-num": [
{
"entry": "integer"
}
],
"data-write-byte": [
{
"entry": "integer"
}
],
"control-write-error-num": [
{
"entry": "integer"
}
],
"async-session": "boolean",
"data-read-byte": [
{
"entry": "integer"
}
],
"control-read-error-num": [
{
"entry": "integer"
}
],
"data-read-success-num": [
{
"entry": "integer"
}
],
"data-read-error-num": [
{
"entry": "integer"
}
],
"data-write-success-num": [
{
"entry": "integer"
}
],
"control-write-success-num": [
{
"entry": "integer"
}
],
"control-read-success-num": [
{
"entry": "integer"
}
]
},
"xipc-pulse-received": "integer",
"send-queue-net-io-failed": "integer"
}
]
}
pcb_schema:
- cb_id: string
-
Displaying statistics associated with a particular PCB
Example
{
"cb_id": "string",
"send-window-shrink-ignored": "integer",
"send-queue-failed": "integer",
"write-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"received-packets-queued": "integer",
"send-packets-queued": "integer",
"segment-instruction-received": "integer",
"is-paw-socket": "boolean",
"send-packets-queued-net-io": "integer",
"vrf-id": "integer",
"packets-received": "integer",
"packets-sent": "integer",
"read-io-time": "integer",
"write-io-time": "integer",
"receive-queue-failed": "integer",
"pcb": "integer",
"read-io-counts": {
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
},
"async-session-stats": {
"data-write-error-num": [
{
"entry": "integer"
}
],
"data-write-byte": [
{
"entry": "integer"
}
],
"control-write-error-num": [
{
"entry": "integer"
}
],
"async-session": "boolean",
"data-read-byte": [
{
"entry": "integer"
}
],
"control-read-error-num": [
{
"entry": "integer"
}
],
"data-read-success-num": [
{
"entry": "integer"
}
],
"data-read-error-num": [
{
"entry": "integer"
}
],
"data-write-success-num": [
{
"entry": "integer"
}
],
"control-write-success-num": [
{
"entry": "integer"
}
],
"control-read-success-num": [
{
"entry": "integer"
}
]
},
"xipc-pulse-received": "integer",
"send-queue-net-io-failed": "integer"
}
data-write-success-num_schema:
- entry: integer
-
Number of successful data write to XIPC
Example
{
"entry": "integer"
}
data-read-success-num_schema:
- entry: integer
-
Number of successful data read from XIPC
Example
{
"entry": "integer"
}
data-write-error-num_schema:
- entry: integer
-
Number of failed data write to XIPC
Example
{
"entry": "integer"
}
data-read-error-num_schema:
- entry: integer
-
Number of failed data read from XIPC
Example
{
"entry": "integer"
}
control-write-success-num_schema:
- entry: integer
-
Number of successful control write to XIPC
Example
{
"entry": "integer"
}
control-read-success-num_schema:
- entry: integer
-
Number of successful control read to XIPC
Example
{
"entry": "integer"
}
control-write-error-num_schema:
- entry: integer
-
Number of failed control write to XIPC
Example
{
"entry": "integer"
}
control-read-error-num_schema:
- entry: integer
-
Number of failed control read from XIPC
Example
{
"entry": "integer"
}
data-write-byte_schema:
- entry: integer
-
Number of bytes data has been written
Example
{
"entry": "integer"
}
data-read-byte_schema:
- entry: integer
-
Number of bytes data has been read
Example
{
"entry": "integer"
}
iqs-total-ingpacket_schema:
- entry: integer
-
Total Number of Ingress packets on TCP iqs
Example
{
"entry": "integer"
}
iqs-total-egpacket_schema:
- entry: integer
-
Total Number of Egress packets on TCP iqs
Example
{
"entry": "integer"
}
extended-information_schema:
Extended Filter related Information
- display-types: object
-
Table listing display types
-
- display-type: object[]
-
Describing particular display type
-
object - disp-type: string all, static-policy, interface-filter, packet-filter
-
Specifying display type
- connection-id: object[]
-
Describing connection ID
-
- pcb-id: string
-
Displaying inforamtion based on selected display type associatedwith a particular PCB
Example
{
"display-types": {
"display-type": [
{
"disp-type": "string",
"connection-id": [
{
"pcb-id": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"l4-protocol": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"common": {
"af-name": "string",
"lpts-pcb": {
"accept-mask": {
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
},
"lpts-flags": {
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
},
"filter": [
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
],
"flow-types-info": "integer",
"ttl": "integer",
"options": {
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
}
}
}
]
}
]
}
}
display-types_schema:
Table listing display types
- display-type: object[]
-
Describing particular display type
-
object - disp-type: string all, static-policy, interface-filter, packet-filter
-
Specifying display type
- connection-id: object[]
-
Describing connection ID
-
- pcb-id: string
-
Displaying inforamtion based on selected display type associatedwith a particular PCB
Example
{
"display-type": [
{
"disp-type": "string",
"connection-id": [
{
"pcb-id": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"l4-protocol": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"common": {
"af-name": "string",
"lpts-pcb": {
"accept-mask": {
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
},
"lpts-flags": {
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
},
"filter": [
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
],
"flow-types-info": "integer",
"ttl": "integer",
"options": {
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
}
}
}
]
}
]
}
display-type_schema:
- disp-type: string all, static-policy, interface-filter, packet-filter
-
Specifying display type
- connection-id: object[]
-
Describing connection ID
-
- pcb-id: string
-
Displaying inforamtion based on selected display type associatedwith a particular PCB
Example
{
"disp-type": "string",
"connection-id": [
{
"pcb-id": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"l4-protocol": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"common": {
"af-name": "string",
"lpts-pcb": {
"accept-mask": {
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
},
"lpts-flags": {
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
},
"filter": [
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
],
"flow-types-info": "integer",
"ttl": "integer",
"options": {
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
}
}
}
]
}
connection-id_schema:
- pcb-id: string
-
Displaying inforamtion based on selected display type associatedwith a particular PCB
Example
{
"pcb-id": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"l4-protocol": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"common": {
"af-name": "string",
"lpts-pcb": {
"accept-mask": {
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
},
"lpts-flags": {
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
},
"filter": [
{
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"interface-name": "string",
"packet-type": {
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
},
"local-length": "integer",
"priority": "integer",
"flow-types-info": "integer",
"receive-remote-port": "integer",
"ttl": "integer",
"remote-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"receive-local-port": "integer",
"remote-length": "integer"
}
],
"flow-types-info": "integer",
"ttl": "integer",
"options": {
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
}
}
}
detail-informations_schema:
Table listing TCP connections for which detailed information is provided
- detail-information: object[]
-
Protocol Control Block ID
-
- pcb-id: string
-
Detail information about TCP connection, put null for all
Example
{
"detail-information": [
{
"rqst-send-wnd-scale": "integer",
"established-time": "integer",
"send-sack-hole": [
{
"start": "integer",
"retransmitted": "integer",
"end": "integer",
"duplicated-ack": "integer"
}
],
"recvbuf-hiwat": "integer",
"pcb": "integer",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"retries": "integer",
"max-mss": "integer",
"receive-buf-state-flags": {
"async-io": "boolean",
"locked": "boolean",
"output-select": "boolean",
"waiting-for-data": "boolean",
"io-timer-set": "boolean",
"out-of-band-select": "boolean",
"not-interruptible": "boolean",
"delayed-wakeup": "boolean",
"input-select": "boolean",
"wakeup": "boolean",
"connect-wakeup": "boolean",
"waiting-for-lock": "boolean"
},
"send-max-sequence-num": "integer",
"socket-option-flags": {
"linger": "boolean",
"reuse-address": "boolean",
"keep-alive": "boolean",
"out-of-band-inline": "boolean",
"broadcast": "boolean",
"dont-route": "boolean",
"debug": "boolean",
"reuse-port": "boolean",
"accept-connection": "boolean",
"use-loopback": "boolean",
"nonblocking-io": "boolean"
},
"tcpcb": "integer",
"srtv": "integer",
"last-ack-sent": "integer",
"srtt": "integer",
"packet-priority": "string",
"sack-blk": [
{
"start": "integer",
"end": "integer"
}
],
"krtt": "integer",
"local-pid": "integer",
"request-receive-window-scale": "integer",
"min-rtt": "integer",
"is-retrans-forever": "boolean",
"receive-adv-window-size": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"peer-mss": "integer",
"keep-alive-time": "integer",
"fib-pd-ctx": [
{
"entry": "integer"
}
],
"local-port": "integer",
"foreign-port": "integer",
"rxsy-naclname": "string",
"socket-state-flags": {
"is-confirming": "boolean",
"cant-receive-more": "boolean",
"block-close": "boolean",
"received-at-mark": "boolean",
"is-connected": "boolean",
"cant-send-more": "boolean",
"privileged": "boolean",
"is-detached": "boolean",
"is-solock": "boolean",
"block-send": "boolean",
"no-file-descriptor-reference": "boolean",
"is-disconnecting": "boolean",
"async-io-notify": "boolean",
"is-connecting": "boolean",
"block-receive": "boolean"
},
"packet-ttl": "integer",
"save-queue-size": "integer",
"connect-retries": "integer"
}
]
}
detail-information_schema:
- pcb-id: string
-
Detail information about TCP connection, put null for all
Example
{
"rqst-send-wnd-scale": "integer",
"established-time": "integer",
"send-sack-hole": [
{
"start": "integer",
"retransmitted": "integer",
"end": "integer",
"duplicated-ack": "integer"
}
],
"recvbuf-hiwat": "integer",
"pcb": "integer",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"retries": "integer",
"max-mss": "integer",
"receive-buf-state-flags": {
"async-io": "boolean",
"locked": "boolean",
"output-select": "boolean",
"waiting-for-data": "boolean",
"io-timer-set": "boolean",
"out-of-band-select": "boolean",
"not-interruptible": "boolean",
"delayed-wakeup": "boolean",
"input-select": "boolean",
"wakeup": "boolean",
"connect-wakeup": "boolean",
"waiting-for-lock": "boolean"
},
"send-max-sequence-num": "integer",
"socket-option-flags": {
"linger": "boolean",
"reuse-address": "boolean",
"keep-alive": "boolean",
"out-of-band-inline": "boolean",
"broadcast": "boolean",
"dont-route": "boolean",
"debug": "boolean",
"reuse-port": "boolean",
"accept-connection": "boolean",
"use-loopback": "boolean",
"nonblocking-io": "boolean"
},
"tcpcb": "integer",
"srtv": "integer",
"last-ack-sent": "integer",
"srtt": "integer",
"packet-priority": "string",
"sack-blk": [
{
"start": "integer",
"end": "integer"
}
],
"krtt": "integer",
"local-pid": "integer",
"request-receive-window-scale": "integer",
"min-rtt": "integer",
"is-retrans-forever": "boolean",
"receive-adv-window-size": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"peer-mss": "integer",
"keep-alive-time": "integer",
"fib-pd-ctx": [
{
"entry": "integer"
}
],
"local-port": "integer",
"foreign-port": "integer",
"rxsy-naclname": "string",
"socket-state-flags": {
"is-confirming": "boolean",
"cant-receive-more": "boolean",
"block-close": "boolean",
"received-at-mark": "boolean",
"is-connected": "boolean",
"cant-send-more": "boolean",
"privileged": "boolean",
"is-detached": "boolean",
"is-solock": "boolean",
"block-send": "boolean",
"no-file-descriptor-reference": "boolean",
"is-disconnecting": "boolean",
"async-io-notify": "boolean",
"is-connecting": "boolean",
"block-receive": "boolean"
},
"packet-ttl": "integer",
"save-queue-size": "integer",
"connect-retries": "integer",
"num-labels": "integer",
"recvbuf-lowwat": "integer"
}
keychains_schema:
Table listing keychains configured for TCP-AO.
- keychain: object[]
-
Details of a keychain
-
- keychain-name: string
-
Keychain name
Example
{
"keychain": [
{
"keychain-name": "string",
"desired-key-available": "boolean",
"chain-name": "string",
"is-configured": "boolean",
"desired-key-id": "integer",
"keys": [
{
"overlapping-key-available": "boolean",
"is-valid": "boolean",
"crypt-algo": "string",
"is-configured": "boolean",
"reason": "string",
"invalidated-key": [
{
"key-id": "integer"
}
],
"overlapping-key": "integer",
"recv-id": "integer",
"is-active": "boolean",
"send-id": "integer",
"is-expired": "boolean",
"key-id": "integer"
}
],
"send-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"receive-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"active-key": [
{
"key-id": "integer"
}
]
}
]
}
keychain_schema:
- keychain-name: string
-
Keychain name
Example
{
"keychain-name": "string",
"desired-key-available": "boolean",
"chain-name": "string",
"is-configured": "boolean",
"desired-key-id": "integer",
"keys": [
{
"overlapping-key-available": "boolean",
"is-valid": "boolean",
"crypt-algo": "string",
"is-configured": "boolean",
"reason": "string",
"invalidated-key": [
{
"key-id": "integer"
}
],
"overlapping-key": "integer",
"recv-id": "integer",
"is-active": "boolean",
"send-id": "integer",
"is-expired": "boolean",
"key-id": "integer"
}
],
"send-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"receive-id": [
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
],
"active-key": [
{
"key-id": "integer"
}
]
}
brief-informations_schema:
Table listing connections for which brief information is provided.Note that not all connections are listed in the brief table.
- brief-information: object[]
-
Brief information about a TCP connection
-
- pcb-id: string
-
Protocol Control Block ID
Example
{
"brief-information": [
{
"pcb-id": "string",
"local-pid": "integer",
"af-name": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"current-send-queue-size": "integer",
"vrf-id": "integer",
"current-receive-queue-size": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pcb": "integer",
"connection-state": "string"
}
]
}
brief-information_schema:
- pcb-id: string
-
Protocol Control Block ID
Example
{
"pcb-id": "string",
"local-pid": "integer",
"af-name": "string",
"local-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"foreign-port": "integer",
"local-port": "integer",
"current-send-queue-size": "integer",
"vrf-id": "integer",
"current-receive-queue-size": "integer",
"foreign-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"pcb": "integer",
"connection-state": "string"
}
tcp_schema:
tcp
- nodes: object
-
Node-specific TCP operational data
-
- node: object[]
-
TCP operational data for a particular node
-
object
Example
{
"nodes": {
"node": [
{
"node-name": "string",
"statistics": {
"ipv4-traffic": {
"tcp-checksum-error-packets": "integer",
"tcp-dropped-packets": "integer",
"tcp-input-packets": "integer",
"tcp-retransmitted-packets": "integer",
"tcp-output-packets": "integer"
},
"ipv6-traffic": {
"tcp-checksum-error-packets": "integer",
"tcp-dropped-packets": "integer",
"tcp-input-packets": "integer",
"tcp-retransmitted-packets": "integer",
"tcp-output-packets": "integer"
}
}
}
]
}
}
tcp-nsr_schema:
tcp nsr
- nodes: object
-
Table of information about all nodes present on the system
-
- node: object[]
-
Information about a single node
-
object - session-set: object
-
Information about TCP NSR Session Sets
-
- brief-sets: object
-
Information about TCP NSR Session Sets
-
- brief-set: object[]
-
Brief information about NSR Session Sets
-
- id: string
-
ID of NSR Session Set
- detail-sets: object
-
Table about TCP NSR Session Sets details
-
- detail-set: object[]
-
showing detailed information of NSR Session Sets
-
- id: string
-
ID of NSR Sesison Set
- statistics: object
-
Statis Information about TCP NSR connections
-
- statistic-clients: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-client: object[]
-
showing statistic information of NSR Clients
-
- id: string
-
ID of NSR Client
- statistic-sessions: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-session: object[]
-
showing statistic information of TCP connections
-
- id: string
-
ID of TCP connection
- statistic-sets: object
-
Table listing NSR connections for which statistic information is provided
-
- statistic-set: object[]
-
showing statistic information of NSR Session Set
-
- id: string
-
ID of NSR Session Set
- summary: TCP-NSR-SUMMARY-STATS-BAG
-
Summary statistics across all NSR connections
- id: string
-
Describing a location
- session: object
-
Information about TCP NSR Sessions
-
- detail-sessions: object
-
Table about TCP NSR Sessions details
-
- detail-session: object[]
-
showing detailed information of NSR Sessions
-
- id: string
-
ID of NSR Sesison
- brief-sessions: object
-
Information about TCP NSR Sessions
-
- brief-session: object[]
-
Brief information about NSR Sessions
-
- id: string
-
ID of NSR Sesison
- client: object
-
Information about TCP NSR Client
-
- brief-clients: object
-
Information about TCP NSR Client
-
- brief-client: object[]
-
Brief information about NSR Client
-
- id: string
-
ID of NSR client
- detail-clients: object
-
Table about TCP NSR Client details
-
- detail-client: object[]
-
showing detailed information of NSR Clients
-
- id: string
-
ID of NSR client
Example
{
"nodes": {
"node": [
{
"session-set": {
"brief-sets": {
"brief-set": [
{
"id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
]
},
"detail-sets": {
"detail-set": [
{
"id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
]
}
},
"statistics": {
"statistic-clients": {
"statistic-client": [
{
"id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
]
},
"statistic-sessions": {
"statistic-session": [
{
"internal-ack-drops-stale": "integer"
}
]
}
}
}
]
}
}
session_schema:
Information about TCP NSR Sessions
- detail-sessions: object
-
Table about TCP NSR Sessions details
-
- detail-session: object[]
-
showing detailed information of NSR Sessions
-
- id: string
-
ID of NSR Sesison
- brief-sessions: object
-
Information about TCP NSR Sessions
-
- brief-session: object[]
-
Brief information about NSR Sessions
-
- id: string
-
ID of NSR Sesison
Example
{
"detail-sessions": {
"detail-session": [
{
"id": "string",
"max-number-of-held-packet-reach-time": "integer",
"init-sync-end-time": "integer",
"is-session-replicated": "boolean",
"vrf-id": "integer",
"peer-endp-hdl-down-stream": "integer",
"max-number-of-held-packet": "string",
"init-sync-start-time-down-stream": "integer",
"peer-endp-hdl-up-stream": "integer",
"foreign-address": [
{
"entry": "string"
}
],
"internal-ack-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"init-sync-flags": "integer",
"foreign-port": "integer",
"set-information": {
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
},
"is-session-synced": "boolean",
"nsr-down-reason-up-stream": "string",
"init-sync-end-time-up-stream": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"fist-standby-sequence-number-down-stream": "integer",
"pcb": "integer",
"sequence-number-of-init-sync-up-stream": "integer",
"nsr-down-reason": "string",
"max-number-of-held-internal-ack-reach-time": "integer",
"sequence-number-of-init-sync": "integer",
"local-address": [
{
"entry": "string"
}
],
"local-port": "integer",
"fist-standby-sequence-number": "integer",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-ds-operational-up": "string",
"nsr-down-reason-down-stream": "string",
"sequence-number-of-init-sync-down-stream": "integer",
"init-sync-start-time-up-stream": "integer",
"nsr-down-time-down-stream": "integer",
"is-only-receive-path-replication": "boolean",
"fssn-offset": "integer",
"address-family": "string",
"init-sync-error": "string",
"is-admin-configured-up": "boolean",
"fist-standby-sequence-number-up-stream": "integer",
"nsr-down-time": "integer",
"packet-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"max-number-of-held-internal-ack": "string",
"init-sync-start-time": "integer",
"nsr-down-time-up-stream": "integer",
"cookie": "integer",
"init-sync-end-time-down-stream": "integer",
"is-init-sync-in-progress": "boolean"
}
]
},
"brief-sessions": {
"brief-session": [
{
"foreign-address": [
{
"entry": "string"
}
],
"local-address": [
{
"entry": "string"
}
]
}
]
}
}
brief-sessions_schema:
Information about TCP NSR Sessions
- brief-session: object[]
-
Brief information about NSR Sessions
-
- id: string
-
ID of NSR Sesison
Example
{
"brief-session": [
{
"id": "string",
"foreign-address": [
{
"entry": "string"
}
],
"local-address": [
{
"entry": "string"
}
],
"foreign-port": "integer",
"local-port": "integer",
"is-ds-operational-up": "string",
"vrf-id": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"is-only-receive-path-replication": "boolean",
"pcb": "integer",
"address-family": "string",
"is-admin-configured-up": "boolean"
}
]
}
brief-session_schema:
- rief-session_id: string
-
ID of NSR Sesison
Example
{
"rief-session_id": "string",
"foreign-address": [
{
"entry": "string"
}
],
"local-address": [
{
"entry": "string"
}
],
"foreign-port": "integer",
"local-port": "integer",
"is-ds-operational-up": "string",
"vrf-id": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"is-only-receive-path-replication": "boolean",
"pcb": "integer",
"address-family": "string",
"is-admin-configured-up": "boolean"
}
detail-sessions_schema:
Table about TCP NSR Sessions details
- detail-session: object[]
-
showing detailed information of NSR Sessions
-
- id: string
-
ID of NSR Sesison
Example
{
"detail-session": [
{
"id": "string",
"max-number-of-held-packet-reach-time": "integer",
"init-sync-end-time": "integer",
"is-session-replicated": "boolean",
"vrf-id": "integer",
"peer-endp-hdl-down-stream": "integer",
"max-number-of-held-packet": "string",
"init-sync-start-time-down-stream": "integer",
"peer-endp-hdl-up-stream": "integer",
"foreign-address": [
{
"entry": "string"
}
],
"internal-ack-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"init-sync-flags": "integer",
"foreign-port": "integer",
"set-information": {
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
},
"is-session-synced": "boolean",
"nsr-down-reason-up-stream": "string",
"init-sync-end-time-up-stream": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"fist-standby-sequence-number-down-stream": "integer",
"pcb": "integer",
"sequence-number-of-init-sync-up-stream": "integer",
"nsr-down-reason": "string",
"max-number-of-held-internal-ack-reach-time": "integer",
"sequence-number-of-init-sync": "integer",
"local-address": [
{
"entry": "string"
}
],
"local-port": "integer",
"fist-standby-sequence-number": "integer",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-ds-operational-up": "string",
"nsr-down-reason-down-stream": "string",
"sequence-number-of-init-sync-down-stream": "integer",
"init-sync-start-time-up-stream": "integer",
"nsr-down-time-down-stream": "integer",
"is-only-receive-path-replication": "boolean",
"fssn-offset": "integer",
"address-family": "string",
"init-sync-error": "string",
"is-admin-configured-up": "boolean",
"fist-standby-sequence-number-up-stream": "integer",
"nsr-down-time": "integer",
"packet-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"max-number-of-held-internal-ack": "string",
"init-sync-start-time": "integer",
"nsr-down-time-up-stream": "integer",
"cookie": "integer",
"init-sync-end-time-down-stream": "integer",
"is-init-sync-in-progress": "boolean"
}
]
}
detail-session_schema:
- etail-session_id: string
-
ID of NSR Sesison
Example
{
"etail-session_id": "string",
"max-number-of-held-packet-reach-time": "integer",
"init-sync-end-time": "integer",
"is-session-replicated": "boolean",
"vrf-id": "integer",
"peer-endp-hdl-down-stream": "integer",
"max-number-of-held-packet": "string",
"init-sync-start-time-down-stream": "integer",
"peer-endp-hdl-up-stream": "integer",
"foreign-address": [
{
"entry": "string"
}
],
"internal-ack-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"init-sync-flags": "integer",
"foreign-port": "integer",
"set-information": {
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
},
"is-session-synced": "boolean",
"nsr-down-reason-up-stream": "string",
"init-sync-end-time-up-stream": "integer",
"is-us-operational-up": "string",
"sscb": "integer",
"fist-standby-sequence-number-down-stream": "integer",
"pcb": "integer",
"sequence-number-of-init-sync-up-stream": "integer",
"nsr-down-reason": "string",
"max-number-of-held-internal-ack-reach-time": "integer",
"sequence-number-of-init-sync": "integer",
"local-address": [
{
"entry": "string"
}
],
"local-port": "integer",
"fist-standby-sequence-number": "integer",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-ds-operational-up": "string",
"nsr-down-reason-down-stream": "string",
"sequence-number-of-init-sync-down-stream": "integer",
"init-sync-start-time-up-stream": "integer",
"nsr-down-time-down-stream": "integer",
"is-only-receive-path-replication": "boolean",
"fssn-offset": "integer",
"address-family": "string",
"init-sync-error": "string",
"is-admin-configured-up": "boolean",
"fist-standby-sequence-number-up-stream": "integer",
"nsr-down-time": "integer",
"packet-hold-queue": [
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
],
"max-number-of-held-internal-ack": "string",
"init-sync-start-time": "integer",
"nsr-down-time-up-stream": "integer",
"cookie": "integer",
"init-sync-end-time-down-stream": "integer",
"is-init-sync-in-progress": "boolean"
}
detail-clients_schema:
Table about TCP NSR Client details
- detail-client: object[]
-
showing detailed information of NSR Clients
-
- id: string
-
ID of NSR client
Example
{
"detail-client": [
{
"id": "string",
"number-of-up-sessions": "integer",
"is-notification-registered": "boolean",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
]
}
detail-client_schema:
- etail-client_id: string
-
ID of NSR client
Example
{
"etail-client_id": "string",
"number-of-up-sessions": "integer",
"is-notification-registered": "boolean",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
brief-clients_schema:
Information about TCP NSR Client
- brief-client: object[]
-
Brief information about NSR Client
-
- id: string
-
ID of NSR client
Example
{
"brief-client": [
{
"id": "string",
"number-of-up-sessions": "integer",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
]
}
brief-client_schema:
- rief-client_id: string
-
ID of NSR client
Example
{
"rief-client_id": "string",
"number-of-up-sessions": "integer",
"number-of-sessions": "integer",
"pid": "integer",
"process-name": "string",
"instance": "integer",
"numberof-sets": "integer",
"job-id": "string",
"ccb": "integer"
}
session-set_schema:
Information about TCP NSR Session Sets
- brief-sets: object
-
Information about TCP NSR Session Sets
-
- brief-set: object[]
-
Brief information about NSR Session Sets
-
- id: string
-
ID of NSR Session Set
- detail-sets: object
-
Table about TCP NSR Session Sets details
-
- detail-set: object[]
-
showing detailed information of NSR Session Sets
-
- id: string
-
ID of NSR Sesison Set
Example
{
"brief-sets": {
"brief-set": [
{
"id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
]
},
"detail-sets": {
"detail-set": [
{
"id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
]
}
}
detail-sets_schema:
Table about TCP NSR Session Sets details
- detail-set: object[]
-
showing detailed information of NSR Session Sets
-
- id: string
-
ID of NSR Sesison Set
Example
{
"detail-set": [
{
"id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
]
}
detail-set_schema:
- etail-set_id: string
-
ID of NSR Sesison Set
Example
{
"etail-set_id": "string",
"total-number-of-init-sync-sessions": "integer",
"init-sync-end-time": "integer",
"audit-end-time": "integer",
"protect-node": "string",
"protect-instance": "integer",
"pid": "integer",
"is-audit-in-progress": "boolean",
"sso-role": "integer",
"audit-start-time": "integer",
"number-of-sessions": "integer",
"sscb": "integer",
"audit-seq-number": "integer",
"init-sync-ready-start-time": "integer",
"local-node": "string",
"local-instance": "integer",
"sequence-number-of-init-sync": "integer",
"number-of-init-synced-sessions": "integer",
"nsr-reset-time": "integer",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-second-phase": "boolean",
"is-init-sync-error-local": "boolean",
"is-init-sync-in-progress": "boolean",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"init-sync-error": "string",
"number-of-sessions-init-sync-failed": "integer",
"well-known-port": "integer",
"set-id": "integer",
"init-sync-start-time": "integer",
"number-of-synced-sessions-down-stream": "integer",
"init-sync-timer": "integer",
"mode": "integer",
"init-sync-ready-end-time": "integer"
}
brief-sets_schema:
Information about TCP NSR Session Sets
- brief-set: object[]
-
Brief information about NSR Session Sets
-
- id: string
-
ID of NSR Session Set
Example
{
"brief-set": [
{
"id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
]
}
brief-set_schema:
- rief-set_id: string
-
ID of NSR Session Set
Example
{
"rief-set_id": "string",
"well-known-port": "integer",
"client-instance": "integer",
"number-of-sessions": "integer",
"local-instance": "integer",
"set-id": "integer",
"pid": "integer",
"protect-node": "string",
"protect-instance": "integer",
"client-name": "string",
"number-of-synced-sessions-down-stream": "integer",
"local-node": "string",
"sscb": "integer",
"mode": "integer",
"sso-role": "integer",
"number-of-synced-sessions-up-stream": "integer",
"address-family": "string",
"is-sscb-init-sync-ready": "boolean",
"is-init-sync-in-progress": "boolean"
}
statistic-clients_schema:
Table listing NSR connections for which statistic information is provided
- statistic-client: object[]
-
showing statistic information of NSR Clients
-
- id: string
-
ID of NSR Client
Example
{
"statistic-client": [
{
"id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
]
}
statistic-client_schema:
- tatistic-client_id: string
-
ID of NSR Client
Example
{
"tatistic-client_id": "string",
"number-of-deleted-sscb": "integer",
"number-of-created-sscb": "integer",
"notification-statistic": [
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
],
"pid": "integer",
"process-name": "string",
"instance": "integer",
"connected-at": "integer",
"job-id": "string",
"last-cleared-time": "integer",
"ccb": "integer"
}
statistic-sets_schema:
Table listing NSR connections for which statistic information is provided
- statistic-set: object[]
-
showing statistic information of NSR Session Set
-
- id: string
-
ID of NSR Session Set
Example
{
"statistic-set": [
{
"id": "string",
"set-id": "integer",
"number-of-nsr-resets": "integer",
"number-of-failed-init-sync": "integer",
"sscb": "integer",
"number-of-succeeded-init-sync": "integer",
"number-of-failover": "integer",
"number-of-attempted-init-sync": "integer",
"last-cleared-time": "integer"
}
]
}
statistic-set_schema:
- tatistic-set_id: string
-
ID of NSR Session Set
Example
{
"tatistic-set_id": "string",
"set-id": "integer",
"number-of-nsr-resets": "integer",
"number-of-failed-init-sync": "integer",
"sscb": "integer",
"number-of-succeeded-init-sync": "integer",
"number-of-failover": "integer",
"number-of-attempted-init-sync": "integer",
"last-cleared-time": "integer"
}
statistic-sessions_schema:
Table listing NSR connections for which statistic information is provided
- statistic-session: object[]
-
showing statistic information of TCP connections
-
- id: string
-
ID of TCP connection
Example
{
"statistic-session": [
{
"id": "string",
"internal-ack-drops-stale": "integer",
"snd-counters": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
},
"internal-ack-drops-not-replicated": "integer",
"number-of-times-nsr-up": "integer",
"number-of-times-nsr-disabled": "integer",
"internal-ack-drops-initsync-first-phase": "integer",
"internal-ack-drops-immediate-match": "integer",
"number-of-timers-nsr-down": "integer",
"pcb": "integer",
"number-of-times-nsr-fail-over": "integer",
"last-cleared-time": "integer"
}
]
}
statistic-session_schema:
- tatistic-session_id: string
-
ID of TCP connection
Example
{
"tatistic-session_id": "string",
"internal-ack-drops-stale": "integer",
"snd-counters": {
"seg-instr-send": "integer",
"seg-instr-rcv": "integer",
"seg-instr-rcv-fail-buffer-trim": "integer",
"nack-rcv-success": "integer",
"seg-instr-rcv-fail-tcp-process": "integer",
"data-xfer-rcv-fail-buffer-trim": "integer",
"data-xfer-send-iov-alloc": "integer",
"cleanup-send-drop": "integer",
"data-xfer-rcv-success": "integer",
"data-xfer-rcv-fail-snd-una-out-of-sync": "integer",
"data-xfer-send-total": "integer",
"seg-instr-send-units": "integer",
"cleanup-rcv": "integer",
"data-xfer-send-drop": "integer",
"nack-rcv": "integer",
"nack-send-drop": "integer",
"cleanup-send": "integer",
"nack-rcv-fail-data-send": "integer",
"cleanup-rcv-fail-buffer-trim": "integer",
"cleanup-rcv-success": "integer",
"seg-instr-rcv-success": "integer",
"data-xfer-rcv": "integer",
"data-xfer-send": "integer",
"nack-send": "integer",
"seg-instr-send-drop": "integer"
},
"internal-ack-drops-not-replicated": "integer",
"number-of-times-nsr-up": "integer",
"number-of-times-nsr-disabled": "integer",
"internal-ack-drops-initsync-first-phase": "integer",
"internal-ack-drops-immediate-match": "integer",
"number-of-timers-nsr-down": "integer",
"pcb": "integer",
"number-of-times-nsr-fail-over": "integer",
"last-cleared-time": "integer"
}