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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Frequency in Seconds

DME

YANG

Copy
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"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<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>

Configuring a DNS Operation

Configuring the Frequency in Seconds

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.

MO	DN
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 Name	Data Type	Description	Values
frequency	sla: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
nameServerIp	address: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
targetEntry	string: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 Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default frequency

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
frequency	sla: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
nameServerIp	address: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
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no frequency 597709

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
frequency	sla: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
nameServerIp	address: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
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
owner SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default owner

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no owner SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
tag SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default tag

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no tag SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters
targetEntry	string: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
threshold 10734

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
threshold	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default threshold

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
threshold	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no threshold 10734

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
threshold	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
timeout 477429727

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
timeout	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default timeout

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
timeout	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no timeout 477429727

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
timeout	sla: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

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
vrf SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
default vrf

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no vrf SampleString_123

MO	DN
slaDns	sys/sla/inst/sender/operation-1/dns
slaProbe	sys/sla/inst/sender/operation-1

slaDns Properties

Property Name	Data Type	Description	Values
nameServerIp	address: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
targetEntry	string: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
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar: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

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

CLI Commands

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.

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-1
slaDns	sys/sla/inst/sender/operation-1/dns

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar: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

Property Name	Data Type	Description	Values
bucketsKept	scalar:Uint32	Bucket size value - Maximum number of history buckets to collect	RANGE: [1 , 60] DEFAULT: 15
nameServerIp	address: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
targetEntry	string: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

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

CLI Commands

ip sla 1
dns www.cisco.com name-server 1.2.3.4
no history buckets-kept 32

Verifying a DME Configuration

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-1
slaDns	sys/sla/inst/sender/operation-1/dns

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar: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

Property Name	Data Type	Description	Values
bucketsKept	scalar:Uint32	Bucket size value - Maximum number of history buckets to collect	RANGE: [1 , 60] DEFAULT: 15
nameServerIp	address: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
targetEntry	string: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