{ "openapi": "3.0.0", "info": { "title": "PIM-MIB MIB API", "version": "1.0.0", "description": "The MIB module for management of PIM routers.\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 PIM-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/PIM-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "PIM-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/PIM-MIB:pim": { "get": { "summary": "Get pim data", "description": "Retrieve pim operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The default interval at which periodic PIM-SM Join/Prune\n messages are to be sent.", "properties": { "pimJoinPruneInterval": { "type": "integer", "description": "The default interval at which periodic PIM-SM Join/Prune\n messages are to be sent.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "PIM-MIB:pim": { "pimJoinPruneInterval": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pim", "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": "/pim", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimInterfaceTable": { "get": { "summary": "Get pimInterfaceTable data", "description": "Retrieve pimInterfaceTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the router's PIM interfaces.\n IGMP and PIM are enabled on all interfaces listed in this\n table.", "properties": { "pimInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1." }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address" }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus" }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "PIM-MIB:pimInterfaceTable": { "pimInterfaceEntry": [ { "pimInterfaceIfIndex": "1", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 }, { "pimInterfaceIfIndex": "2", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 }, { "pimInterfaceIfIndex": "3", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimInterfaceTable", "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": "/pimInterfaceTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimInterfaceTable/pimInterfaceEntry": { "get": { "summary": "Get pimInterfaceEntry list", "description": "Retrieve list of pimInterfaceEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1." }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address" }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus" }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "PIM-MIB:pimInterfaceEntry": [ { "pimInterfaceIfIndex": "GigabitEthernet1/0/1", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimInterfaceEntry", "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": "/pimInterfaceTable/pimInterfaceEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimInterfaceTable/pimInterfaceEntry={pimInterfaceIfIndex}": { "get": { "summary": "Get pimInterfaceEntry entry", "description": "Retrieve specific pimInterfaceEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimInterfaceIfIndex", "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": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1." }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address" }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus" }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "PIM-MIB:pimInterfaceEntry": { "pimInterfaceIfIndex": "GigabitEthernet1/0/1", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimInterfaceEntry-2" }, "x-yang-path": "/pimInterfaceTable/pimInterfaceEntry={pimInterfaceIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimInterfaceIfIndex" ] }, "/data/PIM-MIB:pimNeighborTable": { "get": { "summary": "Get pimNeighborTable data", "description": "Retrieve pimNeighborTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the router's PIM neighbors.", "properties": { "pimNeighborEntry": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address" }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks" }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks" }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface." } } } } } }, "example": { "PIM-MIB:pimNeighborTable": { "pimNeighborEntry": [ { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "1", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" }, { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "2", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" }, { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "3", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimNeighborTable", "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": "/pimNeighborTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimNeighborTable/pimNeighborEntry": { "get": { "summary": "Get pimNeighborEntry list", "description": "Retrieve list of pimNeighborEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address" }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks" }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks" }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface." } } } }, "example": { "PIM-MIB:pimNeighborEntry": [ { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "example-string", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimNeighborEntry", "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": "/pimNeighborTable/pimNeighborEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimNeighborTable/pimNeighborEntry={pimNeighborAddress}": { "get": { "summary": "Get pimNeighborEntry entry", "description": "Retrieve specific pimNeighborEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimNeighborAddress", "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": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address" }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks" }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks" }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface." } } }, "example": { "PIM-MIB:pimNeighborEntry": { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "example-string", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimNeighborEntry-2" }, "x-yang-path": "/pimNeighborTable/pimNeighborEntry={pimNeighborAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimNeighborAddress" ] }, "/data/PIM-MIB:pimIpMRouteTable": { "get": { "summary": "Get pimIpMRouteTable data", "description": "Retrieve pimIpMRouteTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing PIM-specific information on\n a subset of the rows of the ipMRouteTable defined in the IP\n Multicast MIB.", "properties": { "pimIpMRouteEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref" }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref" }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref" }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks" }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect." }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary" } } } } } }, "example": { "PIM-MIB:pimIpMRouteTable": { "pimIpMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" }, { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" }, { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteTable", "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": "/pimIpMRouteTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimIpMRouteTable/pimIpMRouteEntry": { "get": { "summary": "Get pimIpMRouteEntry list", "description": "Retrieve list of pimIpMRouteEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref" }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref" }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref" }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks" }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect." }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary" } } } }, "example": { "PIM-MIB:pimIpMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteEntry", "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": "/pimIpMRouteTable/pimIpMRouteEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPTable": { "get": { "summary": "Get pimRPTable data", "description": "Retrieve pimRPTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing PIM version 1 information\n for the Rendezvous Points (RPs) for IP multicast groups.\n This table is deprecated since its function is replaced by\n the pimRPSetTable for PIM version 2.", "properties": { "pimRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address" }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address" }, "pimRPState": { "type": "string", "description": "The state of the RP." }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks" }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks" }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "PIM-MIB:pimRPTable": { "pimRPEntry": [ { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" }, { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" }, { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPTable", "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": "/pimRPTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPTable/pimRPEntry": { "get": { "summary": "Get pimRPEntry list", "description": "Retrieve list of pimRPEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address" }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address" }, "pimRPState": { "type": "string", "description": "The state of the RP." }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks" }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks" }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimRPEntry": [ { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPEntry", "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": "/pimRPTable/pimRPEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPSetTable": { "get": { "summary": "Get pimRPSetTable data", "description": "Retrieve pimRPSetTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing PIM information for\n candidate Rendezvous Points (RPs) for IP multicast groups.\n When the local router is the BSR, this information is\n obtained from received Candidate-RP-Advertisements. When\n the local router is not the BSR, this information is\n obtained from received RP-Set messages.", "properties": { "pimRPSetEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647 }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks" }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "PIM-MIB:pimRPSetTable": { "pimRPSetEntry": [ { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 }, { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 }, { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPSetTable", "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": "/pimRPSetTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPSetTable/pimRPSetEntry": { "get": { "summary": "Get pimRPSetEntry list", "description": "Retrieve list of pimRPSetEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647 }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks" }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "PIM-MIB:pimRPSetEntry": [ { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPSetEntry", "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": "/pimRPSetTable/pimRPSetEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimIpMRouteNextHopTable": { "get": { "summary": "Get pimIpMRouteNextHopTable data", "description": "Retrieve pimIpMRouteNextHopTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing PIM-specific information on\n a subset of the rows of the ipMRouteNextHopTable defined in\n the IP Multicast MIB.", "properties": { "pimIpMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref" }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref" }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref" }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing." } } } } } }, "example": { "PIM-MIB:pimIpMRouteNextHopTable": { "pimIpMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "1", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" }, { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "2", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" }, { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "3", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteNextHopTable", "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": "/pimIpMRouteNextHopTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimIpMRouteNextHopTable/pimIpMRouteNextHopEntry": { "get": { "summary": "Get pimIpMRouteNextHopEntry list", "description": "Retrieve list of pimIpMRouteNextHopEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref" }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref" }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref" }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing." } } } }, "example": { "PIM-MIB:pimIpMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteNextHopEntry", "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": "/pimIpMRouteNextHopTable/pimIpMRouteNextHopEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimCandidateRPTable": { "get": { "summary": "Get pimCandidateRPTable data", "description": "Retrieve pimCandidateRPTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The (conceptual) table listing the IP multicast groups for\n which the local router is to advertise itself as a\n Candidate-RP when the value of pimComponentCRPHoldTime is\n non-zero. If this table is empty, then the local router\n \n \n \n \n \n will advertise itself as a Candidate-RP for all groups\n (providing the value of pimComponentCRPHoldTime is non-\n zero).", "properties": { "pimCandidateRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "PIM-MIB:pimCandidateRPTable": { "pimCandidateRPEntry": [ { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" }, { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" }, { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimCandidateRPTable", "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": "/pimCandidateRPTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimCandidateRPTable/pimCandidateRPEntry": { "get": { "summary": "Get pimCandidateRPEntry list", "description": "Retrieve list of pimCandidateRPEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimCandidateRPEntry": [ { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimCandidateRPEntry", "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": "/pimCandidateRPTable/pimCandidateRPEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimComponentTable": { "get": { "summary": "Get pimComponentTable data", "description": "Retrieve pimComponentTable operational data from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "pimComponentTable", "properties": { "pimComponentEntry": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address" }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks" }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "PIM-MIB:pimComponentTable": { "pimComponentEntry": [ { "pimComponentIndex": 1, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" }, { "pimComponentIndex": 2, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" }, { "pimComponentIndex": 3, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimComponentTable", "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": "/pimComponentTable", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimComponentTable/pimComponentEntry": { "get": { "summary": "Get pimComponentEntry list", "description": "Retrieve list of pimComponentEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address" }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks" }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimComponentEntry": [ { "pimComponentIndex": 1, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimComponentEntry", "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": "/pimComponentTable/pimComponentEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimComponentTable/pimComponentEntry={pimComponentIndex}": { "get": { "summary": "Get pimComponentEntry entry", "description": "Retrieve specific pimComponentEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimComponentIndex", "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": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address" }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks" }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimComponentEntry": { "pimComponentIndex": 1, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimComponentEntry-2" }, "x-yang-path": "/pimComponentTable/pimComponentEntry={pimComponentIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimComponentIndex" ] }, "/data/PIM-MIB:pimInterfaceEntry": { "get": { "summary": "Get pimInterfaceEntry list", "description": "Retrieve list of pimInterfaceEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1." }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address" }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus" }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "PIM-MIB:pimInterfaceEntry": [ { "pimInterfaceIfIndex": "GigabitEthernet1/0/1", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimInterfaceEntry-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": "/pimInterfaceEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimInterfaceEntry={pimInterfaceIfIndex}": { "get": { "summary": "Get pimInterfaceEntry entry", "description": "Retrieve specific pimInterfaceEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimInterfaceIfIndex", "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": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address" }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1." }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address" }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus" }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647 }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "PIM-MIB:pimInterfaceEntry": { "pimInterfaceIfIndex": "GigabitEthernet1/0/1", "pimInterfaceAddress": "192.168.1.1", "pimInterfaceNetMask": "GigabitEthernet1/0/1", "pimInterfaceMode": "GigabitEthernet1/0/1", "pimInterfaceDR": "GigabitEthernet1/0/1", "pimInterfaceHelloInterval": -2147483648, "pimInterfaceStatus": "GigabitEthernet1/0/1", "pimInterfaceJoinPruneInterval": -2147483648, "pimInterfaceCBSRPreference": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimInterfaceEntry-4" }, "x-yang-path": "/pimInterfaceEntry={pimInterfaceIfIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimInterfaceIfIndex" ] }, "/data/PIM-MIB:pimNeighborEntry": { "get": { "summary": "Get pimNeighborEntry list", "description": "Retrieve list of pimNeighborEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address" }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks" }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks" }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface." } } } }, "example": { "PIM-MIB:pimNeighborEntry": [ { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "example-string", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimNeighborEntry-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": "/pimNeighborEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimNeighborEntry={pimNeighborAddress}": { "get": { "summary": "Get pimNeighborEntry entry", "description": "Retrieve specific pimNeighborEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimNeighborAddress", "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": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address" }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex" }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks" }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks" }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface." } } }, "example": { "PIM-MIB:pimNeighborEntry": { "pimNeighborAddress": "192.168.1.1", "pimNeighborIfIndex": "example-string", "pimNeighborUpTime": "example-string", "pimNeighborExpiryTime": "example-string", "pimNeighborMode": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimNeighborEntry-4" }, "x-yang-path": "/pimNeighborEntry={pimNeighborAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimNeighborAddress" ] }, "/data/PIM-MIB:pimIpMRouteEntry": { "get": { "summary": "Get pimIpMRouteEntry list", "description": "Retrieve list of pimIpMRouteEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref" }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref" }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref" }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks" }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect." }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary" } } } }, "example": { "PIM-MIB:pimIpMRouteEntry": [ { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteEntry-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": "/pimIpMRouteEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPEntry": { "get": { "summary": "Get pimRPEntry list", "description": "Retrieve list of pimRPEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address" }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address" }, "pimRPState": { "type": "string", "description": "The state of the RP." }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks" }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks" }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimRPEntry": [ { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPEntry-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": "/pimRPEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimRPSetEntry": { "get": { "summary": "Get pimRPSetEntry list", "description": "Retrieve list of pimRPSetEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647 }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks" }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "PIM-MIB:pimRPSetEntry": [ { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPSetEntry-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": "/pimRPSetEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimIpMRouteNextHopEntry": { "get": { "summary": "Get pimIpMRouteNextHopEntry list", "description": "Retrieve list of pimIpMRouteNextHopEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref" }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref" }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref" }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing." } } } }, "example": { "PIM-MIB:pimIpMRouteNextHopEntry": [ { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteNextHopEntry-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": "/pimIpMRouteNextHopEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimCandidateRPEntry": { "get": { "summary": "Get pimCandidateRPEntry list", "description": "Retrieve list of pimCandidateRPEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimCandidateRPEntry": [ { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimCandidateRPEntry-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": "/pimCandidateRPEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimComponentEntry": { "get": { "summary": "Get pimComponentEntry list", "description": "Retrieve list of pimComponentEntry entries from MIB", "tags": [ "PIM-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address" }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks" }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "PIM-MIB:pimComponentEntry": [ { "pimComponentIndex": 1, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimComponentEntry-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": "/pimComponentEntry", "x-restconf-kind": "container" }, "/data/PIM-MIB:pimComponentEntry={pimComponentIndex}": { "get": { "summary": "Get pimComponentEntry entry", "description": "Retrieve specific pimComponentEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimComponentIndex", "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": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address" }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks" }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647 }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimComponentEntry": { "pimComponentIndex": 1, "pimComponentBSRAddress": "192.168.1.1", "pimComponentBSRExpiryTime": "example-string", "pimComponentCRPHoldTime": -2147483648, "pimComponentStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimComponentEntry-4" }, "x-yang-path": "/pimComponentEntry={pimComponentIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimComponentIndex" ] }, "/data/PIM-MIB:pimIpMRouteTable/pimIpMRouteEntry={ipMRouteGroup},{ipMRouteSource},{ipMRouteSourceMask}": { "get": { "summary": "Get pimIpMRouteEntry entry", "description": "Retrieve specific pimIpMRouteEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "ipMRouteGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSourceMask", "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": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref" }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref" }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref" }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks" }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect." }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary" } } }, "example": { "PIM-MIB:pimIpMRouteEntry": { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteEntry-2" }, "x-yang-path": "/pimIpMRouteTable/pimIpMRouteEntry={ipMRouteGroup ipMRouteSource ipMRouteSourceMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteGroup ipMRouteSource ipMRouteSourceMask" ] }, "/data/PIM-MIB:pimRPTable/pimRPEntry={pimRPGroupAddress},{pimRPAddress}": { "get": { "summary": "Get pimRPEntry entry", "description": "Retrieve specific pimRPEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimRPGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPAddress", "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": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address" }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address" }, "pimRPState": { "type": "string", "description": "The state of the RP." }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks" }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks" }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimRPEntry": { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPEntry-2" }, "x-yang-path": "/pimRPTable/pimRPEntry={pimRPGroupAddress pimRPAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimRPGroupAddress pimRPAddress" ] }, "/data/PIM-MIB:pimRPSetTable/pimRPSetEntry={pimRPSetComponent},{pimRPSetGroupAddress},{pimRPSetGroupMask},{pimRPSetAddress}": { "get": { "summary": "Get pimRPSetEntry entry", "description": "Retrieve specific pimRPSetEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimRPSetComponent", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetGroupMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetAddress", "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": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647 }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks" }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "PIM-MIB:pimRPSetEntry": { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPSetEntry-2" }, "x-yang-path": "/pimRPSetTable/pimRPSetEntry={pimRPSetComponent pimRPSetGroupAddress pimRPSetGroupMask pimRPSetAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimRPSetComponent pimRPSetGroupAddress pimRPSetGroupMask pimRPSetAddress" ] }, "/data/PIM-MIB:pimIpMRouteNextHopTable/pimIpMRouteNextHopEntry={ipMRouteNextHopGroup},{ipMRouteNextHopSource},{ipMRouteNextHopSourceMask},{ipMRouteNextHopIfIndex},{ipMRouteNextHopAddress}": { "get": { "summary": "Get pimIpMRouteNextHopEntry entry", "description": "Retrieve specific pimIpMRouteNextHopEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "ipMRouteNextHopGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSourceMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopAddress", "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": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref" }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref" }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref" }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing." } } }, "example": { "PIM-MIB:pimIpMRouteNextHopEntry": { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteNextHopEntry-2" }, "x-yang-path": "/pimIpMRouteNextHopTable/pimIpMRouteNextHopEntry={ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress" ] }, "/data/PIM-MIB:pimCandidateRPTable/pimCandidateRPEntry={pimCandidateRPGroupAddress},{pimCandidateRPGroupMask}": { "get": { "summary": "Get pimCandidateRPEntry entry", "description": "Retrieve specific pimCandidateRPEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimCandidateRPGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimCandidateRPGroupMask", "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": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimCandidateRPEntry": { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimCandidateRPEntry-2" }, "x-yang-path": "/pimCandidateRPTable/pimCandidateRPEntry={pimCandidateRPGroupAddress pimCandidateRPGroupMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimCandidateRPGroupAddress pimCandidateRPGroupMask" ] }, "/data/PIM-MIB:pimIpMRouteEntry={ipMRouteGroup},{ipMRouteSource},{ipMRouteSourceMask}": { "get": { "summary": "Get pimIpMRouteEntry entry", "description": "Retrieve specific pimIpMRouteEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "ipMRouteGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteSourceMask", "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": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref" }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref" }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref" }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks" }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647 }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect." }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary" } } }, "example": { "PIM-MIB:pimIpMRouteEntry": { "ipMRouteGroup": "192.168.1.1", "ipMRouteSource": "192.168.1.1", "ipMRouteSourceMask": "192.168.1.1", "pimIpMRouteUpstreamAssertTimer": "192.168.1.1", "pimIpMRouteAssertMetric": -2147483648, "pimIpMRouteAssertMetricPref": -2147483648, "pimIpMRouteAssertRPTBit": true, "pimIpMRouteFlags": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteEntry-4" }, "x-yang-path": "/pimIpMRouteEntry={ipMRouteGroup ipMRouteSource ipMRouteSourceMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteGroup ipMRouteSource ipMRouteSourceMask" ] }, "/data/PIM-MIB:pimRPEntry={pimRPGroupAddress},{pimRPAddress}": { "get": { "summary": "Get pimRPEntry entry", "description": "Retrieve specific pimRPEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimRPGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPAddress", "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": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address" }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address" }, "pimRPState": { "type": "string", "description": "The state of the RP." }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks" }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks" }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimRPEntry": { "pimRPGroupAddress": "192.168.1.1", "pimRPAddress": "192.168.1.1", "pimRPState": "up(1)", "pimRPStateTimer": "up(1)", "pimRPLastChange": "example-string", "pimRPRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPEntry-4" }, "x-yang-path": "/pimRPEntry={pimRPGroupAddress pimRPAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimRPGroupAddress pimRPAddress" ] }, "/data/PIM-MIB:pimRPSetEntry={pimRPSetComponent},{pimRPSetGroupAddress},{pimRPSetGroupMask},{pimRPSetAddress}": { "get": { "summary": "Get pimRPSetEntry entry", "description": "Retrieve specific pimRPSetEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimRPSetComponent", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetGroupMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimRPSetAddress", "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": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address" }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647 }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks" }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "PIM-MIB:pimRPSetEntry": { "pimRPSetGroupAddress": "192.168.1.1", "pimRPSetGroupMask": "example-string", "pimRPSetAddress": "192.168.1.1", "pimRPSetHoldTime": -2147483648, "pimRPSetExpiryTime": "example-string", "pimRPSetComponent": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimRPSetEntry-4" }, "x-yang-path": "/pimRPSetEntry={pimRPSetComponent pimRPSetGroupAddress pimRPSetGroupMask pimRPSetAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimRPSetComponent pimRPSetGroupAddress pimRPSetGroupMask pimRPSetAddress" ] }, "/data/PIM-MIB:pimIpMRouteNextHopEntry={ipMRouteNextHopGroup},{ipMRouteNextHopSource},{ipMRouteNextHopSourceMask},{ipMRouteNextHopIfIndex},{ipMRouteNextHopAddress}": { "get": { "summary": "Get pimIpMRouteNextHopEntry entry", "description": "Retrieve specific pimIpMRouteNextHopEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "ipMRouteNextHopGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSource", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopSourceMask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopIfIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ipMRouteNextHopAddress", "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": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref" }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref" }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref" }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref" }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref" }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing." } } }, "example": { "PIM-MIB:pimIpMRouteNextHopEntry": { "ipMRouteNextHopGroup": "192.168.1.1", "ipMRouteNextHopSource": "192.168.1.1", "ipMRouteNextHopSourceMask": "192.168.1.1", "ipMRouteNextHopIfIndex": "192.168.1.1", "ipMRouteNextHopAddress": "192.168.1.1", "pimIpMRouteNextHopPruneReason": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimIpMRouteNextHopEntry-4" }, "x-yang-path": "/pimIpMRouteNextHopEntry={ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ipMRouteNextHopGroup ipMRouteNextHopSource ipMRouteNextHopSourceMask ipMRouteNextHopIfIndex ipMRouteNextHopAddress" ] }, "/data/PIM-MIB:pimCandidateRPEntry={pimCandidateRPGroupAddress},{pimCandidateRPGroupMask}": { "get": { "summary": "Get pimCandidateRPEntry entry", "description": "Retrieve specific pimCandidateRPEntry entry by key from MIB", "tags": [ "PIM-MIB" ], "parameters": [ { "name": "pimCandidateRPGroupAddress", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pimCandidateRPGroupMask", "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": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address" }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "PIM-MIB:pimCandidateRPEntry": { "pimCandidateRPGroupAddress": "192.168.1.1", "pimCandidateRPGroupMask": "example-string", "pimCandidateRPAddress": "192.168.1.1", "pimCandidateRPRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pimCandidateRPEntry-4" }, "x-yang-path": "/pimCandidateRPEntry={pimCandidateRPGroupAddress pimCandidateRPGroupMask}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pimCandidateRPGroupAddress pimCandidateRPGroupMask" ] } }, "components": { "schemas": { "PIM-MIB_PIM-MIB": { "type": "object", "description": "The default interval at which periodic PIM-SM Join/Prune\n messages are to be sent.", "properties": { "pimInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1.", "readOnly": true }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "pimNeighborEntry": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address", "readOnly": true }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface.", "readOnly": true } } }, "readOnly": true }, "pimIpMRouteEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect.", "readOnly": true }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "pimRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPState": { "type": "string", "description": "The state of the RP.", "readOnly": true }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "pimRPSetEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "pimIpMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing.", "readOnly": true } } }, "readOnly": true }, "pimCandidateRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "pimComponentEntry": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address", "readOnly": true }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "pim": { "type": "object", "description": "The default interval at which periodic PIM-SM Join/Prune\n messages are to be sent.", "properties": { "pimJoinPruneInterval": { "type": "integer", "description": "The default interval at which periodic PIM-SM Join/Prune\n messages are to be sent.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } }, "readOnly": true }, "pimInterfaceTable": { "type": "object", "description": "The (conceptual) table listing the router's PIM interfaces.\n IGMP and PIM are enabled on all interfaces listed in this\n table.", "properties": { "pimInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1.", "readOnly": true }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimNeighborTable": { "type": "object", "description": "The (conceptual) table listing the router's PIM neighbors.", "properties": { "pimNeighborEntry": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address", "readOnly": true }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimIpMRouteTable": { "type": "object", "description": "The (conceptual) table listing PIM-specific information on\n a subset of the rows of the ipMRouteTable defined in the IP\n Multicast MIB.", "properties": { "pimIpMRouteEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect.", "readOnly": true }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimRPTable": { "type": "object", "description": "The (conceptual) table listing PIM version 1 information\n for the Rendezvous Points (RPs) for IP multicast groups.\n This table is deprecated since its function is replaced by\n the pimRPSetTable for PIM version 2.", "properties": { "pimRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPState": { "type": "string", "description": "The state of the RP.", "readOnly": true }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimRPSetTable": { "type": "object", "description": "The (conceptual) table listing PIM information for\n candidate Rendezvous Points (RPs) for IP multicast groups.\n When the local router is the BSR, this information is\n obtained from received Candidate-RP-Advertisements. When\n the local router is not the BSR, this information is\n obtained from received RP-Set messages.", "properties": { "pimRPSetEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimIpMRouteNextHopTable": { "type": "object", "description": "The (conceptual) table listing PIM-specific information on\n a subset of the rows of the ipMRouteNextHopTable defined in\n the IP Multicast MIB.", "properties": { "pimIpMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimCandidateRPTable": { "type": "object", "description": "The (conceptual) table listing the IP multicast groups for\n which the local router is to advertise itself as a\n Candidate-RP when the value of pimComponentCRPHoldTime is\n non-zero. If this table is empty, then the local router\n \n \n \n \n \n will advertise itself as a Candidate-RP for all groups\n (providing the value of pimComponentCRPHoldTime is non-\n zero).", "properties": { "pimCandidateRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pimComponentTable": { "type": "object", "description": "pimComponentTable", "properties": { "pimComponentEntry": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address", "readOnly": true }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "PIM-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "pimNeighborAddress": { "type": "string", "description": "pimNeighborAddress", "x-yang-type": "leafref", "readOnly": true }, "pimNeighborIfIndex": { "type": "string", "description": "pimNeighborIfIndex", "x-yang-type": "leafref", "readOnly": true } } }, "PIM-MIB_pimInterfaceEntry": { "type": "array", "description": "An entry (conceptual row) in the pimInterfaceTable.", "items": { "type": "object", "properties": { "pimInterfaceIfIndex": { "type": "string", "description": "The ifIndex value of this PIM interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimInterfaceAddress": { "type": "string", "description": "The IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceNetMask": { "type": "string", "description": "The network mask for the IP address of the PIM interface.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceMode": { "type": "string", "description": "The configured mode of this PIM interface. A value of\n sparseDense is only valid for PIMv1.", "readOnly": true }, "pimInterfaceDR": { "type": "string", "description": "The Designated Router on this PIM interface. For point-to-\n point interfaces, this object has the value 0.0.0.0.", "format": "inet:ipv4-address", "readOnly": true }, "pimInterfaceHelloInterval": { "type": "integer", "description": "The frequency at which PIM Hello messages are transmitted\n on this interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceStatus": { "type": "string", "description": "The status of this entry. Creating the entry enables PIM\n on the interface; destroying the entry disables PIM on the\n interface.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "pimInterfaceJoinPruneInterval": { "type": "integer", "description": "The frequency at which PIM Join/Prune messages are\n transmitted on this PIM interface. The default value of\n this object is the pimJoinPruneInterval.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimInterfaceCBSRPreference": { "type": "integer", "description": "The preference value for the local interface as a candidate\n bootstrap router. The value of -1 is used to indicate that\n the local interface is not a candidate BSR interface.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "PIM-MIB_pimNeighborEntry": { "type": "array", "description": "An entry (conceptual row) in the pimNeighborTable.", "items": { "type": "object", "properties": { "pimNeighborAddress": { "type": "string", "description": "The IP address of the PIM neighbor for which this entry\n contains information.", "format": "inet:ipv4-address", "readOnly": true }, "pimNeighborIfIndex": { "type": "string", "description": "The value of ifIndex for the interface used to reach this\n PIM neighbor.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "pimNeighborUpTime": { "type": "string", "description": "The time since this PIM neighbor (last) became a neighbor\n of the local router.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborExpiryTime": { "type": "string", "description": "The minimum time remaining before this PIM neighbor will be\n aged out.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimNeighborMode": { "type": "string", "description": "The active PIM mode of this neighbor. This object is\n deprecated for PIMv2 routers since all neighbors on the\n interface must be either dense or sparse as determined by\n the protocol running on the interface.", "readOnly": true } } } }, "PIM-MIB_pimIpMRouteEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteTable. There\n is one entry per entry in the ipMRouteTable whose incoming\n interface is running PIM.", "items": { "type": "object", "properties": { "ipMRouteGroup": { "type": "string", "description": "ipMRouteGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSource": { "type": "string", "description": "ipMRouteSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteSourceMask": { "type": "string", "description": "ipMRouteSourceMask", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteUpstreamAssertTimer": { "type": "string", "description": "The time remaining before the router changes its upstream\n neighbor back to its RPF neighbor. This timer is called the\n Assert timer in the PIM Sparse and Dense mode specification.\n \n \n \n \n \n A value of 0 indicates that no Assert has changed the\n upstream neighbor away from the RPF neighbor.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimIpMRouteAssertMetric": { "type": "integer", "description": "The metric advertised by the assert winner on the upstream\n interface, or 0 if no such assert is in received.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertMetricPref": { "type": "integer", "description": "The preference advertised by the assert winner on the\n upstream interface, or 0 if no such assert is in effect.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimIpMRouteAssertRPTBit": { "type": "boolean", "description": "The value of the RPT-bit advertised by the assert winner on\n the upstream interface, or false if no such assert is in\n effect.", "readOnly": true }, "pimIpMRouteFlags": { "type": "string", "description": "This object describes PIM-specific flags related to a\n multicast state entry. See the PIM Sparse Mode\n specification for the meaning of the RPT and SPT bits.", "format": "binary", "readOnly": true } } } }, "PIM-MIB_pimRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPTable. There is one\n entry per RP address for each IP multicast group.", "items": { "type": "object", "properties": { "pimRPGroupAddress": { "type": "string", "description": "The IP multicast group address for which this entry\n contains information about an RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPAddress": { "type": "string", "description": "The unicast address of the RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPState": { "type": "string", "description": "The state of the RP.", "readOnly": true }, "pimRPStateTimer": { "type": "string", "description": "The minimum time remaining before the next state change.\n When pimRPState is up, this is the minimum time which must\n expire until it can be declared down. When pimRPState is\n down, this is the time until it will be declared up (in\n order to retry).", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPLastChange": { "type": "string", "description": "The value of sysUpTime at the time when the corresponding\n instance of pimRPState last changed its value.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "PIM-MIB_pimRPSetEntry": { "type": "array", "description": "An entry (conceptual row) in the pimRPSetTable.", "items": { "type": "object", "properties": { "pimRPSetGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimRPSetGroupMask, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimRPSetGroupAddress, gives the group prefix for which this\n entry contains information about the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetAddress": { "type": "string", "description": "The IP address of the Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimRPSetHoldTime": { "type": "integer", "description": "The holdtime of a Candidate-RP. If the local router is not\n the BSR, this value is 0.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimRPSetExpiryTime": { "type": "string", "description": "The minimum time remaining before the Candidate-RP will be\n declared down. If the local router is not the BSR, this\n value is 0.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimRPSetComponent": { "type": "integer", "description": "A number uniquely identifying the component. Each\n protocol instance connected to a separate domain should have\n a different index value.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "PIM-MIB_pimIpMRouteNextHopEntry": { "type": "array", "description": "An entry (conceptual row) in the pimIpMRouteNextHopTable.\n There is one entry per entry in the ipMRouteNextHopTable\n whose interface is running PIM and whose\n ipMRouteNextHopState is pruned(1).", "items": { "type": "object", "properties": { "ipMRouteNextHopGroup": { "type": "string", "description": "ipMRouteNextHopGroup", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSource": { "type": "string", "description": "ipMRouteNextHopSource", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopSourceMask": { "type": "string", "description": "ipMRouteNextHopSourceMask", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopIfIndex": { "type": "string", "description": "ipMRouteNextHopIfIndex", "x-yang-type": "leafref", "readOnly": true }, "ipMRouteNextHopAddress": { "type": "string", "description": "ipMRouteNextHopAddress", "x-yang-type": "leafref", "readOnly": true }, "pimIpMRouteNextHopPruneReason": { "type": "string", "description": "This object indicates why the downstream interface was\n pruned, whether in response to a PIM prune message or due to\n PIM Assert processing.", "readOnly": true } } } }, "PIM-MIB_pimCandidateRPEntry": { "type": "array", "description": "An entry (conceptual row) in the pimCandidateRPTable.", "items": { "type": "object", "properties": { "pimCandidateRPGroupAddress": { "type": "string", "description": "The IP multicast group address which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPGroupMask": { "type": "string", "description": "The multicast group address mask which, when combined with\n pimCandidateRPGroupMask, identifies a group prefix for which\n the local router will advertise itself as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPAddress": { "type": "string", "description": "The (unicast) address of the interface which will be\n \n \n \n \n \n advertised as a Candidate-RP.", "format": "inet:ipv4-address", "readOnly": true }, "pimCandidateRPRowStatus": { "type": "string", "description": "The status of this row, by which new entries may be\n created, or old entries deleted from this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "PIM-MIB_pimComponentEntry": { "type": "array", "description": "An entry (conceptual row) in the pimComponentTable.", "items": { "type": "object", "properties": { "pimComponentIndex": { "type": "integer", "description": "A number uniquely identifying the component. Each protocol\n instance connected to a separate domain should have a\n different index value. Routers that only support membership\n in a single PIM-SM domain should use a pimComponentIndex\n value of 1.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentBSRAddress": { "type": "string", "description": "The IP address of the bootstrap router (BSR) for the local\n PIM region.", "format": "inet:ipv4-address", "readOnly": true }, "pimComponentBSRExpiryTime": { "type": "string", "description": "The minimum time remaining before the bootstrap router in\n the local domain will be declared down. For candidate BSRs,\n this is the time until the component sends an RP-Set\n message. For other routers, this is the time until it may\n accept an RP-Set message from a lower candidate BSR.", "x-yang-type": "yang:timeticks", "readOnly": true }, "pimComponentCRPHoldTime": { "type": "integer", "description": "The holdtime of the component when it is a candidate RP in\n the local domain. The value of 0 is used to indicate that\n the local system is not a Candidate-RP.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pimComponentStatus": { "type": "string", "description": "The status of this entry. Creating the entry creates\n another protocol instance; destroying the entry disables a\n protocol instance.", "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": "PIM-MIB", "description": "MIB operations for PIM-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }