Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring an IPv6 Snooping Binding Table with the Maximum Times set to Infinite

DME

YANG

Copy
 http://<mgmt0_IP>/api/mo/sys/sisf.json
{
  "sisfEntity": {
    "children": [
      {
        "sisfInstBinding": {
          "attributes": {
            "DownLifetimer": "0",
            "ReachableLifetimer": "0",
            "StaleLifetimer": "0"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <sisf-items>
    <neighborbinding-items>
      <DownLifetimer>0</DownLifetimer>
      <ReachableLifetimer>0</ReachableLifetimer>
      <StaleLifetimer>0</StaleLifetimer>
    </neighborbinding-items>
  </sisf-items>
</System>

Configuring an IPv6 Snooping Binding Table

Using information extracted from intercepted DHCP messages, DHCP snooping dynamically builds and maintains a database. The database contains an entry for each untrusted host with a leased IP address if the host is associated with a VLAN that has DHCP snooping enabled. The database does not contain entries for hosts connected through trusted interfaces.

Note: The DHCP snooping binding database is also referred to as the DHCP snooping binding table.

DHCP snooping updates the database when the device receives specific DHCP messages. For example, the feature adds an entry to the database when the device receives a DHCPACK message from the server. The feature removes the entry in the database when the IP address lease expires or the device receives a DHCPRELEASE message from the host.

Each entry in the DHCP snooping binding database includes the MAC address of the host, the leased IP address, the lease time, the binding type, and the VLAN number and interface information associated with the host.

Dynamic ARP inspection (DAI) and IP Source Guard also use information stored in the DHCP snooping binding database.

For more information, see the Cisco Nexus 9000 Series NX-OS Security Configuration Guide.

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Configuring an IPv6 Snooping Binding Table with the Maximum Times Set to Infinite

Configuring an IPv6 Snooping Binding Table with the Maximum Times set to Infinite

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.

ipv6 neighbor binding reachable-lifetime infinite down-lifetime infinite stale-lifetime infinite

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
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

The following table contains information about the sisfInstBinding 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
DownLifetimer	sisf:downLifetimer (scalar:Uint64)	Set down-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400
ReachableLifetimer	sisf:reachableLifetimer (scalar:Uint64)	Set reachable-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 300
StaleLifetimer	sisf:staleLifetimer (scalar:Uint64)	Set stale-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400

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 an IPv6 Snooping Binding Table with the Maximum Times set to Specific Time Values (in Seconds)

CLI Commands

ipv6 neighbor binding reachable-lifetime 123 down-lifetime 123 stale-lifetime 123

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
DownLifetimer	sisf:downLifetimer (scalar:Uint64)	Set down-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400
ReachableLifetimer	sisf:reachableLifetimer (scalar:Uint64)	Set reachable-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 300
StaleLifetimer	sisf:staleLifetimer (scalar:Uint64)	Set stale-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400

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 Configuration of an IPv6 Snooping Binding Table with the Maximum Times Set to Specific Time Values (in Seconds)

CLI Commands

no ipv6 neighbor binding reachable-lifetime 123 down-lifetime 123 stale-lifetime 123

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
DownLifetimer	sisf:downLifetimer (scalar:Uint64)	Set down-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400
ReachableLifetimer	sisf:reachableLifetimer (scalar:Uint64)	Set reachable-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 300
StaleLifetimer	sisf:staleLifetimer (scalar:Uint64)	Set stale-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400

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 Configuration of an IPv6 Snooping Binding Table with the Maximum Times set to Infinite

CLI Commands

no ipv6 neighbor binding reachable-lifetime infinite down-lifetime infinite stale-lifetime infinite

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
DownLifetimer	sisf:downLifetimer (scalar:Uint64)	Set down-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400
ReachableLifetimer	sisf:reachableLifetimer (scalar:Uint64)	Set reachable-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 300
StaleLifetimer	sisf:staleLifetimer (scalar:Uint64)	Set stale-lifetimer of IPv6 snooping binding table	RANGE: [0 , 86400] DEFAULT: 86400

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 an IPv6 Snooping Binding Table with a VLAN Interface

CLI Commands

ipv6 neighbor binding vlan 123 1:2::3:4 interface ethernet1/2 1.2.3 tracking default reachable-lifetime default

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

MO	DN
sisfInstBinding	sys/sisf/neighborbinding
sisfStaticBinding	sys/sisf/neighborbinding/bindingip-{v6Addr}-bindingvlan-{vlanID}

sisfStaticBinding Properties

The following table contains information about the sisfStaticBinding 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
interface	nw:IfId (base:IfIndex)	Configure interface of static binding entry	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
mac	address:MAC	Configure mac address of static binding entry	Value must match MM:MM:MM:SS:SS:SS format
v6Addr	address:IPv6	Configure IPv6 address of static binding entry	Value must match ipv6 format
vlanID	sisf:VlanID (scalar:Uint16)	Configure Vlan ID of static binding entry	RANGE: [1 , 4096]

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 Configuration of an IPv6 Snooping Binding Table That Contains a VLAN Interface

CLI Commands

no ipv6 neighbor binding vlan 123 1:2::3:4 interface ethernet1/2 1.2.3 tracking default reachable-lifetime default

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

MO	DN
sisfInstBinding	sys/sisf/neighborbinding
sisfStaticBinding	sys/sisf/neighborbinding/bindingip-{v6Addr}-bindingvlan-{vlanID}

sisfStaticBinding Properties

Property Name	Data Type	Description	Values
interface	nw:IfId (base:IfIndex)	Configure interface of static binding entry	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
mac	address:MAC	Configure mac address of static binding entry	Value must match MM:MM:MM:SS:SS:SS format
reachableLifetimer	sisf:ReachableLifetimerBinding (scalar:Sint32)	Configure reachable-lifetimer of static binding entry	RANGE: [-1 , 86400] DEFAULT: 0
retryInterval	sisf:RetryIntervalBinding (scalar:Sint16)	Configure retry interfval between two probings of static binding entry	RANGE: [0 , 3600] DEFAULT: 0
tracking	sisf:NonGlobalTracking (scalar:Enum8)	Configure tracking option of static binding entry	SELECTION: 0 - default 1 - disable 2 - enable DEFAULT: default
v6Addr	address:IPv6	Configure IPv6 address of static binding entry	Value must match ipv6 format
vlanID	sisf:VlanID (scalar:Uint16)	Configure Vlan ID of static binding entry	RANGE: [1 , 4096]

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 Maximum Number of Entries for an IPv6 Snooping Binding Table

CLI Commands

ipv6 neighbor binding max-entries 123 vlan-limit 123 port-limit 123 mac-limit 123

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
MacLimit	sisf:macLimit (scalar:Uint32)	Define maximum number of entries allowed per mac	RANGE: [0 , 100000] DEFAULT: 0
MaxEntries	sisf:maxEntries (scalar:Uint32)	Define maximum number of entries in the IPv6 snoopiong binding table	RANGE: [0 , 1000000] DEFAULT: 0
PortLimit	sisf:portLimit (scalar:Uint32)	Define maximum number of entries allowed per port	RANGE: [0 , 100000] DEFAULT: 0
VlanLimit	sisf:vlanLimit (scalar:Uint32)	Define maximum number of entries allowed per vlan	RANGE: [0 , 200000] DEFAULT: 0

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 Configuration of the Maximum Number of Entries for an IPv6 Snooping Binding Table

CLI Commands

no ipv6 neighbor binding max-entries 123 vlan-limit 123 port-limit 123 mac-limit 123

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
MacLimit	sisf:macLimit (scalar:Uint32)	Define maximum number of entries allowed per mac	RANGE: [0 , 100000] DEFAULT: 0
MaxEntries	sisf:maxEntries (scalar:Uint32)	Define maximum number of entries in the IPv6 snoopiong binding table	RANGE: [0 , 1000000] DEFAULT: 0
PortLimit	sisf:portLimit (scalar:Uint32)	Define maximum number of entries allowed per port	RANGE: [0 , 100000] DEFAULT: 0
VlanLimit	sisf:vlanLimit (scalar:Uint32)	Define maximum number of entries allowed per vlan	RANGE: [0 , 200000] DEFAULT: 0

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 Syslog Logging of Binding Table Events

CLI Commands

ipv6 neighbor binding logging

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
logging	scalar:Bool	Enable syslog logging of IPv6 snooping binding table events	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

Disabling the Syslog Logging of Binding Table Events

CLI Commands

no ipv6 neighbor binding logging

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

MO	DN
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
logging	scalar:Bool	Enable syslog logging of IPv6 snooping binding table events	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 the Interval Time Between Two Probings

Tracks entries in the binding table.

CLI Commands

ipv6 neighbor tracking retry-interval 123

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

MO	DN
topSystem	sys
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
retryInterval	sisf:retryInterval (scalar:Uint16)	Configure interval time between two probings	RANGE: [1 , 3600] DEFAULT: 1
tracking	scalar:Bool	Configure IPv6 snooping tracking for static binding entry	SELECTION: true or false DEFAULT: 0

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

Disabling the Interval Time Between Two Probings

CLI Commands

no ipv6 neighbor tracking retry-interval 123

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

MO	DN
topSystem	sys
sisfEntity	sys/sisf
sisfInstBinding	sys/sisf/neighborbinding

sisfInstBinding Properties

Property Name	Data Type	Description	Values
retryInterval	sisf:retryInterval (scalar:Uint16)	Configure interval time between two probings	RANGE: [1 , 3600] DEFAULT: 1
tracking	scalar:Bool	Configure IPv6 snooping tracking for static binding entry	SELECTION: true or false DEFAULT: 0

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