{ "openapi": "3.0.0", "info": { "title": "TCP-MIB MIB API", "version": "1.0.0", "description": "The MIB module for managing TCP implementations.\n \n Copyright (C) The Internet Society (2005). This version\n of this MIB module is a part of RFC 4022; see the RFC\n itself for full legal notices.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View TCP-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/TCP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "TCP-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/TCP-MIB:tcp": { "get": { "summary": "Get tcp data", "description": "Retrieve tcp operational data from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "tcp", "properties": { "tcpRtoAlgorithm": { "type": "string", "description": "The algorithm used to determine the timeout value used for\n retransmitting unacknowledged octets." }, "tcpRtoMin": { "type": "integer", "description": "The minimum value permitted by a TCP implementation for\n the retransmission timeout, measured in milliseconds.\n More refined semantics for objects of this type depend\n on the algorithm used to determine the retransmission\n timeout; in particular, the IETF standard algorithm\n rfc2988(5) provides a minimum value.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpRtoMax": { "type": "integer", "description": "The maximum value permitted by a TCP implementation for\n the retransmission timeout, measured in milliseconds.\n More refined semantics for objects of this type depend\n on the algorithm used to determine the retransmission\n timeout; in particular, the IETF standard algorithm\n rfc2988(5) provides an upper bound (as part of an\n adaptive backoff algorithm).", "minimum": -2147483648, "maximum": 2147483647 }, "tcpMaxConn": { "type": "integer", "description": "The limit on the total number of TCP connections the entity\n can support. In entities where the maximum number of\n connections is dynamic, this object should contain the\n value -1.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpActiveOpens": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the SYN-SENT state from the CLOSED state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpPassiveOpens": { "type": "integer", "description": "The number of times TCP connections have made a direct\n transition to the SYN-RCVD state from the LISTEN state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpAttemptFails": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the CLOSED state from either the SYN-SENT\n state or the SYN-RCVD state, plus the number of times that\n TCP connections have made a direct transition to the\n LISTEN state from the SYN-RCVD state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpEstabResets": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the CLOSED state from either the ESTABLISHED\n state or the CLOSE-WAIT state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpCurrEstab": { "type": "integer", "description": "The number of TCP connections for which the current state\n is either ESTABLISHED or CLOSE-WAIT.", "minimum": 0, "maximum": 4294967295 }, "tcpInSegs": { "type": "integer", "description": "The total number of segments received, including those\n received in error. This count includes segments received\n on currently established connections.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpOutSegs": { "type": "integer", "description": "The total number of segments sent, including those on\n current connections but excluding those containing only\n retransmitted octets.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpRetransSegs": { "type": "integer", "description": "The total number of segments retransmitted; that is, the\n number of TCP segments transmitted containing one or more\n previously transmitted octets.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpInErrs": { "type": "integer", "description": "The total number of segments received in error (e.g., bad\n TCP checksums).\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpOutRsts": { "type": "integer", "description": "The number of TCP segments sent containing the RST flag.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "tcpHCInSegs": { "type": "integer", "description": "The total number of segments received, including those\n received in error. This count includes segments received\n \n on currently established connections. This object is\n the 64-bit equivalent of tcpInSegs.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0 }, "tcpHCOutSegs": { "type": "integer", "description": "The total number of segments sent, including those on\n current connections but excluding those containing only\n retransmitted octets. This object is the 64-bit\n equivalent of tcpOutSegs.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0 } } }, "example": { "TCP-MIB:tcp": { "tcpRtoAlgorithm": "example-string", "tcpRtoMin": -2147483648, "tcpRtoMax": -2147483648, "tcpMaxConn": -2147483648, "tcpActiveOpens": 0, "tcpPassiveOpens": 0, "tcpAttemptFails": 0, "tcpEstabResets": 0, "tcpCurrEstab": 0, "tcpInSegs": 0, "tcpOutSegs": 0, "tcpRetransSegs": 0, "tcpInErrs": 0, "tcpOutRsts": 0, "tcpHCInSegs": 0, "tcpHCOutSegs": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcp", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcp", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnTable": { "get": { "summary": "Get tcpConnTable data", "description": "Retrieve tcpConnTable operational data from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about existing IPv4-specific\n TCP connections or listeners. This table has been\n deprecated in favor of the version neutral\n tcpConnectionTable.", "properties": { "tcpConnEntry": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address" }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "TCP-MIB:tcpConnTable": { "tcpConnEntry": [ { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 }, { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 }, { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnTable", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnTable/tcpConnEntry": { "get": { "summary": "Get tcpConnEntry list", "description": "Retrieve list of tcpConnEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address" }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "TCP-MIB:tcpConnEntry": [ { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnTable/tcpConnEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnectionTable": { "get": { "summary": "Get tcpConnectionTable data", "description": "Retrieve tcpConnectionTable operational data from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about existing TCP\n connections. Note that unlike earlier TCP MIBs, there\n is a separate table for connections in the LISTEN state.", "properties": { "tcpConnectionEntry": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "TCP-MIB:tcpConnectionTable": { "tcpConnectionEntry": [ { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 }, { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 }, { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnectionTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnectionTable", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnectionTable/tcpConnectionEntry": { "get": { "summary": "Get tcpConnectionEntry list", "description": "Retrieve list of tcpConnectionEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "TCP-MIB:tcpConnectionEntry": [ { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnectionEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnectionTable/tcpConnectionEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpListenerTable": { "get": { "summary": "Get tcpListenerTable data", "description": "Retrieve tcpListenerTable operational data from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "tcpListenerTable", "properties": { "tcpListenerEntry": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType" }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "TCP-MIB:tcpListenerTable": { "tcpListenerEntry": [ { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 }, { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 }, { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpListenerTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpListenerTable", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpListenerTable/tcpListenerEntry": { "get": { "summary": "Get tcpListenerEntry list", "description": "Retrieve list of tcpListenerEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType" }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "TCP-MIB:tcpListenerEntry": [ { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpListenerEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpListenerTable/tcpListenerEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnEntry": { "get": { "summary": "Get tcpConnEntry list", "description": "Retrieve list of tcpConnEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address" }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "TCP-MIB:tcpConnEntry": [ { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnectionEntry": { "get": { "summary": "Get tcpConnectionEntry list", "description": "Retrieve list of tcpConnectionEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "TCP-MIB:tcpConnectionEntry": [ { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnectionEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpConnectionEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpListenerEntry": { "get": { "summary": "Get tcpListenerEntry list", "description": "Retrieve list of tcpListenerEntry entries from MIB", "tags": [ "TCP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType" }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "TCP-MIB:tcpListenerEntry": [ { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpListenerEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/tcpListenerEntry", "x-restconf-kind": "container" }, "/data/TCP-MIB:tcpConnTable/tcpConnEntry={tcpConnLocalAddress},{tcpConnLocalPort},{tcpConnRemAddress},{tcpConnRemPort}": { "get": { "summary": "Get tcpConnEntry entry", "description": "Retrieve specific tcpConnEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpConnLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnRemAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnRemPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address" }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "TCP-MIB:tcpConnEntry": { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnEntry-2" }, "x-yang-path": "/tcpConnTable/tcpConnEntry={tcpConnLocalAddress tcpConnLocalPort tcpConnRemAddress tcpConnRemPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpConnLocalAddress tcpConnLocalPort tcpConnRemAddress tcpConnRemPort" ] }, "/data/TCP-MIB:tcpConnectionTable/tcpConnectionEntry={tcpConnectionLocalAddressType},{tcpConnectionLocalAddress},{tcpConnectionLocalPort},{tcpConnectionRemAddressType},{tcpConnectionRemAddress},{tcpConnectionRemPort}": { "get": { "summary": "Get tcpConnectionEntry entry", "description": "Retrieve specific tcpConnectionEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpConnectionLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "TCP-MIB:tcpConnectionEntry": { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnectionEntry-2" }, "x-yang-path": "/tcpConnectionTable/tcpConnectionEntry={tcpConnectionLocalAddressType tcpConnectionLocalAddress tcpConnectionLocalPort tcpConnectionRemAddressType tcpConnectionRemAddress tcpConnectionRemPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpConnectionLocalAddressType tcpConnectionLocalAddress tcpConnectionLocalPort tcpConnectionRemAddressType tcpConnectionRemAddress tcpConnectionRemPort" ] }, "/data/TCP-MIB:tcpListenerTable/tcpListenerEntry={tcpListenerLocalAddressType},{tcpListenerLocalAddress},{tcpListenerLocalPort}": { "get": { "summary": "Get tcpListenerEntry entry", "description": "Retrieve specific tcpListenerEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpListenerLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpListenerLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpListenerLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType" }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "TCP-MIB:tcpListenerEntry": { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpListenerEntry-2" }, "x-yang-path": "/tcpListenerTable/tcpListenerEntry={tcpListenerLocalAddressType tcpListenerLocalAddress tcpListenerLocalPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpListenerLocalAddressType tcpListenerLocalAddress tcpListenerLocalPort" ] }, "/data/TCP-MIB:tcpConnEntry={tcpConnLocalAddress},{tcpConnLocalPort},{tcpConnRemAddress},{tcpConnRemPort}": { "get": { "summary": "Get tcpConnEntry entry", "description": "Retrieve specific tcpConnEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpConnLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnRemAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnRemPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address" }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "TCP-MIB:tcpConnEntry": { "tcpConnState": "up(1)", "tcpConnLocalAddress": "192.168.1.1", "tcpConnLocalPort": -2147483648, "tcpConnRemAddress": "192.168.1.1", "tcpConnRemPort": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnEntry-4" }, "x-yang-path": "/tcpConnEntry={tcpConnLocalAddress tcpConnLocalPort tcpConnRemAddress tcpConnRemPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpConnLocalAddress tcpConnLocalPort tcpConnRemAddress tcpConnRemPort" ] }, "/data/TCP-MIB:tcpConnectionEntry={tcpConnectionLocalAddressType},{tcpConnectionLocalAddress},{tcpConnectionLocalPort},{tcpConnectionRemAddressType},{tcpConnectionRemAddress},{tcpConnectionRemPort}": { "get": { "summary": "Get tcpConnectionEntry entry", "description": "Retrieve specific tcpConnectionEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpConnectionLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpConnectionRemPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType" }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number" }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably)." }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "TCP-MIB:tcpConnectionEntry": { "tcpConnectionLocalAddressType": "192.168.1.1", "tcpConnectionLocalAddress": "192.168.1.1", "tcpConnectionLocalPort": "example-string", "tcpConnectionRemAddressType": "192.168.1.1", "tcpConnectionRemAddress": "192.168.1.1", "tcpConnectionRemPort": "example-string", "tcpConnectionState": "up(1)", "tcpConnectionProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpConnectionEntry-4" }, "x-yang-path": "/tcpConnectionEntry={tcpConnectionLocalAddressType tcpConnectionLocalAddress tcpConnectionLocalPort tcpConnectionRemAddressType tcpConnectionRemAddress tcpConnectionRemPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpConnectionLocalAddressType tcpConnectionLocalAddress tcpConnectionLocalPort tcpConnectionRemAddressType tcpConnectionRemAddress tcpConnectionRemPort" ] }, "/data/TCP-MIB:tcpListenerEntry={tcpListenerLocalAddressType},{tcpListenerLocalAddress},{tcpListenerLocalPort}": { "get": { "summary": "Get tcpListenerEntry entry", "description": "Retrieve specific tcpListenerEntry entry by key from MIB", "tags": [ "TCP-MIB" ], "parameters": [ { "name": "tcpListenerLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpListenerLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tcpListenerLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType" }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number" }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "TCP-MIB:tcpListenerEntry": { "tcpListenerLocalAddressType": "192.168.1.1", "tcpListenerLocalAddress": "192.168.1.1", "tcpListenerLocalPort": "example-string", "tcpListenerProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-tcpListenerEntry-4" }, "x-yang-path": "/tcpListenerEntry={tcpListenerLocalAddressType tcpListenerLocalAddress tcpListenerLocalPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "tcpListenerLocalAddressType tcpListenerLocalAddress tcpListenerLocalPort" ] } }, "components": { "schemas": { "TCP-MIB_TCP-MIB": { "type": "object", "description": "TCP-MIB", "properties": { "tcpConnEntry": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "tcpConnectionEntry": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "tcpListenerEntry": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "tcp": { "type": "object", "description": "tcp", "properties": { "tcpRtoAlgorithm": { "type": "string", "description": "The algorithm used to determine the timeout value used for\n retransmitting unacknowledged octets.", "readOnly": true }, "tcpRtoMin": { "type": "integer", "description": "The minimum value permitted by a TCP implementation for\n the retransmission timeout, measured in milliseconds.\n More refined semantics for objects of this type depend\n on the algorithm used to determine the retransmission\n timeout; in particular, the IETF standard algorithm\n rfc2988(5) provides a minimum value.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpRtoMax": { "type": "integer", "description": "The maximum value permitted by a TCP implementation for\n the retransmission timeout, measured in milliseconds.\n More refined semantics for objects of this type depend\n on the algorithm used to determine the retransmission\n timeout; in particular, the IETF standard algorithm\n rfc2988(5) provides an upper bound (as part of an\n adaptive backoff algorithm).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpMaxConn": { "type": "integer", "description": "The limit on the total number of TCP connections the entity\n can support. In entities where the maximum number of\n connections is dynamic, this object should contain the\n value -1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpActiveOpens": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the SYN-SENT state from the CLOSED state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpPassiveOpens": { "type": "integer", "description": "The number of times TCP connections have made a direct\n transition to the SYN-RCVD state from the LISTEN state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpAttemptFails": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the CLOSED state from either the SYN-SENT\n state or the SYN-RCVD state, plus the number of times that\n TCP connections have made a direct transition to the\n LISTEN state from the SYN-RCVD state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpEstabResets": { "type": "integer", "description": "The number of times that TCP connections have made a direct\n transition to the CLOSED state from either the ESTABLISHED\n state or the CLOSE-WAIT state.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpCurrEstab": { "type": "integer", "description": "The number of TCP connections for which the current state\n is either ESTABLISHED or CLOSE-WAIT.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpInSegs": { "type": "integer", "description": "The total number of segments received, including those\n received in error. This count includes segments received\n on currently established connections.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpOutSegs": { "type": "integer", "description": "The total number of segments sent, including those on\n current connections but excluding those containing only\n retransmitted octets.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpRetransSegs": { "type": "integer", "description": "The total number of segments retransmitted; that is, the\n number of TCP segments transmitted containing one or more\n previously transmitted octets.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpInErrs": { "type": "integer", "description": "The total number of segments received in error (e.g., bad\n TCP checksums).\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpOutRsts": { "type": "integer", "description": "The number of TCP segments sent containing the RST flag.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "tcpHCInSegs": { "type": "integer", "description": "The total number of segments received, including those\n received in error. This count includes segments received\n \n on currently established connections. This object is\n the 64-bit equivalent of tcpInSegs.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "readOnly": true }, "tcpHCOutSegs": { "type": "integer", "description": "The total number of segments sent, including those on\n current connections but excluding those containing only\n retransmitted octets. This object is the 64-bit\n equivalent of tcpOutSegs.\n \n Discontinuities in the value of this counter are\n indicated via discontinuities in the value of sysUpTime.", "minimum": 0, "readOnly": true } }, "readOnly": true }, "tcpConnTable": { "type": "object", "description": "A table containing information about existing IPv4-specific\n TCP connections or listeners. This table has been\n deprecated in favor of the version neutral\n tcpConnectionTable.", "properties": { "tcpConnEntry": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "tcpConnectionTable": { "type": "object", "description": "A table containing information about existing TCP\n connections. Note that unlike earlier TCP MIBs, there\n is a separate table for connections in the LISTEN state.", "properties": { "tcpConnectionEntry": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "tcpListenerTable": { "type": "object", "description": "tcpListenerTable", "properties": { "tcpListenerEntry": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "TCP-MIB_tcpConnEntry": { "type": "array", "description": "A conceptual row of the tcpConnTable containing information\n about a particular current IPv4 TCP connection. Each row\n of this table is transient in that it ceases to exist when\n (or soon after) the connection makes the transition to the\n CLOSED state.", "items": { "type": "object", "properties": { "tcpConnState": { "type": "string", "description": "The state of this TCP connection.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. In the case\n of a connection in the listen state willing to\n accept connections for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnLocalPort": { "type": "integer", "description": "The local port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "tcpConnRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection.", "format": "inet:ipv4-address", "readOnly": true }, "tcpConnRemPort": { "type": "integer", "description": "The remote port number for this TCP connection.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "TCP-MIB_tcpConnectionEntry": { "type": "array", "description": "A conceptual row of the tcpConnectionTable containing\n information about a particular current TCP connection.\n Each row of this table is transient in that it ceases to\n exist when (or soon after) the connection makes the\n transition to the CLOSED state.", "items": { "type": "object", "properties": { "tcpConnectionLocalAddressType": { "type": "string", "description": "The address type of tcpConnectionLocalAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionLocalAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionRemAddressType": { "type": "string", "description": "The address type of tcpConnectionRemAddress.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpConnectionRemAddress": { "type": "string", "description": "The remote IP address for this TCP connection. The type\n of this address is determined by the value of\n tcpConnectionRemAddressType.\n \n As this object is used in the index for the\n tcpConnectionTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed by using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpConnectionRemPort": { "type": "string", "description": "The remote port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpConnectionState": { "type": "string", "description": "The state of this TCP connection.\n \n The value listen(2) is included only for parallelism to the\n old tcpConnTable and should not be used. A connection in\n LISTEN state should be present in the tcpListenerTable.\n \n The only value that may be set by a management station is\n deleteTCB(12). Accordingly, it is appropriate for an agent\n to return a `badValue' response if a management station\n attempts to set this object to any other value.\n \n If a management station sets this object to the value\n deleteTCB(12), then the TCB (as defined in [RFC793]) of\n the corresponding connection on the managed node is\n deleted, resulting in immediate termination of the\n connection.\n \n As an implementation-specific option, a RST segment may be\n sent from the managed node to the other TCP endpoint (note,\n however, that RST segments are not sent reliably).", "readOnly": true }, "tcpConnectionProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this connection, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "TCP-MIB_tcpListenerEntry": { "type": "array", "description": "A conceptual row of the tcpListenerTable containing\n information about a particular TCP listener.", "items": { "type": "object", "properties": { "tcpListenerLocalAddressType": { "type": "string", "description": "The address type of tcpListenerLocalAddress. The value\n should be unknown (0) if connection initiations to all\n local IP addresses are accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "tcpListenerLocalAddress": { "type": "string", "description": "The local IP address for this TCP connection.\n \n The value of this object can be represented in three\n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application willing to accept both IPv4 and\n IPv6 datagrams, the value of this object must be\n ''h (a zero-length octet-string), with the value\n of the corresponding tcpListenerLocalAddressType\n object being unknown (0).\n \n 2. For an application willing to accept only IPv4 or\n IPv6 datagrams, the value of this object must be\n '0.0.0.0' or '::' respectively, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n 3. For an application which is listening for data\n destined only to a specific IP address, the value\n of this object is the specific local address, with\n tcpListenerLocalAddressType representing the\n appropriate address type.\n \n As this object is used in the index for the\n tcpListenerTable, implementors should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; otherwise the information\n cannot be accessed, using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "tcpListenerLocalPort": { "type": "string", "description": "The local port number for this TCP connection.", "format": "inet:port-number", "readOnly": true }, "tcpListenerProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this listener, or zero if there is no such process. This\n value is expected to be the same as HOST-RESOURCES-MIB::\n hrSWRunIndex or SYSAPPL-MIB::sysApplElmtRunIndex for some\n row in the appropriate tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "TCP-MIB", "description": "MIB operations for TCP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }