Querying PIM Information

Querying PIM Interface Information

Querying PIM Interface Information
GET http://<IP_Address>/api/mo/sys/pim/inst/dom-default/if-[eth1/49].json
{
"totalCount": "1",
"imdata": [
    {
        "pimIf": {
            "attributes": {
                "adminSt": "enabled",
                "bfdInst": "none",
                "border": "no",
                "childAction": "",
                "ctrl": "",
                "descr": "",
                "dn": "sys/pim/inst/dom-default/if-[eth1/49]",
                "dr": "30.30.30.2/32",
                "drDelay": "3",
                "drPrio": "1",
                "genID": "202058884",
                "id": "eth1/49",
                "ipAddr": "30.30.30.1/24",
                "jpRtMap": "",
                "modTs": "2017-12-20T23:34:02.258+00:00",
                "monPolDn": "uni/fabric/monfab-default",
                "name": "",
                "nbrHoldTime": "105",
                "neighRtMap": "",
                "neighpfxList": "",
                "nextHello": "2017-12-22T14:06:28.486+00:00",
                "persistentOnReload": "true",
                "pimSparseMode": "yes",
                "rtEpPDn": "",
                "status": "",
                "uid": "0"
}}}]}
GET  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/pim-items
<pim-items>
    <adminSt>enabled</adminSt>
    <inst-items>
        <adminSt>enabled</adminSt>
        <dom-items>
            <Dom-list>
                <name>default</name>
                <adminSt>disabled</adminSt>
                <autoEnable>true</autoEnable>
                <bfd>false</bfd>
                <db-items>
                    <Db-list>
                        <type>route</type>
                        <name/>
                        <src-items>
                            <Route-list>
                                <src>0.0.0.0</src>
                                <grp>232.0.0.0/8</grp>
                                <assertMetric>0</assertMetric>
                                <assertMetricPref>0</assertMetricPref>
                                <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                <createTs>2017-12-21T17:50:30.899+00:00</createTs>
                                <expiryTs>2017-12-21T18:23:06.969+00:00</expiryTs>
                                <hwByteCnt>0</hwByteCnt>
                                <hwPktCnt>0</hwPktCnt>
                                <iif>unspecified</iif>
                                <jpHoldTime>3</jpHoldTime>
                                <name/>
                                <routeBits/>
                                <rpAddrRoute>8.8.8.100</rpAddrRoute>
                                <rpfNbr>0.0.0.0/32</rpfNbr>
                                <rpfSrc>0.0.0.0/32</rpfSrc>
                                <rtTimeOutInvtl>1</rtTimeOutInvtl>
                                <rtType/>
                                <swByteCnt>0</swByteCnt>
                                <swPktCnt>0</swPktCnt>
                                <ver>0</ver>
                            </Route-list>
                            <Route-list>
                                <src>0.0.0.0</src>
                                <grp>224.1.1.1/32</grp>
                                <assertMetric>0</assertMetric>
                                <assertMetricPref>0</assertMetricPref>
                                <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                <createTs>2017-12-21T17:49:51.052+00:00</createTs>
                                <expiryTs>2017-12-21T18:24:07.999+00:00</expiryTs>
                                <hwByteCnt>0</hwByteCnt>
                                <hwPktCnt>0</hwPktCnt>
                                <iif>unspecified</iif>
                                <jpHoldTime>3</jpHoldTime>
                                <name/>
                                <routeBits>rp_bit,wc_bit</routeBits>
                                <rpAddrRoute>0.0.0.0</rpAddrRoute>
                                <rpfNbr>0.0.0.0/32</rpfNbr>
                                <rpfSrc>8.8.8.100/32</rpfSrc>
                                <rtTimeOutInvtl>2</rtTimeOutInvtl>
                                <rtType/>
                                <swByteCnt>0</swByteCnt>
                                <swPktCnt>0</swPktCnt>
                                <ver>0</ver>
                            </Route-list>
                            <Route-list>
                                <src>2.2.2.200</src>
                                <grp>224.1.1.1/32</grp>
                                <assertMetric>0</assertMetric>
                                <assertMetricPref>0</assertMetricPref>
                                <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                <createTs>2017-12-21T17:49:51.051+00:00</createTs>
                                <expiryTs>2017-12-21T18:24:07.999+00:00</expiryTs>
                                <hwByteCnt>229500</hwByteCnt>
                                <hwPktCnt>4500</hwPktCnt>
                                <iif>lo0</iif>
                                <jpHoldTime>3</jpHoldTime>
                                <name/>
                                <routeBits/>
                                <rpAddrRoute>8.8.8.100</rpAddrRoute>
                                <rpfNbr>2.2.2.200/32</rpfNbr>
                                <rpfSrc>2.2.2.200/32</rpfSrc>
                                <rtTimeOutInvtl>2</rtTimeOutInvtl>
                                <rtType/>
                                <swByteCnt>0</swByteCnt>
                                <swPktCnt>0</swPktCnt>
                                <ver>0</ver>
                            </Route-list>
                        </src-items>
                    </Db-list>
                    <Db-list>
                        <type>grange</type>
                        <grange-items>
                            <RPGrange-list>
                                <addr>224.0.0.0/4</addr>
                                <flags>asm,static</flags>
                                <rpAddr>1.1.1.100</rpAddr>
                            </RPGrange-list>
                        </grange-items>
                        <name/>
                    </Db-list>
                    <Db-list>
                        <type>rp</type>
                        <name/>
                        <rp-items>
                            <RPInfo-list>
                                <addr>1.1.1.100/32</addr>
                                <arpExp>1969-12-31T16:00:00.000+00:00</arpExp>
                                <bsrAddr>0.0.0.0</bsrAddr>
                                <bsrExp>1969-12-31T16:00:00.000+00:00</bsrExp>
                                <dfOrdinal>0</dfOrdinal>
                                <discType>staticRP</discType>
                                <local>false</local>
                                <name/>
                                <priority>255</priority>
                                <uptime>2017-12-20T23:33:54.097+00:00</uptime>
                            </RPInfo-list>
                            <RPInfo-list>
                                <addr>8.8.8.100/32</addr>
                                <arpExp>1969-12-31T16:00:00.000+00:00</arpExp>
                                <bsrAddr>0.0.0.0</bsrAddr>
                                <bsrExp>1969-12-31T16:00:00.000+00:00</bsrExp>
                                <dfOrdinal>0</dfOrdinal>
                                <discType>staticRP</discType>
                                <local>false</local>
                                <name/>
                                <priority>255</priority>
                                <uptime>2017-12-20T23:33:54.266+00:00</uptime>
                            </RPInfo-list>
                        </rp-items>
                    </Db-list>
                </db-items>
                <domstats-items>
                    <autoRPAnnouncesRcvd>0</autoRPAnnouncesRcvd>
                    <autoRPAnnouncesSent>0</autoRPAnnouncesSent>
                    <autoRPDiscoveriesRcvd>0</autoRPDiscoveriesRcvd>
                    <autoRPDiscoveriesSent>0</autoRPDiscoveriesSent>
                    <autoRPFromBorderIF>0</autoRPFromBorderIF>
                    <autoRPInvalidType>0</autoRPInvalidType>
                    <autoRPRPFFailed>0</autoRPRPFFailed>
                    <autoRPRcvdLisNotConf>0</autoRPRcvdLisNotConf>
                    <autoRPTTLExp>0</autoRPTTLExp>
                    <bsrBsFromBorderIF>0</bsrBsFromBorderIF>
                    <bsrBsFromNonNbr>0</bsrBsFromNonNbr>
                    <bsrBsLenErr>0</bsrBsLenErr>
                    <bsrBsRPFFail>0</bsrBsRPFFail>
                    <bsrBsRcvd>0</bsrBsRcvd>
                    <bsrBsRcvdLisNotConf>0</bsrBsRcvdLisNotConf>
                    <bsrBsSent>0</bsrBsSent>
                    <bsrCRPFromBorderIF>0</bsrCRPFromBorderIF>
                    <bsrCRPRcvd>0</bsrCRPRcvd>
                    <bsrCRPRcvdLisNotConf>0</bsrCRPRcvdLisNotConf>
                    <bsrCRPSent>0</bsrCRPSent>
                    <cpRPFFailNoRoute>3</cpRPFFailNoRoute>
                    <dpCrtRouteStateCnt>0</dpCrtRouteStateCnt>
                    <dpNoMcastState>0</dpNoMcastState>
                    <dpRPFFailNoRoute>0</dpRPFFailNoRoute>
                    <nullRegRcvd>0</nullRegRcvd>
                    <nullRegSent>1124</nullRegSent>
                    <regRcvd>0</regRcvd>
                    <regRcvdAndNotRP>0</regRcvdAndNotRP>
                    <regRcvdBiDir>0</regRcvdBiDir>
                    <regRcvdSSM>0</regRcvdSSM>
                    <regSent>0</regSent>
                    <regStopRcvd>0</regStopRcvd>
                    <regStopSent>0</regStopSent>
                </domstats-items>
                <flushRoutes>false</flushRoutes>
                <if-items>
                    <If-list>
                        <id>eth1/49</id>
                        <adj-items>
                            <AdjEp-list>
                                <addr>30.30.30.2/32</addr>
                                <adjstats-items>
                                    <lastHelloRcvd>1969-12-31T16:01:09.479+00:00</lastHelloRcvd>
                                    <lastHoldTime>39464</lastHoldTime>
                                    <longHelloItvl>1841</longHelloItvl>
                                    <nonHelloExpResets>0</nonHelloExpResets>
                                </adjstats-items>
                                <bfdSt>down</bfdSt>
                                <drPrio>1</drPrio>
                                <expiryTime>2017-12-21T18:23:42.619+00:00</expiryTime>
                                <flags>bidir-cap</flags>
                                <genId>312886236</genId>
                                <learnTime>2017-12-20T23:34:39.805+00:00</learnTime>
                                <name>30.30.30.2</name>
                                <operSt>up</operSt>
                            </AdjEp-list>
                        </adj-items>
                        <adminSt>enabled</adminSt>
                        <bfdInst>none</bfdInst>
                        <border>false</border>
                        <dr>30.30.30.2/32</dr>
                        <drDelay>3</drDelay>
                        <drPrio>1</drPrio>
                        <genID>202058884</genID>
                        <ifstats-items>
                            <assertRcvd>0</assertRcvd>
                            <assertSent>0</assertSent>
                            <authFail>0</authFail>
                            <badVerPkt>0</badVerPkt>
                            <chksumErr>0</chksumErr>
                            <dfBackoffRcvd>0</dfBackoffRcvd>
                            <dfBackoffSent>0</dfBackoffSent>
                            <dfOfferRcvd>0</dfOfferRcvd>
                            <dfOfferSent>0</dfOfferSent>
                            <dfPassesRcvd>0</dfPassesRcvd>
                            <dfPassesSent>0</dfPassesSent>
                            <dfWinnerRcvd>0</dfWinnerRcvd>
                            <dfWinnerSent>0</dfWinnerSent>
                            <graftsRcvd>0</graftsRcvd>
                            <graftsSent>0</graftsSent>
                            <grftAckRcvd>0</grftAckRcvd>
                            <grftAckSent>0</grftAckSent>
                            <helloRcvd>2375</helloRcvd>
                            <helloSent>2377</helloSent>
                            <invalidPktRcvd>0</invalidPktRcvd>
                            <invalidPktSent>0</invalidPktSent>
                            <joinNoRP>0</joinNoRP>
                            <joinWrongRp>0</joinWrongRp>
                            <jpBidirRcvd>0</jpBidirRcvd>
                            <jpFilterIn>0</jpFilterIn>
                            <jpFilterOut>0</jpFilterOut>
                            <jpRcvd>0</jpRcvd>
                            <jpRcvdOnRPF>0</jpRcvdOnRPF>
                            <jpSSMRcvd>0</jpSSMRcvd>
                            <jpSent>0</jpSent>
                            <pktFrmNonNbr>0</pktFrmNonNbr>
                            <pktFrmSelf>0</pktFrmSelf>
                            <pktLenErr>0</pktLenErr>
                            <pktOnPassiveIf>0</pktOnPassiveIf>
                        </ifstats-items>
                        <ipAddr>30.30.30.1/24</ipAddr>
                        <nbrHoldTime>105</nbrHoldTime>
                        <nextHello>2017-12-21T18:22:31.194+00:00</nextHello>
                        <pimSparseMode>true</pimSparseMode>
                    </If-list>
                    <If-list>
                        <id>lo0</id>
                        <adminSt>enabled</adminSt>
                        <bfdInst>none</bfdInst>
                        <border>false</border>
                        <dr>2.2.2.100/32</dr>
                        <drDelay>3</drDelay>
                        <drPrio>1</drPrio>
                        <genID>671644221</genID>
                        <ifstats-items>
                            <assertRcvd>0</assertRcvd>
                            <assertSent>0</assertSent>
                            <authFail>0</authFail>
                            <badVerPkt>0</badVerPkt>
                            <chksumErr>0</chksumErr>
                            <dfBackoffRcvd>0</dfBackoffRcvd>
                            <dfBackoffSent>0</dfBackoffSent>
                            <dfOfferRcvd>0</dfOfferRcvd>
                            <dfOfferSent>0</dfOfferSent>
                            <dfPassesRcvd>0</dfPassesRcvd>
                            <dfPassesSent>0</dfPassesSent>
                            <dfWinnerRcvd>0</dfWinnerRcvd>
                            <dfWinnerSent>0</dfWinnerSent>
                            <graftsRcvd>0</graftsRcvd>
                            <graftsSent>0</graftsSent>
                            <grftAckRcvd>0</grftAckRcvd>
                            <grftAckSent>0</grftAckSent>
                            <helloRcvd>0</helloRcvd>
                            <helloSent>2369</helloSent>
                            <invalidPktRcvd>0</invalidPktRcvd>
                            <invalidPktSent>0</invalidPktSent>
                            <joinNoRP>0</joinNoRP>
                            <joinWrongRp>0</joinWrongRp>
                            <jpBidirRcvd>0</jpBidirRcvd>
                            <jpFilterIn>0</jpFilterIn>
                            <jpFilterOut>0</jpFilterOut>
                            <jpRcvd>0</jpRcvd>
                            <jpRcvdOnRPF>0</jpRcvdOnRPF>
                            <jpSSMRcvd>0</jpSSMRcvd>
                            <jpSent>0</jpSent>
                            <pktFrmNonNbr>0</pktFrmNonNbr>
                            <pktFrmSelf>0</pktFrmSelf>
                            <pktLenErr>0</pktLenErr>
                            <pktOnPassiveIf>0</pktOnPassiveIf>
                        </ifstats-items>
                        <ipAddr>2.2.2.100/32</ipAddr>
                        <nbrHoldTime>105</nbrHoldTime>
                        <nextHello>2017-12-21T18:22:14.811+00:00</nextHello>
                        <pimSparseMode>true</pimSparseMode>
                    </If-list>
                </if-items>
                <logNbhChng>false</logNbhChng>
                <mtu>1500</mtu>
                <ssm-items>
                    <range-items>
                        <grpList>232.0.0.0/8</grpList>
                        <ssmNone>false</ssmNone>
                    </range-items>
                </ssm-items>
                <staticrp-items>
                    <rp-items>
                        <StaticRP-list>
                            <addr>8.8.8.100/32</addr>
                            <rpgrplist-items>
                                <RPGrpList-list>
                                    <grpListName>224.0.0.0/4</grpListName>
                                    <bidir>false</bidir>
                                    <override>false</override>
                                </RPGrpList-list>
                            </rpgrplist-items>
                        </StaticRP-list>
                        <StaticRP-list>
                            <addr>1.1.1.100/32</addr>
                            <rpgrplist-items>
                                <RPGrpList-list>
                                    <grpListName>224.0.0.0/4</grpListName>
                                    <bidir>false</bidir>
                                    <override>false</override>
                                </RPGrpList-list>
                            </rpgrplist-items>
                        </StaticRP-list>
                    </rp-items>
                </staticrp-items>
            </Dom-list>
        </dom-items>
        <jpDelay>100</jpDelay>
        <operErr/>
        <regStop>false</regStop>
    </inst-items>
    <operErr/>
    <operSt>enabled</operSt>
</pim-items>

DME Requests

A DME GET request is individually sent for each interface, as shown in the example. To view all PIM information in a single payload, send a DME GET request to http://<IP_Address>/api/mo/sys/pim.json?rsp-subtree=full

Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).

CLI Output
switch# show ip pim interface brief   
PIM Interface Status for VRF "default"   
Interface            IP Address      PIM DR Address  Neighbor  Border   
                                                     Count     Interface   
Ethernet1/49         30.30.30.1      30.30.30.2      1         no   
loopback0            2.2.2.100       2.2.2.100       0         no 

Note: The property information for this example was added in Release 9.3(3).


pimIf Properties

The following table contains information about the pimIf 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
bfdInstpim:BfdInstSt
(scalar:Enum8)
BFD Instance StateSELECTION:
0 - none
1 - enabled
2 - disabled
DEFAULT: none
borderscalar:Bool
Border policy - Treat interface as boundary of PIM domainSELECTION: true or false
childAction
mo:ModificationChildAction
scalar:Bitmask32
Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
  • ctrlpim:IfCtrl
    (scalar:Bitmask8)
    Interface ControlsSELECTION:
    1 - border
    2 - passive
    DEFAULT: 1
    descrnaming:Descr1024
    (string:Basic)
    Description
    MAX SIZE: 1024
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    drNANANA
    drDelaypim:DRDelay
    (scalar:Uint16)
    Designated Router Delay value
    RANGE: [1 , 65535]
    DEFAULT: 3
    drPriopim:DRPrio
    (scalar:Uint32)
    Designated Router Priority level
    RANGE: [1 , 4294967295]
    DEFAULT: 1
    genIDNANANA
    idnw:IfId
    (base:IfIndex)
    An identifier .Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    ipAddraddress:Ip
    IP Address of the interfaceValue must match ipv4 or ipv6 known format
    jpRtMapstring:Basic
    Join Prune Policy nameA sequence of characters
    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
    nbrHoldTimeNANANA
    neighRtMapstring:Basic
    Neighbor route-map PolicyA sequence of characters
    neighpfxListstring:Basic
    Neighbor prefix-list PolicyA sequence of characters
    nextHelloNANANA
    persistentOnReload
    mo:Persistent
    scalar:Enum8
    NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
  • pimSparseModescalar:Bool
    Sparse Mode configuredSELECTION: true or false
    rtEpPDnreference:BinRef
    L3 Router EpP DN
    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.


    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

    Querying PIM Neighbor Related Information
    
    GET http://<IP_Address>/api/mo/sys/pim/inst/dom-default/if-[eth1/49]/adj-[30.30.30.2/32].json
    
    {
    "totalCount": "1",
    "imdata": [
    {
    "pimAdjEp": {
        "attributes": {
            "addr": "30.30.30.2/32",
            "bfdSt": "down",
            "dn": "sys/pim/inst/dom-default/if-[eth1/49]/adj-[30.30.30.2/32]",
            "drPrio": "1",
            "expiryTime": "2017-12-22T14:25:59.985+00:00",
            "flags": "bidir-cap",
            "genId": "312886236",
            "learnTime": "2017-12-20T23:34:39.805+00:00",
            "name": "30.30.30.2",
            "operSt": "up"
    }}}]}
    
    GET  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/pim-items
    
    <pim-items>
        <adminSt>enabled</adminSt>
        <inst-items>
            <adminSt>enabled</adminSt>
            <dom-items>
                <Dom-list>
                    <name>default</name>
                    <adminSt>disabled</adminSt>
                    <autoEnable>true</autoEnable>
                    <bfd>false</bfd>
                    <db-items>
                        <Db-list>
                            <type>route</type>
                            <name/>
                            <src-items>
                                <Route-list>
                                    <src>0.0.0.0</src>
                                    <grp>232.0.0.0/8</grp>
                                    <assertMetric>0</assertMetric>
                                    <assertMetricPref>0</assertMetricPref>
                                    <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                    <createTs>2017-12-21T17:50:30.899+00:00</createTs>
                                    <expiryTs>2017-12-21T18:23:06.969+00:00</expiryTs>
                                    <hwByteCnt>0</hwByteCnt>
                                    <hwPktCnt>0</hwPktCnt>
                                    <iif>unspecified</iif>
                                    <jpHoldTime>3</jpHoldTime>
                                    <name/>
                                    <routeBits/>
                                    <rpAddrRoute>8.8.8.100</rpAddrRoute>
                                    <rpfNbr>0.0.0.0/32</rpfNbr>
                                    <rpfSrc>0.0.0.0/32</rpfSrc>
                                    <rtTimeOutInvtl>1</rtTimeOutInvtl>
                                    <rtType/>
                                    <swByteCnt>0</swByteCnt>
                                    <swPktCnt>0</swPktCnt>
                                    <ver>0</ver>
                                </Route-list>
                                <Route-list>
                                    <src>0.0.0.0</src>
                                    <grp>224.1.1.1/32</grp>
                                    <assertMetric>0</assertMetric>
                                    <assertMetricPref>0</assertMetricPref>
                                    <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                    <createTs>2017-12-21T17:49:51.052+00:00</createTs>
                                    <expiryTs>2017-12-21T18:24:07.999+00:00</expiryTs>
                                    <hwByteCnt>0</hwByteCnt>
                                    <hwPktCnt>0</hwPktCnt>
                                    <iif>unspecified</iif>
                                    <jpHoldTime>3</jpHoldTime>
                                    <name/>
                                    <routeBits>rp_bit,wc_bit</routeBits>
                                    <rpAddrRoute>0.0.0.0</rpAddrRoute>
                                    <rpfNbr>0.0.0.0/32</rpfNbr>
                                    <rpfSrc>8.8.8.100/32</rpfSrc>
                                    <rtTimeOutInvtl>2</rtTimeOutInvtl>
                                    <rtType/>
                                    <swByteCnt>0</swByteCnt>
                                    <swPktCnt>0</swPktCnt>
                                    <ver>0</ver>
                                </Route-list>
                                <Route-list>
                                    <src>2.2.2.200</src>
                                    <grp>224.1.1.1/32</grp>
                                    <assertMetric>0</assertMetric>
                                    <assertMetricPref>0</assertMetricPref>
                                    <assertTime>1969-12-31T16:00:00.000+00:00</assertTime>
                                    <createTs>2017-12-21T17:49:51.051+00:00</createTs>
                                    <expiryTs>2017-12-21T18:24:07.999+00:00</expiryTs>
                                    <hwByteCnt>229500</hwByteCnt>
                                    <hwPktCnt>4500</hwPktCnt>
                                    <iif>lo0</iif>
                                    <jpHoldTime>3</jpHoldTime>
                                    <name/>
                                    <routeBits/>
                                    <rpAddrRoute>8.8.8.100</rpAddrRoute>
                                    <rpfNbr>2.2.2.200/32</rpfNbr>
                                    <rpfSrc>2.2.2.200/32</rpfSrc>
                                    <rtTimeOutInvtl>2</rtTimeOutInvtl>
                                    <rtType/>
                                    <swByteCnt>0</swByteCnt>
                                    <swPktCnt>0</swPktCnt>
                                    <ver>0</ver>
                                </Route-list>
                            </src-items>
                        </Db-list>
                        <Db-list>
                            <type>grange</type>
                            <grange-items>
                                <RPGrange-list>
                                    <addr>224.0.0.0/4</addr>
                                    <flags>asm,static</flags>
                                    <rpAddr>1.1.1.100</rpAddr>
                                </RPGrange-list>
                            </grange-items>
                            <name/>
                        </Db-list>
                        <Db-list>
                            <type>rp</type>
                            <name/>
                            <rp-items>
                                <RPInfo-list>
                                    <addr>1.1.1.100/32</addr>
                                    <arpExp>1969-12-31T16:00:00.000+00:00</arpExp>
                                    <bsrAddr>0.0.0.0</bsrAddr>
                                    <bsrExp>1969-12-31T16:00:00.000+00:00</bsrExp>
                                    <dfOrdinal>0</dfOrdinal>
                                    <discType>staticRP</discType>
                                    <local>false</local>
                                    <name/>
                                    <priority>255</priority>
                                    <uptime>2017-12-20T23:33:54.097+00:00</uptime>
                                </RPInfo-list>
                                <RPInfo-list>
                                    <addr>8.8.8.100/32</addr>
                                    <arpExp>1969-12-31T16:00:00.000+00:00</arpExp>
                                    <bsrAddr>0.0.0.0</bsrAddr>
                                    <bsrExp>1969-12-31T16:00:00.000+00:00</bsrExp>
                                    <dfOrdinal>0</dfOrdinal>
                                    <discType>staticRP</discType>
                                    <local>false</local>
                                    <name/>
                                    <priority>255</priority>
                                    <uptime>2017-12-20T23:33:54.266+00:00</uptime>
                                </RPInfo-list>
                            </rp-items>
                        </Db-list>
                    </db-items>
                    <domstats-items>
                        <autoRPAnnouncesRcvd>0</autoRPAnnouncesRcvd>
                        <autoRPAnnouncesSent>0</autoRPAnnouncesSent>
                        <autoRPDiscoveriesRcvd>0</autoRPDiscoveriesRcvd>
                        <autoRPDiscoveriesSent>0</autoRPDiscoveriesSent>
                        <autoRPFromBorderIF>0</autoRPFromBorderIF>
                        <autoRPInvalidType>0</autoRPInvalidType>
                        <autoRPRPFFailed>0</autoRPRPFFailed>
                        <autoRPRcvdLisNotConf>0</autoRPRcvdLisNotConf>
                        <autoRPTTLExp>0</autoRPTTLExp>
                        <bsrBsFromBorderIF>0</bsrBsFromBorderIF>
                        <bsrBsFromNonNbr>0</bsrBsFromNonNbr>
                        <bsrBsLenErr>0</bsrBsLenErr>
                        <bsrBsRPFFail>0</bsrBsRPFFail>
                        <bsrBsRcvd>0</bsrBsRcvd>
                        <bsrBsRcvdLisNotConf>0</bsrBsRcvdLisNotConf>
                        <bsrBsSent>0</bsrBsSent>
                        <bsrCRPFromBorderIF>0</bsrCRPFromBorderIF>
                        <bsrCRPRcvd>0</bsrCRPRcvd>
                        <bsrCRPRcvdLisNotConf>0</bsrCRPRcvdLisNotConf>
                        <bsrCRPSent>0</bsrCRPSent>
                        <cpRPFFailNoRoute>3</cpRPFFailNoRoute>
                        <dpCrtRouteStateCnt>0</dpCrtRouteStateCnt>
                        <dpNoMcastState>0</dpNoMcastState>
                        <dpRPFFailNoRoute>0</dpRPFFailNoRoute>
                        <nullRegRcvd>0</nullRegRcvd>
                        <nullRegSent>1124</nullRegSent>
                        <regRcvd>0</regRcvd>
                        <regRcvdAndNotRP>0</regRcvdAndNotRP>
                        <regRcvdBiDir>0</regRcvdBiDir>
                        <regRcvdSSM>0</regRcvdSSM>
                        <regSent>0</regSent>
                        <regStopRcvd>0</regStopRcvd>
                        <regStopSent>0</regStopSent>
                    </domstats-items>
                    <flushRoutes>false</flushRoutes>
                    <if-items>
                        <If-list>
                            <id>eth1/49</id>
                            <adj-items>
                                <AdjEp-list>
                                    <addr>30.30.30.2/32</addr>
                                    <adjstats-items>
                                        <lastHelloRcvd>1969-12-31T16:01:09.479+00:00</lastHelloRcvd>
                                        <lastHoldTime>39464</lastHoldTime>
                                        <longHelloItvl>1841</longHelloItvl>
                                        <nonHelloExpResets>0</nonHelloExpResets>
                                    </adjstats-items>
                                    <bfdSt>down</bfdSt>
                                    <drPrio>1</drPrio>
                                    <expiryTime>2017-12-21T18:23:42.619+00:00</expiryTime>
                                    <flags>bidir-cap</flags>
                                    <genId>312886236</genId>
                                    <learnTime>2017-12-20T23:34:39.805+00:00</learnTime>
                                    <name>30.30.30.2</name>
                                    <operSt>up</operSt>
                                </AdjEp-list>
                            </adj-items>
                            <adminSt>enabled</adminSt>
                            <bfdInst>none</bfdInst>
                            <border>false</border>
                            <dr>30.30.30.2/32</dr>
                            <drDelay>3</drDelay>
                            <drPrio>1</drPrio>
                            <genID>202058884</genID>
                            <ifstats-items>
                                <assertRcvd>0</assertRcvd>
                                <assertSent>0</assertSent>
                                <authFail>0</authFail>
                                <badVerPkt>0</badVerPkt>
                                <chksumErr>0</chksumErr>
                                <dfBackoffRcvd>0</dfBackoffRcvd>
                                <dfBackoffSent>0</dfBackoffSent>
                                <dfOfferRcvd>0</dfOfferRcvd>
                                <dfOfferSent>0</dfOfferSent>
                                <dfPassesRcvd>0</dfPassesRcvd>
                                <dfPassesSent>0</dfPassesSent>
                                <dfWinnerRcvd>0</dfWinnerRcvd>
                                <dfWinnerSent>0</dfWinnerSent>
                                <graftsRcvd>0</graftsRcvd>
                                <graftsSent>0</graftsSent>
                                <grftAckRcvd>0</grftAckRcvd>
                                <grftAckSent>0</grftAckSent>
                                <helloRcvd>2375</helloRcvd>
                                <helloSent>2377</helloSent>
                                <invalidPktRcvd>0</invalidPktRcvd>
                                <invalidPktSent>0</invalidPktSent>
                                <joinNoRP>0</joinNoRP>
                                <joinWrongRp>0</joinWrongRp>
                                <jpBidirRcvd>0</jpBidirRcvd>
                                <jpFilterIn>0</jpFilterIn>
                                <jpFilterOut>0</jpFilterOut>
                                <jpRcvd>0</jpRcvd>
                                <jpRcvdOnRPF>0</jpRcvdOnRPF>
                                <jpSSMRcvd>0</jpSSMRcvd>
                                <jpSent>0</jpSent>
                                <pktFrmNonNbr>0</pktFrmNonNbr>
                                <pktFrmSelf>0</pktFrmSelf>
                                <pktLenErr>0</pktLenErr>
                                <pktOnPassiveIf>0</pktOnPassiveIf>
                            </ifstats-items>
                            <ipAddr>30.30.30.1/24</ipAddr>
                            <nbrHoldTime>105</nbrHoldTime>
                            <nextHello>2017-12-21T18:22:31.194+00:00</nextHello>
                            <pimSparseMode>true</pimSparseMode>
                        </If-list>
                        <If-list>
                            <id>lo0</id>
                            <adminSt>enabled</adminSt>
                            <bfdInst>none</bfdInst>
                            <border>false</border>
                            <dr>2.2.2.100/32</dr>
                            <drDelay>3</drDelay>
                            <drPrio>1</drPrio>
                            <genID>671644221</genID>
                            <ifstats-items>
                                <assertRcvd>0</assertRcvd>
                                <assertSent>0</assertSent>
                                <authFail>0</authFail>
                                <badVerPkt>0</badVerPkt>
                                <chksumErr>0</chksumErr>
                                <dfBackoffRcvd>0</dfBackoffRcvd>
                                <dfBackoffSent>0</dfBackoffSent>
                                <dfOfferRcvd>0</dfOfferRcvd>
                                <dfOfferSent>0</dfOfferSent>
                                <dfPassesRcvd>0</dfPassesRcvd>
                                <dfPassesSent>0</dfPassesSent>
                                <dfWinnerRcvd>0</dfWinnerRcvd>
                                <dfWinnerSent>0</dfWinnerSent>
                                <graftsRcvd>0</graftsRcvd>
                                <graftsSent>0</graftsSent>
                                <grftAckRcvd>0</grftAckRcvd>
                                <grftAckSent>0</grftAckSent>
                                <helloRcvd>0</helloRcvd>
                                <helloSent>2369</helloSent>
                                <invalidPktRcvd>0</invalidPktRcvd>
                                <invalidPktSent>0</invalidPktSent>
                                <joinNoRP>0</joinNoRP>
                                <joinWrongRp>0</joinWrongRp>
                                <jpBidirRcvd>0</jpBidirRcvd>
                                <jpFilterIn>0</jpFilterIn>
                                <jpFilterOut>0</jpFilterOut>
                                <jpRcvd>0</jpRcvd>
                                <jpRcvdOnRPF>0</jpRcvdOnRPF>
                                <jpSSMRcvd>0</jpSSMRcvd>
                                <jpSent>0</jpSent>
                                <pktFrmNonNbr>0</pktFrmNonNbr>
                                <pktFrmSelf>0</pktFrmSelf>
                                <pktLenErr>0</pktLenErr>
                                <pktOnPassiveIf>0</pktOnPassiveIf>
                            </ifstats-items>
                            <ipAddr>2.2.2.100/32</ipAddr>
                            <nbrHoldTime>105</nbrHoldTime>
                            <nextHello>2017-12-21T18:22:14.811+00:00</nextHello>
                            <pimSparseMode>true</pimSparseMode>
                        </If-list>
                    </if-items>
                    <logNbhChng>false</logNbhChng>
                    <mtu>1500</mtu>
                    <ssm-items>
                        <range-items>
                            <grpList>232.0.0.0/8</grpList>
                            <ssmNone>false</ssmNone>
                        </range-items>
                    </ssm-items>
                    <staticrp-items>
                        <rp-items>
                            <StaticRP-list>
                                <addr>8.8.8.100/32</addr>
                                <rpgrplist-items>
                                    <RPGrpList-list>
                                        <grpListName>224.0.0.0/4</grpListName>
                                        <bidir>false</bidir>
                                        <override>false</override>
                                    </RPGrpList-list>
                                </rpgrplist-items>
                            </StaticRP-list>
                            <StaticRP-list>
                                <addr>1.1.1.100/32</addr>
                                <rpgrplist-items>
                                    <RPGrpList-list>
                                        <grpListName>224.0.0.0/4</grpListName>
                                        <bidir>false</bidir>
                                        <override>false</override>
                                    </RPGrpList-list>
                                </rpgrplist-items>
                            </StaticRP-list>
                        </rp-items>
                    </staticrp-items>
                </Dom-list>
            </dom-items>
            <jpDelay>100</jpDelay>
            <operErr/>
            <regStop>false</regStop>
        </inst-items>
        <operErr/>
        <operSt>enabled</operSt>
    </pim-items>
    

    DME Requests

    A DME GET request is individually sent for each interface, as shown in the example. To view all PIM information in a single payload, send a DME GET request to http://<IP_Address>/api/mo/sys/pim.json?rsp-subtree=full

    Note: This example was added in Cisco NX-OS Release 7.0(3)I7(3).

    CLI Output
    switch# show ip pim neighbor   
    PIM Neighbor Status for VRF "default"    
    Neighbor        Interface            Uptime    Expires   DR            Bidir-   BFD    ECMP Redirect                                                            
                                                             Priority      Capable  State     Capable   
    30.30.30.2      Ethernet1/49         1d00h     00:01:36  1             yes      n/a     no   
    

    Note: The property information for this example was added in Release 9.3(3).


    pimAdjEp Properties

    The following table contains information about the pimAdjEp 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
    addraddress:Ip
    AddressValue must match ipv4 or ipv6 known format
    bfdStrtdmc:BfdOperSt
    (scalar:Enum8)
    BFD StateSELECTION:
    0 - down
    1 - rem-pend
    2 - up
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    drPriortdmc:DRPrio
    (scalar:Uint32)
    DR Priority
    RANGE: [1 , 4294967295]
    DEFAULT: 1
    expiryTimescalar:Date
    Expiry TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    flagsrtdmc:AdjFlags
    (scalar:Bitmask16)
    FlagsSELECTION:
    0 - no-dr-prio
    1 - bidir-cap
    2 - vpc-peer
    4 - auth-pend
    genIdrtdmc:GenId
    (scalar:Uint32)
    Generation IDRANGE: [0, 4294967295]
    learnTimescalar:Date
    First Learn TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    namenaming:Name256
    (string:Basic)
    The name of the object.
    MAX SIZE: 63
    operStrtdmc:AdjOperSt
    (scalar:Enum8)
    Operational StateSELECTION:
    0 - up
    1 - inactive


    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

    Querying PIM Neighbor Interface Information

    Querying PIM Neighbor Interface Information
    
    GET http://<IP_Address>/api/mo/sys/pim/inst/dom-default/if-[eth1/49]/adj-[30.30.30.2/32].json
    
    {
    "totalCount": "1",
    "imdata": [
        {
            "pimAdjEp": {
                "attributes": {
                    "addr": "30.30.30.2/32",
                    "bfdSt": "down",
                    "dn": "sys/pim/inst/dom-default/if-[eth1/49]/adj-[30.30.30.2/32]",
                    "drPrio": "1",
                    "expiryTime": "2018-01-03T14:55:29.011+00:00",
                    "flags": "bidir-cap",
                    "genId": "343733100",
                    "learnTime": "2018-01-03T14:45:47.652+00:00",
                    "name": "30.30.30.2",
                    "operSt": "up"
    }}}]}
    
    GET  http://<IP_Address>/restconf/data/Cisco-NX-OS-device:System/pim-items/inst-items/dom-items/Dom-list=default/if-items/If-list=[eth1%2f49]
    
    <If-list>
        <id>eth1/49</id>
        <adj-items>
            <AdjEp-list>
                <addr>30.30.30.2/32</addr>
                <adjstats-items>
                    <lastHelloRcvd>1969-12-31T16:01:25.441+00:00</lastHelloRcvd>
                    <lastHoldTime>39464</lastHoldTime>
                    <longHelloItvl>393</longHelloItvl>
                    <nonHelloExpResets>0</nonHelloExpResets>
                </adjstats-items>
                <bfdSt>down</bfdSt>
                <drPrio>1</drPrio>
                <expiryTime>2018-01-06T17:18:47.789+00:00</expiryTime>
                <flags>bidir-cap</flags>
                <genId>391794114</genId>
                <learnTime>2018-01-05T17:39:34.820+00:00</learnTime>
                <name>30.30.30.2</name>
                <operSt>up</operSt>
            </AdjEp-list>
        </adj-items>
        <adminSt>enabled</adminSt>
        <bfdInst>none</bfdInst>
        <border>false</border>
        <dr>30.30.30.2/32</dr>
        <drDelay>3</drDelay>
        <drPrio>1</drPrio>
        <genID>762145955</genID>
        <ifstats-items>
            <assertRcvd>0</assertRcvd>
            <assertSent>0</assertSent>
            <authFail>0</authFail>
            <badVerPkt>0</badVerPkt>
            <chksumErr>0</chksumErr>
            <dfBackoffRcvd>0</dfBackoffRcvd>
            <dfBackoffSent>0</dfBackoffSent>
            <dfOfferRcvd>0</dfOfferRcvd>
            <dfOfferSent>0</dfOfferSent>
            <dfPassesRcvd>0</dfPassesRcvd>
            <dfPassesSent>0</dfPassesSent>
            <dfWinnerRcvd>0</dfWinnerRcvd>
            <dfWinnerSent>0</dfWinnerSent>
            <graftsRcvd>0</graftsRcvd>
            <graftsSent>0</graftsSent>
            <grftAckRcvd>0</grftAckRcvd>
            <grftAckSent>0</grftAckSent>
            <helloRcvd>2986</helloRcvd>
            <helloSent>2987</helloSent>
            <invalidPktRcvd>0</invalidPktRcvd>
            <invalidPktSent>0</invalidPktSent>
            <joinNoRP>0</joinNoRP>
            <joinWrongRp>0</joinWrongRp>
            <jpBidirRcvd>0</jpBidirRcvd>
            <jpFilterIn>0</jpFilterIn>
            <jpFilterOut>0</jpFilterOut>
            <jpRcvd>0</jpRcvd>
            <jpRcvdOnRPF>0</jpRcvdOnRPF>
            <jpSSMRcvd>0</jpSSMRcvd>
            <jpSent>0</jpSent>
            <pktFrmNonNbr>0</pktFrmNonNbr>
            <pktFrmSelf>0</pktFrmSelf>
            <pktLenErr>0</pktLenErr>
            <pktOnPassiveIf>0</pktOnPassiveIf>
        </ifstats-items>
        <ipAddr>30.30.30.1/24</ipAddr>
        <nbrHoldTime>105</nbrHoldTime>
        <nextHello>2018-01-06T17:17:21.146+00:00</nextHello>
        <pimSparseMode>true</pimSparseMode>
    </If-list>
    

    CLI Output
    switch(config)# show ip pim neighbor ethernet 1/49   
    PIM Neighbor Status for VRF"default"   
    Neighbor        Interface            Uptime    Expires   DR        Bidir-    BFD    ECMP Redirect   
                                                             Priority  Capable   State     Capable   
    30.30.30.2      Ethernet1/49         1d00h     00:01:36  1      yes      n/a          no
    

    Note: The property information for this example was added in Release 9.3(3).


    pimAdjEp Properties

    The following table contains information about the pimAdjEp 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
    addraddress:Ip
    AddressValue must match ipv4 or ipv6 known format
    bfdStrtdmc:BfdOperSt
    (scalar:Enum8)
    BFD StateSELECTION:
    0 - down
    1 - rem-pend
    2 - up
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    drPriortdmc:DRPrio
    (scalar:Uint32)
    DR Priority
    RANGE: [1 , 4294967295]
    DEFAULT: 1
    expiryTimescalar:Date
    Expiry TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    flagsrtdmc:AdjFlags
    (scalar:Bitmask16)
    FlagsSELECTION:
    0 - no-dr-prio
    1 - bidir-cap
    2 - vpc-peer
    4 - auth-pend
    genIdrtdmc:GenId
    (scalar:Uint32)
    Generation IDRANGE: [0, 4294967295]
    learnTimescalar:Date
    First Learn TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    namenaming:Name256
    (string:Basic)
    The name of the object.
    MAX SIZE: 63
    operStrtdmc:AdjOperSt
    (scalar:Enum8)
    Operational StateSELECTION:
    0 - up
    1 - inactive


    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