Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Querying VRRP Information
DME
YANG
Copy
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"
}}}]}}]}}]}

Copy
GET http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/vrrp-items

Response
<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>

Querying VRRP Information

Querying VRRP Information

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 NameData TypeDescriptionValues
adminStnw:AdminSt
(scalar:Enum8)		The administrative state of the object or policy.SELECTION:
1 - enabled
2 - disabled
DEFAULT: enabled
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • ctrlnw:InstCtrl
    (scalar:Bitmask64)    		The control state.SELECTION:
    1 - stateful-ha
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    monPolDn
    reference:BinRef    		The monitoring policy attached to this observable object.
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 128
    operErrnw:OperErrQual
    (scalar:Bitmask64)    		Operational Errors QualifierSELECTION:
    1 - init-err
    2 - mem-err
    4 - ipc-err
    8 - int-err
    16 - sock-err
    32 - proto-err
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    uid
    scalar:Uint16    		A 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 NameData TypeDescriptionValues
    adminStnw:IfAdminSt
    (nw:AdminSt)    		The administrative state of the object or policy.SELECTION:
    1 - enabled
    2 - disabled
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descrnaming:Descr1024
    (string:Basic)    		Description
    MAX SIZE: 1024
    idnw:IfId
    (base:IfIndex)    		An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    isCreate
    scalar:UByte    		Flag added to store create notification for an interface, This is set when HSRP is configured first time on an interface SELECTION:
  • 0 - defaultValue
  • defaultValue: 0
    • modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    monPolDn
    reference:BinRef    		The monitoring policy attached to this observable object.
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    uid
    scalar:Uint16    		A 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 NameData TypeDescriptionValues
    adminStvrrp:AdminSt
    (scalar:Enum8)    		Admin stateSELECTION:
    1 - disabled
    2 - enabled
    DEFAULT: disabled
    advIntvlvrrp:AdvIntvl
    (scalar:UByte)    		Advertisement Interval
    RANGE: [1 , 255]
    DEFAULT: 1
    authTextvrrp:AuthTextType
    (string:Password)    		Authentication Text
    MAX SIZE: 8
    DEFAULT:
    authTypevrrp:AuthType
    (scalar:Enum8)    		Authentication TypeSELECTION:
    1 - none
    2 - simple
    DEFAULT: none
    bfdPeerAddraddress:Ip
    		BFD Peer addressValue must match ipv4 or ipv6 known format
    bfdSessionStvrrp:bfdSessionSt
    (scalar:Enum8)    		vrrp bfd session statusSELECTION:
    0 - disabled
    1 - inactive
    2 - deleted
    3 - unknown
    4 - active
    DEFAULT: disabled
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • fwdLwrThrldvrrp:PriVal
    (scalar:UByte)    		Fowarding Lower Threshold
    RANGE: [1 , 254]
    DEFAULT: 1
    fwdUprThrldvrrp:UprThrshld
    (scalar:UByte)    		Forwarding Upper Threshold
    RANGE: [0 , 254]
    DEFAULT: 0
    groupStvrrp:GroupSt
    (scalar:Enum8)    		vrrp group stateSELECTION:
    0 - init
    1 - backup
    2 - master
    groupStQualvrrp:GroupStQual
    (scalar:Enum8)    		vrrp group state qualifierSELECTION:
    0 - up
    1 - down
    2 - no-primary-vip
    3 - admin-down
    4 - interface-down
    5 - no-intf-ip-cfgd
    6 - no-vrf-info-for-intf
    7 - bd-not-allocated
    8 - vmac-not-added
    9 - invalid-vip
    10 - IfIp-vip-subnet-mismatch
    11 - internal error
    idvrrp:Id
    (scalar:UByte)    		VRRP Id
    RANGE: [1 , 255]
    macaddress:MAC
    		vrrp vmacValue must match MM:MM:MM:SS:SS:SS format
    masterAddraddress:Ip
    		vrrp master addressValue must match ipv4 or ipv6 known format
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • preemptvrrp:Preempt
    (scalar:Enum8)    		PreemptSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: enabled
    priCfgvrrp:PriVal
    (scalar:UByte)    		Configured Priority
    RANGE: [1 , 254]
    DEFAULT: 100
    primaryaddress:Ip
    		primary IP addressValue must match ipv4 or ipv6 known format
    rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    uid
    scalar:Uint16    		A unique identifier for this object.
    vrrpCfgFailedBmp
    scalar:Bitmask64    		NO COMMENTSSELECTION:
  • -9223372036854775808ull - vrrp:IdmodTs_failed_flag
  • 1024ull - vrrp:Idprimary_failed_flag
  • 128ull - vrrp:Idid_failed_flag
  • 16ull - vrrp:IdbfdPeerAddr_failed_flag
  • 1ull - vrrp:IdadminSt_failed_flag
  • 2305843009213693952ull - vrrp:Iduid_failed_flag
  • 256ull - vrrp:Idpreempt_failed_flag
  • 2ull - vrrp:IdadvIntvl_failed_flag
  • 32ull - vrrp:IdfwdLwrThrld_failed_flag
  • 4611686018427387904ull - vrrp:IdpersistentOnReload_failed_flag
  • 4ull - vrrp:IdauthText_failed_flag
  • 512ull - vrrp:IdpriCfg_failed_flag
  • 64ull - vrrp:IdfwdUprThrld_failed_flag
  • 8ull - vrrp:IdauthType_failed_flag
  • DEFAULT: 0
    • vrrpCfgFailedTs
    scalar:Uint64    		NO COMMENTS
    vrrpCfgState
    scalar:UByte    		NO COMMENTS


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    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:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

    Next