Configuring PIM6 on an Ethernet Interface
Configuring the Interface to be a Boundary of a PIM6 Domain
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
ipv6 pim border
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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 |
border | scalar:Bool
| Border policy | SELECTION: true or false |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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
Deleting the Interface to be a Boundary of a PIM6 Domain
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
no ipv6 pim border
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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 |
border | scalar:Bool
| Border policy | SELECTION: true or false |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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
Configuring Sparse Mode
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
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
Deleting Sparse Mode
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
no ip pim sparse-mode
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
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
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
ipv6 pim hello-authentication ah-md5 <auth-key>
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6HelloTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/hello |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6HelloTrP Properties
The following table contains information about the pim6HelloTrP 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 |
authKey | rtdmc:AuthKey (string:Password) | Authentication Key | |
authT | rtdmc:AuthT (scalar:Enum8) | Authentication Type | SELECTION: 0 - none 1 - ah-md5 DEFAULT: none |
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
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
no ipv6 pim hello-authentication ah-md5 <auth-key>
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6HelloTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/hello |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6HelloTrP Properties
The following table contains information about the pim6HelloTrP 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 |
authKey | rtdmc:AuthKey (string:Password) | Authentication Key | |
authT | rtdmc:AuthT (scalar:Enum8) | Authentication Type | SELECTION: 0 - none 1 - ah-md5 DEFAULT: none |
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
Configuring a Neighbor Policy for Filtering Adjacencies
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
ipv6 pim neighbor-policy RtMap_1
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
neighRtMap | string:Basic
| Neighbor route-map Policy | A sequence of characters |
neighpfxList | string:Basic
| Neighbor prefix-list Policy | A sequence of characters |
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
Deleting a Neighbor Policy for Filtering Adjacencies
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
no ipv6 pim neighbor-policy RtMap_1
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
neighRtMap | string:Basic
| Neighbor route-map Policy | A sequence of characters |
neighpfxList | string:Basic
| Neighbor prefix-list Policy | A sequence of characters |
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
Configuring the Priority for PIM6 DR Election on Interface
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
ipv6 pim dr-priority 123
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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 |
drPrio | rtdmc:DRPrio (scalar:Uint32) | Designated Router Priority | RANGE: [1 , 4294967295] DEFAULT: 1 |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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
Deleting the Priority for PIM6 DR Election on Interface
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
no ipv6 pim dr-priority 123
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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 |
drPrio | rtdmc:DRPrio (scalar:Uint32) | Designated Router Priority | RANGE: [1 , 4294967295] DEFAULT: 1 |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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
Configuring the Policy for Receiving Join-Prune Messages
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
ipv6 pim jp-policy RtMap_1
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6JpTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/jp-{policyDir} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6JpTrP Properties
The following table contains information about the pim6JpTrP 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 |
RtMap | string:Basic
| Out Route Map | A sequence of characters |
pfxList | string:Basic
| In Prefix List | A sequence of characters |
policyDir | rtdmc:PolicyDirType (scalar:Enum8) | Policy Direction | SELECTION: 0 - none 1 - in 2 - out DEFAULT: none |
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
Deleting the Policy for Receiving Join-Prune Messages
Note: This example was added in Release 9.2(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.
interface ethernet 1/2
no switchport
ip pim sparse-mode
no ipv6 pim jp-policy RtMap_1
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pimEntity |
sys/pim |
pimInst |
sys/pim/inst |
pimDom |
sys/pim/inst/dom-{name} |
pimIf |
sys/pim/inst/dom-{name}/if-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6JpTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/jp-{policyDir} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pimDom Properties
The following table contains information about the pimDom 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 |
pimIf Properties
The following table contains information about the pimIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode configured | SELECTION: true or false |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6JpTrP Properties
The following table contains information about the pim6JpTrP 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 |
RtMap | string:Basic
| Out Route Map | A sequence of characters |
pfxList | string:Basic
| In Prefix List | A sequence of characters |
policyDir | rtdmc:PolicyDirType (scalar:Enum8) | Policy Direction | SELECTION: 0 - none 1 - in 2 - out DEFAULT: none |
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
Configuring the Hello-Event Interval
Note: This example was added in Release 9.2(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.
interface ethernet 1/3
no switchport
ip pim sparse-mode
ipv6 pim hello-interval 1001
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6HelloTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/hello |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode | SELECTION: true or false |
pim6HelloTrP Properties
The following table contains information about the pim6HelloTrP 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 |
helloItvl | rtdmc:HelloItvl (scalar:Uint32) | Hello Interval | RANGE: [1 , 18724286] DEFAULT: 30000 |
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
Deleting the Hello-Event Interval
Note: This example was added in Release 9.2(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.
interface ethernet 1/3
no switchport
ip pim sparse-mode
no ipv6 pim hello-interval 1001
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
pim6HelloTrP |
sys/pim6/inst/dom-{name}/if-{[id]}/hello |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
layer | l1:Layer (scalar:Enum8) | Administrative port layer | SELECTION: 1 - Layer2 2 - Layer3 DEFAULT: Layer2 |
userCfgdFlags | l1:userCfgdFlags (scalar:Bitmask8) | Port User Config Flags | SELECTION: 0 - none 1 - admin_state 2 - admin_layer 4 - admin_router_mac 8 - admin_dce_mode 16 - admin_mtu DEFAULT: none |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode | SELECTION: true or false |
pim6HelloTrP Properties
The following table contains information about the pim6HelloTrP 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 |
helloItvl | rtdmc:HelloItvl (scalar:Uint32) | Hello Interval | RANGE: [1 , 18724286] DEFAULT: 30000 |
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
Configuring the Interface in Passive Mode
Note: This example was added in Release 9.2(2).
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.
interface ethernet 1/2
ipv6 pim passive
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
passive | scalar:Bool
| Interface in Passive mode. No send/receive. | SELECTION: true or false |
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
Deleting the Interface in Passive Mode
Note: This example was added in Release 9.2(2).
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.
interface ethernet 1/2
no ipv6 pim passive
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 |
topSystem |
sys |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-{[id]} |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-{name} |
pim6If |
sys/pim6/inst/dom-{name}/if-{[id]} |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
passive | scalar:Bool
| Interface in Passive mode. No send/receive. | SELECTION: true or false |
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
Configuring Sparse-Mode PIM6 on an Interface
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.
interface ethernet 1/2
ipv6 pim sparse-mode
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 |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-default |
pim6If |
sys/pim6/inst/dom-default/if-[eth1/2] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode | SELECTION: true or false |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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
Deleting Sparse-Mode PIM6 on an Interface
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.
interface ethernet 1/2
no ipv6 pim sparse-mode
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 |
pim6Entity |
sys/pim6 |
pim6Inst |
sys/pim6/inst |
pim6Dom |
sys/pim6/inst/dom-default |
pim6If |
sys/pim6/inst/dom-default/if-[eth1/2] |
interfaceEntity |
sys/intf |
l1PhysIf |
sys/intf/phys-[eth1/2] |
pim6Dom Properties
The following table contains information about the pim6Dom 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 |
pim6If Properties
The following table contains information about the pim6If 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
pimSparseMode | scalar:Bool
| Sparse Mode | SELECTION: true or false |
l1PhysIf Properties
The following table contains information about the l1PhysIf 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) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
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