Configuring a TCP-Connect Operation
Configuring to Disable Control Packets Exchange
Configuring to Disable Control Packets Exchange
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"
}}}]}}]}}
{
imdata:[]
}
<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>
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:
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:
Deleting Disable Control Packets Exchange
Deleting Disable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destHostName": "",
"destip": "0.0.0.0",
"dstPort": "0",
"srcHostName": "",
"srcPort": "0",
"srcip": "0.0.0.0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destHostName></destHostName>
<destip>0.0.0.0</destip>
<dstPort>0</dstPort>
<srcHostName></srcHostName>
<srcPort>0</srcPort>
<srcip>0.0.0.0</srcip>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
no 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 |
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:
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:
Configuring Enable Control packets Exchange
Configuring Enable Control packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.2.3.4",
"dstPort": "47131",
"srcHostName": "SampleString_123",
"srcPort": "47131"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</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>
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 enable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
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:
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:
Deleting Enable Control Packets Exchange
Deleting Enable Control Packets Exchange
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destHostName": "",
"destip": "0.0.0.0",
"dstPort": "0",
"srcHostName": "",
"srcPort": "0",
"srcip": "0.0.0.0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destHostName></destHostName>
<destip>0.0.0.0</destip>
<dstPort>0</dstPort>
<srcHostName></srcHostName>
<srcPort>0</srcPort>
<srcip>0.0.0.0</srcip>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
no tcp-connect 1.2.3.4 47131 source-port 47131 source-ip SampleString_123 control enable
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
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 |
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:
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:
Configuring the Destination Port
Configuring the Destination Port
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "18792"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>18792</dstPort>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
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
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] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Frequency in Seconds
Configuring the Frequency in Seconds
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"frequency": "597709"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<frequency>597709</frequency>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
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 |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default Frequency
Configuring the Default Frequency
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"frequency": "60"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<frequency>60</frequency>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default frequency
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting the Frequency in Seconds
Deleting the Frequency in Seconds
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"frequency": "60"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<frequency>60</frequency>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no frequency 597709
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Owner of Entry
Configuring the Owner of Entry
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"owner": "SampleString_123"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<owner>SampleString_123</owner>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
owner SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default Owner
Configuring the Default Owner
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"owner": ""
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<owner></owner>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default owner
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting the Owner of Entry
Deleting the Owner of Entry
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"owner": ""
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<owner></owner>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no owner SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring a User-Defined Tag
Configuring a User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"tag": "SampleString_123"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<tag>SampleString_123</tag>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
tag SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default User-Defined Tag
Configuring the Default User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"tag": ""
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<tag></tag>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default tag
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting a User-Defined Tag
Deleting a User-Defined Tag
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"tag": ""
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<tag></tag>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no tag SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Operation Threshold
Configuring the Operation Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"threshold": "10734"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<threshold>10734</threshold>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
threshold 10734
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default Threshold
Configuring the Default Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"threshold": "5000"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<threshold>5000</threshold>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default threshold
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting the Operation Threshold
Deleting the Operation Threshold
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"threshold": "5000"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<threshold>5000</threshold>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no threshold 10734
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Timeout of an Operation
Configuring the Timeout of an Operation
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"timeout": "477429727"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<timeout>477429727</timeout>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
timeout 477429727
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default Timeout
Configuring the Default Timeout
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"timeout": "60000"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<timeout>60000</timeout>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default timeout
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting the Timeout of an Operation
Deleting the Timeout of an Operation
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"timeout": "60000"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<timeout>60000</timeout>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no timeout 477429727
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Type of Service
Configuring the Type of Service
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipTos": "130"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipTos>130</ipTos>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
tos 130
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
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] |
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:
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:
Configuring the Default Type of Service
Configuring the Default Type of Service
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipTos": "0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipTos>0</ipTos>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default tos
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
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] |
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:
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:
Deleting the Type of Service
Deleting the Type of Service
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipTos": "0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipTos>0</ipTos>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no tos 130
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
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] |
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:
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:
Configuring the Traffic Class
Configuring the Traffic Class
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipv6TrafficClass": "14"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipv6TrafficClass>14</ipv6TrafficClass>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
traffic-class 14
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
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] |
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:
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:
Configuring the Default Traffic Class
Configuring the Default Traffic Class
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipv6TrafficClass": "0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipv6TrafficClass>0</ipv6TrafficClass>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default traffic-class
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
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] |
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:
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:
Deleting the Traffic Class
Deleting the Traffic Class
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"ipv6TrafficClass": "0"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<ipv6TrafficClass>0</ipv6TrafficClass>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no traffic-class 14
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
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] |
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:
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:
Configuring IP SLAs for a VPN Routing/Forwarding Instances
Configuring IP SLAs for a VPN Routing/Forwarding Instances
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"vrf": "SampleString_123"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<vrf>SampleString_123</vrf>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
vrf SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Default IP SLAs for a VPN Routing/Forwarding instance
Configuring the Default IP SLAs for a VPN Routing/Forwarding instance
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"vrf": "default"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<vrf>default</vrf>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
default vrf
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Deleting IP SLAs for a VPN Routing/Forwarding Instances
Deleting IP SLAs for a VPN Routing/Forwarding Instances
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333",
"vrf": "default"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
<vrf>default</vrf>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no vrf SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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] |
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:
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:
Configuring the Destination IP Address
Configuring the Destination IP Address
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destHostName": "SampleString_123",
"destip": "1.1.1.1",
"dstPort": "333"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destHostName>SampleString_123</destHostName>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
dest-ipaddr SampleString_123
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
slaProbe | sys/sla/inst/sender/operation-1 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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 |
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:
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:
Configuring the IPv6 Destination Address
Configuring the Destination Address
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"control": "yes",
"destip": "1:2::3:4",
"dstPort": "333"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<control>true</control>
<destip>1:2::3:4</destip>
<dstPort>333</dstPort>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
dest-ipaddr 1:2::3:4
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
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] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Max Number of History Buckets to Collect
Configuring the Max Number of History Buckets to Collect
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"bucketsKept": "17",
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<bucketsKept>17</bucketsKept>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
history buckets-kept 17
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 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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: [1 , 2147483647] |
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 |
---|---|---|---|
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:
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:
Deleting the Max Number of History Buckets to Collect
Deleting the Max Number of History Buckets to Collect
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaTcpConnect": {
"attributes": {
"bucketsKept": "15",
"control": "yes",
"destip": "1.1.1.1",
"dstPort": "333"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<tcpconnect-items>
<bucketsKept>15</bucketsKept>
<control>true</control>
<destip>1.1.1.1</destip>
<dstPort>333</dstPort>
</tcpconnect-items>
</Probe-list>
</operation-items>
</sender-items>
</inst-items>
</sla-items>
</System>
Note: This example was added in Release 9.3(3).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
ip sla 1
tcp-connect 1.1.1.1 333
no history buckets-kept 17
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 |
slaTcpConnect | sys/sla/inst/sender/operation-1/tcpconnect |
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: [1 , 2147483647] |
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 |
---|---|---|---|
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:
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: