Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring UDP Forwarding

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/dhcp/inst/udprelay.json
{
  "dhcpUdpRelay": {
    "children": [
      {
        "dhcpUdpRelayPort": {
          "attributes": {
            "port": "46618"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <dhcp-items>
    <inst-items>
      <udprelay-items>
        <port-items>
          <UdpRelayPort-list>
            <port>46618</port>
          </UdpRelayPort-list>
        </port-items>
      </udprelay-items>
    </inst-items>
  </dhcp-items>
</System>

Configuring UDP Relay

By default, routers do not forward broadcast packets. You must configure routers if you want to forward broadcast packets. You can use the UDP relay feature to relay broadcasts destined for UDP ports except DHCPv4 port numbers 67 and 68. The UDP relay feature is also known as the IP Helper feature.

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 UDP Forwarding

Note: This example was added in Release 9.3(5).

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.

ip forward-protocol udp 46618

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
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpRelayPort	sys/dhcp/inst/udprelay/port-46618

dhcpUdpRelayPort Properties

The following table contains information about the dhcpUdpRelayPort 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
port	dhcp:IpFwdProtoPortType (scalar:Uint16)	Enable/disable UDP forwarding for any udp port in the range 1-65535	RANGE: [1 , 65535] DEFAULT: 37

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 UDP Forwarding

Note: This example was added in Release 9.3(5).

CLI Commands

no ip forward-protocol udp 46618

Verifying a DME Configuration

MO	DN
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpRelayPort	sys/dhcp/inst/udprelay/port-46618

dhcpUdpRelayPort Properties

Property Name	Data Type	Description	Values
port	dhcp:IpFwdProtoPortType (scalar:Uint16)	Enable/disable UDP forwarding for any udp port in the range 1-65535	RANGE: [1 , 65535] DEFAULT: 37
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 UDP Forwarding (Using UDP Port Number)

Note: This example was added in Release 9.3(5).

CLI Commands

ip forward-protocol udp 54443

Verifying a DME Configuration

MO	DN
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpRelayPort	sys/dhcp/inst/udprelay/port-54443

dhcpUdpRelayPort Properties

Property Name	Data Type	Description	Values
port	dhcp:IpFwdProtoPortType (scalar:Uint16)	Enable/disable UDP forwarding for any udp port in the range 1-65535	RANGE: [1 , 65535] DEFAULT: 37

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 UDP Forwarding (Using UDP Port Number)

Note: This example was added in Release 9.3(5).

CLI Commands

no ip forward-protocol udp 54443

Verifying a DME Configuration

MO	DN
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpRelayPort	sys/dhcp/inst/udprelay/port-54443

dhcpUdpRelayPort Properties

Property Name	Data Type	Description	Values
port	dhcp:IpFwdProtoPortType (scalar:Uint16)	Enable/disable UDP forwarding for any udp port in the range 1-65535	RANGE: [1 , 65535] DEFAULT: 37
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 UDP Relay

Note: This example was added in Release 9.3(5).

CLI Commands

object-group udp relay ip address SampleString_123

Verifying a DME Configuration

MO	DN
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpObjectGroup	sys/dhcp/inst/udprelay/objgrp-SampleString_123

dhcpUdpObjectGroup Properties

The following table contains information about the dhcpUdpObjectGroup 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
objgrp	string:Basic	object-group name as a string	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 UDP Relay

Note: This example was added in Release 9.3(5).

CLI Commands

no object-group udp relay ip address SampleString_123

Verifying a DME Configuration

MO	DN
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpObjectGroup	sys/dhcp/inst/udprelay/objgrp-SampleString_123

dhcpUdpObjectGroup Properties

Property Name	Data Type	Description	Values
objgrp	string:Basic	object-group name as a string	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

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 UDP Relay IP Address Group

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
ip udp relay addrgroup SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
dhcpEntity	sys/dhcp
dhcpInst	sys/dhcp/inst
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpObjectGroup	sys/dhcp/inst/udprelay/objgrp-SampleString_123
dhcpUdpObjectGroupIf	sys/dhcp/inst/udprelay/objgrp-SampleString_123/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

dhcpUdpObjectGroup Properties

Property Name	Data Type	Description	Values
objgrp	string:Basic	object-group name as a string	A sequence of characters

dhcpUdpObjectGroupIf Properties

The following table contains information about the dhcpUdpObjectGroupIf 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)	Name of Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

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 UDP Relay IP Address Group

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
no ip udp relay addrgroup SampleString_123

Verifying a DME Configuration

MO	DN
topSystem	sys
dhcpEntity	sys/dhcp
dhcpInst	sys/dhcp/inst
dhcpUdpRelay	sys/dhcp/inst/udprelay
dhcpUdpObjectGroup	sys/dhcp/inst/udprelay/objgrp-SampleString_123
dhcpUdpObjectGroupIf	sys/dhcp/inst/udprelay/objgrp-SampleString_123/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

dhcpUdpObjectGroup Properties

Property Name	Data Type	Description	Values
objgrp	string:Basic	object-group name as a string	A sequence of characters

dhcpUdpObjectGroupIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Name of Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l1PhysIf Properties

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

Configuring UDP Forwarding for Subnet Broadcast

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
ip udp relay subnet-broadcast

Verifying a DME Configuration

MO	DN
topSystem	sys
dhcpEntity	sys/dhcp
dhcpInst	sys/dhcp/inst
dhcpUdpSubnetBroadcast	sys/dhcp/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

dhcpUdpSubnetBroadcast Properties

The following table contains information about the dhcpUdpSubnetBroadcast 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)	Name of Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

l1PhysIf Properties

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 UDP Forwarding for Subnet Broadcast

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
no ip udp relay subnet-broadcast

Verifying a DME Configuration

MO	DN
topSystem	sys
dhcpEntity	sys/dhcp
dhcpInst	sys/dhcp/inst
dhcpUdpSubnetBroadcast	sys/dhcp/inst/if-[eth1/2]
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

dhcpUdpSubnetBroadcast Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	Name of Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l1PhysIf Properties

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