{ "openapi": "3.0.0", "info": { "title": "SNMP-TARGET-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines MIB objects which provide\n mechanisms to remotely configure the parameters used\n by an SNMP entity for the generation of SNMP messages.\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-TARGET-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/SNMP-TARGET-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "SNMP-TARGET-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-TARGET-MIB:snmpTargetObjects": { "get": { "summary": "Get snmpTargetObjects data", "description": "Retrieve snmpTargetObjects operational data from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "snmpTargetObjects", "properties": { "snmpTargetSpinLock": { "type": "string", "description": "This object is used to facilitate modification of table\n entries in the SNMP-TARGET-MIB module by multiple\n \n \n \n \n \n managers. In particular, it is useful when modifying\n the value of the snmpTargetAddrTagList object.\n \n The procedure for modifying the snmpTargetAddrTagList\n object is as follows:\n \n 1. Retrieve the value of snmpTargetSpinLock and\n of snmpTargetAddrTagList.\n \n 2. Generate a new value for snmpTargetAddrTagList.\n \n 3. Set the value of snmpTargetSpinLock to the\n retrieved value, and the value of\n snmpTargetAddrTagList to the new value. If\n the set fails for the snmpTargetSpinLock\n object, go back to step 1.", "x-yang-type": "snmpv2-tc:TestAndIncr" }, "snmpUnavailableContexts": { "type": "integer", "description": "The total number of packets received by the SNMP\n engine which were dropped because the context\n contained in the message was unavailable.", "minimum": 0, "maximum": 4294967295 }, "snmpUnknownContexts": { "type": "integer", "description": "The total number of packets received by the SNMP\n engine which were dropped because the context\n contained in the message was unknown.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "SNMP-TARGET-MIB:snmpTargetObjects": { "snmpTargetSpinLock": "example-string", "snmpUnavailableContexts": 0, "snmpUnknownContexts": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetObjects", "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": "/snmpTargetObjects", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetAddrTable": { "get": { "summary": "Get snmpTargetAddrTable data", "description": "Retrieve snmpTargetAddrTable operational data from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of transport addresses to be used in the generation\n of SNMP messages.", "properties": { "snmpTargetAddrEntry": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain" }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress" }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval" }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647 }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList" }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetAddrTable": { "snmpTargetAddrEntry": [ { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" }, { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" }, { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetAddrTable", "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": "/snmpTargetAddrTable", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetAddrTable/snmpTargetAddrEntry": { "get": { "summary": "Get snmpTargetAddrEntry list", "description": "Retrieve list of snmpTargetAddrEntry entries from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain" }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress" }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval" }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647 }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList" }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetAddrEntry": [ { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetAddrEntry", "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": "/snmpTargetAddrTable/snmpTargetAddrEntry", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetAddrTable/snmpTargetAddrEntry={snmpTargetAddrName}": { "get": { "summary": "Get snmpTargetAddrEntry entry", "description": "Retrieve specific snmpTargetAddrEntry entry by key from MIB", "tags": [ "SNMP-TARGET-MIB" ], "parameters": [ { "name": "snmpTargetAddrName", "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": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain" }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress" }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval" }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647 }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList" }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-TARGET-MIB:snmpTargetAddrEntry": { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetAddrEntry-2" }, "x-yang-path": "/snmpTargetAddrTable/snmpTargetAddrEntry={snmpTargetAddrName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpTargetAddrName" ] }, "/data/SNMP-TARGET-MIB:snmpTargetParamsTable": { "get": { "summary": "Get snmpTargetParamsTable data", "description": "Retrieve snmpTargetParamsTable operational data from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of SNMP target information to be used\n in the generation of SNMP messages.", "properties": { "snmpTargetParamsEntry": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel" }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel" }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel" }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetParamsTable": { "snmpTargetParamsEntry": [ { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" }, { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" }, { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetParamsTable", "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": "/snmpTargetParamsTable", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetParamsTable/snmpTargetParamsEntry": { "get": { "summary": "Get snmpTargetParamsEntry list", "description": "Retrieve list of snmpTargetParamsEntry entries from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel" }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel" }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel" }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetParamsEntry": [ { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetParamsEntry", "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": "/snmpTargetParamsTable/snmpTargetParamsEntry", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetParamsTable/snmpTargetParamsEntry={snmpTargetParamsName}": { "get": { "summary": "Get snmpTargetParamsEntry entry", "description": "Retrieve specific snmpTargetParamsEntry entry by key from MIB", "tags": [ "SNMP-TARGET-MIB" ], "parameters": [ { "name": "snmpTargetParamsName", "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": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel" }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel" }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel" }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-TARGET-MIB:snmpTargetParamsEntry": { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetParamsEntry-2" }, "x-yang-path": "/snmpTargetParamsTable/snmpTargetParamsEntry={snmpTargetParamsName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpTargetParamsName" ] }, "/data/SNMP-TARGET-MIB:snmpTargetAddrEntry": { "get": { "summary": "Get snmpTargetAddrEntry list", "description": "Retrieve list of snmpTargetAddrEntry entries from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain" }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress" }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval" }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647 }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList" }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetAddrEntry": [ { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetAddrEntry-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": "/snmpTargetAddrEntry", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetAddrEntry={snmpTargetAddrName}": { "get": { "summary": "Get snmpTargetAddrEntry entry", "description": "Retrieve specific snmpTargetAddrEntry entry by key from MIB", "tags": [ "SNMP-TARGET-MIB" ], "parameters": [ { "name": "snmpTargetAddrName", "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": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain" }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress" }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval" }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647 }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList" }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-TARGET-MIB:snmpTargetAddrEntry": { "snmpTargetAddrName": "192.168.1.1", "snmpTargetAddrTDomain": "192.168.1.1", "snmpTargetAddrTAddress": "192.168.1.1", "snmpTargetAddrTimeout": "192.168.1.1", "snmpTargetAddrRetryCount": -2147483648, "snmpTargetAddrTagList": "192.168.1.1", "snmpTargetAddrParams": "192.168.1.1", "snmpTargetAddrStorageType": "192.168.1.1", "snmpTargetAddrRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetAddrEntry-4" }, "x-yang-path": "/snmpTargetAddrEntry={snmpTargetAddrName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpTargetAddrName" ] }, "/data/SNMP-TARGET-MIB:snmpTargetParamsEntry": { "get": { "summary": "Get snmpTargetParamsEntry list", "description": "Retrieve list of snmpTargetParamsEntry entries from MIB", "tags": [ "SNMP-TARGET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel" }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel" }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel" }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "SNMP-TARGET-MIB:snmpTargetParamsEntry": [ { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetParamsEntry-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": "/snmpTargetParamsEntry", "x-restconf-kind": "container" }, "/data/SNMP-TARGET-MIB:snmpTargetParamsEntry={snmpTargetParamsName}": { "get": { "summary": "Get snmpTargetParamsEntry entry", "description": "Retrieve specific snmpTargetParamsEntry entry by key from MIB", "tags": [ "SNMP-TARGET-MIB" ], "parameters": [ { "name": "snmpTargetParamsName", "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": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel" }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel" }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel" }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "SNMP-TARGET-MIB:snmpTargetParamsEntry": { "snmpTargetParamsName": "interface-1", "snmpTargetParamsMPModel": "example-string", "snmpTargetParamsSecurityModel": "example-string", "snmpTargetParamsSecurityName": "interface-1", "snmpTargetParamsSecurityLevel": "example-string", "snmpTargetParamsStorageType": "ethernetCsmacd(6)", "snmpTargetParamsRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-snmpTargetParamsEntry-4" }, "x-yang-path": "/snmpTargetParamsEntry={snmpTargetParamsName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "snmpTargetParamsName" ] } }, "components": { "schemas": { "SNMP-TARGET-MIB_SNMP-TARGET-MIB": { "type": "object", "description": "SNMP-TARGET-MIB", "properties": { "snmpTargetAddrEntry": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval", "readOnly": true }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList", "readOnly": true }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "snmpTargetParamsEntry": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel", "readOnly": true }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel", "readOnly": true }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel", "readOnly": true }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "snmpTargetObjects": { "type": "object", "description": "snmpTargetObjects", "properties": { "snmpTargetSpinLock": { "type": "string", "description": "This object is used to facilitate modification of table\n entries in the SNMP-TARGET-MIB module by multiple\n \n \n \n \n \n managers. In particular, it is useful when modifying\n the value of the snmpTargetAddrTagList object.\n \n The procedure for modifying the snmpTargetAddrTagList\n object is as follows:\n \n 1. Retrieve the value of snmpTargetSpinLock and\n of snmpTargetAddrTagList.\n \n 2. Generate a new value for snmpTargetAddrTagList.\n \n 3. Set the value of snmpTargetSpinLock to the\n retrieved value, and the value of\n snmpTargetAddrTagList to the new value. If\n the set fails for the snmpTargetSpinLock\n object, go back to step 1.", "x-yang-type": "snmpv2-tc:TestAndIncr", "readOnly": true }, "snmpUnavailableContexts": { "type": "integer", "description": "The total number of packets received by the SNMP\n engine which were dropped because the context\n contained in the message was unavailable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "snmpUnknownContexts": { "type": "integer", "description": "The total number of packets received by the SNMP\n engine which were dropped because the context\n contained in the message was unknown.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "snmpTargetAddrTable": { "type": "object", "description": "A table of transport addresses to be used in the generation\n of SNMP messages.", "properties": { "snmpTargetAddrEntry": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval", "readOnly": true }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList", "readOnly": true }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "snmpTargetParamsTable": { "type": "object", "description": "A table of SNMP target information to be used\n in the generation of SNMP messages.", "properties": { "snmpTargetParamsEntry": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel", "readOnly": true }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel", "readOnly": true }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel", "readOnly": true }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "SNMP-TARGET-MIB_snmpTargetAddrEntry": { "type": "array", "description": "A transport address to be used in the generation\n of SNMP operations.\n \n Entries in the snmpTargetAddrTable are created and\n deleted using the snmpTargetAddrRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetAddrName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetAddrEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrTDomain": { "type": "string", "description": "This object indicates the transport type of the address\n contained in the snmpTargetAddrTAddress object.", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "snmpTargetAddrTAddress": { "type": "string", "description": "This object contains a transport address. The format of\n this address depends on the value of the\n snmpTargetAddrTDomain object.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "snmpTargetAddrTimeout": { "type": "string", "description": "This object should reflect the expected maximum round\n trip time for communicating with the transport address\n defined by this row. When a message is sent to this\n address, and a response (if one is expected) is not\n received within this time period, an implementation\n may assume that the response will not be delivered.\n \n Note that the time interval that an application waits\n for a response may actually be derived from the value\n of this object. The method for deriving the actual time\n interval is implementation dependent. One such method\n \n \n \n \n \n is to derive the expected round trip time based on a\n particular retransmission algorithm and on the number\n of timeouts which have occurred. The type of message may\n also be considered when deriving expected round trip\n times for retransmissions. For example, if a message is\n being sent with a securityLevel that indicates both\n authentication and privacy, the derived value may be\n increased to compensate for extra processing time spent\n during authentication and encryption processing.", "x-yang-type": "snmpv2-tc:TimeInterval", "readOnly": true }, "snmpTargetAddrRetryCount": { "type": "integer", "description": "This object specifies a default number of retries to be\n attempted when a response is not received for a generated\n message. An application may provide its own retry count,\n in which case the value of this object is ignored.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "snmpTargetAddrTagList": { "type": "string", "description": "This object contains a list of tag values which are\n used to select target addresses for a particular\n operation.", "x-yang-type": "SNMP-TARGET-MIB:SnmpTagList", "readOnly": true }, "snmpTargetAddrParams": { "type": "string", "description": "The value of this object identifies an entry in the\n snmpTargetParamsTable. The identified entry\n contains SNMP parameters to be used when generating\n messages to be sent to this transport address.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetAddrStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetAddrRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetAddrRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n active until the corresponding instances of\n snmpTargetAddrTDomain, snmpTargetAddrTAddress, and\n snmpTargetAddrParams have all been set.\n \n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetAddrTDomain\n - snmpTargetAddrTAddress\n An attempt to set these objects while the value of\n snmpTargetAddrRowStatus is active(1) will result in\n an inconsistentValue error.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "SNMP-TARGET-MIB_snmpTargetParamsEntry": { "type": "array", "description": "A set of SNMP target information.\n \n Entries in the snmpTargetParamsTable are created and\n deleted using the snmpTargetParamsRowStatus object.", "items": { "type": "object", "properties": { "snmpTargetParamsName": { "type": "string", "description": "The locally arbitrary, but unique identifier associated\n with this snmpTargetParamsEntry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsMPModel": { "type": "string", "description": "The Message Processing Model to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpMessageProcessingModel", "readOnly": true }, "snmpTargetParamsSecurityModel": { "type": "string", "description": "The Security Model to be used when generating SNMP\n messages using this entry. An implementation may\n choose to return an inconsistentValue error if an\n attempt is made to set this variable to a value\n for a security model which the implementation does\n \n \n \n \n \n not support.", "x-yang-type": "snmp-framework:SnmpSecurityModel", "readOnly": true }, "snmpTargetParamsSecurityName": { "type": "string", "description": "The securityName which identifies the Principal on\n whose behalf SNMP messages will be generated using\n this entry.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "snmpTargetParamsSecurityLevel": { "type": "string", "description": "The Level of Security to be used when generating\n SNMP messages using this entry.", "x-yang-type": "snmp-framework:SnmpSecurityLevel", "readOnly": true }, "snmpTargetParamsStorageType": { "type": "string", "description": "The storage type for this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "snmpTargetParamsRowStatus": { "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 Until instances of all corresponding columns are\n appropriately configured, the value of the\n corresponding instance of the snmpTargetParamsRowStatus\n column is 'notReady'.\n \n In particular, a newly created row cannot be made\n \n \n \n \n \n active until the corresponding\n snmpTargetParamsMPModel,\n snmpTargetParamsSecurityModel,\n snmpTargetParamsSecurityName,\n and snmpTargetParamsSecurityLevel have all been set.\n The following objects may not be modified while the\n value of this object is active(1):\n - snmpTargetParamsMPModel\n - snmpTargetParamsSecurityModel\n - snmpTargetParamsSecurityName\n - snmpTargetParamsSecurityLevel\n An attempt to set these objects while the value of\n snmpTargetParamsRowStatus is active(1) will result in\n an inconsistentValue error.", "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-TARGET-MIB", "description": "MIB operations for SNMP-TARGET-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }