Configuring IP SLAs
The Cisco NX-OS IP SLAs use active traffic monitoring--the generation of traffic in a continuous, reliable, and predictable manner--for measuring network performance. Cisco NX-OS IP SLAs send data across the network to measure performance between multiple network locations or across multiple network paths. It simulates network data and IP services and collects network performance information in real time. The information collected includes data about the response time, one-way latency, jitter (interpacket delay variance), packet loss, voice quality scoring, network resource availability, application performance, and server response time. Cisco NX-OS IP SLAs performs active monitoring by generating and analyzing traffic to measure performance either between Cisco NX-OS devices or from a Cisco NX-OS device to a remote IP device such as a network application server. Measurement statistics provided by the various Cisco NX-OS IP SLAs operations can be used for troubleshooting, problem analysis, and designing network topologies.
For more information, see the Cisco Nexus 9000 Series NX-OS IP SLAs Configuration Guide:
Enabling Responder Part of SLA
Enabling Responder Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaResponder": {
"attributes": {
"adminSt": "enabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slaresponder-items>
<adminSt>enabled</adminSt>
</slaresponder-items>
</fm-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.
feature sla responder
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 |
---|---|
fmEntity | sys/fm |
fmSlaResponder | sys/fm/slaresponder |
fmSlaResponder Properties
The following table contains information about the fmSlaResponder 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling Responder Part of SLA
Disabling Responder Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaResponder": {
"attributes": {
"adminSt": "disabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slaresponder-items>
<adminSt>disabled</adminSt>
</slaresponder-items>
</fm-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.
no feature sla responder
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 |
---|---|
fmEntity | sys/fm |
fmSlaResponder | sys/fm/slaresponder |
fmSlaResponder Properties
The following table contains information about the fmSlaResponder 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling Sender Part of SLA
Enabling Sender Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaSender": {
"attributes": {
"adminSt": "enabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slasender-items>
<adminSt>enabled</adminSt>
</slasender-items>
</fm-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.
feature sla sender
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 |
---|---|
fmEntity | sys/fm |
fmSlaSender | sys/fm/slasender |
fmSlaSender Properties
The following table contains information about the fmSlaSender 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling Sender Part of SLA
Disabling Sender Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaSender": {
"attributes": {
"adminSt": "disabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slasender-items>
<adminSt>disabled</adminSt>
</slasender-items>
</fm-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.
no feature sla sender
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 |
---|---|
fmEntity | sys/fm |
fmSlaSender | sys/fm/slasender |
fmSlaSender Properties
The following table contains information about the fmSlaSender 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Enabling Twamp-Server Part of SLA
Enabling Twamp-Server Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaTwampServer": {
"attributes": {
"adminSt": "enabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slatwampserver-items>
<adminSt>enabled</adminSt>
</slatwampserver-items>
</fm-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.
feature sla twamp-server
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 |
---|---|
fmEntity | sys/fm |
fmSlaTwampServer | sys/fm/slatwampserver |
fmSlaTwampServer Properties
The following table contains information about the fmSlaTwampServer 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Disabling Twamp-Server Part of SLA
Disabling Twamp-Server Part of SLA
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmSlaTwampServer": {
"attributes": {
"adminSt": "disabled"
}}}]}}
{
imdata:[]
}
<System>
<fm-items>
<slatwampserver-items>
<adminSt>disabled</adminSt>
</slatwampserver-items>
</fm-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.
no feature sla twamp-server
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 |
---|---|
fmEntity | sys/fm |
fmSlaTwampServer | sys/fm/slatwampserver |
fmSlaTwampServer Properties
The following table contains information about the fmSlaTwampServer 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 |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring IP SLAs Trigger Assignment
Configuring IP SLAs Trigger Assignment
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaReactionTrigger": {
"attributes": {
"targetProbe": "1"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<trigger-items>
<ReactionTrigger-list>
<targetProbe>1</targetProbe>
</ReactionTrigger-list>
</trigger-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 reaction-trigger 1 1
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 |
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] |
slaReactionTrigger Properties
The following table contains information about the slaReactionTrigger 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 |
---|---|---|---|
targetProbe | scalar:Uint32 | The target entry Number which will be triggered when the reactionType is configured as trapAndTrigger or triggerOnly. It is mandatory that this targetId probe should be configured prior to setting this property. | 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 IP SLAs Trigger Assignment
Deleting IP SLAs Trigger Assignment
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1"
},
"children": [
{
"slaReactionTrigger": {
"attributes": {
"status": "deleted",
"targetProbe": "1"
}}}]}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<trigger-items>
<ReactionTrigger-list xc:operation="delete">
<targetProbe>1</targetProbe>
</ReactionTrigger-list>
</trigger-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.
no ip sla reaction-trigger 1 1
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 |
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] |
slaReactionTrigger Properties
The following table contains information about the slaReactionTrigger 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 |
---|---|---|---|
status | mo:ModificationStatus (scalar:Bitmask32) | Modification status | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
targetProbe | scalar:Uint32 | The target entry Number which will be triggered when the reactionType is configured as trapAndTrigger or triggerOnly. It is mandatory that this targetId probe should be configured prior to setting this property. | 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:
Restarting an Active Entry
Restarting an Active Entry
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json
{
"slaSender": {
"children": [
{
"slaProbe": {
"attributes": {
"id": "1",
"restart": "yes"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<operation-items>
<Probe-list>
<id>1</id>
<restart>true</restart>
</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 restart 1
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 |
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] |
restart | scalar:Bool | Restarting a scheduled probe | SELECTION: true or false DEFAULT: false |
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 Syslog Traps
Configuring Syslog Traps
POST http://<mgmt0_IP>/api/mo/sys/sla/inst.json
{
"slaInst": {
"children": [
{
"slaSender": {
"attributes": {
"loggingTraps": "yes"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<loggingTraps>true</loggingTraps>
</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 logging traps
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 |
---|---|
slaInst | sys/sla/inst |
slaSender | sys/sla/inst/sender |
slaSender Properties
The following table contains information about the slaSender 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 |
---|---|---|---|
loggingTraps | scalar:Bool | Enable syslog traps which sends the trap meesages on reaction-config trap is enabled. | SELECTION: true or false |
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 Syslog Traps
Deleting Syslog Traps
POST http://<mgmt0_IP>/api/mo/sys/sla/inst.json
{
"slaInst": {
"children": [
{
"slaSender": {
"attributes": {
"loggingTraps": "no"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<loggingTraps>false</loggingTraps>
</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.
no ip sla logging traps
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 |
---|---|
slaInst | sys/sla/inst |
slaSender | sys/sla/inst/sender |
slaSender Properties
The following table contains information about the slaSender 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 |
---|---|---|---|
loggingTraps | scalar:Bool | Enable syslog traps which sends the trap meesages on reaction-config trap is enabled. | SELECTION: true or false |
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 Port on Which to Listen
Configuring the Port on Which to Listen
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaPermanentResponder": {
"attributes": {
"ipAddress": "1.2.3.4",
"port": "60353",
"protocol": "tcp"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<type-items>
<PermanentResponder-list>
<protocol>tcp</protocol>
<port>60353</port>
<ipAddress>1.2.3.4</ipAddress>
</PermanentResponder-list>
</type-items>
</responder-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 responder tcp-connect ipaddress 1.2.3.4 port 60353
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaPermanentResponder | sys/sla/inst/responder/type-tcp-port-60353-ip-[1.2.3.4] |
slaPermanentResponder Properties
The following table contains information about the slaPermanentResponder 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 |
---|---|---|---|
ipAddress | address:Ip | IP on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port and IP. If the user needs wild card IP address, then use 0.0.0.0(any IP) | Value must match ipv4 or ipv6 known format |
port | sla:PortNum (scalar:Uint16) | Port on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port. | RANGE: [1 , 65535] |
protocol | sla:RespProto (scalar:Enum8) | Responder protocol types supported types are udp-echo, tcp-connect | SELECTION: 1 - udp 2 - tcp DEFAULT: tcp |
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 Port on Which to Listen
Deleting the Port on Which to Listen
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaPermanentResponder": {
"attributes": {
"ipAddress": "1.2.3.4",
"port": "60353",
"protocol": "tcp",
"status": "deleted"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<type-items>
<PermanentResponder-list nc:operation="delete">
<protocol>tcp</protocol>
<port>60353</port>
<ipAddress>1.2.3.4</ipAddress>
</PermanentResponder-list>
</type-items>
</responder-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.
no ip sla responder tcp-connect ipaddress 1.2.3.4 port 60353
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaPermanentResponder | sys/sla/inst/responder/type-tcp-port-60353-ip-[1.2.3.4] |
slaPermanentResponder Properties
The following table contains information about the slaPermanentResponder 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 |
---|---|---|---|
ipAddress | address:Ip | IP on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port and IP. If the user needs wild card IP address, then use 0.0.0.0(any IP) | Value must match ipv4 or ipv6 known format |
port | sla:PortNum (scalar:Uint16) | Port on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port. | RANGE: [1 , 65535] |
protocol | sla:RespProto (scalar:Enum8) | Responder protocol types supported types are udp-echo, tcp-connect | SELECTION: 1 - udp 2 - tcp DEFAULT: tcp |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 Port on Which to Listen
Configuring the Port on Which to Listen
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaPermanentResponder": {
"attributes": {
"ipAddress": "1.2.3.4",
"port": "60353",
"protocol": "udp"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<type-items>
<PermanentResponder-list>
<protocol>udp</protocol>
<port>60353</port>
<ipAddress>1.2.3.4</ipAddress>
</PermanentResponder-list>
</type-items>
</responder-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 responder udp-echo ipaddress 1.2.3.4 port 60353
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaPermanentResponder | sys/sla/inst/responder/type-udp-port-60353-ip-[1.2.3.4] |
slaPermanentResponder Properties
The following table contains information about the slaPermanentResponder 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 |
---|---|---|---|
ipAddress | address:Ip | IP on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port and IP. If the user needs wild card IP address, then use 0.0.0.0(any IP) | Value must match ipv4 or ipv6 known format |
port | sla:PortNum (scalar:Uint16) | Port on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port. | RANGE: [1 , 65535] |
protocol | sla:RespProto (scalar:Enum8) | Responder protocol types supported types are udp-echo, tcp-connect | SELECTION: 1 - udp 2 - tcp DEFAULT: tcp |
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 Port on Which to Listen
Deleting the Port on Which to Listen
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaPermanentResponder": {
"attributes": {
"ipAddress": "1.2.3.4",
"port": "60353",
"protocol": "udp",
"status": "deleted"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<type-items>
<PermanentResponder-list nc:operation="delete">
<protocol>udp</protocol>
<port>60353</port>
<ipAddress>1.2.3.4</ipAddress>
</PermanentResponder-list>
</type-items>
</responder-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.
no ip sla responder udp-echo ipaddress 1.2.3.4 port 60353
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaPermanentResponder | sys/sla/inst/responder/type-udp-port-60353-ip-[1.2.3.4] |
slaPermanentResponder Properties
The following table contains information about the slaPermanentResponder 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 |
---|---|---|---|
ipAddress | address:Ip | IP on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port and IP. If the user needs wild card IP address, then use 0.0.0.0(any IP) | Value must match ipv4 or ipv6 known format |
port | sla:PortNum (scalar:Uint16) | Port on which the responder is listenening to receive the packets from the sender. This property is applicable only for TCP or UDP protocol. Required only if ip sla sender probe's control is disabled. Permanently enables the responder functionality on the specified port. | RANGE: [1 , 65535] |
protocol | sla:RespProto (scalar:Enum8) | Responder protocol types supported types are udp-echo, tcp-connect | SELECTION: 1 - udp 2 - tcp DEFAULT: tcp |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
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 TWAMP Responder
Configuring TWAMP Responder
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaTwampResponder": {
"attributes": {
"adminState": "yes"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<twampresponder-items>
<adminState>true</adminState>
</twampresponder-items>
</responder-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 responder twamp
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaTwampResponder | sys/sla/inst/responder/twampresponder |
slaTwampResponder Properties
The following table contains information about the slaTwampResponder 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 |
---|---|---|---|
adminState | scalar:Bool | Enable or disable the twamp responder. To enable twamp responder, feature sla responder is to be enabled | SELECTION: true or false DEFAULT: FALSE |
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 TWAMP Responder
Deleting TWAMP Responder
POST http://<mgmt0_IP>/api/mo/sys/sla/inst/responder.json
{
"slaResponder": {
"children": [
{
"slaTwampResponder": {
"attributes": {
"adminState": "no"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<responder-items>
<twampresponder-items>
<adminState>false</adminState>
</twampresponder-items>
</responder-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.
no ip sla responder twamp
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 |
---|---|
slaResponder | sys/sla/inst/responder |
slaTwampResponder | sys/sla/inst/responder/twampresponder |
slaTwampResponder Properties
The following table contains information about the slaTwampResponder 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 |
---|---|---|---|
adminState | scalar:Bool | Enable or disable the twamp responder. To enable twamp responder, feature sla responder is to be enabled | SELECTION: true or false DEFAULT: FALSE |
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 IPSLA IPPM TWAMP Server
Configuring IPSLA IPPM TWAMP Server
POST http://<mgmt0_IP>/api/mo/sys/sla/inst.json
{
"slaInst": {
"children": [
{
"slaTwampServer": {
"attributes": {
"adminState": "yes"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<twampserver-items>
<adminState>true</adminState>
</twampserver-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 server twamp
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 |
---|---|
slaInst | sys/sla/inst |
slaTwampServer | sys/sla/inst/twampserver |
slaTwampServer Properties
The following table contains information about the slaTwampServer 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 |
---|---|---|---|
adminState | scalar:Bool | Enable or disable the ip sla twamp server. To enable twamp-server, feature sla twamp-server is to be enabled | SELECTION: true or false DEFAULT: FALSE |
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 IPSLA IPPM TWAMP Server
Deleting IPSLA IPPM TWAMP Server
POST http://<mgmt0_IP>/api/mo/sys/sla/inst.json
{
"slaInst": {
"children": [
{
"slaTwampServer": {
"attributes": {
"adminState": "no"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<twampserver-items>
<adminState>false</adminState>
</twampserver-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.
no ip sla server twamp
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 |
---|---|
slaInst | sys/sla/inst |
slaTwampServer | sys/sla/inst/twampserver |
slaTwampServer Properties
The following table contains information about the slaTwampServer 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 |
---|---|---|---|
adminState | scalar:Bool | Enable or disable the ip sla twamp server. To enable twamp-server, feature sla twamp-server is to be enabled | SELECTION: true or false DEFAULT: FALSE |
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 SLA Reset
Configuring IP SLA Reset
POST http://<mgmt0_IP>/api/mo/sys/sla/inst.json
{
"slaInst": {
"children": [
{
"slaSender": {
"attributes": {
"resetSender": "yes"
}}}]}}
{
imdata:[]
}
<System>
<sla-items>
<inst-items>
<sender-items>
<resetSender>true</resetSender>
</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 reset
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 |
---|---|
slaInst | sys/sla/inst |
slaSender | sys/sla/inst/sender |
slaSender Properties
The following table contains information about the slaSender 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 |
---|---|---|---|
resetSender | scalar:Bool | Resets all sla probe related configuration. | SELECTION: true or false DEFAULT: false |
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: