{ "openapi": "3.0.0", "info": { "title": "UDP-MIB MIB API", "version": "1.0.0", "description": "The MIB module for managing UDP implementations.\n Copyright (C) The Internet Society (2005). This\n version of this MIB module is part of RFC 4113;\n see the RFC 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 UDP-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/UDP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "UDP-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/UDP-MIB:udp": { "get": { "summary": "Get udp data", "description": "Retrieve udp operational data from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The total number of UDP datagrams delivered to UDP\n users.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "properties": { "udpInDatagrams": { "type": "integer", "description": "The total number of UDP datagrams delivered to UDP\n users.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "udpNoPorts": { "type": "integer", "description": "The total number of received UDP datagrams for which\n there was no application at the destination port.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "udpInErrors": { "type": "integer", "description": "The number of received UDP datagrams that could not be\n delivered for reasons other than the lack of an\n application at the destination port.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "udpOutDatagrams": { "type": "integer", "description": "The total number of UDP datagrams sent from this\n entity.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295 }, "udpHCInDatagrams": { "type": "integer", "description": "The total number of UDP datagrams delivered to UDP\n users, for devices that can receive more than 1\n million UDP datagrams per second.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0 }, "udpHCOutDatagrams": { "type": "integer", "description": "The total number of UDP datagrams sent from this\n entity, for devices that can transmit more than 1\n million UDP datagrams per second.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0 } } }, "example": { "UDP-MIB:udp": { "udpInDatagrams": 0, "udpNoPorts": 0, "udpInErrors": 0, "udpOutDatagrams": 0, "udpHCInDatagrams": 0, "udpHCOutDatagrams": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udp", "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": "/udp", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpTable": { "get": { "summary": "Get udpTable data", "description": "Retrieve udpTable operational data from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing IPv4-specific UDP listener\n information. It contains information about all local\n IPv4 UDP end-points on which an application is\n currently accepting datagrams. This table has been\n deprecated in favor of the version neutral\n udpEndpointTable.", "properties": { "udpEntry": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "UDP-MIB:udpTable": { "udpEntry": [ { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 }, { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 }, { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpTable", "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": "/udpTable", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpTable/udpEntry": { "get": { "summary": "Get udpEntry list", "description": "Retrieve list of udpEntry entries from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "UDP-MIB:udpEntry": [ { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEntry", "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": "/udpTable/udpEntry", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpEndpointTable": { "get": { "summary": "Get udpEndpointTable data", "description": "Retrieve udpEndpointTable operational data from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "udpEndpointTable", "properties": { "udpEndpointEntry": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number" }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number" }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295 }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "UDP-MIB:udpEndpointTable": { "udpEndpointEntry": [ { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 }, { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 }, { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEndpointTable", "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": "/udpEndpointTable", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpEndpointTable/udpEndpointEntry": { "get": { "summary": "Get udpEndpointEntry list", "description": "Retrieve list of udpEndpointEntry entries from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number" }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number" }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295 }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "UDP-MIB:udpEndpointEntry": [ { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEndpointEntry", "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": "/udpEndpointTable/udpEndpointEntry", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpEntry": { "get": { "summary": "Get udpEntry list", "description": "Retrieve list of udpEntry entries from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "UDP-MIB:udpEntry": [ { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEntry-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": "/udpEntry", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpEndpointEntry": { "get": { "summary": "Get udpEndpointEntry list", "description": "Retrieve list of udpEndpointEntry entries from MIB", "tags": [ "UDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number" }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number" }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295 }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "UDP-MIB:udpEndpointEntry": [ { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEndpointEntry-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": "/udpEndpointEntry", "x-restconf-kind": "container" }, "/data/UDP-MIB:udpTable/udpEntry={udpLocalAddress},{udpLocalPort}": { "get": { "summary": "Get udpEntry entry", "description": "Retrieve specific udpEntry entry by key from MIB", "tags": [ "UDP-MIB" ], "parameters": [ { "name": "udpLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpLocalPort", "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": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "UDP-MIB:udpEntry": { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEntry-2" }, "x-yang-path": "/udpTable/udpEntry={udpLocalAddress udpLocalPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "udpLocalAddress udpLocalPort" ] }, "/data/UDP-MIB:udpEndpointTable/udpEndpointEntry={udpEndpointLocalAddressType},{udpEndpointLocalAddress},{udpEndpointLocalPort},{udpEndpointRemoteAddressType},{udpEndpointRemoteAddress},{udpEndpointRemotePort},{udpEndpointInstance}": { "get": { "summary": "Get udpEndpointEntry entry", "description": "Retrieve specific udpEndpointEntry entry by key from MIB", "tags": [ "UDP-MIB" ], "parameters": [ { "name": "udpEndpointLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemoteAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemoteAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemotePort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointInstance", "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": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number" }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number" }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295 }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "UDP-MIB:udpEndpointEntry": { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEndpointEntry-2" }, "x-yang-path": "/udpEndpointTable/udpEndpointEntry={udpEndpointLocalAddressType udpEndpointLocalAddress udpEndpointLocalPort udpEndpointRemoteAddressType udpEndpointRemoteAddress udpEndpointRemotePort udpEndpointInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "udpEndpointLocalAddressType udpEndpointLocalAddress udpEndpointLocalPort udpEndpointRemoteAddressType udpEndpointRemoteAddress udpEndpointRemotePort udpEndpointInstance" ] }, "/data/UDP-MIB:udpEntry={udpLocalAddress},{udpLocalPort}": { "get": { "summary": "Get udpEntry entry", "description": "Retrieve specific udpEntry entry by key from MIB", "tags": [ "UDP-MIB" ], "parameters": [ { "name": "udpLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpLocalPort", "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": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address" }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "UDP-MIB:udpEntry": { "udpLocalAddress": "192.168.1.1", "udpLocalPort": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEntry-4" }, "x-yang-path": "/udpEntry={udpLocalAddress udpLocalPort}", "x-restconf-kind": "list-instance", "x-list-keys": [ "udpLocalAddress udpLocalPort" ] }, "/data/UDP-MIB:udpEndpointEntry={udpEndpointLocalAddressType},{udpEndpointLocalAddress},{udpEndpointLocalPort},{udpEndpointRemoteAddressType},{udpEndpointRemoteAddress},{udpEndpointRemotePort},{udpEndpointInstance}": { "get": { "summary": "Get udpEndpointEntry entry", "description": "Retrieve specific udpEndpointEntry entry by key from MIB", "tags": [ "UDP-MIB" ], "parameters": [ { "name": "udpEndpointLocalAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointLocalAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointLocalPort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemoteAddressType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemoteAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointRemotePort", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "udpEndpointInstance", "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": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number" }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType" }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress" }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number" }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295 }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "UDP-MIB:udpEndpointEntry": { "udpEndpointLocalAddressType": "192.168.1.1", "udpEndpointLocalAddress": "192.168.1.1", "udpEndpointLocalPort": "example-string", "udpEndpointRemoteAddressType": "192.168.1.1", "udpEndpointRemoteAddress": "192.168.1.1", "udpEndpointRemotePort": "example-string", "udpEndpointInstance": 0, "udpEndpointProcess": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-udpEndpointEntry-4" }, "x-yang-path": "/udpEndpointEntry={udpEndpointLocalAddressType udpEndpointLocalAddress udpEndpointLocalPort udpEndpointRemoteAddressType udpEndpointRemoteAddress udpEndpointRemotePort udpEndpointInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "udpEndpointLocalAddressType udpEndpointLocalAddress udpEndpointLocalPort udpEndpointRemoteAddressType udpEndpointRemoteAddress udpEndpointRemotePort udpEndpointInstance" ] } }, "components": { "schemas": { "UDP-MIB_UDP-MIB": { "type": "object", "description": "The total number of UDP datagrams delivered to UDP\n users.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "properties": { "udpEntry": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "udpEndpointEntry": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number", "readOnly": true }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number", "readOnly": true }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "udp": { "type": "object", "description": "The total number of UDP datagrams delivered to UDP\n users.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "properties": { "udpInDatagrams": { "type": "integer", "description": "The total number of UDP datagrams delivered to UDP\n users.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpNoPorts": { "type": "integer", "description": "The total number of received UDP datagrams for which\n there was no application at the destination port.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpInErrors": { "type": "integer", "description": "The number of received UDP datagrams that could not be\n delivered for reasons other than the lack of an\n application at the destination port.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpOutDatagrams": { "type": "integer", "description": "The total number of UDP datagrams sent from this\n entity.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpHCInDatagrams": { "type": "integer", "description": "The total number of UDP datagrams delivered to UDP\n users, for devices that can receive more than 1\n million UDP datagrams per second.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "readOnly": true }, "udpHCOutDatagrams": { "type": "integer", "description": "The total number of UDP datagrams sent from this\n entity, for devices that can transmit more than 1\n million UDP datagrams per second.\n \n Discontinuities in the value of this counter can occur\n at re-initialization of the management system, and at\n other times as indicated by discontinuities in the\n value of sysUpTime.", "minimum": 0, "readOnly": true } }, "readOnly": true }, "udpTable": { "type": "object", "description": "A table containing IPv4-specific UDP listener\n information. It contains information about all local\n IPv4 UDP end-points on which an application is\n currently accepting datagrams. This table has been\n deprecated in favor of the version neutral\n udpEndpointTable.", "properties": { "udpEntry": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "udpEndpointTable": { "type": "object", "description": "udpEndpointTable", "properties": { "udpEndpointEntry": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number", "readOnly": true }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number", "readOnly": true }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n tables.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "UDP-MIB_udpEntry": { "type": "array", "description": "Information about a particular current UDP listener.", "items": { "type": "object", "properties": { "udpLocalAddress": { "type": "string", "description": "The local IP address for this UDP listener. In the\n case of a UDP listener that is willing to accept\n datagrams for any IP interface associated with the\n node, the value 0.0.0.0 is used.", "format": "inet:ipv4-address", "readOnly": true }, "udpLocalPort": { "type": "integer", "description": "The local port number for this UDP listener.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "UDP-MIB_udpEndpointEntry": { "type": "array", "description": "udpEndpointEntry", "items": { "type": "object", "properties": { "udpEndpointLocalAddressType": { "type": "string", "description": "The address type of udpEndpointLocalAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all local IP addresses are\n accepted.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointLocalAddress": { "type": "string", "description": "The local IP address for this UDP endpoint.\n \n The value of this object can be represented in three\n \n possible ways, depending on the characteristics of the\n listening application:\n \n 1. For an application that is willing to accept both\n IPv4 and IPv6 datagrams, the value of this object\n must be ''h (a zero-length octet-string), with\n the value of the corresponding instance of the\n udpEndpointLocalAddressType object being unknown(0).\n \n 2. For an application that is willing to accept only IPv4\n or only IPv6 datagrams, the value of this object\n must be '0.0.0.0' or '::', respectively, while the\n corresponding instance of the\n udpEndpointLocalAddressType object represents the\n appropriate address type.\n \n 3. For an application that is listening for data\n destined only to a specific IP address, the value\n of this object is the specific IP address for which\n this node is receiving packets, with the\n corresponding instance of the\n udpEndpointLocalAddressType object representing the\n appropriate address type.\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointLocalPort": { "type": "string", "description": "The local port number for this UDP endpoint.", "format": "inet:port-number", "readOnly": true }, "udpEndpointRemoteAddressType": { "type": "string", "description": "The address type of udpEndpointRemoteAddress. Only\n IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or\n unknown(0) if datagrams for all remote IP addresses are\n accepted. Also, note that some combinations of\n \n udpEndpointLocalAdressType and\n udpEndpointRemoteAddressType are not supported. In\n particular, if the value of this object is not\n unknown(0), it is expected to always refer to the\n same IP version as udpEndpointLocalAddressType.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "udpEndpointRemoteAddress": { "type": "string", "description": "The remote IP address for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is ''h (a zero-length octet-string).\n Otherwise, it has the type described by\n udpEndpointRemoteAddressType and is the address of the\n remote system from which datagrams are to be accepted\n (or to which all datagrams will be sent).\n \n As this object is used in the index for the\n udpEndpointTable, implementors of this table should be\n careful not to create entries that would result in OIDs\n with more than 128 subidentifiers; else the information\n cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "udpEndpointRemotePort": { "type": "string", "description": "The remote port number for this UDP endpoint. If\n datagrams from any remote system are to be accepted,\n this value is zero.", "format": "inet:port-number", "readOnly": true }, "udpEndpointInstance": { "type": "integer", "description": "The instance of this tuple. This object is used to\n distinguish among multiple processes 'connected' to\n the same UDP endpoint. For example, on a system\n implementing the BSD sockets interface, this would be\n used to support the SO_REUSEADDR and SO_REUSEPORT\n socket options.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "udpEndpointProcess": { "type": "integer", "description": "The system's process ID for the process associated with\n this endpoint, or zero if there is no such process.\n This value is expected to be the same as\n HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::\n sysApplElmtRunIndex for some row in the appropriate\n 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": "UDP-MIB", "description": "MIB operations for UDP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }