Configuring an IPv6 MVPN Address Family
This section uses examples to demonstrate BGP configuration options and to show how the REST APIs correspond to the CLI commands.
Configuring All Routes Regardless Of Target-VPN Communities
Configuring all Routes Regardless Of Target-VPN Communities
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"retainRttAll": "enabled",
"retainRttRtMap": "",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
"imdata": []
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<retainRttAll>enabled</retainRttAll>
<retainRttRtMap></retainRttRtMap>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
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.
router bgp 100
address-family ipv6 mvpn
retain route-target all
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.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
retainRttAll | bgp:AdminSt (scalar:Enum8) | Retain Route Target All | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
retainRttRtMap | string:Basic | Retain Route Target Route Map | A sequence of characters |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Configuration Of All Routes
Deleting The Configuration Of All Routes
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"retainRttAll": "disabled",
"retainRttRtMap": "",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
"imdata": []
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<retainRttAll>disabled</retainRttAll>
<retainRttRtMap></retainRttRtMap>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
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.
router bgp 100
address-family ipv6 mvpn
no retain route-target all
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.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
retainRttAll | bgp:AdminSt (scalar:Enum8) | Retain Route Target All | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
retainRttRtMap | string:Basic | Retain Route Target Route Map | A sequence of characters |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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:
Applying a Route Map To Filter Routes
Applying a Route Map To Filter Routes
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"retainRttAll": "disabled",
"retainRttRtMap": "Rt_Map1",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
"imdata": []
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<retainRttAll>disabled</retainRttAll>
<retainRttRtMap>Rt_Map1</retainRttRtMap>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
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.
router bgp 100
address-family ipv6 mvpn
retain route-target route-map Rt_Map1
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.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
retainRttAll | bgp:AdminSt (scalar:Enum8) | Retain Route Target All | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
retainRttRtMap | string:Basic | Retain Route Target Route Map | A sequence of characters |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Route Map To Filter Routes
Deleting a Route Map To Filter Routes
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"retainRttAll": "disabled",
"retainRttRtMap": "",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
"imdata": []
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<retainRttAll>disabled</retainRttAll>
<retainRttRtMap></retainRttRtMap>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
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.
router bgp 100
address-family ipv6 mvpn
no retain route-target route-map Rt_Map1
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.
MO | DN |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-{name} |
bgpDomAf | sys/bgp/inst/dom-{name}/af-{[type]} |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
retainRttAll | bgp:AdminSt (scalar:Enum8) | Retain Route Target All | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
retainRttRtMap | string:Basic | Retain Route Target Route Map | A sequence of characters |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Forward Packets Over Multipath Paths
Configuring Forward Packets Over Multipath Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"maxExtEcmp": "6",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<maxExtEcmp>6</maxExtEcmp>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
Note: This example was added in Release 9.3(1).
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.
router bgp 100
address-family ipv6 mvpn
maximum-paths 6
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 |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpDomAf | sys/bgp/inst/dom-default/af-ipv6-mvpn |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
maxExtEcmp | bgp:MaxEcmp (scalar:UByte) | Max External ECMP | RANGE: [1 , 64] DEFAULT: 1 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Forward Packets Over Multipath Paths
Deleting Forward Packets Over Multipath Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"maxExtEcmp": "1",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<maxExtEcmp>1</maxExtEcmp>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
Note: This example was added in Release 9.3(1).
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.
router bgp 100
address-family ipv6 mvpn
no maximum-paths 6
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 |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpDomAf | sys/bgp/inst/dom-default/af-ipv6-mvpn |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
maxExtEcmp | bgp:MaxEcmp (scalar:UByte) | Max External ECMP | RANGE: [1 , 64] DEFAULT: 1 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Multipath for IBGP Paths
Configuring Multipath for IBGP Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"maxEcmp": "24",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<maxEcmp>24</maxEcmp>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
Note: This example was added in Release 9.3(1).
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.
router bgp 100
address-family ipv6 mvpn
maximum-paths ibgp 24
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 |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpDomAf | sys/bgp/inst/dom-default/af-ipv6-mvpn |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
maxEcmp | bgp:MaxEcmp (scalar:UByte) | The maximum number of equal-cost paths for BGP load sharing. | RANGE: [1 , 64] DEFAULT: 1 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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 Multipath for IBGP Paths
Deleting Multipath for IBGP Paths
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "default"
},
"children": [
{
"bgpDomAf": {
"attributes": {
"maxEcmp": "1",
"type": "ipv6-mvpn"
}}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>default</name>
<af-items>
<DomAf-list>
<type>ipv6-mvpn</type>
<maxEcmp>1</maxEcmp>
</DomAf-list>
</af-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-items>
</System>
Note: This example was added in Release 9.3(1).
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.
router bgp 100
address-family ipv6 mvpn
no maximum-paths ibgp 24
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 |
---|---|
bgpEntity | sys/bgp |
bgpInst | sys/bgp/inst |
bgpDom | sys/bgp/inst/dom-default |
bgpDomAf | sys/bgp/inst/dom-default/af-ipv6-mvpn |
bgpInst Properties
The following table contains information about the bgpInst 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 |
---|---|---|---|
asn | bgp:AsnNum (string:Basic) | Autonomous system number | A sequence of characters |
bgpDom Properties
The following table contains information about the bgpDom 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 BGP Domain name. This name can be up to 64 alphanumeric characters. Note that you cannot change this name after the object has been saved. |
bgpDomAf Properties
The following table contains information about the bgpDomAf 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 |
---|---|---|---|
maxEcmp | bgp:MaxEcmp (scalar:UByte) | The maximum number of equal-cost paths for BGP load sharing. | RANGE: [1 , 64] DEFAULT: 1 |
type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 2 - ipv4-mcast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 11 - ipv6-lucast 12 - lnkstate 13 - ipv4-mvpn 14 - ipv6-mvpn 15 - l2vpn-vpls 16 - ipv4-mdt DEFAULT: ipv4-ucast |
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: