Configuring a DNS Operation

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": [
            {
              "slaDns": {
                "attributes": {
                  "frequency": "597709",
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <frequency>597709</frequency>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "frequency": "60",
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <frequency>60</frequency>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "frequency": "60",
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <frequency>60</frequency>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "owner": "SampleString_123",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <owner>SampleString_123</owner>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
ownerstring:Basic
Owner string of the probe(Max size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "owner": "",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <owner></owner>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
ownerstring:Basic
Owner string of the probe(Max size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "owner": "",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <owner></owner>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
ownerstring:Basic
Owner string of the probe(Max size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "tag": "SampleString_123",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <tag>SampleString_123</tag>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
tagstring:Basic
User defined tag string (Max Size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "tag": "",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <tag></tag>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
tagstring:Basic
User defined tag string (Max Size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "tag": "",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <tag></tag>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
tagstring:Basic
User defined tag string (Max Size 127)A sequence of characters
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "threshold": "10734"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <threshold>10734</threshold>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "threshold": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <threshold>5000</threshold>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "threshold": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <threshold>5000</threshold>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "timeout": "477429727"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <timeout>477429727</timeout>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "timeout": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <timeout>5000</timeout>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "timeout": "5000"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <timeout>5000</timeout>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
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


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]


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 IP SLAs for a VPN Routing/Forwarding Instances

Configuring IP SLAs for a VPN Routing/Forwarding Instances
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "vrf": "SampleString_123"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <vrf>SampleString_123</vrf>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  vrf 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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
vrfl3:VrfName
(string:Basic)
vrf on which the probe is configured.A sequence of characters
DEFAULT: default


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]


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 IP SLAs for a VPN Routing/Forwarding instance

Configuring the Default IP SLAs for a VPN Routing/Forwarding instance
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "vrf": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <vrf>default</vrf>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  default vrf


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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
vrfl3:VrfName
(string:Basic)
vrf on which the probe is configured.A sequence of characters
DEFAULT: default


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]


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 IP SLAs for a VPN Routing/Forwarding Instances

Deleting IP SLAs for a VPN Routing/Forwarding Instances
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaDns": {
                "attributes": {
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com",
                  "vrf": "default"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
              <vrf>default</vrf>
            </dns-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
 dns www.cisco.com name-server 1.2.3.4
  no vrf 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
slaDns sys/sla/inst/sender/operation-1/dns
slaProbe sys/sla/inst/sender/operation-1


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.A sequence of characters
vrfl3:VrfName
(string:Basic)
vrf on which the probe is configured.A sequence of characters
DEFAULT: default


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]


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": [
            {
              "slaDns": {
                "attributes": {
                  "bucketsKept": "32",
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <bucketsKept>32</bucketsKept>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
  dns www.cisco.com name-server 1.2.3.4
   history buckets-kept 32


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
slaDns sys/sla/inst/sender/operation-1/dns


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]


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.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 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": [
            {
              "slaDns": {
                "attributes": {
                  "bucketsKept": "15",
                  "nameServerIp": "1.2.3.4",
                  "targetEntry": "www.cisco.com"
}}}]}}]}}
{
    imdata:[]
}
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <dns-items>
              <bucketsKept>15</bucketsKept>
              <nameServerIp>1.2.3.4</nameServerIp>
              <targetEntry>www.cisco.com</targetEntry>
            </dns-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
  dns www.cisco.com name-server 1.2.3.4
   no history buckets-kept 32


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
slaDns sys/sla/inst/sender/operation-1/dns


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]


slaDns Properties

The following table contains information about the slaDns 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
nameServerIpaddress:Ip
Name server IP address which is used to resolve the target host name or target host ip configured in the probe.This property is applicable only if the configured probe type is DNS.Value must match ipv4 or ipv6 known format
targetEntrystring:Basic
This property can be either Host name or IP address (IPv4 address format x.x.x.x),(no IPv6 support) for which the resolution happens either by name or by IP to name respectively, in the configured probe. This property is applicable only incase of DNS probe.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