Querying MSDP Ephemeral Data

Querying the MSDP Domain

Querying the MSDP Domain

GET http://<IP_Address>/api/node/mo/sys/msdp/inst/dom-default.json

{
  "totalCount": "1",
  "imdata": [
{
  "msdpDom": {
    "attributes": {
      "childAction": "",
      "ctrl": "",
      "dn": "sys/msdp/inst/dom-default",
      "modTs": "2016-12-07T03:47:02.900+00:00",
      "name": "default",
      "origIf": "eth1/10",
      "persistentOnReload": "true",
      "reConnIntvl": "10",
      "srcActiveMsgIntvl": "120",
      "status": "",
      "uid": "0"
},
"children": [
  {
    "msdpPeer": {
      "attributes": {
        "addr": "192.0.20.123",
        "adminSt": "disabled",
        "asn": "200",
        "childAction": "",
        "connTmrTs": "1970-01-01T00:00:00.000+00:00",
        "descr": "This is an example of a peer",
        "discontinuityTs": "2016-12-07T03:47:02.947+00:00",
        "establishTransitions": "0",
        "kaIntvl": "50",
        "kaTimeout": "70",
        "lastResetOperQual": "Password change",
        "localPort": "unspecified",
        "modTs": "2016-12-07T17:03:55.036+00:00",
        "name": "",
        "operSt": "admin-down",
        "persistentOnReload": "true",
        "remPort": "unspecified",
        "rn": "peer-[192.0.20.123]",
        "srcActiveMsgLimit": "9999999",
        "srcIf": "eth1/9",
        "status": "",
        "uid": "22322",
        "upTs": "2016-12-07T03:47:02.961+00:00"
},
"children": [
{
  "msdpMeshGrp": {
    "attributes": {
      "childAction": "",
      "descr": "",
      "grpName": "my_mesh_grp1",
      "modTs": "2016-12-07T17:04:25.140+00:00",
      "name": "",
      "persistentOnReload": "true",
      "rn": "meshgrp",
      "status": "",
      "uid": "22322"
}}},{
"msdpAuthP": {
"attributes": {
  "childAction": "",
  "descr": "",
  "key": "",
  "modTs": "2016-12-07T03:47:02.900+00:00",
  "name": "",
  "persistentOnReload": "true",
  "rn": "auth",
  "status": "",
  "type": "none",
  "uid": "22322"
}}}]}}]}}]}

This example returns the MSDP configuration for the default MSDP domain.

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


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
msdpDom sys/msdp/inst/dom-{name}
msdpPeer sys/msdp/inst/dom-{name}/peer-{[addr]}
msdpMeshGrp sys/msdp/inst/dom-{name}/peer-{[addr]}/meshgrp
msdpAuthP sys/msdp/inst/dom-{name}/peer-{[addr]}/auth


msdpDom Properties

The following table contains information about the msdpDom 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
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • ctrlmsdp:DomCtrl
    (scalar:Bitmask8)    		Flush routesSELECTION:
    1 - flush-routes
    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
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    origIfnw:IfId
    (base:IfIndex)    		Originator Interface identifying IP address in RP field of Source-Active message. Supported interfaces include Ethernet-like, port/channel, loopback and vlan interfacesMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • reConnIntvlmsdp:ReConnIntvl
    (scalar:Uint16)    		Reconnect Interval
    RANGE: [1 , 60]
    DEFAULT: 10
    srcActiveMsgIntvlmsdp:SrcActiveMsgIntvl
    (scalar:Uint16)    		Source Active message Interval
    RANGE: [60 , 65535]
    DEFAULT: 60
    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.


    msdpPeer Properties

    The following table contains information about the msdpPeer 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
    		IP address of MSDP PeerValue must match ipv4 or ipv6 known format
    adminStnw:AdminSt
    (scalar:Enum8)    		Administrative state enabled/disabledSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: enabled
    asnmsdp:Asn
    (string:Basic)    		Autonomous System NumberA sequence of characters
    DEFAULT: none
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • connTmrTsscalar:Date
    		Connect Timer TimestampDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    descrmsdp:Descr
    		Description of the specified attribute
    discontinuityTsscalar:Date
    		Discontinuity TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    establishTransitionsnw:Counter32
    (scalar:Uint32)    		Count of established transitionsRANGE: [0, 4294967295]
    kaIntvlmsdp:KaIntvl
    (scalar:Uint16)    		Keepalive interval, how often you send keepalives
    RANGE: [1 , 60]
    DEFAULT: 60
    kaTimeoutmsdp:KaTimeout
    (scalar:Uint16)    		Keepalive Timeout
    RANGE: [1 , 90]
    DEFAULT: 90
    lastResetOperQualmsdp:LastResetT
    (string:Basic)    		Reason for last reset
    MAX SIZE: 255
    localPortl4:Port
    (scalar:Uint16)    		Local TCP connection port to this peer
    RANGE: [0 , 0xffff]
    DEFAULT: unspecified
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    operStmsdp:OperSt
    (scalar:Enum8)    		Operational StatusSELECTION:
    0 - inactive
    1 - down
    2 - admin-down
    3 - connecting
    4 - listening
    5 - established
    DEFAULT: inactive
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • remPortl4:Port
    (scalar:Uint16)    		Remote TCP connection port to this peer
    RANGE: [0 , 0xffff]
    DEFAULT: unspecified
    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.
    srcActiveMsgLimitmsdp:SrcActiveMsgLimit
    (scalar:Uint32)    		Source Active msg Limit
    RANGE: [0 , 4294967295]
    DEFAULT: 4294967295
    srcIfnw:IfId
    (base:IfIndex)    		Source Interface. Supported interfaces include Ethernet-like, port/channel, loopback and vlan interfacesMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    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.
    upTsscalar:Date
    		UptimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z


    msdpMeshGrp Properties

    The following table contains information about the msdpMeshGrp 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
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descrpol:Descr
    		Description of the specified attribute
    grpNamemsdp:GrpNameT
    (string:Basic)    		Mesh Group Name
    MAX SIZE: 254
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    namepol:ObjName
    (naming:Name256)    		Object name
    MAX SIZE: 64
    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.


    msdpAuthP Properties

    The following table contains information about the msdpAuthP 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
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descrpol:Descr
    		Description of the specified attribute
    keymsdp:AuthKey
    (string:Password)    		Authentication key
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    namepol:ObjName
    (naming:Name256)    		Object name
    MAX SIZE: 64
    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
    typemsdp:AuthT
    (scalar:Enum8)    		Authentication typeSELECTION:
    0 - none
    1 - md5
    DEFAULT: none
    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 Ephemeral Operational Data

    - **rsp-foreign-subtree=ephemeral**—Specifies that this is an ephemeral request, retrieving high-volume data. - **rsp-subtree=full**—Should be specified to retrieve all children under the dn query. - **batch-id**—An integer with a range of 1 to N. You can specify in increments (1, 2, 3, …) to retrieve data in iteration. - **batch-size**—An integer with a range of 1 to 100,000. You can specify the maximum number of managed objects to be retrieved in each batch iteration.

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

    Command Ephemeral DN Query Description
    show ip msdp peer http://{{ip}}/api/mo/sys/msdp/inst/dom-default/peer-2.2.2.2.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=10&batch-id=1 Query MSDP peers
    show ip msdp route http://{{ip}}/api/mo/sys/msdp/inst/dom-default/db-route.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=10000&batch-id=1 Query MSDP routes
    show ip msdp source http://{{ip}}/api/mo/sys/msdp/inst/dom-default/db-source.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-size=10000&batch-id=1 Query MSDP sources

    Ephemeral REST Output

    Ephemeral REST Output

    http://{{ip}}/api/mo/sys/arp/inst/dom-management/db-ip.json?rsp-subtree=full&rsp-foreign-subtree=ephemeral&batch-id=1&batch-size=20000

    {
  "totalCount": "1",
  "imdata": [
{
"msdpPeer": {
"attributes": {
  "addr": "2.2.2.2",
  "adminSt": "enabled",
  "asn": "",
  "childAction": "",
  "descr": "",
  "dn": "sys/msdp/inst/dom-default/peer-[2.2.2.2]",
  "kaIntvl": "60",
  "kaTimeout": "90",
  "localPort": "59039",
  "modTs": "2016-06-28T06:02:48.355+00:00",
  "name": "",
  "operSt": "established",
  "persistentOnReload": "true",
  "remPort": "639",
  "rstReason": "",
  "srcActiveMsgLimit": "4294967295",
  "srcIf": "vlan100",
  "status": "",
  "uid": "0"
},
"children": [
  {
    "msdpPeerStats": {
      "attributes": {
        "cacheLfTime": "2016-06-28T18:41:28.923+00:00",
        "childAction": "",
        "connAttempts": "7",
        "connTmrTs": "2016-06-28T18:37:58.923+00:00",
        "ctrlMsgsRcvd": "120",
        "ctrlMsgsSent": "0",
        "dataMsgsRcvd": "0",
        "dataMsgsSent": "0",
        "disTime": "2016-06-28T18:35:01.484+00:00",
        "estTrans": "1",
        "kaRcvd": "3",
        "kaSent": "4",
        "lastMsgRcvd": "2016-06-28T18:37:21.801+00:00",
        "modTs": "never",
        "notifRcvd": "0",
        "notifSent": "0",
        "persistentOnReload": "false",
        "rn": "peerstats",
        "rpfChkFail": "0",
        "rtCnt": "10000",
        "saReqRcvd": "0",
        "saReqSent": "0",
        "saRspRcvd": "0",
        "saRspSent": "0",
        "status": "",
        "uptime": "2016-06-28T18:35:01.484+00:00"
}}}]}}]}

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


    Verifying a DME Configuration
    The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

    MODN
    msdpPeer sys/msdp/inst/dom-{name}/peer-{[addr]}
    msdpPeerStats sys/msdp/inst/dom-{name}/peer-{[addr]}/peerstats


    msdpPeer Properties

    The following table contains information about the msdpPeer 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
    		IP address of MSDP PeerValue must match ipv4 or ipv6 known format
    adminStnw:AdminSt
    (scalar:Enum8)    		Administrative state enabled/disabledSELECTION:
    1 - enabled
    2 - disabled
    DEFAULT: enabled
    asnmsdp:Asn
    (string:Basic)    		Autonomous System NumberA sequence of characters
    DEFAULT: none
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descrmsdp:Descr
    		Description of the specified attribute
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    kaIntvlmsdp:KaIntvl
    (scalar:Uint16)    		Keepalive interval, how often you send keepalives
    RANGE: [1 , 60]
    DEFAULT: 60
    kaTimeoutmsdp:KaTimeout
    (scalar:Uint16)    		Keepalive Timeout
    RANGE: [1 , 90]
    DEFAULT: 90
    localPortl4:Port
    (scalar:Uint16)    		Local TCP connection port to this peer
    RANGE: [0 , 0xffff]
    DEFAULT: unspecified
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    namenaming:Name256
    (string:Basic)    		The name of the object.
    MAX SIZE: 63
    operStmsdp:OperSt
    (scalar:Enum8)    		Operational StatusSELECTION:
    0 - inactive
    1 - down
    2 - admin-down
    3 - connecting
    4 - listening
    5 - established
    DEFAULT: inactive
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • remPortl4:Port
    (scalar:Uint16)    		Remote TCP connection port to this peer
    RANGE: [0 , 0xffff]
    DEFAULT: unspecified
    rstReasonNANANA
    srcActiveMsgLimitmsdp:SrcActiveMsgLimit
    (scalar:Uint32)    		Source Active msg Limit
    RANGE: [0 , 4294967295]
    DEFAULT: 4294967295
    srcIfnw:IfId
    (base:IfIndex)    		Source Interface. Supported interfaces include Ethernet-like, port/channel, loopback and vlan interfacesMust match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
    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.


    msdpPeerStats Properties

    The following table contains information about the msdpPeerStats 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
    cacheLfTimeNANANA
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • connAttemptsnw:Counter32
    (scalar:Uint32)    		Count of Connection AttemptsRANGE: [0, 4294967295]
    connTmrTsNANANA
    ctrlMsgsRcvdNANANA
    ctrlMsgsSentNANANA
    dataMsgsRcvdNANANA
    dataMsgsSentNANANA
    disTimeNANANA
    estTransNANANA
    kaRcvdnw:Counter32
    (scalar:Uint32)    		Count of Keepalives ReceivedRANGE: [0, 4294967295]
    kaSentnw:Counter32
    (scalar:Uint32)    		Count of Keepalives SentRANGE: [0, 4294967295]
    lastMsgRcvdNANANA
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    notifRcvdnw:Counter32
    (scalar:Uint32)    		Count of SA Notifications ReceivedRANGE: [0, 4294967295]
    notifSentnw:Counter32
    (scalar:Uint32)    		Count of SA Notifications SentRANGE: [0, 4294967295]
    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.
    rpfChkFailnw:Counter32
    (scalar:Uint32)    		Count of RPF Check FailuresRANGE: [0, 4294967295]
    rtCntnw:Counter32
    (scalar:Uint32)    		Count of SG cache entries learntRANGE: [0, 4294967295]
    saReqRcvdnw:Counter32
    (scalar:Uint32)    		Count of SA Request ReceivedRANGE: [0, 4294967295]
    saReqSentnw:Counter32
    (scalar:Uint32)    		 Count of SA Request SentRANGE: [0, 4294967295]
    saRspRcvdnw:Counter32
    (scalar:Uint32)    		Count of SA Response ReceivedRANGE: [0, 4294967295]
    saRspSentnw:Counter32
    (scalar:Uint32)    		Count of SA Response SentRANGE: [0, 4294967295]
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    uptimeNANANA


    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