{ "openapi": "3.0.0", "info": { "title": "CISCO-HSRP-EXT-MIB MIB API", "version": "1.0.0", "description": "The Extension MIB module for the CISCO-HSRP-MIB which is\n based on RFC2281.\n \n This MIB provides an extension to the CISCO-HSRP-MIB which \n defines Cisco's proprietary Hot Standby Routing Protocol \n (HSRP), defined in RFC2281. The extensions cover assigning \n of secondary HSRP ip addresses, modifying an HSRP Group's \n priority by tracking the operational status of interfaces, \n etc. \n \n Terminology:\n HSRP is a protocol used amoung a group of routers for the \n purpose of selecting an active router and a standby router. \n \n An active router is the router of choice for routing \n packets.\n \n A standby router is a router that takes over the routing \n duties when an active router fails, or when preset \n conditions have been met.\n \n A HSRP group or a standby group is a set of routers \n which communicate using HSRP. An HSRP group has a group \n MAC address and a group IP address. These are the \n designated addresses. The active router assumes \n (i.e. inherits) these group addresses. An HSRP group is\n identified by a ( ifIndex, cHsrpGrpNumber ) pair.\n \n BIA stands for Burned In Address.\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 CISCO-HSRP-EXT-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-HSRP-EXT-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-HSRP-EXT-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/CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedTable": { "get": { "summary": "Get cHsrpExtIfTrackedTable data", "description": "Retrieve cHsrpExtIfTrackedTable operational data from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about tracked interfaces per\n HSRP group.", "properties": { "cHsrpExtIfTrackedEntry": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedTable": { "cHsrpExtIfTrackedEntry": [ { "ifIndex": "1", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true }, { "ifIndex": "2", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true }, { "ifIndex": "3", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTrackedTable", "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": "/cHsrpExtIfTrackedTable", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedTable/cHsrpExtIfTrackedEntry": { "get": { "summary": "Get cHsrpExtIfTrackedEntry list", "description": "Retrieve list of cHsrpExtIfTrackedEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTrackedEntry", "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": "/cHsrpExtIfTrackedTable/cHsrpExtIfTrackedEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrTable": { "get": { "summary": "Get cHsrpExtSecAddrTable data", "description": "Retrieve cHsrpExtSecAddrTable operational data from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about secondary HSRP IP\n Addresses per interface and group.", "properties": { "cHsrpExtSecAddrEntry": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address" }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrTable": { "cHsrpExtSecAddrEntry": [ { "ifIndex": "1", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" }, { "ifIndex": "2", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" }, { "ifIndex": "3", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtSecAddrTable", "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": "/cHsrpExtSecAddrTable", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrTable/cHsrpExtSecAddrEntry": { "get": { "summary": "Get cHsrpExtSecAddrEntry list", "description": "Retrieve list of cHsrpExtSecAddrEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address" }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtSecAddrEntry", "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": "/cHsrpExtSecAddrTable/cHsrpExtSecAddrEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyTable": { "get": { "summary": "Get cHsrpExtIfStandbyTable data", "description": "Retrieve cHsrpExtIfStandbyTable operational data from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information about standby\n interfaces per HSRP group.", "properties": { "cHsrpExtIfStandbyEntry": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyTable": { "cHsrpExtIfStandbyEntry": [ { "ifIndex": "1", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 1, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" }, { "ifIndex": "2", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 2, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" }, { "ifIndex": "3", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 3, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfStandbyTable", "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": "/cHsrpExtIfStandbyTable", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyTable/cHsrpExtIfStandbyEntry": { "get": { "summary": "Get cHsrpExtIfStandbyEntry list", "description": "Retrieve list of cHsrpExtIfStandbyEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 1, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfStandbyEntry", "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": "/cHsrpExtIfStandbyTable/cHsrpExtIfStandbyEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTable": { "get": { "summary": "Get cHsrpExtIfTable data", "description": "Retrieve cHsrpExtIfTable operational data from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "HSRP-specific configurations for each physical interface.", "properties": { "cHsrpExtIfEntry": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces." }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTable": { "cHsrpExtIfEntry": [ { "ifIndex": "1", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" }, { "ifIndex": "2", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" }, { "ifIndex": "3", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTable", "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": "/cHsrpExtIfTable", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTable/cHsrpExtIfEntry": { "get": { "summary": "Get cHsrpExtIfEntry list", "description": "Retrieve list of cHsrpExtIfEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces." }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry": [ { "ifIndex": "example-string", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfEntry", "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": "/cHsrpExtIfTable/cHsrpExtIfEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTable/cHsrpExtIfEntry={ifIndex}": { "get": { "summary": "Get cHsrpExtIfEntry entry", "description": "Retrieve specific cHsrpExtIfEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces." }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry": { "ifIndex": "example-string", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfEntry-2" }, "x-yang-path": "/cHsrpExtIfTable/cHsrpExtIfEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry": { "get": { "summary": "Get cHsrpExtIfTrackedEntry list", "description": "Retrieve list of cHsrpExtIfTrackedEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTrackedEntry-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": "/cHsrpExtIfTrackedEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry": { "get": { "summary": "Get cHsrpExtSecAddrEntry list", "description": "Retrieve list of cHsrpExtSecAddrEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address" }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtSecAddrEntry-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": "/cHsrpExtSecAddrEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry": { "get": { "summary": "Get cHsrpExtIfStandbyEntry list", "description": "Retrieve list of cHsrpExtIfStandbyEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 1, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfStandbyEntry-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": "/cHsrpExtIfStandbyEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry": { "get": { "summary": "Get cHsrpExtIfEntry list", "description": "Retrieve list of cHsrpExtIfEntry entries from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces." }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry": [ { "ifIndex": "example-string", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfEntry-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": "/cHsrpExtIfEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry={ifIndex}": { "get": { "summary": "Get cHsrpExtIfEntry entry", "description": "Retrieve specific cHsrpExtIfEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces." }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfEntry": { "ifIndex": "example-string", "cHsrpExtIfUseBIA": true, "cHsrpExtIfRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfEntry-4" }, "x-yang-path": "/cHsrpExtIfEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedTable/cHsrpExtIfTrackedEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtIfTracked}": { "get": { "summary": "Get cHsrpExtIfTrackedEntry entry", "description": "Retrieve specific cHsrpExtIfTrackedEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtIfTracked", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTrackedEntry-2" }, "x-yang-path": "/cHsrpExtIfTrackedTable/cHsrpExtIfTrackedEntry={ifIndex cHsrpGrpNumber cHsrpExtIfTracked}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtIfTracked" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrTable/cHsrpExtSecAddrEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtSecAddrAddress}": { "get": { "summary": "Get cHsrpExtSecAddrEntry entry", "description": "Retrieve specific cHsrpExtSecAddrEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtSecAddrAddress", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address" }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtSecAddrEntry-2" }, "x-yang-path": "/cHsrpExtSecAddrTable/cHsrpExtSecAddrEntry={ifIndex cHsrpGrpNumber cHsrpExtSecAddrAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtSecAddrAddress" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyTable/cHsrpExtIfStandbyEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtIfStandbyIndex}": { "get": { "summary": "Get cHsrpExtIfStandbyEntry entry", "description": "Retrieve specific cHsrpExtIfStandbyEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtIfStandbyIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 1, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfStandbyEntry-2" }, "x-yang-path": "/cHsrpExtIfStandbyTable/cHsrpExtIfStandbyEntry={ifIndex cHsrpGrpNumber cHsrpExtIfStandbyIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtIfStandbyIndex" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtIfTracked}": { "get": { "summary": "Get cHsrpExtIfTrackedEntry entry", "description": "Retrieve specific cHsrpExtIfTrackedEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtIfTracked", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex" }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfTrackedEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfTracked": "example-string", "cHsrpExtIfTrackedPriority": 0, "cHsrpExtIfTrackedRowStatus": "up(1)", "cHsrpExtIfTrackedIpNone": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfTrackedEntry-4" }, "x-yang-path": "/cHsrpExtIfTrackedEntry={ifIndex cHsrpGrpNumber cHsrpExtIfTracked}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtIfTracked" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtSecAddrAddress}": { "get": { "summary": "Get cHsrpExtSecAddrEntry entry", "description": "Retrieve specific cHsrpExtSecAddrEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtSecAddrAddress", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address" }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtSecAddrEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtSecAddrAddress": "192.168.1.1", "cHsrpExtSecAddrRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtSecAddrEntry-4" }, "x-yang-path": "/cHsrpExtSecAddrEntry={ifIndex cHsrpGrpNumber cHsrpExtSecAddrAddress}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtSecAddrAddress" ] }, "/data/CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry={ifIndex},{cHsrpGrpNumber},{cHsrpExtIfStandbyIndex}": { "get": { "summary": "Get cHsrpExtIfStandbyEntry entry", "description": "Retrieve specific cHsrpExtIfStandbyEntry entry by key from MIB", "tags": [ "CISCO-HSRP-EXT-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpExtIfStandbyIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref" }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295 }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress" }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-HSRP-EXT-MIB:cHsrpExtIfStandbyEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": "example-string", "cHsrpExtIfStandbyIndex": 1, "cHsrpExtIfStandbyDestAddrType": "192.168.1.1", "cHsrpExtIfStandbyDestAddr": "192.168.1.1", "cHsrpExtIfStandbySourceAddrType": "192.168.1.1", "cHsrpExtIfStandbySourceAddr": "192.168.1.1", "cHsrpExtIfStandbyRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpExtIfStandbyEntry-4" }, "x-yang-path": "/cHsrpExtIfStandbyEntry={ifIndex cHsrpGrpNumber cHsrpExtIfStandbyIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber cHsrpExtIfStandbyIndex" ] } }, "components": { "schemas": { "CISCO-HSRP-EXT-MIB_CISCO-HSRP-EXT-MIB": { "type": "object", "description": "A table containing information about tracked interfaces per\n HSRP group.", "properties": { "cHsrpExtIfTrackedEntry": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "readOnly": true } } }, "readOnly": true }, "cHsrpExtSecAddrEntry": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cHsrpExtIfStandbyEntry": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cHsrpExtIfEntry": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces.", "readOnly": true }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cHsrpExtIfTrackedTable": { "type": "object", "description": "A table containing information about tracked interfaces per\n HSRP group.", "properties": { "cHsrpExtIfTrackedEntry": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cHsrpExtSecAddrTable": { "type": "object", "description": "A table containing information about secondary HSRP IP\n Addresses per interface and group.", "properties": { "cHsrpExtSecAddrEntry": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cHsrpExtIfStandbyTable": { "type": "object", "description": "A table containing information about standby\n interfaces per HSRP group.", "properties": { "cHsrpExtIfStandbyEntry": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cHsrpExtIfTable": { "type": "object", "description": "HSRP-specific configurations for each physical interface.", "properties": { "cHsrpExtIfEntry": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces.", "readOnly": true }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-HSRP-EXT-MIB_cHsrpExtIfTrackedEntry": { "type": "array", "description": "cHsrpExtIfTrackedEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfTracked": { "type": "string", "description": "The ifIndex value of the tracked interface.", "x-yang-type": "if-mib:InterfaceIndex", "readOnly": true }, "cHsrpExtIfTrackedPriority": { "type": "integer", "description": "Priority of the tracked interface for the corresponding\n { ifIndex, cHsrpGrpNumber } pair. In the range of 0 to 255, 0\n is the lowest priority and 255 is the highest. When a tracked \n interface is unavailable, the cHsrpGrpPriority of the router \n is decreased by the value of this object instance (If the \n cHsrpGrpPriority is less than the \n cHsrpExtIfTrackedPriority, then the HSRP priority \n becomes 0). This allows a standby router to be configured \n with a priority such that if the currently active router's \n priority is lowered because the tracked interface goes down, \n the standby router can takeover.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfTrackedRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfTrackedEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpExtIfTrackedIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "readOnly": true } } } }, "CISCO-HSRP-EXT-MIB_cHsrpExtSecAddrEntry": { "type": "array", "description": "cHsrpExtSecAddrEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtSecAddrAddress": { "type": "string", "description": "A secondary IpAddress for the {ifIndex, cHsrpGrpNumber} pair.\n As explained in the DESCRIPTION for cHsrpExtSecAddrEntry, a\n primary address must exist before a secondary address for \n the same {ifIndex, cHsrpGrpNumber} pair can be created.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpExtSecAddrRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtSecAddrEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-HSRP-EXT-MIB_cHsrpExtIfStandbyEntry": { "type": "array", "description": "The cHsrpExtIfStandbyEntry allows an HSRP group\n interface to track one or more standby interfaces.\n \n To create a new cHsrpExtIfStandbyEntry row, a\n management station should choose the ifIndex of\n the interface which is to be added as part of an\n HSRP group. Also, an HSRP group number and a\n cHsrpExtIfStandbyIndex should be chosen.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfStandbyIndex": { "type": "integer", "description": "This object defines the index of the standby table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpExtIfStandbyDestAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbyDestAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbyDestAddr": { "type": "string", "description": "This object specifies the destination IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbySourceAddrType": { "type": "string", "description": "This object specifies the type of Internet address\n denoted by cHsrpExtIfStandbySourceAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cHsrpExtIfStandbySourceAddr": { "type": "string", "description": "This object specifies the source IP address of\n the standby router.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cHsrpExtIfStandbyRowStatus": { "type": "string", "description": "The control that allows modification, creation,\n and deletion of entries. Entries may not be created\n via SNMP without explicitly setting\n cHsrpExtIfStandbyRowStatus to either\n 'createAndGo' or 'createAndWait'.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-HSRP-EXT-MIB_cHsrpExtIfEntry": { "type": "array", "description": "cHsrpExtIfEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpExtIfUseBIA": { "type": "boolean", "description": "If set to TRUE, the HSRP Group MAC Address for all groups\n on this interface will be the burned-in-address. Otherwise,\n this will be determined by ciscoHsrpGroupNumber. In case of\n sub-interfaces, UseBIA applies to all sub-interfaces on an \n interface and to all groups on those sub-interfaces.", "readOnly": true }, "cHsrpExtIfRowStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cHsrpExtIfEntry.", "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": "CISCO-HSRP-EXT-MIB", "description": "MIB operations for CISCO-HSRP-EXT-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }