Cisco-IOS-XR-ip-tcp-oper API API Reference
API generated from<EMAIL_ADDRESS>API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
TCP-CONNECTION - Retrieve
Retrieve operation of resource: tcp-connection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": [
{}
]
}
}
}
]
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: node
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": {}
}
]
}
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
}
CLIENTS - Retrieve
Retrieve operation of resource: clients
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: client
ID of id
ID of client-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: pcbs
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: pcb
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
READ-IO-COUNTS - Retrieve
Retrieve operation of resource: read-io-counts
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
}
WRITE-IO-COUNTS - Retrieve
Retrieve operation of resource: write-io-counts
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
}
ASYNC-SESSION-STATS - Retrieve
Retrieve operation of resource: async-session-stats
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
DATA-WRITE-SUCCESS-NUM - Retrieve
Retrieve operation of resource: data-write-success-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
DATA-READ-SUCCESS-NUM - Retrieve
Retrieve operation of resource: data-read-success-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
DATA-WRITE-ERROR-NUM - Retrieve
Retrieve operation of resource: data-write-error-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
DATA-READ-ERROR-NUM - Retrieve
Retrieve operation of resource: data-read-error-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CONTROL-WRITE-SUCCESS-NUM - Retrieve
Retrieve operation of resource: control-write-success-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CONTROL-READ-SUCCESS-NUM - Retrieve
Retrieve operation of resource: control-read-success-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CONTROL-WRITE-ERROR-NUM - Retrieve
Retrieve operation of resource: control-write-error-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
CONTROL-READ-ERROR-NUM - Retrieve
Retrieve operation of resource: control-read-error-num
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
DATA-WRITE-BYTE - Retrieve
Retrieve operation of resource: data-write-byte
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
DATA-READ-BYTE - Retrieve
Retrieve operation of resource: data-read-byte
ID of id
ID of cb_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
IQS-TOTAL-INGPACKET - Retrieve
Retrieve operation of resource: iqs-total-ingpacket
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
IQS-TOTAL-EGPACKET - Retrieve
Retrieve operation of resource: iqs-total-egpacket
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
EXTENDED-INFORMATION - Retrieve
Retrieve operation of resource: extended-information
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: display-types
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: display-type
ID of id
ID of disp-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: connection-id
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
}
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
FOREIGN-ADDRESS - Retrieve
Retrieve operation of resource: foreign-address
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
COMMON - Retrieve
Retrieve operation of resource: common
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
}
LPTS-PCB - Retrieve
Retrieve operation of resource: lpts-pcb
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
OPTIONS - Retrieve
Retrieve operation of resource: options
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
LPTS-FLAGS - Retrieve
Retrieve operation of resource: lpts-flags
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-ignore-vrf-filter": "boolean",
"is-pcb-bound": "boolean",
"is-local-address-ignore": "boolean"
}
ACCEPT-MASK - Retrieve
Retrieve operation of resource: accept-mask
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-interface": "boolean",
"is-remote-port": "boolean",
"is-packet-type": "boolean",
"is-remote-address": "boolean",
"is-local-port": "boolean",
"is-local-address": "boolean"
}
FILTER - Retrieve
Retrieve operation of resource: filter
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
PACKET-TYPE - Retrieve
Retrieve operation of resource: packet-type
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-id": "string",
"icm-pv6-message-type": "string",
"icmp-message-type": "string",
"type": "string",
"igmp-message-type": "string"
}
REMOTE-ADDRESS - Retrieve
Retrieve operation of resource: remote-address
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of disp-type
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-INFORMATIONS - Retrieve
Retrieve operation of resource: detail-informations
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
DETAIL-INFORMATION - Retrieve
Retrieve operation of resource: detail-information
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
FOREIGN-ADDRESS - Retrieve
Retrieve operation of resource: foreign-address
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOCKET-OPTION-FLAGS - Retrieve
Retrieve operation of resource: socket-option-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
SOCKET-STATE-FLAGS - Retrieve
Retrieve operation of resource: socket-state-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
FEATURE-FLAGS - Retrieve
Retrieve operation of resource: feature-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-mtu-discovery": "boolean",
"giveup-timer": "boolean",
"mss-cisco": "boolean",
"connection-keep-alive-timer": "boolean",
"selective-ack": "boolean",
"timestamps": "boolean",
"window-scaling": "boolean",
"nagle": "boolean",
"md5": "boolean"
}
STATE-FLAGS - Retrieve
Retrieve operation of resource: state-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nagle-wait": "boolean",
"fin-sent": "boolean",
"ack-needed": "boolean",
"path-mtu-ager": "boolean",
"pushed": "boolean",
"in-syn-cache": "boolean",
"probing": "boolean",
"need-push": "boolean"
}
REQUEST-FLAGS - Retrieve
Retrieve operation of resource: request-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-mtu-discovery": "boolean",
"giveup-timer": "boolean",
"mss-cisco": "boolean",
"connection-keep-alive-timer": "boolean",
"selective-ack": "boolean",
"timestamps": "boolean",
"window-scaling": "boolean",
"nagle": "boolean",
"md5": "boolean"
}
RECEIVE-BUF-STATE-FLAGS - Retrieve
Retrieve operation of resource: receive-buf-state-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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-BUF-STATE-FLAGS - Retrieve
Retrieve operation of resource: send-buf-state-flags
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
FIB-PD-CTX - Retrieve
Retrieve operation of resource: fib-pd-ctx
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
FIB-LABEL-OUTPUT - Retrieve
Retrieve operation of resource: fib-label-output
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "integer"
}
TIMER - Retrieve
Retrieve operation of resource: timer
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"timer-expirations": "integer",
"timer-activations": "integer",
"timer-type": "string",
"timer-next-activation": "integer"
}
SACK-BLK - Retrieve
Retrieve operation of resource: sack-blk
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"start": "integer",
"end": "integer"
}
SEND-SACK-HOLE - Retrieve
Retrieve operation of resource: send-sack-hole
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"start": "integer",
"retransmitted": "integer",
"end": "integer",
"duplicated-ack": "integer"
}
KEYCHAINS - Retrieve
Retrieve operation of resource: keychains
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: keychain
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
KEYS - Retrieve
Retrieve operation of resource: keys
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
INVALIDATED-KEY - Retrieve
Retrieve operation of resource: invalidated-key
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"key-id": "integer"
}
ACTIVE-KEY - Retrieve
Retrieve operation of resource: active-key
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"key-id": "integer"
}
SEND-ID - Retrieve
Retrieve operation of resource: send-id
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
KEYS - Retrieve
Retrieve operation of resource: keys
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"key-id": "integer"
}
RECEIVE-ID - Retrieve
Retrieve operation of resource: receive-id
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"keys": [
{
"key-id": "integer"
}
],
"id": "integer"
}
KEYS - Retrieve
Retrieve operation of resource: keys
ID of id
ID of keychain-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"key-id": "integer"
}
BRIEF-INFORMATIONS - Retrieve
Retrieve operation of resource: brief-informations
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-information
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
FOREIGN-ADDRESS - Retrieve
Retrieve operation of resource: foreign-address
ID of id
ID of pcb-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TCP - Retrieve
Retrieve operation of resource: tcp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
}
]
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: node
ID of node-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": {}
}
]
}
}
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of node-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
}
IPV4-TRAFFIC - Retrieve
Retrieve operation of resource: ipv4-traffic
ID of node-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-checksum-error-packets": "integer",
"tcp-dropped-packets": "integer",
"tcp-input-packets": "integer",
"tcp-retransmitted-packets": "integer",
"tcp-output-packets": "integer"
}
IPV6-TRAFFIC - Retrieve
Retrieve operation of resource: ipv6-traffic
ID of node-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tcp-checksum-error-packets": "integer",
"tcp-dropped-packets": "integer",
"tcp-input-packets": "integer",
"tcp-retransmitted-packets": "integer",
"tcp-output-packets": "integer"
}
TCP-NSR - Retrieve
Retrieve operation of resource: tcp-nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": [
{}
]
}
}
}
]
}
}
NODES - Retrieve
Retrieve operation of resource: nodes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: node
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": {}
}
]
}
}
}
SESSION - Retrieve
Retrieve operation of resource: session
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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": [
{}
]
}
]
}
}
BRIEF-SESSIONS - Retrieve
Retrieve operation of resource: brief-sessions
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-session
ID of id
ID of rief-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of rief-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
FOREIGN-ADDRESS - Retrieve
Retrieve operation of resource: foreign-address
ID of id
ID of rief-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
DETAIL-SESSIONS - Retrieve
Retrieve operation of resource: detail-sessions
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: detail-session
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
SET-INFORMATION - Retrieve
Retrieve operation of resource: set-information
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
LOCAL-ADDRESS - Retrieve
Retrieve operation of resource: local-address
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
FOREIGN-ADDRESS - Retrieve
Retrieve operation of resource: foreign-address
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"entry": "string"
}
PACKET-HOLD-QUEUE - Retrieve
Retrieve operation of resource: packet-hold-queue
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
INTERNAL-ACK-HOLD-QUEUE - Retrieve
Retrieve operation of resource: internal-ack-hold-queue
ID of id
ID of etail-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"acknoledgement-number": "integer",
"sequence-number": "integer",
"data-length": "integer"
}
CLIENT - Retrieve
Retrieve operation of resource: client
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
}
DETAIL-CLIENTS - Retrieve
Retrieve operation of resource: detail-clients
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: detail-client
ID of id
ID of etail-client_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-clients
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-client
ID of id
ID of rief-client_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: session-set
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: detail-sets
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: detail-set
ID of id
ID of etail-set_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-sets
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: brief-set
ID of id
ID of rief-set_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
STATISTICS - Retrieve
Retrieve operation of resource: statistics
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
}
SND-COUNTERS - Retrieve
Retrieve operation of resource: snd-counters
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
COMMON - Retrieve
Retrieve operation of resource: common
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
AGGR-ONLY - Retrieve
Retrieve operation of resource: aggr-only
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
AUDIT-COUNTERS - Retrieve
Retrieve operation of resource: audit-counters
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
}
COMMON - Retrieve
Retrieve operation of resource: common
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
AGGR-ONLY - Retrieve
Retrieve operation of resource: aggr-only
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
NOTIFICATION-STATISTIC - Retrieve
Retrieve operation of resource: notification-statistic
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
STATISTIC-CLIENTS - Retrieve
Retrieve operation of resource: statistic-clients
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: statistic-client
ID of id
ID of tatistic-client_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
NOTIFICATION-STATISTIC - Retrieve
Retrieve operation of resource: notification-statistic
ID of id
ID of tatistic-client_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"failed-count": "integer",
"dropped-count": "integer",
"queued-count": "integer",
"delivered-count": "integer"
}
STATISTIC-SETS - Retrieve
Retrieve operation of resource: statistic-sets
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: statistic-set
ID of id
ID of tatistic-set_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: statistic-sessions
ID of id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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 - Retrieve
Retrieve operation of resource: statistic-session
ID of id
ID of tatistic-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
SND-COUNTERS - Retrieve
Retrieve operation of resource: snd-counters
ID of id
ID of tatistic-session_id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"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"
}
Schema Definitions
TCP-NSR-SND-COUNTERS-AGGR-ONLY-NODE:
Send path aggregate only counters
- cleanup-rcv-drop-no-scb-dp: integer
-
Number of Cleanup messages dropped because SCB DP wasn't found
- seg-instr-rcv-drop-no-scb-dp: integer
-
Number of Segmentation instruction messages dropped because SCB DP wasn't found
- nack-rcv-drop-no-pcb: integer
-
Number of NACK messages dropped because PCB wasn't found
- cleanup-rcv-drop-no-pcb: integer
-
Number of Cleanup messages dropped because PCB wasn't found
- data-xfer-rcv-drop-no-scb-dp: integer
-
Number of Data transfer messages dropped because SCB DP wasn't found
- seg-instr-rcv-drop-no-pcb: integer
-
Number of Segmentation instruction messages dropped because PCB wasn't found
- data-xfer-rcv-drop-no-pcb: integer
-
Number of Data transfer messages dropped because PCB wasn't found
- nack-rcv-drop-no-scb-dp: integer
-
Number of NACK messages dropped because SCB DP wasn't found
Example
{
"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"
}
TCP-SOCK-STATES-BAG:
TCP Socket State Flags
- is-confirming: boolean
-
Deciding to accept connection req
- cant-receive-more: boolean
-
Can't recv more data from peer
- block-close: boolean
-
Close is blocked (i.e. socket is a replicated socket on a standby node
- received-at-mark: boolean
-
At mark on input
- is-connected: boolean
-
Socket is connected to peer
- cant-send-more: boolean
-
Can't send more data to peer
- privileged: boolean
-
Privileged for broadcast, raw...
- is-detached: boolean
-
PCB and socket are detached
- is-solock: boolean
-
Mutex acquired by solock()
- block-send: boolean
-
Socket is blocked for send (if it is a replicated socket on a standby node)
- no-file-descriptor-reference: boolean
-
No file descriptor ref
- is-disconnecting: boolean
-
Disconnecting in progress
- async-io-notify: boolean
-
Async i/o notify
- is-connecting: boolean
-
Connecting in progress
- block-receive: boolean
-
Socket is blocked for receive - while going through SSO initial sync
Example
{
"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"
}
TCP-IO-COUNTS-BAG:
Counts of I/O events
- unarm-count: integer
-
How many times socket was unarmed by application
- autoarm-count: integer
-
How many times socket was auto-armed by TCP
- arm-count: integer
-
How many times socket was armed by application
- io-count: integer
-
Number of I/O operations done by application
Example
{
"unarm-count": "integer",
"autoarm-count": "integer",
"arm-count": "integer",
"io-count": "integer"
}
TCP-NSR-CCB-STATS-BAG:
SSO/NSR statistics of a Client
- number-of-deleted-sscb: integer
-
Num of deleted session sets
- number-of-created-sscb: integer
-
Num of created session sets
- notification-statistic: TSS-NOTIF-STATS
-
Various types of notification stats
-
TSS-NOTIF-STATS - pid: integer
-
PID of the Client
- process-name: string
-
Proc name of Clinet
- instance: integer
-
Instance of the Client
- connected-at: integer
-
Time of connect (in seconds since 1st Jan 1970 00:00:00)
- job-id: string
-
JOb ID of Client
- last-cleared-time: integer
-
Time of last clear (in seconds since 1st Jan 1970 00:00:00)
- ccb: integer
-
Address of the Client Control Block
Example
{
"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"
}
SACKHOLE-BAG:
Sack send hole entry
- start: integer
-
Start seq no. of hole
- retransmitted: integer
-
Next seq. no in hole to be retransmitted
- end: integer
-
End seq no. of hole
- duplicated-ack: integer
-
Number of dup (s)acks for this hole
Example
{
"start": "integer",
"retransmitted": "integer",
"end": "integer",
"duplicated-ack": "integer"
}
TCP-NSR-CCB-DETAILED-BAG:
Detailed Information about an SSO/NSR Client
- number-of-up-sessions: integer
-
Number of sessions with NSR up
- is-notification-registered: boolean
-
Registered with TCP for notifications?
- 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
- connected-at: integer
-
Time of connect (in seconds since 1st Jan 1970 00:00:00)
- 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",
"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"
}
TCP-NSR-AUDIT-COUNTERS-NODE:
Audit counters
- mark-session-set-ack-rcv-drop: integer
-
Number of audit mark acks dropped by active
- session-send-drop: integer
-
Number of session audits that couldn't be sent by active
- sweep-session-set-send: integer
-
Number of successful session-set Sweep's sent by active
- mark-session-set-ack-send-drop: integer
-
Number of audit mark acks that couldn't be sent by standby
- session-set-response-send-drop: integer
-
Number of audit responses that couldn't be sent by standby
- sweep-session-set-rcv-drop: integer
-
Number of session-set Sweep's dropped by standby
- abort: integer
-
Number of times the active aborted an audit session
- mark-session-set-ack-send: integer
-
Number of successful audit mark acks sent by standby
- mark-session-set-rcv-drop: integer
-
Number of session-set Mark's dropped by standby
- sweep-session-set-rcv: integer
-
Number of successful session-set Sweep's received by standby
- session-rcv: integer
-
Number of session audits received by standby
- mark-session-set-nack-send: integer
-
Number of successful audit mark nacks sent by standby
- session-send: integer
-
Number of successful session audits sent by active
- mark-session-set-nack-rcv: integer
-
Number of audit mark nacks received by active
- session-set-response-rcv-drop: integer
-
Number of audit responses dropped by active
- session-set-response-rcv: integer
-
Number of audit responses received by active
- mark-session-set-send-drop: integer
-
Number of failed session-set Mark's
- mark-session-set-ack-rcv: integer
-
Number of audit mark acks received by active
- mark-session-set-rcv: integer
-
Number of successful session-set Mark's received by standby
- mark-session-set-send: integer
-
Number of successful session-set Mark's sent by active
- session-set-response-send: integer
-
Number of successful audit responses sent by standby
- mark-session-set-nack-rcv-drop: integer
-
Number of audit mark nacks dropped by active
- mark-session-set-nack-send-drop: integer
-
Number of audit mark nacks that couldn't be sent by standby
- session-rcv-drop: integer
-
Number of session audits dropped by standby
- sweep-session-set-send-drop: integer
-
Number of failed session-set Sweep's
Example
{
"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"
}
COMMON-PCB-INFO:
Common information for all PCB types
- af-name: string internetwork, ip-version6
-
Address Family
- lpts-pcb: LPTS-PCB
-
LPTS PCB information
Example
{
"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"
}
}
}
TCP-SH-BRIEF-BAG:
Summary information about a TCP connection
- local-pid: integer
-
Id of the local process
- af-name: string ipv4, ipv6
-
Address family
- local-address: TCP-ADDRESS-TYPE
-
Local address
- foreign-port: integer
-
Foreign port
- local-port: integer
-
Local port
- current-send-queue-size: integer
-
Current send queue size in bytes
- vrf-id: integer
-
VRF ID
- current-receive-queue-size: integer
-
Current receive queue size in bytes
- foreign-address: TCP-ADDRESS-TYPE
-
Foreign address
- pcb: integer
-
PCB Address
- connection-state: string closed, listen, syn-sent, syn-received, established, close-wait, fin-wait1, closing, last-ack, fin-wait2, time-wait
-
Connection state
Example
{
"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"
}
LPTS-PCB:
LPTS PCB information block
- accept-mask: LPTS-ACCEPT-MASK
-
AcceptMask
- lpts-flags: LPTS-FLAGS
-
LPTS flags
- filter: LPTS-RX-FILTER
-
Interface Filters
-
LPTS-RX-FILTER - flow-types-info: integer
-
flow information
- ttl: integer
-
Minimum TTL
- options: LPTS-OPTIONS
-
Receive options
Example
{
"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"
}
}
TCP-NSR-AUDIT-COUNTERS-AGGR-ONLY-NODE:
Aggregate-only counters for NSR audit
- mark-session-set-nack-rcv-drop-aggr: integer
-
Number of session-set mark nack messages dropped by active
- mark-session-set-ack-rcv-drop-aggr: integer
-
Number of session-set mark ack messages dropped by active
- mark-session-set-rcv-drop-aggr: integer
-
Number of session-set Mark messages dropped by standby
- sweep-session-set-rcv-drop-aggr: integer
-
Number of session-set Sweep messages dropped by standby
- session-rcv-drop-aggr: integer
-
Number of session audit messages dropped by standby
- session-set-response-rcv-drop-aggr: integer
-
Number of session-set response messages dropped by active
Example
{
"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"
}
IP-ADDR:
IP Address
- af-name: string internetwork, ip-version6
-
AFName
- ipv6-address: string
-
IPv6 address
- ipv4-address: string
-
IPv4 address
Example
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IP-TCP:
TCP Traffic Information
- tcp-checksum-error-packets: integer
-
TCP packets with checksum errors
- tcp-dropped-packets: integer
-
TCP packets dropped (no port)
- tcp-input-packets: integer
-
TCP packets received
- tcp-retransmitted-packets: integer
-
TCP packets retransmitted
- tcp-output-packets: integer
-
TCP packets transmitted
Example
{
"tcp-checksum-error-packets": "integer",
"tcp-dropped-packets": "integer",
"tcp-input-packets": "integer",
"tcp-retransmitted-packets": "integer",
"tcp-output-packets": "integer"
}
TCP-SOCK-OPTIONS-BAG:
TCP Socket Option Flags
- linger: boolean
-
Linger on close if data present
- reuse-address: boolean
-
Allow local address reuse
- keep-alive: boolean
-
Keep connections alive
- out-of-band-inline: boolean
-
Leave received Out-of-band data inline
- broadcast: boolean
-
Permit sending of broadcast msgs
- dont-route: boolean
-
Just use interface addresses
- debug: boolean
-
Turn on debugging info recording
- reuse-port: boolean
-
Allow local address & port reuse
- accept-connection: boolean
-
Socket has had listen()
- use-loopback: boolean
-
Bypass hardware when possible
- nonblocking-io: boolean
-
Nonblocking socket I/O operation
Example
{
"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"
}
SHOW-PCB-INFO:
PCB information to display
- local-address: IP-ADDR
-
Local IP address
- foreign-port: integer
-
Remote port
- local-port: integer
-
Local port
- l4-protocol: integer
-
Layer 4 protocol
- foreign-address: IP-ADDR
-
Remote IP address
- common: COMMON-PCB-INFO
-
Common PCB information
Example
{
"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"
}
}
}
}
LPTS-OPTIONS:
LPTS options
- is-ip-sla: boolean
-
IP SLA
- is-receive-filter: boolean
-
Receive filter enabled
Example
{
"is-ip-sla": "boolean",
"is-receive-filter": "boolean"
}
TCP-CONN-FEATURES-BAG:
TCP Connection features
- path-mtu-discovery: boolean
-
Path MTU Discovery feature is on?
- giveup-timer: boolean
-
Giveup timer is on?
- mss-cisco: boolean
-
tcp mss feature is on?
- connection-keep-alive-timer: boolean
-
Keepalive timer is on?
- selective-ack: boolean
-
Selective ack on?
- timestamps: boolean
-
Timestamps on?
- window-scaling: boolean
-
Window-scaling on?
- nagle: boolean
-
Nagle algorithm on?
- md5: boolean
-
MD5 option on?
Example
{
"path-mtu-discovery": "boolean",
"giveup-timer": "boolean",
"mss-cisco": "boolean",
"connection-keep-alive-timer": "boolean",
"selective-ack": "boolean",
"timestamps": "boolean",
"window-scaling": "boolean",
"nagle": "boolean",
"md5": "boolean"
}
TCP-NSR-PCB-DETAILED-BAG:
Detailed SSO/NSR information about a TCP connection
- max-number-of-held-packet-reach-time: integer
-
Max number of held incoming packets reaches at
- init-sync-end-time: integer
-
Time at which the initial sync operation was ended (in seconds since 1st Jan 1970 00:00:00)
- is-session-replicated: boolean
-
Has the session been replicated to standby?
- vrf-id: integer
-
VRF Id
- peer-endp-hdl-down-stream: integer
-
Peer NCD endp handle
- max-number-of-held-packet: string
-
Max number of incoming packets have been held
- init-sync-start-time-down-stream: integer
-
Time at which the initial sync operation was started (in seconds since 1st Jan 1970 00:00:00)
- peer-endp-hdl-up-stream: integer
-
Peer NCD endp handle
- foreign-address: object[]
-
Foreign address
-
object - entry: string
-
Foreign address
- internal-ack-hold-queue: TCP-NSR-HOLD-QUEUE-NODE
-
Sequence Number and datalength of each node in hold_iackqueue
-
TCP-NSR-HOLD-QUEUE-NODE - init-sync-flags: integer
-
Init Sync flags for the session
- foreign-port: integer
-
Foreign port
- set-information: TCP-NSR-SSCB-BRIEF-BAG
-
Sesson-set information
- is-session-synced: boolean
-
Has the session completed initial-sync?
- nsr-down-reason-up-stream: string none, init-sync-aborted, client-disabled, client-disconnect, tcp-disconnect, failover, nsr-clear, internal-error, retransmit-threshold-exceed, init-sync-failure-thresh-exceeded, audit-timeout, audit-failed, standby-sscb-deleted, standby-session-close, standby-rxpath-frozen, partner-deleted
-
The reason NSR is not up towards the upstream partner
- init-sync-end-time-up-stream: integer
-
Time at which the initial sync operation was ended (in seconds since 1st Jan 1970 00:00:00)
- is-us-operational-up: string down, up, na
-
Is Upstream NSR operational?
- sscb: integer
-
SSCB Address
- fist-standby-sequence-number-down-stream: integer
-
FSSN for the upstream partner
- pcb: integer
-
PCB Address
- sequence-number-of-init-sync-up-stream: integer
-
ID of the Initial sync operation
- nsr-down-reason: string none, init-sync-aborted, client-disabled, client-disconnect, tcp-disconnect, failover, nsr-clear, internal-error, retransmit-threshold-exceed, init-sync-failure-thresh-exceeded, audit-timeout, audit-failed, standby-sscb-deleted, standby-session-close, standby-rxpath-frozen, partner-deleted
-
If NSR is not up, the reason for it.
- max-number-of-held-internal-ack-reach-time: integer
-
Max number of held internal acks reaches at
- sequence-number-of-init-sync: integer
-
ID of the Initial sync operation
- local-address: object[]
-
Local address
-
object - entry: string
-
Local address
- local-port: integer
-
Local port
- fist-standby-sequence-number: integer
-
If initial sync is completed, then the FSSN - First Standby Sequence Number
- 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-ds-operational-up: string down, up, na
-
Is Downstream NSR operational?
- nsr-down-reason-down-stream: string none, init-sync-aborted, client-disabled, client-disconnect, tcp-disconnect, failover, nsr-clear, internal-error, retransmit-threshold-exceed, init-sync-failure-thresh-exceeded, audit-timeout, audit-failed, standby-sscb-deleted, standby-session-close, standby-rxpath-frozen, partner-deleted
-
The reason NSR is not up towards the upstream partner
- sequence-number-of-init-sync-down-stream: integer
-
ID of the Initial sync operation
- init-sync-start-time-up-stream: integer
-