Querying VRRP Information
Querying VRRP Information
GET http://<IP_Address>/api/mo/sys/vrrp/inst.json?rsp-subtree=full
{
"totalCount": "1",
"imdata": [
{
"vrrpInst": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"ctrl": "",
"dn": "sys/vrrp/inst",
"modTs": "2017-12-23T13:55:06.368+00:00",
"monPolDn": "",
"name": "",
"operErr": "",
"persistentOnReload": "true",
"status": "",
"uid": "0"
},
"children": [
{
"vrrpInterface": {
"attributes": {
"adminSt": "enabled",
"childAction": "",
"descr": "",
"id": "eth1/7",
"isCreate": "1",
"modTs": "2017-12-23T13:55:09.473+00:00",
"monPolDn": "",
"name": "",
"persistentOnReload": "true",
"rn": "if-[eth1/7]",
"status": "",
"uid": "0"
},
"children": [
{
"vrrpId": {
"attributes": {
"adminSt": "disabled",
"advIntvl": "1",
"authText": "",
"authType": "none",
"bfdPeerAddr": "0.0.0.0",
"bfdSessionSt": "disabled",
"childAction": "",
"fwdLwrThrld": "1",
"fwdUprThrld": "100",
"groupSt": "init",
"groupStQual": "up",
"id": "123",
"mac": "00:00:00:00:00:00",
"masterAddr": "0.0.0.0",
"modTs": "2017-12-23T13:55:09.490+00:00",
"persistentOnReload": "true",
"preempt": "enabled",
"priCfg": "100",
"primary": "123.1.2.3",
"rn": "id-123",
"status": "",
"uid": "0",
"vrrpCfgFailedBmp": "",
"vrrpCfgFailedTs": "00:00:00:00.000",
"vrrpCfgState": "0"
}}}]}}]}}]}
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/vrrp-items
<vrrp-items>
<adminSt>enabled</adminSt>
<inst-items>
<adminSt>enabled</adminSt>
<if-items>
<Interface-list>
<id>eth1/7</id>
<adminSt>enabled</adminSt>
<id-items>
<Id-list>
<id>123</id>
<adminSt>disabled</adminSt>
<advIntvl>1</advIntvl>
<authType>none</authType>
<bfdSessionSt>disabled</bfdSessionSt>
<fwdLwrThrld>1</fwdLwrThrld>
<fwdUprThrld>0</fwdUprThrld>
<groupSt>init</groupSt>
<groupStQual>admin-down</groupStQual>
<mac>00:00:5E:00:01:7B</mac>
<masterAddr>0.0.0.0</masterAddr>
<preempt>enabled</preempt>
<priCfg>100</priCfg>
<primary>123.1.2.3</primary>
</Id-list>
</id-items>
<isCreate>0</isCreate>
</Interface-list>
</if-items>
<operErr/>
</inst-items>
<operErr/>
<operSt>enabled</operSt>
</vrrp-items>
Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).
CLI Output switch# show vrrp
Interface VR IpVersion Pri Time Pre State VR IP addr
---------------------------------------------------------------
Ethernet1/7 123 IPV4 100 1 s Y Init 123.1.2.3
Note: The property information for this example was added in Release 9.3(3).
vrrpInst Properties
The following table contains information about the vrrpInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:AdminSt
(scalar:Enum8)The administrative state of the object or policy. SELECTION: childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
ctrl nw:InstCtrl
(scalar:Bitmask64)The control state. SELECTION: dn
reference:BinRefA tag or metadata is a non-hierarchical keyword or term assigned to the fabric module. modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: monPolDn
reference:BinRefThe monitoring policy attached to this observable object. name naming:Name256
(string:Basic)The name of the object. operErr nw:OperErrQual
(scalar:Bitmask64)Operational Errors Qualifier SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
status mo:ModificationStatus
(scalar:Bitmask32)The upgrade status. This property is for internal use only. SELECTION: uid
scalar:Uint16A unique identifier for this object.
vrrpInterface Properties
The following table contains information about the vrrpInterface properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt nw:IfAdminSt
(nw:AdminSt)The administrative state of the object or policy. SELECTION: childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
descr naming:Descr1024
(string:Basic)Description id nw:IfId
(base:IfIndex)An identifier . Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 isCreate
scalar:UByteFlag added to store create notification for an interface,
This is set when HSRP is configured first time on an interface
SELECTION:
modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: monPolDn
reference:BinRefThe monitoring policy attached to this observable object. name naming:Name256
(string:Basic)The name of the object. persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)The upgrade status. This property is for internal use only. SELECTION: uid
scalar:Uint16A unique identifier for this object.
vrrpId Properties
The following table contains information about the vrrpId properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name Data Type Description Values adminSt vrrp:AdminSt
(scalar:Enum8)Admin state SELECTION: advIntvl vrrp:AdvIntvl
(scalar:UByte)Advertisement Interval authText vrrp:AuthTextType
(string:Password)Authentication Text authType vrrp:AuthType
(scalar:Enum8)Authentication Type SELECTION: bfdPeerAddr address:Ip BFD Peer address Value must match ipv4 or ipv6 known format bfdSessionSt vrrp:bfdSessionSt
(scalar:Enum8)vrrp bfd session status SELECTION: childAction
mo:ModificationChildAction
scalar:Bitmask32Delete or ignore. For internal use only. SELECTION:
fwdLwrThrld vrrp:PriVal
(scalar:UByte)Fowarding Lower Threshold fwdUprThrld vrrp:UprThrshld
(scalar:UByte)Forwarding Upper Threshold groupSt vrrp:GroupSt
(scalar:Enum8)vrrp group state SELECTION: groupStQual vrrp:GroupStQual
(scalar:Enum8)vrrp group state qualifier SELECTION: id vrrp:Id
(scalar:UByte)VRRP Id mac address:MAC vrrp vmac Value must match MM:MM:MM:SS:SS:SS format masterAddr address:Ip vrrp master address Value must match ipv4 or ipv6 known format modTs mo:TStamp
(scalar:Date)The time when this object was last modified. SELECTION: persistentOnReload
mo:Persistent
scalar:Enum8NO COMMENTS SELECTION:
preempt vrrp:Preempt
(scalar:Enum8)Preempt SELECTION: priCfg vrrp:PriVal
(scalar:UByte)Configured Priority primary address:Ip primary IP address Value must match ipv4 or ipv6 known format rn
reference:BinRNIdentifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names. status mo:ModificationStatus
(scalar:Bitmask32)The upgrade status. This property is for internal use only. SELECTION: uid
scalar:Uint16A unique identifier for this object. vrrpCfgFailedBmp
scalar:Bitmask64NO COMMENTS SELECTION:
vrrpCfgFailedTs
scalar:Uint64NO COMMENTS vrrpCfgState
scalar:UByteNO COMMENTS
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: