Configuring MVPNs
The multicast virtual private networks (MVPNs) feature allows you to support multicast connectivity over Layer 3 VPN. IP multicast is used to stream video, voice, and data to an VPN network core. Historically, point-to-point tunnels were the only way to connect through an enterprise or service provider network. Although such tunneled networks had scalability issues, they were the only means of passing IP multicast traffic through a virtual private network (VPN). Because Layer 3 VPNs support only unicast traffic connectivity, deploying with a Layer 3 VPN allows operators to offer both unicast and multicast connectivity to Layer 3 VPN customers.
MVPNs allows you to configure and support multicast traffic in an MVPN environment. MVPNs support routing and forwarding of multicast packets for each individual virtual routing and forwarding (VRF) instance, and it also provides a mechanism to transport VPN multicast packets across the enterprise or service provider backbone. IP multicast is used to stream video, voice, and data to a VPN network core. A VPN allows network connectivity across a shared infrastructure, such as an Internet Service Provider (ISP). Its function is to provide the same policies and performance as a private network at a reduced cost of ownership. MVPNs allow an enterprise to transparently interconnect its private network across the network backbone. Using MVPNs to interconnect an enterprise network does not change the way that an enterprise network is administered and it does not change general enterprise connectivity.
For more information, see the Cisco Nexus 9000 Series NX-OS Label Switching Configuration Guide:
Configuring the Default Group
Configuring the Default Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"mdtDefaultEnabled": "yes",
"mdtDefaultGroup": "229.34.4.3",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<mdtDefaultEnabled>true</mdtDefaultEnabled>
<mdtDefaultGroup>229.34.4.3</mdtDefaultGroup>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt default 229.34.4.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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
mdtDefaultEnabled | scalar:Bool | This property helps us manage mdtDefaultGroup property. If set to "no", the mdtDefaultGroup is NOT active. | SELECTION: true or false |
mdtDefaultGroup | address:Ip | IP multicast group address | Value must match ipv4 or ipv6 known format |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting the Default Group
Deleting the Default Group
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"mdtDefaultEnabled": "no",
"mdtDefaultGroup": "229.34.4.3",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<mdtDefaultEnabled>false</mdtDefaultEnabled>
<mdtDefaultGroup>229.34.4.3</mdtDefaultGroup>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt default 229.34.4.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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
mdtDefaultEnabled | scalar:Bool | This property helps us manage mdtDefaultGroup property. If set to "no", the mdtDefaultGroup is NOT active. | SELECTION: true or false |
mdtDefaultGroup | address:Ip | IP multicast group address | Value must match ipv4 or ipv6 known format |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring the Source Interface Used inthe Backbone Network
Configuring the Source Interface Used inthe Backbone Network
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"mdtSourceIntf": "eth1/2",
"mdtSrcEnabled": "yes",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<mdtSourceIntf>eth1/2</mdtSourceIntf>
<mdtSrcEnabled>true</mdtSrcEnabled>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt source ethernet 1/2
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
mdtSourceIntf | nw:IfId (base:IfIndex) | Source interface to be used in the backbone network | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100. Note: There is no support for "mti" interfaces. |
mdtSrcEnabled | scalar:Bool | If set to "False", sourceTntf will not be active | SELECTION: true or false |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting the Source Interface Used inthe Backbone Network
Deleting the Source Interface Used inthe Backbone Network
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"mdtSourceIntf": "eth1/2",
"mdtSrcEnabled": "no",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<mdtSourceIntf>eth1/2</mdtSourceIntf>
<mdtSrcEnabled>false</mdtSrcEnabled>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt source ethernet 1/2
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
mdtSourceIntf | nw:IfId (base:IfIndex) | Source interface to be used in the backbone network | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100. Note: There is no support for "mti" interfaces. |
mdtSrcEnabled | scalar:Bool | If this set to "False", sourceTntf will not be active | SELECTION: true or false |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring (*,G)-only State
Configuring (*,G)-only State
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"asmUseSharedTree": "yes",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<asmUseSharedTree>true</asmUseSharedTree>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt asm-use-shared-tree
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
asmUseSharedTree | scalar:Bool | ASM use shared tree configured | SELECTION: true or false |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting (*,G)-only State
Deleting (*,G)-only State
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"asmUseSharedTree": "no",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<asmUseSharedTree>false</asmUseSharedTree>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt asm-use-shared-tree
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
asmUseSharedTree | scalar:Bool | ASM use shared tree configured | SELECTION: true or false |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring Dependence on BGP-MDT SAFI for Auto-Discovery
Configuring Dependence on BGP-MDT SAFI for Auto-Discovery
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"enforceBGPmdtSafi": "yes",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<enforceBGPmdtSafi>true</enforceBGPmdtSafi>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note:
- This is a default config and will not appear in
show running-config
. However, it will appear inshow running-config all
. When set to no, this config will appear inshow running-config
. - This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt enforce-bgp-mdt-safi
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
enforceBGPmdtSafi | scalar:Bool | Depend on BGP MDT SAFI for auto-discovery | SELECTION: true or false DEFAULT: true |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting Dependence on BGP-MDT SAFI for Auto-Discovery
Deleting Dependence on BGP-MDT SAFI for Auto-Discovery
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"enforceBGPmdtSafi": "no",
"name": "VRF_1"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<enforceBGPmdtSafi>false</enforceBGPmdtSafi>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt enforce-bgp-mdt-safi
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
enforceBGPmdtSafi | scalar:Bool | Depend on BGP MDT SAFI for auto-discovery | SELECTION: true or false DEFAULT: true |
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring a PIM Hello-Interval
Configuring a PIM Hello-Interval
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1",
"pimHelloIntvl": "13338552"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<pimHelloIntvl>13338552</pimHelloIntvl>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt pim hello-interval 13338552
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
pimHelloIntvl | mvpn:PimHelloIntvl (scalar:Uint32) | PIM hello interval used between peers | RANGE: [1 , 18724286] DEFAULT: 30000 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting a PIM Hello-Interval
Deleting a PIM Hello-Interval
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1",
"pimHelloIntvl": "30000"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<pimHelloIntvl>30000</pimHelloIntvl>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt pim hello-interval 13338552
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
pimHelloIntvl | mvpn:PimHelloIntvl (scalar:Uint32) | PIM hello interval used between peers | RANGE: [1 , 18724286] DEFAULT: 30000 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring a PIM JP-Interval
Configuring a PIM JP-Interval
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1",
"pimJoinPruneIntvl": "33109"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<pimJoinPruneIntvl>33109</pimJoinPruneIntvl>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt pim jp-interval 33109
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
pimJoinPruneIntvl | mvpn:PimJPIntvl (scalar:Uint32) | Join-Prune interval used between peers | RANGE: [60 , 65520] DEFAULT: 60 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting a PIM JP-Interval
Deleting a PIM JP-Interval
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1",
"pimJoinPruneIntvl": "60"
}
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<pimJoinPruneIntvl>60</pimJoinPruneIntvl>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
no mdt pim jp-interval 33109
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
pimJoinPruneIntvl | mvpn:PimJPIntvl (scalar:Uint32) | Join-Prune interval used between peers | RANGE: [60 , 65520] DEFAULT: 60 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring a Policy for Creating Data MDTs (with a Route Map)
Configuring a Policy for Creating Data MDTs (with a Route Map)
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"mvpnDataGrp": {
"attributes": {
"grpAddr": "229.34.4.0/24",
"rtMap": "SampleString_123"
}
}
}
]
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<group-items>
<DataGrp-list>
<grpAddr>229.34.4.0/24</grpAddr>
<rtMap>SampleString_123</rtMap>
</DataGrp-list>
</group-items>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt data 229.34.4.3/24 immediate-switch route-map SampleString_123
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
mvpnDataGrp | sys/mvpn/inst/dom-VRF_1/group-[229.34.4.0/24] |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
mvpnDataGrp Properties
The following table contains information about the mvpnDataGrp 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 |
---|---|---|---|
grpAddr | address:Ip | List of group range prefixes, only multicast allowed | Value must match ipv4 or ipv6 known format |
rtMap | mvpn:RtMapType (string:Basic) | Route Map Name to control the distribution | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Configuring a Policy for Creating Data MDT
Configuring a Policy for Creating Data MDT
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"mvpnDataGrp": {
"attributes": {
"grpAddr": "229.34.4.0/24",
"rtMap": ""
}
}
}
]
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<group-items>
<DataGrp-list>
<grpAddr>229.34.4.0/24</grpAddr>
<rtMap></rtMap>
</DataGrp-list>
</group-items>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt data 229.34.4.3/24 immediate-switch
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
mvpnDataGrp | sys/mvpn/inst/dom-VRF_1/group-[229.34.4.0/24] |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
mvpnDataGrp Properties
The following table contains information about the mvpnDataGrp 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 |
---|---|---|---|
grpAddr | address:Ip | List of group range prefixes, only multicast allowed | Value must match ipv4 or ipv6 known format |
rtMap | mvpn:RtMapType (string:Basic) | Route Map Name to control the distribution | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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:
Deleting a Policy for Creating Data MDT
Deleting a Policy for Creating Data MDT
POST http://<mgmt0_IP>/api/mo/sys.json
{
"topSystem": {
"children": [
{
"mvpnEntity": {
"children": [
{
"mvpnInst": {
"children": [
{
"mvpnDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"mvpnDataGrp": {
"attributes": {
"grpAddr": "229.34.4.0/24",
"rtMap": ""
}
}
}
]
}
}
]
}
}
]
}
},
{
"l3Inst": {
"attributes": {
"name": "VRF_1"
}
}
}
]
}
}
{
imdata:[]
}
<System>
<mvpn-items>
<inst-items>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<group-items>
<DataGrp-list>
<grpAddr>229.34.4.0/24</grpAddr>
<rtMap></rtMap>
</DataGrp-list>
</group-items>
</Dom-list>
</dom-items>
</inst-items>
</mvpn-items>
<inst-items>
<Inst-list>
<name>VRF_1</name>
</Inst-list>
</inst-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
vrf context VRF_1
mdt data 229.34.4.3/24 immediate-switch
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.
MO | DN |
---|---|
topSystem | sys |
mvpnEntity | sys/mvpn |
mvpnInst | sys/mvpn/inst |
mvpnDom | sys/mvpn/inst/dom-VRF_1 |
mvpnDataGrp | sys/mvpn/inst/dom-VRF_1/group-[229.34.4.0/24] |
l3Inst | sys/inst-VRF_1 |
mvpnDom Properties
The following table contains information about the mvpnDom 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 63 |
mvpnDataGrp Properties
The following table contains information about the mvpnDataGrp 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 |
---|---|---|---|
grpAddr | address:Ip | List of group range prefixes, only multicast allowed | Value must match ipv4 or ipv6 known format |
rtMap | mvpn:RtMapType (string:Basic) | Route Map Name to control the distribution | MAX SIZE: 63 |
l3Inst Properties
The following table contains information about the l3Inst 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 |
---|---|---|---|
name | naming:Name256 (string:Basic) | The name of the object. | MAX SIZE: 128 |
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: