{ "openapi": "3.0.0", "info": { "title": "DRAFT-MSDP-MIB MIB API", "version": "1.0.0", "description": "An experimental MIB module for MSDP Management.\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 DRAFT-MSDP-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/DRAFT-MSDP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "DRAFT-MSDP-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/DRAFT-MSDP-MIB:msdp": { "get": { "summary": "Get msdp data", "description": "Retrieve msdp operational data from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The state of MSDP on this MSDP speaker - globally\n enabled or disabled.", "properties": { "msdpEnabled": { "type": "boolean", "description": "The state of MSDP on this MSDP speaker - globally\n enabled or disabled." }, "msdpCacheLifetime": { "type": "string", "description": "The lifetime given to SA cache entries when created\n or refreshed. A value of 0 means no SA caching is\n done by this MSDP speaker.", "x-yang-type": "yang:timeticks" }, "msdpNumSACacheEntries": { "type": "integer", "description": "The total number of entries in the SA Cache table.", "minimum": 0, "maximum": 4294967295 }, "msdpSAHoldDownPeriod": { "type": "integer", "description": "The number of seconds in the MSDP SA Hold-down\n period", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "DRAFT-MSDP-MIB:msdp": { "msdpEnabled": true, "msdpCacheLifetime": "example-string", "msdpNumSACacheEntries": 0, "msdpSAHoldDownPeriod": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdp", "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": "/msdp", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpRequestsTable": { "get": { "summary": "Get msdpRequestsTable data", "description": "Retrieve msdpRequestsTable operational data from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing group ranges and MSDP\n peers used when deciding where to send an SA Request\n message when required. If SA Caching is enabled, this\n table may be empty.", "properties": { "msdpRequestsEntry": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address" }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "DRAFT-MSDP-MIB:msdpRequestsTable": { "msdpRequestsEntry": [ { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" }, { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" }, { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpRequestsTable", "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": "/msdpRequestsTable", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpRequestsTable/msdpRequestsEntry": { "get": { "summary": "Get msdpRequestsEntry list", "description": "Retrieve list of msdpRequestsEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address" }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DRAFT-MSDP-MIB:msdpRequestsEntry": [ { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpRequestsEntry", "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": "/msdpRequestsTable/msdpRequestsEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpPeerTable": { "get": { "summary": "Get msdpPeerTable data", "description": "Retrieve msdpPeerTable operational data from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the MSDP speaker's\n peers.", "properties": { "msdpPeerEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address" }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer." }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address" }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0." }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus" }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine." }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer." }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary" } } } } } }, "example": { "DRAFT-MSDP-MIB:msdpPeerTable": { "msdpPeerEntry": [ { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" }, { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" }, { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpPeerTable", "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": "/msdpPeerTable", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpPeerTable/msdpPeerEntry": { "get": { "summary": "Get msdpPeerEntry list", "description": "Retrieve list of msdpPeerEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address" }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer." }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address" }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0." }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus" }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine." }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer." }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary" } } } }, "example": { "DRAFT-MSDP-MIB:msdpPeerEntry": [ { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpPeerEntry", "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": "/msdpPeerTable/msdpPeerEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpPeerTable/msdpPeerEntry={msdpPeerRemoteAddress}": { "get": { "summary": "Get msdpPeerEntry entry", "description": "Retrieve specific msdpPeerEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpPeerRemoteAddress", "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": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address" }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer." }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address" }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0." }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus" }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine." }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer." }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary" } } }, "example": { "DRAFT-MSDP-MIB:msdpPeerEntry": { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpPeerEntry-2" }, "x-yang-path": "/msdpPeerTable/msdpPeerEntry={msdpPeerRemoteAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpPeerRemoteAddress" ] }, "/data/DRAFT-MSDP-MIB:msdpSACacheTable": { "get": { "summary": "Get msdpSACacheTable data", "description": "Retrieve msdpSACacheTable operational data from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the MSDP SA\n advertisements currently in the MSDP speaker's cache.", "properties": { "msdpSACacheEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address" }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address" }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address" }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "DRAFT-MSDP-MIB:msdpSACacheTable": { "msdpSACacheEntry": [ { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" }, { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" }, { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpSACacheTable", "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": "/msdpSACacheTable", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpSACacheTable/msdpSACacheEntry": { "get": { "summary": "Get msdpSACacheEntry list", "description": "Retrieve list of msdpSACacheEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address" }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address" }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address" }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DRAFT-MSDP-MIB:msdpSACacheEntry": [ { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpSACacheEntry", "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": "/msdpSACacheTable/msdpSACacheEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpRequestsEntry": { "get": { "summary": "Get msdpRequestsEntry list", "description": "Retrieve list of msdpRequestsEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address" }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DRAFT-MSDP-MIB:msdpRequestsEntry": [ { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpRequestsEntry-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": "/msdpRequestsEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpPeerEntry": { "get": { "summary": "Get msdpPeerEntry list", "description": "Retrieve list of msdpPeerEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address" }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer." }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address" }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0." }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus" }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine." }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer." }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary" } } } }, "example": { "DRAFT-MSDP-MIB:msdpPeerEntry": [ { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpPeerEntry-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": "/msdpPeerEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpPeerEntry={msdpPeerRemoteAddress}": { "get": { "summary": "Get msdpPeerEntry entry", "description": "Retrieve specific msdpPeerEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpPeerRemoteAddress", "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": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address" }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer." }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address" }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0." }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus" }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647 }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine." }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer." }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295 }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary" } } }, "example": { "DRAFT-MSDP-MIB:msdpPeerEntry": { "msdpPeerRemoteAddress": "192.168.1.1", "msdpPeerState": "up(1)", "msdpPeerRPFFailures": 0, "msdpPeerInSAs": 0, "msdpPeerOutSAs": 0, "msdpPeerInSARequests": 0, "msdpPeerOutSARequests": 0, "msdpPeerInSAResponses": 0, "msdpPeerOutSAResponses": 0, "msdpPeerInControlMessages": 0, "msdpPeerOutControlMessages": 0, "msdpPeerInDataPackets": 1234567890, "msdpPeerOutDataPackets": 1234567890, "msdpPeerFsmEstablishedTransitions": 0, "msdpPeerFsmEstablishedTime": 0, "msdpPeerInMessageElapsedTime": 0, "msdpPeerLocalAddress": "192.168.1.1", "msdpPeerSAAdvPeriod": -2147483648, "msdpPeerConnectRetryInterval": -2147483648, "msdpPeerHoldTimeConfigured": -2147483648, "msdpPeerKeepAliveConfigured": -2147483648, "msdpPeerDataTtl": -2147483648, "msdpPeerProcessRequestsFrom": true, "msdpPeerStatus": "up(1)", "msdpPeerRemotePort": -2147483648, "msdpPeerLocalPort": -2147483648, "msdpPeerEncapsulationState": "up(1)", "msdpPeerEncapsulationType": "ethernetCsmacd(6)", "msdpPeerConnectionAttempts": 0, "msdpPeerInNotifications": 0, "msdpPeerOutNotifications": 0, "msdpPeerLastError": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpPeerEntry-4" }, "x-yang-path": "/msdpPeerEntry={msdpPeerRemoteAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpPeerRemoteAddress" ] }, "/data/DRAFT-MSDP-MIB:msdpSACacheEntry": { "get": { "summary": "Get msdpSACacheEntry list", "description": "Retrieve list of msdpSACacheEntry entries from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address" }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address" }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address" }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DRAFT-MSDP-MIB:msdpSACacheEntry": [ { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpSACacheEntry-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": "/msdpSACacheEntry", "x-restconf-kind": "container" }, "/data/DRAFT-MSDP-MIB:msdpRequestsTable/msdpRequestsEntry={msdpRequestsGroupAddress},{msdpRequestsGroupMask}": { "get": { "summary": "Get msdpRequestsEntry entry", "description": "Retrieve specific msdpRequestsEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpRequestsGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpRequestsGroupMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address" }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DRAFT-MSDP-MIB:msdpRequestsEntry": { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpRequestsEntry-2" }, "x-yang-path": "/msdpRequestsTable/msdpRequestsEntry={msdpRequestsGroupAddress msdpRequestsGroupMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpRequestsGroupAddress msdpRequestsGroupMask" ] }, "/data/DRAFT-MSDP-MIB:msdpSACacheTable/msdpSACacheEntry={msdpSACacheGroupAddr},{msdpSACacheSourceAddr},{msdpSACacheOriginRP}": { "get": { "summary": "Get msdpSACacheEntry entry", "description": "Retrieve specific msdpSACacheEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpSACacheGroupAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpSACacheSourceAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpSACacheOriginRP", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address" }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address" }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address" }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DRAFT-MSDP-MIB:msdpSACacheEntry": { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpSACacheEntry-2" }, "x-yang-path": "/msdpSACacheTable/msdpSACacheEntry={msdpSACacheGroupAddr msdpSACacheSourceAddr msdpSACacheOriginRP}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpSACacheGroupAddr msdpSACacheSourceAddr msdpSACacheOriginRP" ] }, "/data/DRAFT-MSDP-MIB:msdpRequestsEntry={msdpRequestsGroupAddress},{msdpRequestsGroupMask}": { "get": { "summary": "Get msdpRequestsEntry entry", "description": "Retrieve specific msdpRequestsEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpRequestsGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpRequestsGroupMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address" }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address" }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DRAFT-MSDP-MIB:msdpRequestsEntry": { "msdpRequestsGroupAddress": "192.168.1.1", "msdpRequestsGroupMask": "example-string", "msdpRequestsPeer": "example-string", "msdpRequestsStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpRequestsEntry-4" }, "x-yang-path": "/msdpRequestsEntry={msdpRequestsGroupAddress msdpRequestsGroupMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpRequestsGroupAddress msdpRequestsGroupMask" ] }, "/data/DRAFT-MSDP-MIB:msdpSACacheEntry={msdpSACacheGroupAddr},{msdpSACacheSourceAddr},{msdpSACacheOriginRP}": { "get": { "summary": "Get msdpSACacheEntry entry", "description": "Retrieve specific msdpSACacheEntry entry by key from MIB", "tags": [ "DRAFT-MSDP-MIB" ], "parameters": [ { "name": "msdpSACacheGroupAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpSACacheSourceAddr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "msdpSACacheOriginRP", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address" }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address" }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address" }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address" }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295 }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks" }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DRAFT-MSDP-MIB:msdpSACacheEntry": { "msdpSACacheGroupAddr": "192.168.1.1", "msdpSACacheSourceAddr": "192.168.1.1", "msdpSACacheOriginRP": "example-string", "msdpSACachePeerLearnedFrom": "example-string", "msdpSACacheRPFPeer": "example-string", "msdpSACacheInSAs": 0, "msdpSACacheInDataPackets": 1234567890, "msdpSACacheUpTime": "example-string", "msdpSACacheExpiryTime": "example-string", "msdpSACacheStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-msdpSACacheEntry-4" }, "x-yang-path": "/msdpSACacheEntry={msdpSACacheGroupAddr msdpSACacheSourceAddr msdpSACacheOriginRP}", "x-restconf-kind": "list-instance", "x-list-keys": [ "msdpSACacheGroupAddr msdpSACacheSourceAddr msdpSACacheOriginRP" ] } }, "components": { "schemas": { "DRAFT-MSDP-MIB_DRAFT-MSDP-MIB": { "type": "object", "description": "The state of MSDP on this MSDP speaker - globally\n enabled or disabled.", "properties": { "msdpRequestsEntry": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "msdpPeerEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer.", "readOnly": true }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0.", "readOnly": true }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine.", "readOnly": true }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer.", "readOnly": true }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "msdpSACacheEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "msdp": { "type": "object", "description": "The state of MSDP on this MSDP speaker - globally\n enabled or disabled.", "properties": { "msdpEnabled": { "type": "boolean", "description": "The state of MSDP on this MSDP speaker - globally\n enabled or disabled.", "readOnly": true }, "msdpCacheLifetime": { "type": "string", "description": "The lifetime given to SA cache entries when created\n or refreshed. A value of 0 means no SA caching is\n done by this MSDP speaker.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpNumSACacheEntries": { "type": "integer", "description": "The total number of entries in the SA Cache table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSAHoldDownPeriod": { "type": "integer", "description": "The number of seconds in the MSDP SA Hold-down\n period", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "msdpRequestsTable": { "type": "object", "description": "The (conceptual) table listing group ranges and MSDP\n peers used when deciding where to send an SA Request\n message when required. If SA Caching is enabled, this\n table may be empty.", "properties": { "msdpRequestsEntry": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "msdpPeerTable": { "type": "object", "description": "The (conceptual) table listing the MSDP speaker's\n peers.", "properties": { "msdpPeerEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer.", "readOnly": true }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0.", "readOnly": true }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine.", "readOnly": true }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer.", "readOnly": true }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "msdpSACacheTable": { "type": "object", "description": "The (conceptual) table listing the MSDP SA\n advertisements currently in the MSDP speaker's cache.", "properties": { "msdpSACacheEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "DRAFT-MSDP-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "msdpPeerRemoteAddress", "x-yang-type": "leafref", "readOnly": true }, "msdpPeerState": { "type": "string", "description": "msdpPeerState", "x-yang-type": "leafref", "readOnly": true } } }, "DRAFT-MSDP-MIB_msdpRequestsEntry": { "type": "array", "description": "An entry (conceptual row) representing a group range\n used when deciding where to send an SA Request\n message.", "items": { "type": "object", "properties": { "msdpRequestsGroupAddress": { "type": "string", "description": "The group address that, when combined with the mask\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsGroupMask": { "type": "string", "description": "The mask that, when combined with the group address\n in this entry, represents the group range for which\n this peer will service MSDP SA Requests.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsPeer": { "type": "string", "description": "The peer to which MSDP SA Requests for groups\n matching this entry's group range will be sent. Must\n match the INDEX of a row in the msdpPeerTable.", "format": "inet:ipv4-address", "readOnly": true }, "msdpRequestsStatus": { "type": "string", "description": "The status of this row, by which new rows may be\n added to the table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "DRAFT-MSDP-MIB_msdpPeerEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP peer.", "items": { "type": "object", "properties": { "msdpPeerRemoteAddress": { "type": "string", "description": "The address of the remote MSDP peer.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerState": { "type": "string", "description": "The state of the MSDP TCP connection with this peer.", "readOnly": true }, "msdpPeerRPFFailures": { "type": "integer", "description": "The number of RPF failures on SA messages received\n from this peer.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAs": { "type": "integer", "description": "The number of MSDP SA messages received on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAs": { "type": "integer", "description": "The number of MSDP SA messages transmitted on this\n connection. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSARequests": { "type": "integer", "description": "The number of MSDP SA-Request messages transmitted on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInSAResponses": { "type": "integer", "description": "The number of MSDP SA-Response messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutSAResponses": { "type": "integer", "description": "The number of MSDP SA Response messages transmitted\n on this TCP connection. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInControlMessages": { "type": "integer", "description": "The total number of MSDP messages received on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutControlMessages": { "type": "integer", "description": "The total number of MSDP messages transmitted on this\n TCP connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets\n received from this peer. This object should be\n initialized to zero when the connection is\n established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutDataPackets": { "type": "integer", "description": "The total number of encapsulated data packets sent to\n this peer. This object should be initialized to zero\n when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTransitions": { "type": "integer", "description": "The total number of times the MSDP FSM transitioned\n into the established state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerFsmEstablishedTime": { "type": "integer", "description": "This timer indicates how long (in seconds) this peer\n has been in the Established state or how long since\n this peer was last in the Established state. It is\n set to zero when a new peer is configured or the MSDP\n speaker is booted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInMessageElapsedTime": { "type": "integer", "description": "Elapsed time in seconds since the last MSDP message\n was received from the peer. Each time\n msdpPeerInControlMessages is incremented, the value of\n this object is set to zero (0).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLocalAddress": { "type": "string", "description": "The local IP address of this entry's MSDP\n connection.", "format": "inet:ipv4-address", "readOnly": true }, "msdpPeerSAAdvPeriod": { "type": "integer", "description": "Time interval in seconds for the\n MinSAAdvertisementInterval MSDP timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerConnectRetryInterval": { "type": "integer", "description": "Time interval in seconds for the ConnectRetry timer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerHoldTimeConfigured": { "type": "integer", "description": "Time interval in seconds for the Hold Timer\n configured for this MSDP speaker with this peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerKeepAliveConfigured": { "type": "integer", "description": "Time interval in seconds for the KeepAlive timer\n configured for this MSDP speaker with this peer. A\n reasonable maximum value for this timer would be\n configured to be one third of that of\n msdpPeerHoldTimeConfigured. If the value of this\n object is zero (0), no periodic KEEPALIVE messages are\n sent to the peer after the MSDP connection has been\n established.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerDataTtl": { "type": "integer", "description": "The minimum TTL a packet is required to have before\n it may be forwarded using SA encapsulation to this\n peer.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerProcessRequestsFrom": { "type": "boolean", "description": "This object indicates whether or not to process MSDP\n SA Request messages from this peer. If True(1), MSDP\n SA Request messages from this peer are processed and\n replied to (if appropriate) with SA Response messages.\n If False(2), MSDP SA Request messages from this peer\n are silently ignored. It defaults to False when\n msdpCacheLifetime is 0 and True when msdpCacheLifetime\n is non-0.", "readOnly": true }, "msdpPeerStatus": { "type": "string", "description": "The RowStatus object by which peers can be added and\n deleted. A transition to 'active' will cause the MSDP\n Start Event to be generated. A transition out of the\n 'active' state will cause the MSDP Stop Event to be\n generated. Care should be used in providing write\n access to this object without adequate\n authentication.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "msdpPeerRemotePort": { "type": "integer", "description": "The remote port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerLocalPort": { "type": "integer", "description": "The local port for the TCP connection between the\n MSDP peers.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "msdpPeerEncapsulationState": { "type": "string", "description": "The status of the encapsulation negotiation state\n machine.", "readOnly": true }, "msdpPeerEncapsulationType": { "type": "string", "description": "The encapsulation in use when encapsulating data in\n SA messages to this peer.", "readOnly": true }, "msdpPeerConnectionAttempts": { "type": "integer", "description": "The number of times the state machine has\n transitioned from inactive to connecting.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerInNotifications": { "type": "integer", "description": "The number of MSDP Notification messages received on\n this connection. This object should be initialized to\n zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerOutNotifications": { "type": "integer", "description": "The number of MSDP Notification messages transmitted\n on this connection. This object should be initialized\n to zero when the connection is established.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpPeerLastError": { "type": "string", "description": "The last error code and subcode seen by this peer on\n this connection. If no error has occurred, this field\n is zero. Otherwise, the first byte of this two byte\n OCTET STRING contains the error code, and the second\n byte contains the subcode.", "format": "binary", "readOnly": true } } } }, "DRAFT-MSDP-MIB_msdpSACacheEntry": { "type": "array", "description": "An entry (conceptual row) representing an MSDP SA\n advert.", "items": { "type": "object", "properties": { "msdpSACacheGroupAddr": { "type": "string", "description": "The group address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheSourceAddr": { "type": "string", "description": "The source address of the SA Cache entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheOriginRP": { "type": "string", "description": "The address of the RP which originated the last SA\n message accepted for this entry.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACachePeerLearnedFrom": { "type": "string", "description": "The peer from which this SA Cache entry was last\n accepted. This address must correspond to the\n msdpPeerRemoteAddress value for a row in the MSDP Peer\n Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheRPFPeer": { "type": "string", "description": "The peer from which an SA message corresponding to\n this cache entry would be accepted (i.e. the RPF peer\n for msdpSACacheOriginRP). This may be different than\n msdpSACachePeerLearnedFrom if this entry was created\n by an MSDP SA-Response. This address must correspond\n to the msdpPeerRemoteAddress value for a row in the\n MSDP Peer Table.", "format": "inet:ipv4-address", "readOnly": true }, "msdpSACacheInSAs": { "type": "integer", "description": "The number of MSDP SA messages received relevant to\n this cache entry. This object must be initialized to\n zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheInDataPackets": { "type": "integer", "description": "The number of MSDP encapsulated data packets received\n relevant to this cache entry. This object must be\n initialized to zero when creating a cache entry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "msdpSACacheUpTime": { "type": "string", "description": "The time since this entry was placed in the SA\n cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheExpiryTime": { "type": "string", "description": "The time remaining before this entry will expire from\n the SA cache.", "x-yang-type": "yang:timeticks", "readOnly": true }, "msdpSACacheStatus": { "type": "string", "description": "The status of this row in the table. The only\n allowable actions are to retreive the status, which\n will be `active', or to set the status to `destroy' in\n order to remove this entry from the cache.", "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": "DRAFT-MSDP-MIB", "description": "MIB operations for DRAFT-MSDP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }