Configuring a UDP-Echo Operation

Configuring the Data-Pattern

Configuring the Data-Pattern
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "dataPattern": "SampleString_123",
                  "destip": "1.1.1.1",
                  "dstPort": "123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <dataPattern>SampleString_123</dataPattern>
              <destip>1.1.1.1</destip>
              <dstPort>123</dstPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.1.1.1 123
  data-pattern SampleString_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.

MODN
slaSender sys/sla/inst/sender
slaProbe sys/sla/inst/sender/operation-{id}
slaUdpEcho sys/sla/inst/sender/operation-{id}/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.
RANGE: [1 , 2147483647]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
dataPatternstring:Basic
Specifies the hexadecimal data pattern in udp-echo probe to test for data corruption.A sequence of characters
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]


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 Data-Pattern

Deleting the Data-Pattern
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "dataPattern": "",
                  "destip": "1.1.1.1",
                  "dstPort": "123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <dataPattern></dataPattern>
              <destip>1.1.1.1</destip>
              <dstPort>123</dstPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.1.1.1 123
  no data-pattern SampleString_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.

MODN
slaSender sys/sla/inst/sender
slaProbe sys/sla/inst/sender/operation-{id}
slaUdpEcho sys/sla/inst/sender/operation-{id}/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.
RANGE: [1 , 2147483647]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
dataPatternstring:Basic
Specifies the hexadecimal data pattern in udp-echo probe to test for data corruption.A sequence of characters
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]


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 Frequency in Seconds

Configuring the Frequency in Seconds
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "frequency": "597709"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <frequency>597709</frequency>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  frequency 597709


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
frequencysla:Frequency
(scalar:Uint32)
Frequency of an operation - The interval at which the configured destination is tracked by the probe. Frequency in seconds(default value is 60). Minimum frequency value for an IP SLAs HTTP probe operation is 60 seconds but 1 second for other probes.
RANGE: [0 , 604800]
DEFAULT: 60


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 Default Frequency

Configuring the Default Frequency
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "frequency": "60"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <frequency>60</frequency>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  default frequency


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
frequencysla:Frequency
(scalar:Uint32)
Frequency of an operation - The interval at which the configured destination is tracked by the probe. Frequency in seconds(default value is 60). Minimum frequency value for an IP SLAs HTTP probe operation is 60 seconds but 1 second for other probes.
RANGE: [0 , 604800]
DEFAULT: 60


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 Frequency in Seconds

Deleting the Frequency in Seconds
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "frequency": "60"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <frequency>60</frequency>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  no frequency 597709


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
frequencysla:Frequency
(scalar:Uint32)
Frequency of an operation - The interval at which the configured destination is tracked by the probe. Frequency in seconds(default value is 60). Minimum frequency value for an IP SLAs HTTP probe operation is 60 seconds but 1 second for other probes.
RANGE: [0 , 604800]
DEFAULT: 60


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 Owner of Entry

Configuring the Owner of Entry
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "owner": "SampleString_123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <owner>SampleString_123</owner>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  owner SampleString_123


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
ownerstring:Basic
Owner string of the probe(Max size 127)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 Default Owner

Configuring the Default Owner
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "owner": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <owner></owner>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  default owner


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
ownerstring:Basic
Owner string of the probe(Max size 127)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 the Owner of Entry

Deleting the Owner of Entry
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "owner": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <owner></owner>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  no owner SampleString_123


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
ownerstring:Basic
Owner string of the probe(Max size 127)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 a User-Defined Tag

Configuring a User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "tag": "SampleString_123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <tag>SampleString_123</tag>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  tag SampleString_123


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
tagstring:Basic
User defined tag string (Max Size 127)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 Default User-Defined Tag

Configuring the Default User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "tag": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <tag></tag>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  default tag


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
tagstring:Basic
User defined tag string (Max Size 127)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 User-Defined Tag

Deleting a User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "tag": ""
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <tag></tag>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  no tag SampleString_123


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
tagstring:Basic
User defined tag string (Max Size 127)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 Operation Threshold

Configuring the Operation Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "threshold": "10734"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <threshold>10734</threshold>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  threshold 10734


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
thresholdsla:Threshold
(scalar:Uint32)
Operation threshold - this is an upper limit for the observed RTT for the probe. RTT value of a probe exceeding the configured threshold will be marked with Overthreshold return code.
RANGE: [1 , 60000]
DEFAULT: 5000


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 Default Threshold

Configuring the Default Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "threshold": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <threshold>5000</threshold>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  default threshold


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
thresholdsla:Threshold
(scalar:Uint32)
Operation threshold - this is an upper limit for the observed RTT for the probe. RTT value of a probe exceeding the configured threshold will be marked with Overthreshold return code.
RANGE: [1 , 60000]
DEFAULT: 5000


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 Operation Threshold

Deleting the Operation Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "threshold": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <threshold>5000</threshold>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  no threshold 10734


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
thresholdsla:Threshold
(scalar:Uint32)
Operation threshold - this is an upper limit for the observed RTT for the probe. RTT value of a probe exceeding the configured threshold will be marked with Overthreshold return code.
RANGE: [1 , 60000]
DEFAULT: 5000


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 Timeout of an Operation

Configuring the Timeout of an Operation
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "timeout": "477429727"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <timeout>477429727</timeout>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  timeout 477429727


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
timeoutsla:Timeout
(scalar:Uint32)
Timeout of an operation - this is the maximum wait time for completing the operation. The probe will be marked with Timeout return code.
RANGE: [0 , 604800000]
DEFAULT: 5000


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 Default Timeout

Configuring the Default Timeout
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "timeout": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <timeout>5000</timeout>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  default timeout


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
timeoutsla:Timeout
(scalar:Uint32)
Timeout of an operation - this is the maximum wait time for completing the operation. The probe will be marked with Timeout return code.
RANGE: [0 , 604800000]
DEFAULT: 5000


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 Timeout of an Operation

Deleting the Timeout of an Operation
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443",
                  "timeout": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
              <timeout>5000</timeout>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.2.3.4 4443
  no timeout 477429727


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
timeoutsla:Timeout
(scalar:Uint32)
Timeout of an operation - this is the maximum wait time for completing the operation. The probe will be marked with Timeout return code.
RANGE: [0 , 604800000]
DEFAULT: 5000


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 Data Verification

Configuring Data Verification
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.1.1.1",
                  "dstPort": "123",
                  "verifyData": "yes"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.1.1.1</destip>
              <dstPort>123</dstPort>
              <verifyData>true</verifyData>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.1.1.1 123
  verify-data


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
verifyDatascalar:Bool
Verify Data for Corruption. When data verification is enabled, each operation response is checked for corruption. Use the verify-data command with caution during normal operations because it generates unnecessary overhead.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 Default Data Verification

Configuring Default Data Verification
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.1.1.1",
                  "dstPort": "123",
                  "verifyData": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.1.1.1</destip>
              <dstPort>123</dstPort>
              <verifyData>false</verifyData>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.1.1.1 123
  default verify-data


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
verifyDatascalar:Bool
Verify Data for Corruption. When data verification is enabled, each operation response is checked for corruption. Use the verify-data command with caution during normal operations because it generates unnecessary overhead.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 Data Verification

Deleting Data Verification
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destip": "1.1.1.1",
                  "dstPort": "123",
                  "verifyData": "no"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destip>1.1.1.1</destip>
              <dstPort>123</dstPort>
              <verifyData>false</verifyData>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo 1.1.1.1 123
  no verify-data


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
verifyDatascalar:Bool
Verify Data for Corruption. When data verification is enabled, each operation response is checked for corruption. Use the verify-data command with caution during normal operations because it generates unnecessary overhead.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

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 Disable Control Packets Exchange

Configuring Disable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "no",
                  "destHostName": "SampleString_123",
                  "dstPort": "29787",
                  "srcHostName": "SampleString_123",
                  "srcPort": "29787"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>false</control>
              <destHostName>SampleString_123</destHostName>
              <dstPort>29787</dstPort>
              <srcHostName>SampleString_123</srcHostName>
              <srcPort>29787</srcPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo SampleString_123 29787 source-port 29787 source-ip SampleString_123 control disable


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho
slaSender sys/sla/inst/sender


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destHostNamestring:Basic
Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.A sequence of characters
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
srcHostNamestring:Basic
Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.A sequence of characters
srcPortscalar:Uint32
Source UDP Port configuration for udp echo probe and if the srcPort is not configured, then source port will be used.RANGE: [0, 4294967295]


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 Disable Control Packets Exchange

Deleting Disable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destHostName": "",
                  "destip": "0.0.0.0",
                  "dstPort": "0",
                  "srcHostName": "",
                  "srcPort": "0",
                  "srcip": "0.0.0.0"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destHostName></destHostName>
              <destip>0.0.0.0</destip>
              <dstPort>0</dstPort>
              <srcHostName></srcHostName>
              <srcPort>0</srcPort>
              <srcip>0.0.0.0</srcip>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 no udp-echo SampleString_123 29787 source-port 29787 source-ip SampleString_123 control disable


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho
slaSender sys/sla/inst/sender


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destHostNamestring:Basic
Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.A sequence of characters
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
srcHostNamestring:Basic
Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.A sequence of characters
srcPortscalar:Uint32
Source UDP Port configuration for udp echo probe and if the srcPort is not configured, then source port will be used.RANGE: [0, 4294967295]
srcipaddress:Ip
Source\\\\\\`IP address from which the configured destination is tracked by the probe. Modifying this property is not allowed.Value must match ipv4 or ipv6 known format


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 Enable Control Packets Exchange

Configuring Enable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destHostName": "SampleString_123",
                  "dstPort": "29787",
                  "srcHostName": "SampleString_123",
                  "srcPort": "29787"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destHostName>SampleString_123</destHostName>
              <dstPort>29787</dstPort>
              <srcHostName>SampleString_123</srcHostName>
              <srcPort>29787</srcPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 udp-echo SampleString_123 29787 source-port 29787 source-ip SampleString_123 control enable


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho
slaSender sys/sla/inst/sender


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destHostNamestring:Basic
Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.A sequence of characters
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
srcHostNamestring:Basic
Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.A sequence of characters
srcPortscalar:Uint32
Source UDP Port configuration for udp echo probe and if the srcPort is not configured, then source port will be used.RANGE: [0, 4294967295]


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 Enable Control Packets Exchange

Deleting Enable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "control": "yes",
                  "destHostName": "",
                  "destip": "0.0.0.0",
                  "dstPort": "0",
                  "srcHostName": "",
                  "srcPort": "0",
                  "srcip": "0.0.0.0"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <control>true</control>
              <destHostName></destHostName>
              <destip>0.0.0.0</destip>
              <dstPort>0</dstPort>
              <srcHostName></srcHostName>
              <srcPort>0</srcPort>
              <srcip>0.0.0.0</srcip>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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.

ip sla 1
 no udp-echo SampleString_123 29787 source-port 29787 source-ip SampleString_123 control enable


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho
slaSender sys/sla/inst/sender


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.RANGE: [0, 4294967295]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destHostNamestring:Basic
Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.A sequence of characters
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]
srcHostNamestring:Basic
Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.A sequence of characters
srcPortscalar:Uint32
Source UDP Port configuration for udp echo probe and if the srcPort is not configured, then source port will be used.RANGE: [0, 4294967295]
srcipaddress:Ip
Source\\\\\\`IP address from which the configured destination is tracked by the probe. Modifying this property is not allowed.Value must match ipv4 or ipv6 known format


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 Max Number of History Buckets to Collect

Configuring the Max Number of History Buckets to Collect 
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "bucketsKept": "56",
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <bucketsKept>56</bucketsKept>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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


CLI Commands

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

ip sla 1
  udp-echo 1.2.3.4 4443
   history buckets-kept 56


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.

MODN
slaSender sys/sla/inst/sender
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.
RANGE: [1 , 2147483647]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
bucketsKeptscalar:Uint32
Bucket size value - Maximum number of history buckets to collect
RANGE: [1 , 60]
DEFAULT: 15
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]


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 Max Number of History Buckets to Collect

Deleting the Max Number of History Buckets to Collect 
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaUdpEcho": {
                "attributes": {
                  "bucketsKept": "15",
                  "control": "yes",
                  "destip": "1.2.3.4",
                  "dstPort": "4443"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <udpecho-items>
              <bucketsKept>15</bucketsKept>
              <control>true</control>
              <destip>1.2.3.4</destip>
              <dstPort>4443</dstPort>
            </udpecho-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

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


CLI Commands

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

ip sla 1
  udp-echo 1.2.3.4 4443
   no history buckets-kept 56


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.

MODN
slaSender sys/sla/inst/sender
slaProbe sys/sla/inst/sender/operation-1
slaUdpEcho sys/sla/inst/sender/operation-1/udpecho


slaProbe Properties

The following table contains information about the slaProbe 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 NameData TypeDescriptionValues
idscalar:Uint32
Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.
RANGE: [1 , 2147483647]


slaUdpEcho Properties

The following table contains information about the slaUdpEcho 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 NameData TypeDescriptionValues
bucketsKeptscalar:Uint32
Bucket size value - Maximum number of history buckets to collect
RANGE: [1 , 60]
DEFAULT: 15
controlscalar:Bool
To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.SELECTION: true or false
DEFAULT: true
destipaddress:Ip
Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.Value must match ipv4 or ipv6 known format
dstPortscalar:Uint32
Destination UDP Port configuration for the UDP probe, it is must to configure the destination port.RANGE: [0, 4294967295]


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