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

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaTcpConnect": {
                "attributes": {
                  "control": "no",
                  "destip": "1.2.3.4",
                  "dstPort": "47131",
                  "srcHostName": "SampleString_123",
                  "srcPort": "47131"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <tcpconnect-items>
              <control>false</control>
              <destip>1.2.3.4</destip>
              <dstPort>47131</dstPort>
              <srcHostName>SampleString_123</srcHostName>
              <srcPort>47131</srcPort>
            </tcpconnect-items>
          </Probe-list>
        </operation-items>
      </sender-items>
    </inst-items>
  </sla-items>
</System>

Configuring a TCP-Connect Operation

Configuring to Disable Control Packets Exchange

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
tcp-connect 1.2.3.4 47131 source-port 47131 source-ip SampleString_123 control disable

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect
slaSender	sys/sla/inst/sender

slaProbe Properties

The following table contains information about the slaProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property 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]

slaTcpConnect Properties

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

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Disable Control Packets Exchange

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

CLI Commands

ip sla 1
no tcp-connect 1.2.3.4 47131 source-port 47131 source-ip SampleString_123 control disable

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect
slaSender	sys/sla/inst/sender

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destHostName	string:Basic	Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.	A sequence of characters
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
srcHostName	string:Basic	Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.	A sequence of characters
srcPort	scalar:Uint32	Source TCP Port configuration for TCP probe, if the srcPort is not configured then the random source port will be used.	RANGE: [0, 4294967295]
srcip	address:Ip	Source\\\\\\`IP address from which the configured destination is tracked by the probe. Modifying this property is not allowed.	Value must match ipv4 or ipv6 known format

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Close-Connection Fin

Note: This example was added in Release 10.4(2).

CLI Commands

{{no | default} close-connection fin | close-connection fin}

Verifying a DME Configuration

MO	DN
slaTcpCloseConnect	sys/sla/inst/sender/operation-1/tcpconnect.closeConnection

tcpconnect.closeConnection Properties

Property Name	Data Type	Description	Values
closeConnection	scalar:Bool	Closes the TCP connection with FIN instead of RST flag.	SELECTION: true or false DEFAULT: false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Enable Control packets Exchange

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

CLI Commands

ip sla 1
tcp-connect 1.2.3.4 47131 source-port 47131 source-ip SampleString_123 control enable

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect
slaSender	sys/sla/inst/sender

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
srcHostName	string:Basic	Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.	A sequence of characters
srcPort	scalar:Uint32	Source TCP Port configuration for TCP probe, if the srcPort is not configured then the random source port will be used.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Enable Control Packets Exchange

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

CLI Commands

ip sla 1
no tcp-connect 1.2.3.4 47131 source-port 47131 source-ip SampleString_123 control enable

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect
slaSender	sys/sla/inst/sender

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destHostName	string:Basic	Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.	A sequence of characters
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
srcHostName	string:Basic	Source Host Name, if IP address is resolved from DNS server. Modifying this property is not allowed.	A sequence of characters
srcPort	scalar:Uint32	Source TCP Port configuration for TCP probe, if the srcPort is not configured then the random source port will be used.	RANGE: [0, 4294967295]
srcip	address:Ip	Source\\\\\\`IP address from which the configured destination is tracked by the probe. Modifying this property is not allowed.	Value must match ipv4 or ipv6 known format

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Destination Port

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
dest-port 18792

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

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Frequency in Seconds

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
frequency 597709

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
default frequency

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
no frequency 597709

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
owner SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Default Owner

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
default owner

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Owner of Entry

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
no owner SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
owner	string:Basic	Owner string of the probe(Max size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a User-Defined Tag

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
tag SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Default User-Defined Tag

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
default tag

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a User-Defined Tag

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
no tag SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
tag	string:Basic	User defined tag string (Max Size 127)	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Operation Threshold

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
threshold 10734

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
default threshold

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
no threshold 10734

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
timeout 477429727

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
default timeout

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
no timeout 477429727

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
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

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
tcp-connect 1.1.1.1 333
tos 130

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
default tos

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
no tos 130

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipTos	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
traffic-class 14

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
default traffic-class

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
no traffic-class 14

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
ipv6TrafficClass	scalar:Uint32	TOS if the probe is tracking IPv4 destination and Traffic Class if the probe is tracking IPv6 destination.	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
tcp-connect 1.1.1.1 333
vrf SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

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
tcp-connect 1.1.1.1 333
default vrf

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

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
tcp-connect 1.1.1.1 333
no vrf SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]
vrf	l3:VrfName (string:Basic)	vrf on which the probe is configured.	A sequence of characters DEFAULT: default

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 Destination IP Address

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
dest-ipaddr SampleString_123

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destHostName	string:Basic	Destination Host Name, if IP address is resolved from DNS server.Modifying this property is not allowed in case of icmp-echo probe.	A sequence of characters
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the IPv6 Destination Address

Configuring the Destination Address

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
dest-ipaddr 1:2::3:4

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect Properties

Property Name	Data Type	Description	Values
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Max Number of History Buckets to Collect

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
history buckets-kept 17

Verifying a DME Configuration

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect 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
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Max Number of History Buckets to Collect

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

CLI Commands

ip sla 1
tcp-connect 1.1.1.1 333
no history buckets-kept 17

Verifying a DME Configuration

MO	DN
slaSender	sys/sla/inst/sender
slaProbe	sys/sla/inst/sender/operation-1
slaTcpConnect	sys/sla/inst/sender/operation-1/tcpconnect

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]

slaTcpConnect 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
control	scalar:Bool	To turn on/off Control Packets Exchanging mechanism between the sender and the responder, control is enabled by default.	SELECTION: true or false DEFAULT: true
destip	address:Ip	Destination IP address which is tracked by the probe.This property is not applicable if the configured probe type is HTTP or DNS. Modifying this property is not allowed in case of icmp-echo probe.	Value must match ipv4 or ipv6 known format
dstPort	scalar:Uint32	Destination TCP Port configuration for the TCP probe, it is must to configure the destination port.	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html