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

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring UDF Names

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/pltfm/udf.json
{
  "platformUdfEntity": {
    "children": [
      {
        "platformUdf": {
          "attributes": {
            "name": "SampleString_123",
            "offsetBase": "inner-header-l4",
            "offsetLength": "2",
            "offsetPosition": "1"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <pltfm-items>
    <udf-items>
      <udf-items>
        <Udf-list>
          <name>SampleString_123</name>
          <offsetBase>inner-header-l4</offsetBase>
          <offsetLength>2</offsetLength>
          <offsetPosition>1</offsetPosition>
        </Udf-list>
      </udf-items>
    </udf-items>
  </pltfm-items>
</System>

Configuring User-Defined Fields

Configuring UDF Names

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

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

udf SampleString_123 header inner l4 1 2

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
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

The following table contains information about the platformUdf 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	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

Related Documentation

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
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

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 UDF Names

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

CLI Commands

no udf SampleString_123 header inner l4 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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 Offset Base From L3 Header

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

CLI Commands

udf SampleString_123 header outer l3 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

Related Documentation

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

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 Offset Base From L3 Header

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

CLI Commands

no udf SampleString_123 header outer l3 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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 Offset Base From L4 Header

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

CLI Commands

udf SampleString_123 header outer l4 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

Related Documentation

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

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 Offset Base From L4 Header

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

CLI Commands

no udf SampleString_123 header outer l4 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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 Offset Base From L2 Header

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

CLI Commands

udf SampleString_123 packet-start 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

Related Documentation

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
offsetBase	platform:UdfOffsetBase (scalar:Enum8)	Offset Base	SELECTION: 0 - packet-start 1 - outer-header-l3 2 - outer-header-l4 3 - inner-header-l3 4 - inner-header-l4 DEFAULT: packet-start
offsetLength	scalar:UByte	offsetLength 1-2	RANGE: [1 , 2]
offsetPosition	scalar:UByte	offsetPosition from base 0-127	RANGE: [0 , 127]

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 Offset Base From L2 Header

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

CLI Commands

no udf SampleString_123 packet-start 1 2

Verifying a DME Configuration

MO	DN
platformUdf	sys/pltfm/udf/udf-SampleString_123
platformUdfEntity	sys/pltfm/udf

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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

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

MO	DN
platformUdfEntity	sys/pltfm/udf
platformUdf	sys/pltfm/udf/udf-{name}

platformUdf Properties

Property Name	Data Type	Description	Values
name	string:Basic	Udf Name	RANGE: [1 , 16]
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