Configuring an IPv4 Unicast Subaddress Family for a BGP Neighbor (Ethernet Interface) Under a VRF
Configuring an IPv4 Unicast Address Family
Configuring an IPv4 Unicast Address Family
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"bgpPeerIf": {
"attributes": {
"id": "eth1/2"
},
"children": [
{
"bgpPeerAf": {
"attributes": {
"type": "ipv4-ucast"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<peerif-items>
<PeerIf-list>
<id>eth1/2</id>
<af-items>
<PeerAf-list>
<type>ipv4-ucast</type>
</PeerAf-list>
</af-items>
</PeerIf-list>
</peerif-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-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.
router bgp 100
vrf VRF_1
neighbor ethernet 1/2
address-family ipv4 unicast
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-VRF_1 |
| bgpPeerIf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2] |
| bgpPeerAf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]/af-ipv4-ucast |
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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf 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 |
|---|---|---|---|
| id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf 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 |
|---|---|---|---|
| type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>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 an IPv4 Unicast Address Family
Deleting an IPv4 Unicast Address Family
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"bgpPeerIf": {
"attributes": {
"id": "eth1/2"
},
"children": [
{
"bgpPeerAf": {
"attributes": {
"status": "deleted",
"type": "ipv4-ucast"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<peerif-items>
<PeerIf-list>
<id>eth1/2</id>
<af-items>
<PeerAf-list nc:operation="delete">
<type>ipv4-ucast</type>
</PeerAf-list>
</af-items>
</PeerIf-list>
</peerif-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-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.
router bgp 100
vrf VRF_1
neighbor ethernet 1/2
no address-family ipv4 unicast
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-VRF_1 |
| bgpPeerIf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2] |
| bgpPeerAf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]/af-ipv4-ucast |
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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf 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 |
|---|---|---|---|
| id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
| type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>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 an IPv6 Multicast Subaddress Family
Configuring an IPv6 Multicast Subaddress Family
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"bgpPeerIf": {
"attributes": {
"id": "eth1/2"
},
"children": [
{
"bgpPeerAf": {
"attributes": {
"type": "ipv6-mcast"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<peerif-items>
<PeerIf-list>
<id>eth1/2</id>
<af-items>
<PeerAf-list>
<type>ipv6-mcast</type>
</PeerAf-list>
</af-items>
</PeerIf-list>
</peerif-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-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.
router bgp 100
vrf VRF_1
neighbor ethernet 1/2
address-family ipv6 multicast
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-VRF_1 |
| bgpPeerIf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2] |
| bgpPeerAf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]/af-ipv6-mcast |
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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf 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 |
|---|---|---|---|
| id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf 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 |
|---|---|---|---|
| type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>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 an IPv6 Multicast Subaddress Family
Deleting an IPv6 Multicast Subaddress Family
POST http://<mgmt0_IP>/api/mo/sys/bgp.json
{
"bgpEntity": {
"children": [
{
"bgpInst": {
"attributes": {
"asn": "100"
},
"children": [
{
"bgpDom": {
"attributes": {
"name": "VRF_1"
},
"children": [
{
"bgpPeerIf": {
"attributes": {
"id": "eth1/2"
},
"children": [
{
"bgpPeerAf": {
"attributes": {
"status": "deleted",
"type": "ipv6-mcast"
}}}]}}]}}]}}]}}
{
imdata:[]
}
<System>
<bgp-items>
<inst-items>
<asn>100</asn>
<dom-items>
<Dom-list>
<name>VRF_1</name>
<peerif-items>
<PeerIf-list>
<id>eth1/2</id>
<af-items>
<PeerAf-list nc:operation="delete">
<type>ipv6-mcast</type>
</PeerAf-list>
</af-items>
</PeerIf-list>
</peerif-items>
</Dom-list>
</dom-items>
</inst-items>
</bgp-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.
router bgp 100
vrf VRF_1
neighbor ethernet 1/2
no address-family ipv6 multicast
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-VRF_1 |
| bgpPeerIf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2] |
| bgpPeerAf | sys/bgp/inst/dom-VRF_1/peerif-[eth1/2]/af-ipv6-mcast |
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 |
bgpPeerIf Properties
The following table contains information about the bgpPeerIf 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 |
|---|---|---|---|
| id | nw:IfId (base:IfIndex) | Interface identifier of the neighbor | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
bgpPeerAf Properties
The following table contains information about the bgpPeerAf 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 |
|---|---|---|---|
| status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
| type | bgp:AfT (scalar:Enum8) | Type | SELECTION: 1 - ipv4-ucast 3 - vpnv4-ucast 5 - ipv6-ucast 6 - ipv6-mcast 7 - vpnv6-ucast 8 - vpnv6-mcast 9 - l2vpn-evpn 10 - ipv4-lucast 12 - lnkstate 14 - ipv6-mvpn 15 - l2vpn-vpls div>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: