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": [
            {
              "slaHttp": {
                "attributes": {
                  "cache": "yes",
                  "frequency": "597709",
                  "httpmethod": "get",
                  "httpurl": "http://www.cisco.com"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <http-items>
              <cache>true</cache>
              <frequency>597709</frequency>
              <httpmethod>get</httpmethod>
              <httpurl>http://www.cisco.com</httpurl>
            </http-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

Configuring an HTTP 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
http get http://www.cisco.com
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
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

The following table contains information about the slaHttp 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
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
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
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
default frequency

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
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
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
no frequency 597709

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
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
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
owner SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
owner	string:Basic	Owner string of the probe(Max size 127)	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
http get http://www.cisco.com
default owner

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
owner	string:Basic	Owner string of the probe(Max size 127)	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
http get http://www.cisco.com
no owner SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
owner	string:Basic	Owner string of the probe(Max size 127)	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
http get http://www.cisco.com
default tag

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
tag	string:Basic	User defined tag string (Max Size 127)	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
http get http://www.cisco.com
tag SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
tag	string:Basic	User defined tag string (Max Size 127)	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
http get http://www.cisco.com
no tag SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
tag	string:Basic	User defined tag string (Max Size 127)	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
http get http://www.cisco.com
threshold 10734

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
default threshold

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
no threshold 10734

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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 Type of Service

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

CLI Commands

ip sla 1
http get http://www.cisco.com
tos 130

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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 Type of Service

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

CLI Commands

ip sla 1
http get http://www.cisco.com
default tos

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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 Type of Service

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

CLI Commands

ip sla 1
http get http://www.cisco.com
no tos 130

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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 Traffic Class

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

CLI Commands

ip sla 1
http get http://www.cisco.com
traffic-class 68

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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 Traffic Class

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

CLI Commands

ip sla 1
http get http://www.cisco.com
default traffic-class

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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 Traffic Class

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

CLI Commands

ip sla 1
http get http://www.cisco.com
no traffic-class 68

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	A sequence of characters
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	RANGE: [0, 4294967295]

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
http get http://www.cisco.com
timeout 477429727

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

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-{id}
slaHttp	sys/sla/inst/sender/operation-{id}/http

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]

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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: 60000

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
http get http://www.cisco.com
default timeout

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
no timeout 477429727

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

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-{id}
slaHttp	sys/sla/inst/sender/operation-{id}/http

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]

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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: 60000

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
http get http://www.cisco.com
vrf SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
default vrf

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
no vrf SampleString_123

MO	DN
slaHttp	sys/sla/inst/sender/operation-1/http
slaProbe	sys/sla/inst/sender/operation-1

slaHttp Properties

Property Name	Data Type	Description	Values
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
history buckets-kept 18

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
slaHttp	sys/sla/inst/sender/operation-1/http

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]

slaHttp 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
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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
http get http://www.cisco.com
no history buckets-kept 18

Verifying a DME Configuration

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-1
slaHttp	sys/sla/inst/sender/operation-1/http

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]

slaHttp 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
cache	scalar:Bool	The config to enable/disable the download of cached HTTP page.	SELECTION: true or false DEFAULT: true
httpmethod	sla:HttpMethodVal (scalar:Enum8)	HTTP method - Currently only the get method is supported.For GET requests,IP SLAs will format the request based on the specified http URL.	SELECTION: 1 - get DEFAULT: get
httpurl	string:Basic	URL string, expecting the input as http:[[//location[:port\]\]/directory\]/filename	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