{ "openapi": "3.0.0", "info": { "title": "CISCO-HSRP-MIB MIB API", "version": "1.0.0", "description": "The MIB module provides a means to monitor and configure\n the Cisco IOS proprietary Hot Standby Router Protocol\n (HSRP). Cisco HSRP protocol is defined in RFC2281.\n \n Terminology:\n \n HSRP is a protocol used amoung a group of routers for the\n purpose of selecting an 'active router' and a 'standby\n 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 An 'HSRP group' or a 'standby group' is a set of routers\n which communicate using HSRP. An HSRP group has a group MAC\n address and a group Virtual IP address. These are the\n designated addresses. The active router assumes (i.e.\n inherits) these group addresses.\n \n 'Hello' messages are sent to indicate that a router is\n running and is capable of becoming the active or standby\n router.\n \n 'Hellotime' is the interval between successive HSRP Hello\n messages from a given router.\n \n 'Holdtime' is the interval between the receipt of a Hello\n message and the presumption that the sending router has\n failed.\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-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-HSRP-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-HSRP-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-MIB:cHsrpGlobalConfig": { "get": { "summary": "Get cHsrpGlobalConfig data", "description": "Retrieve cHsrpGlobalConfig operational data from MIB", "tags": [ "CISCO-HSRP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The amount of time in minutes a row in cHsrpGrpTable can\n remain in a state other than active before being timed out.", "properties": { "cHsrpConfigTimeout": { "type": "integer", "description": "The amount of time in minutes a row in cHsrpGrpTable can\n remain in a state other than active before being timed out.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-HSRP-MIB:cHsrpGlobalConfig": { "cHsrpConfigTimeout": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGlobalConfig", "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": "/cHsrpGlobalConfig", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-MIB:cHsrpGrpTable": { "get": { "summary": "Get cHsrpGrpTable data", "description": "Retrieve cHsrpGrpTable operational data from MIB", "tags": [ "CISCO-HSRP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table containing information on each HSRP group\n for each interface.", "properties": { "cHsrpGrpEntry": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails)." }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned." }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address" }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one." }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState" }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address" }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } } } }, "example": { "CISCO-HSRP-MIB:cHsrpGrpTable": { "cHsrpGrpEntry": [ { "ifIndex": "1", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true }, { "ifIndex": "2", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true }, { "ifIndex": "3", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGrpTable", "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": "/cHsrpGrpTable", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-MIB:cHsrpGrpTable/cHsrpGrpEntry": { "get": { "summary": "Get cHsrpGrpEntry list", "description": "Retrieve list of cHsrpGrpEntry entries from MIB", "tags": [ "CISCO-HSRP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails)." }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned." }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address" }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one." }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState" }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address" }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } }, "example": { "CISCO-HSRP-MIB:cHsrpGrpEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGrpEntry", "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": "/cHsrpGrpTable/cHsrpGrpEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-MIB:cHsrpGrpEntry": { "get": { "summary": "Get cHsrpGrpEntry list", "description": "Retrieve list of cHsrpGrpEntry entries from MIB", "tags": [ "CISCO-HSRP-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails)." }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned." }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address" }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one." }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState" }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address" }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } } }, "example": { "CISCO-HSRP-MIB:cHsrpGrpEntry": [ { "ifIndex": "example-string", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGrpEntry-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": "/cHsrpGrpEntry", "x-restconf-kind": "container" }, "/data/CISCO-HSRP-MIB:cHsrpGrpTable/cHsrpGrpEntry={ifIndex},{cHsrpGrpNumber}": { "get": { "summary": "Get cHsrpGrpEntry entry", "description": "Retrieve specific cHsrpGrpEntry entry by key from MIB", "tags": [ "CISCO-HSRP-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "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": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails)." }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned." }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address" }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one." }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState" }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address" }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } }, "example": { "CISCO-HSRP-MIB:cHsrpGrpEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGrpEntry-2" }, "x-yang-path": "/cHsrpGrpTable/cHsrpGrpEntry={ifIndex cHsrpGrpNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber" ] }, "/data/CISCO-HSRP-MIB:cHsrpGrpEntry={ifIndex},{cHsrpGrpNumber}": { "get": { "summary": "Get cHsrpGrpEntry entry", "description": "Retrieve specific cHsrpGrpEntry entry by key from MIB", "tags": [ "CISCO-HSRP-MIB" ], "parameters": [ { "name": "ifIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cHsrpGrpNumber", "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": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails)." }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned." }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295 }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address" }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one." }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address" }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState" }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address" }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address." } } }, "example": { "CISCO-HSRP-MIB:cHsrpGrpEntry": { "ifIndex": "example-string", "cHsrpGrpNumber": 0, "cHsrpGrpAuth": "example-string", "cHsrpGrpPriority": 0, "cHsrpGrpPreempt": true, "cHsrpGrpPreemptDelay": 0, "cHsrpGrpUseConfiguredTimers": true, "cHsrpGrpConfiguredHelloTime": 0, "cHsrpGrpConfiguredHoldTime": 0, "cHsrpGrpLearnedHelloTime": 0, "cHsrpGrpLearnedHoldTime": 0, "cHsrpGrpVirtualIpAddr": "192.168.1.1", "cHsrpGrpUseConfigVirtualIpAddr": true, "cHsrpGrpActiveRouter": "example-string", "cHsrpGrpStandbyRouter": "example-string", "cHsrpGrpStandbyState": "up(1)", "cHsrpGrpVirtualMacAddr": "00:11:22:33:44:55", "cHsrpGrpEntryRowStatus": "up(1)", "cHsrpGrpIpNone": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cHsrpGrpEntry-4" }, "x-yang-path": "/cHsrpGrpEntry={ifIndex cHsrpGrpNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex cHsrpGrpNumber" ] } }, "components": { "schemas": { "CISCO-HSRP-MIB_CISCO-HSRP-MIB": { "type": "object", "description": "The amount of time in minutes a row in cHsrpGrpTable can\n remain in a state other than active before being timed out.", "properties": { "cHsrpGrpEntry": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails).", "readOnly": true }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned.", "readOnly": true }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one.", "readOnly": true }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState", "readOnly": true }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "readOnly": true } } }, "readOnly": true }, "cHsrpGlobalConfig": { "type": "object", "description": "The amount of time in minutes a row in cHsrpGrpTable can\n remain in a state other than active before being timed out.", "properties": { "cHsrpConfigTimeout": { "type": "integer", "description": "The amount of time in minutes a row in cHsrpGrpTable can\n remain in a state other than active before being timed out.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cHsrpGrpTable": { "type": "object", "description": "A table containing information on each HSRP group\n for each interface.", "properties": { "cHsrpGrpEntry": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails).", "readOnly": true }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned.", "readOnly": true }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one.", "readOnly": true }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState", "readOnly": true }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-HSRP-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "string", "description": "cHsrpGrpNumber", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpStandbyState": { "type": "string", "description": "cHsrpGrpStandbyState", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-HSRP-MIB_cHsrpGrpEntry": { "type": "array", "description": "cHsrpGrpEntry", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "cHsrpGrpNumber": { "type": "integer", "description": "This object along with the ifIndex of a particular interface\n uniquely identifies an HSRP group.\n \n Group numbers 0,1 and 2 are the only valid group numbers\n for TokenRing interfaces. For other media types, numbers\n range from 0 to 255. Each interface has its own set of group\n numbers. There's no relationship between the groups\n configured on different interfaces. Using a group number\n on one interface doesn't preclude using the same group\n number on a different interface. For example, there can be\n a group 1 on an Ethernet and a group 1 on Token Ring. More\n details can be found from RFC 2281.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpAuth": { "type": "string", "description": "This is an unencrypted authentication string which is\n carried in all HSRP messages. An authentication string\n mismatch prevents a router interface from learning the\n designated IP address or HSRP timer values from\n other HSRP-enabled routers with the same group number.\n \n The function of this object is not to supply any sort of\n security-like authentication but rather to confirm that\n what's happening is what's intended. In other words, this\n is meant for sanity checking only.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cHsrpGrpPriority": { "type": "integer", "description": "The cHsrpGrpPriority helps to select the active and the\n standby routers. The router with the highest priority is\n selected as the active router. In the priority range of 0\n to 255, 0 is the lowest priority and 255 is the highest\n priority.\n \n If two (or more) routers in a group have the same priority,\n the one with the highest ip address of the interface is the\n active router. When the active router fails to send a Hello\n message within a configurable period of time, the standby\n router with the highest priority becomes the active\n router.\n \n A router with highest priority will only attempt to\n overthrow a lower priority active router if it is\n configured to preempt. But, if there is more than one\n router which is not active, the highest priority non-active\n router becomes the standby router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpPreempt": { "type": "boolean", "description": "This object, if TRUE, indicates that the current router\n should attempt to overthrow a lower priority active router\n and attempt to become the active router. If this object is\n FALSE, the router will become the active router only if\n there is no such router (or if an active router fails).", "readOnly": true }, "cHsrpGrpPreemptDelay": { "type": "integer", "description": "This delay is the time difference between a router power\n up and the time it can actually start preempting the\n currently active router.\n \n When a router first comes up, it doesn't have a complete\n routing table. If it's configured to preempt, then it will\n become the Active router, but it will not be able to\n provide adequate routing services. The solution to this is\n to allow for a configurable delay before the router\n actually preempts the currently active router.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpUseConfiguredTimers": { "type": "boolean", "description": "HSRP routers learn a group's Hellotime or Holdtime from\n hello messages.\n \n The Hellotime is used to determine the frequency of\n generating hello messages when this router becomes the\n active or standby router. The Holdtime is the interval\n between the receipt of a Hello message and the presumption\n that the sending router has failed.\n \n If this object is TRUE, the cHsrpGrpConfiguredHelloTime and\n cHsrpGrpConfiguredHoldTime will be used. If it is FALSE,\n the Hellotime and Holdtime values are learned.", "readOnly": true }, "cHsrpGrpConfiguredHelloTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHelloTime is used when this router is an\n active router. Otherwise, the Hellotime learned from the\n current active router is used. All routers on a particular\n LAN segment must use the same Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpConfiguredHoldTime": { "type": "integer", "description": "If cHsrpGrpUseConfiguredTimers is true,\n cHsrpGrpConfiguredHoldTime is used when this router is an\n active router. Otherwise, the Holdtime learned from the\n current active router is used. All routers on a particular\n LAN segment should use the same Holdtime. Also, the\n Holdtime should be at least three times the value of the\n Hellotime and must be greater than the Hellotime.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHelloTime": { "type": "integer", "description": "If the Hellotime is not configured on a router, it can be\n learned from the Hello messages from active router,\n provided the Hello message is authenticated. If the\n Hellotime is not learned from a Hello message from the\n active router and it is not manually configured, a default\n value of 3 seconds is recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpLearnedHoldTime": { "type": "integer", "description": "If the Holdtime is not configured on a router, it can be\n learned from the Hello message from the active router.\n Holdtime should be learned only if the Hello message is\n authenticated. If the Holdtime is not learned and it is\n not manually configured, a default value of 10 seconds is \n recommended.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cHsrpGrpVirtualIpAddr": { "type": "string", "description": "This is the primary virtual IP address used by this\n group. If this address is configured (i.e a non zero ip\n address), this value is used. Otherwise, the agent will\n attempt to discover the virtual address through a discovery\n process (which scans the hello messages).", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpUseConfigVirtualIpAddr": { "type": "boolean", "description": "If this object is TRUE, cHsrpGrpVirtualIpAddr was a\n configured one. Otherwise, it indicates that \n cHsrpGrpVirtualIpAddr was a learned one.", "readOnly": true }, "cHsrpGrpActiveRouter": { "type": "string", "description": "Ip Address of the currently active router for this group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyRouter": { "type": "string", "description": "Ip Address of the currently standby router for this\n group.", "format": "inet:ipv4-address", "readOnly": true }, "cHsrpGrpStandbyState": { "type": "string", "description": "The current HSRP state of this group on this interface.", "x-yang-type": "CISCO-HSRP-MIB:HsrpState", "readOnly": true }, "cHsrpGrpVirtualMacAddr": { "type": "string", "description": "Mac Addresses used are as specified in RFC 2281. For\n ethernet and fddi interfaces, a MAC address will be in the\n range 00:00:0c:07:ac:00 through 00:00:0c:07:ac:ff. The last\n octet is the hexadecimal equivalent of cHsrpGrpNumber\n (0-255).\n \n Some Ethernet and FDDI interfaces allow a unicast MAC\n address for each HSRP group. Certain Ethernet\n chipsets(LANCE Ethernet, VGANYLAN and QUICC Ethernet) only\n support a single Unicast Mac Address. In this case, only\n one HSRP group is allowed.\n \n For TokenRing interfaces, the following three MAC \n addresses are permitted (functional addresses):\n C0:00:00:01:00:00\n C0:00:00:02:00:00\n C0:00:00:04:00:00.", "x-yang-type": "yang:mac-address", "readOnly": true }, "cHsrpGrpEntryRowStatus": { "type": "string", "description": "The control that allows modification, creation, and\n deletion of entries. For detailed rules see the\n DESCRIPTION for cHsrpGrpEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cHsrpGrpIpNone": { "type": "boolean", "description": "This object specifies the disable HSRP IPv4 virtual\n IP address.", "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-MIB", "description": "MIB operations for CISCO-HSRP-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }