{ "openapi": "3.0.0", "info": { "title": "SNMP-PROXY-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines MIB objects which provide\n mechanisms to remotely configure the parameters\n used by a proxy forwarding application.\n \n Copyright (C) The Internet Society (2002). This\n version of this MIB module is part of RFC 3413;\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 SNMP-PROXY-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/SNMP-PROXY-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "SNMP-PROXY-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/SNMP-PROXY-MIB:snmpProxyTable": { "get": { "summary": "Get snmpProxyTable data", "description": "Retrieve snmpProxyTable operational data from MIB", "tags": [ "SNMP-PROXY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table of translation parameters used by proxy forwarder\n applications for forwarding SNMP messages.", "properties": { "snmpProxyEntry": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry." }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID" }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue" }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "SNMP-PROXY-MIB:snmpProxyTable": { "snmpProxyEntry": [ { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" }, { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" }, { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpProxyTable", "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": "/snmpProxyTable", "x-restconf-kind": "container" }, "/data/SNMP-PROXY-MIB:snmpProxyTable/snmpProxyEntry": { "get": { "summary": "Get snmpProxyEntry list", "description": "Retrieve list of snmpProxyEntry entries from MIB", "tags": [ "SNMP-PROXY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry." }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID" }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue" }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-PROXY-MIB:snmpProxyEntry": [ { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpProxyEntry", "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": "/snmpProxyTable/snmpProxyEntry", "x-restconf-kind": "container" }, "/data/SNMP-PROXY-MIB:snmpProxyTable/snmpProxyEntry={snmpProxyName}": { "get": { "summary": "Get snmpProxyEntry entry", "description": "Retrieve specific snmpProxyEntry entry by key from MIB", "tags": [ "SNMP-PROXY-MIB" ], "parameters": [ { "name": "snmpProxyName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "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": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry." }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID" }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue" }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-PROXY-MIB:snmpProxyEntry": { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpProxyEntry-2" }, "x-yang-path": "/snmpProxyTable/snmpProxyEntry={snmpProxyName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpProxyName" ] }, "/data/SNMP-PROXY-MIB:snmpProxyEntry": { "get": { "summary": "Get snmpProxyEntry list", "description": "Retrieve list of snmpProxyEntry entries from MIB", "tags": [ "SNMP-PROXY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry." }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID" }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue" }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-PROXY-MIB:snmpProxyEntry": [ { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpProxyEntry-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": "/snmpProxyEntry", "x-restconf-kind": "container" }, "/data/SNMP-PROXY-MIB:snmpProxyEntry={snmpProxyName}": { "get": { "summary": "Get snmpProxyEntry entry", "description": "Retrieve specific snmpProxyEntry entry by key from MIB", "tags": [ "SNMP-PROXY-MIB" ], "parameters": [ { "name": "snmpProxyName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "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": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry." }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID" }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue" }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-PROXY-MIB:snmpProxyEntry": { "snmpProxyName": "interface-1", "snmpProxyType": "ethernetCsmacd(6)", "snmpProxyContextEngineID": "example-string", "snmpProxyContextName": "interface-1", "snmpProxyTargetParamsIn": "example-string", "snmpProxySingleTargetOut": "example-string", "snmpProxyMultipleTargetOut": "192.168.1.1", "snmpProxyStorageType": "ethernetCsmacd(6)", "snmpProxyRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpProxyEntry-4" }, "x-yang-path": "/snmpProxyEntry={snmpProxyName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpProxyName" ] } }, "components": { "schemas": { "SNMP-PROXY-MIB_SNMP-PROXY-MIB": { "type": "object", "description": "The table of translation parameters used by proxy forwarder\n applications for forwarding SNMP messages.", "properties": { "snmpProxyEntry": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry.", "readOnly": true }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID", "readOnly": true }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "snmpProxyTable": { "type": "object", "description": "The table of translation parameters used by proxy forwarder\n applications for forwarding SNMP messages.", "properties": { "snmpProxyEntry": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry.", "readOnly": true }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID", "readOnly": true }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "SNMP-PROXY-MIB_snmpProxyEntry": { "type": "array", "description": "A set of translation parameters used by a proxy forwarder\n application for forwarding SNMP messages.\n \n Entries in the snmpProxyTable are created and deleted\n using the snmpProxyRowStatus object.", "items": { "type": "object", "properties": { "snmpProxyName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpProxyEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyType": { "type": "string", "description": "The type of message that may be forwarded using\n the translation parameters defined by this entry.", "readOnly": true }, "snmpProxyContextEngineID": { "type": "string", "description": "The contextEngineID contained in messages that\n may be forwarded using the translation parameters\n defined by this entry.", "x-yang-type": "snmp-framework:SnmpEngineID", "readOnly": true }, "snmpProxyContextName": { "type": "string", "description": "The contextName contained in messages that may be\n forwarded using the translation parameters defined\n by this entry.\n \n This object is optional, and if not supported, the\n contextName contained in a message is ignored when\n selecting an entry in the snmpProxyTable.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyTargetParamsIn": { "type": "string", "description": "This object selects an entry in the snmpTargetParamsTable.\n The selected entry is used to determine which row of the\n snmpProxyTable to use for forwarding received messages.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxySingleTargetOut": { "type": "string", "description": "This object selects a management target defined in the\n snmpTargetAddrTable (in the SNMP-TARGET-MIB). The\n selected target is defined by an entry in the\n snmpTargetAddrTable whose index value (snmpTargetAddrName)\n is equal to this object.\n \n This object is only used when selection of a single\n target is required (i.e. when forwarding an incoming\n read or write request).", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpProxyMultipleTargetOut": { "type": "string", "description": "This object selects a set of management targets defined\n in the snmpTargetAddrTable (in the SNMP-TARGET-MIB).\n \n This object is only used when selection of multiple\n targets is required (i.e. when forwarding an incoming\n notification).", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "snmpProxyStorageType": { "type": "string", "description": "The storage type of this conceptual row.\n Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpProxyRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n To create a row in this table, a manager must\n set this object to either createAndGo(4) or\n createAndWait(5).\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpProxyType\n - snmpProxyContextEngineID\n - snmpProxyContextName\n - snmpProxyTargetParamsIn\n - snmpProxySingleTargetOut\n - snmpProxyMultipleTargetOut", "x-yang-type": "snmpv2-tc:RowStatus", "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": "SNMP-PROXY-MIB", "description": "MIB operations for SNMP-PROXY-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }