Configuring an IP SLA Group Schedule

Configuring the Start Time After a Certain Amount of Time from the Present

Configuring the Start Time After a Certain Amount of Time from the Present

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "ageOut": "1633369",
            "frequency": "74276",
            "grpSchedulerId": "1",
            "life": "1625150179",
            "modifyGrpSchedule": "create",
            "probeList": "SampleString_123",
            "schedulePeriod": "74276",
            "startProbe": "After",
            "startTime": "1:10:0"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <ageOut>1633369</ageOut>
            <frequency>74276</frequency>
            <life>1625150179</life>
            <modifyGrpSchedule>create</modifyGrpSchedule>
            <probeList>SampleString_123</probeList>
            <schedulePeriod>74276</schedulePeriod>
            <startProbe>After</startProbe>
            <startTime>1:10:0</startTime>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time after 1:10


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep the probes, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
frequencysla:Frequency
(scalar:Uint32)		Group operation frequency (in seconds) using which the probes are scheduled.
RANGE: [0 , 604800]
DEFAULT: 0
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
lifescalar:Uint32
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters
schedulePeriodscalar:Uint32
Group schedule period in seconds, This is the time period in which the group of the probes configured in probeList are scheduled at an equal gap between them.
RANGE: [0 , 604800]
DEFAULT: 0
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending
startTimestring:Basic
When to start this probe on a given day and month in Hour(s):Minute(s):Second(s) i.e in (H:M:S) format. This property is applicable only when the startProbe proeprty is set as At or After.A sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting the Start Time After a Certain Amount of Time from the Present

Deleting the Start Time After a Certain Amount of Time from the Present

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time after 1:10


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring the Start Time as Now

Configuring the Start Time as Now

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "ageOut": "1633369",
            "frequency": "74276",
            "grpSchedulerId": "1",
            "life": "1625150179",
            "modifyGrpSchedule": "create",
            "probeList": "SampleString_123",
            "schedulePeriod": "74276",
            "startProbe": "Now"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <ageOut>1633369</ageOut>
            <frequency>74276</frequency>
            <life>1625150179</life>
            <modifyGrpSchedule>create</modifyGrpSchedule>
            <probeList>SampleString_123</probeList>
            <schedulePeriod>74276</schedulePeriod>
            <startProbe>Now</startProbe>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time now


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep the probes, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
frequencysla:Frequency
(scalar:Uint32)		Group operation frequency (in seconds) using which the probes are scheduled.
RANGE: [0 , 604800]
DEFAULT: 0
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
lifescalar:Uint32
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters
schedulePeriodscalar:Uint32
Group schedule period in seconds, This is the time period in which the group of the probes configured in probeList are scheduled at an equal gap between them.
RANGE: [0 , 604800]
DEFAULT: 0
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending


Related Documentation

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

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

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

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

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

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

Deleting the Start Time as Now

Deleting the Start Time as Now

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time now


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring the Start Time as Pending

Configuring the Start Time as Pending

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "ageOut": "1633369",
            "frequency": "74276",
            "grpSchedulerId": "1",
            "life": "1625150179",
            "modifyGrpSchedule": "create",
            "probeList": "SampleString_123",
            "schedulePeriod": "74276",
            "startProbe": "Pending"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <ageOut>1633369</ageOut>
            <frequency>74276</frequency>
            <life>1625150179</life>
            <modifyGrpSchedule>create</modifyGrpSchedule>
            <probeList>SampleString_123</probeList>
            <schedulePeriod>74276</schedulePeriod>
            <startProbe>Pending</startProbe>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time pending


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep the probes, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
frequencysla:Frequency
(scalar:Uint32)		Group operation frequency (in seconds) using which the probes are scheduled.
RANGE: [0 , 604800]
DEFAULT: 0
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
lifescalar:Uint32
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters
schedulePeriodscalar:Uint32
Group schedule period in seconds, This is the time period in which the group of the probes configured in probeList are scheduled at an equal gap between them.
RANGE: [0 , 604800]
DEFAULT: 0
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending


Related Documentation

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

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

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

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

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

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

Deleting the Start Time as Pending

Deleting the Start Time as Pending

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time pending


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring the Length of Time to Exectute in Seconds

Configuring the Length of Time to Exectute in Seconds 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "ageOut": "1633369",
            "dayOfTheMonth": "26",
            "frequency": "74276",
            "grpSchedulerId": "1",
            "life": "1625150179",
            "modifyGrpSchedule": "create",
            "month": "April",
            "probeList": "SampleString_123",
            "schedulePeriod": "74276",
            "startProbe": "At",
            "startTime": "1:10:0"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <ageOut>1633369</ageOut>
            <dayOfTheMonth>26</dayOfTheMonth>
            <frequency>74276</frequency>
            <life>1625150179</life>
            <modifyGrpSchedule>create</modifyGrpSchedule>
            <month>April</month>
            <probeList>SampleString_123</probeList>
            <schedulePeriod>74276</schedulePeriod>
            <startProbe>At</startProbe>
            <startTime>1:10:0</startTime>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 start-time 1:10 April 26 life 1625150179


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep the probes, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
dayOfTheMonthscalar:Uint16
At which day of the configured month, the probe is to be started.Setting the value as zero means current day of the time. This property is applicable only when the startProbe proeprty is set as At
RANGE: [0 , 31]
DEFAULT: 0
frequencysla:Frequency
(scalar:Uint32)		Group operation frequency (in seconds) using which the probes are scheduled.
RANGE: [0 , 604800]
DEFAULT: 0
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
lifescalar:Uint32
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
monthscalar:Enum8
At which month, the probe is to be started. This property is applicable only when the startProbe proeprty is set as At
DEFAULT: None
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters
schedulePeriodscalar:Uint32
Group schedule period in seconds, This is the time period in which the group of the probes configured in probeList are scheduled at an equal gap between them.
RANGE: [0 , 604800]
DEFAULT: 0
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending
startTimestring:Basic
When to start this probe on a given day and month in Hour(s):Minute(s):Second(s) i.e in (H:M:S) format. This property is applicable only when the startProbe proeprty is set as At or After.A sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting the Length of Time to Exectute in Seconds

Deleting the Length of Time to Exectute in Seconds 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 start-time 1:10 April 26 life 1625150179


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring the SLA Group Schedule to Run Forever

Configuring the SLA Group Schedule to Run Forever

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "ageOut": "1633369",
            "dayOfTheMonth": "26",
            "frequency": "74276",
            "grpSchedulerId": "1",
            "life": "2147483647",
            "modifyGrpSchedule": "create",
            "month": "September",
            "probeList": "SampleString_123",
            "schedulePeriod": "74276",
            "startProbe": "At",
            "startTime": "1:10:0"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <ageOut>1633369</ageOut>
            <dayOfTheMonth>26</dayOfTheMonth>
            <frequency>74276</frequency>
            <life>2147483647</life>
            <modifyGrpSchedule>create</modifyGrpSchedule>
            <month>September</month>
            <probeList>SampleString_123</probeList>
            <schedulePeriod>74276</schedulePeriod>
            <startProbe>At</startProbe>
            <startTime>1:10:0</startTime>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 start-time 1:10 September 26 life forever


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep the probes, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
dayOfTheMonthscalar:Uint16
At which day of the configured month, the probe is to be started.Setting the value as zero means current day of the time. This property is applicable only when the startProbe proeprty is set as At
RANGE: [0 , 31]
DEFAULT: 0
frequencysla:Frequency
(scalar:Uint32)		Group operation frequency (in seconds) using which the probes are scheduled.
RANGE: [0 , 604800]
DEFAULT: 0
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
lifescalar:Uint32
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
monthscalar:Enum8
At which month, the probe is to be started. This property is applicable only when the startProbe proeprty is set as At
DEFAULT: None
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters
schedulePeriodscalar:Uint32
Group schedule period in seconds, This is the time period in which the group of the probes configured in probeList are scheduled at an equal gap between them.
RANGE: [0 , 604800]
DEFAULT: 0
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending
startTimestring:Basic
When to start this probe on a given day and month in Hour(s):Minute(s):Second(s) i.e in (H:M:S) format. This property is applicable only when the startProbe proeprty is set as At or After.A sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting the SLA Group Schedule to Run Forever

Deleting the SLA Group Schedule to Run Forever

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 start-time 1:10 September 26 life forever


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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring Add Probes to Existing Group

Configuring Add Probes to Existing Group

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "modifyGrpSchedule": "add",
            "probeList": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <modifyGrpSchedule>add</modifyGrpSchedule>
            <probeList>SampleString_123</probeList>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 add 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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting Add Probes to Existing Group

Deleting Add Probes to Existing Group

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 add 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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring Probe Deletion From Existing Group

Configuring Probe Deletion From Existing Group

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "modifyGrpSchedule": "delete",
            "probeList": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list>
            <grpSchedulerId>1</grpSchedulerId>
            <modifyGrpSchedule>delete</modifyGrpSchedule>
            <probeList>SampleString_123</probeList>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 delete 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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
modifyGrpSchedulescalar:Enum8
modify the existing group schedule
DEFAULT: create
probeListstring:Basic
Multiple probe ID's to be group scheduled, List of one or more identification(ID) numbers of the IP SLAs operations to be included in a new multioperation schedule. (Max up to 125 characters). Indicate ranges of operation ID numbers with a hyphen. Individual ID numbers and ranges of ID numbers are delimited by a comma. For example, enter a list of operation ID numbers in any of the following ways: x-y,a-b,c-f or x,y,a,b,c,f or x-y,a,b,c-fA sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting Probe Deletion From Existing Group

Deleting Probe Deletion From Existing Group

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaGrpScheduler": {
          "attributes": {
            "grpSchedulerId": "1",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <groupschedule-items>
          <GrpScheduler-list nc:operation="delete">
            <grpSchedulerId>1</grpSchedulerId>
          </GrpScheduler-list>
        </groupschedule-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 group schedule 1 delete 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.

MODN
slaGrpScheduler sys/sla/inst/sender/groupschedule-1
slaSender sys/sla/inst/sender


slaGrpScheduler Properties

The following table contains information about the slaGrpScheduler 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 NameData TypeDescriptionValues
grpSchedulerIdscalar:Uint32
Group scheduler index
RANGE: [1 , 65535]
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring a Probe to be Scheduled Automatically Every Day

Configuring a Probe to be Scheduled Automatically Every Day 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaScheduler": {
                "attributes": {
                  "ageOut": "1458636",
                  "dayOfTheMonth": "25",
                  "life": "1213158206",
                  "month": "April",
                  "recurring": "yes",
                  "startProbe": "At",
                  "startTime": "SampleString_123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <schedule-items>
              <ageOut>1458636</ageOut>
              <dayOfTheMonth>25</dayOfTheMonth>
              <life>1213158206</life>
              <month>April</month>
              <recurring>true</recurring>
              <startProbe>At</startProbe>
              <startTime>SampleString_123</startTime>
            </schedule-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 schedule 1 life 1213158206 start-time SampleString_123 April 25 recurring ageout 1458636


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaScheduler sys/sla/inst/sender/operation-1/schedule
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 NameData TypeDescriptionValues
idscalar: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]


slaScheduler Properties

The following table contains information about the slaScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep this probe, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
dayOfTheMonthscalar:Uint16
At which day of the configured month, the probe is to be started.Setting the value as zero means current day of the time. This property is applicable only when the startProbe proeprty is set as At
RANGE: [0 , 31]
DEFAULT: 0
lifescalar:Uint64
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
monthscalar:Enum8
At which month, the probe is to be started. This property is applicable only when the startProbe proeprty is set as At
DEFAULT: None
recurringscalar:Bool
Probe to be scheduled automatically every daySELECTION: true or false
DEFAULT: false
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending
startTimestring:Basic
When to start this probe on a given day and month in Hour(s):Minute(s):Second(s) i.e in (H:M:S) format. This property is applicable only when the startProbe proeprty is set as At or After.A sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting a Probe to be Scheduled Automatically Every Day

Deleting a Probe to be Scheduled Automatically Every Day 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaScheduler": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <schedule-items nc:operation="delete">
            </schedule-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 schedule 1 life 1213158206 start-time SampleString_123 April 25 recurring ageout 1458636


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaScheduler sys/sla/inst/sender/operation-1/schedule
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 NameData TypeDescriptionValues
idscalar: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]


slaScheduler Properties

The following table contains information about the slaScheduler 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 NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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

Configuring How long to Keep this Entry When Inactive

Configuring How long to Keep this Entry When Inactive 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaScheduler": {
                "attributes": {
                  "ageOut": "1458636",
                  "dayOfTheMonth": "25",
                  "life": "1213158206",
                  "month": "July",
                  "recurring": "yes",
                  "startProbe": "At",
                  "startTime": "SampleString_123"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <schedule-items>
              <ageOut>1458636</ageOut>
              <dayOfTheMonth>25</dayOfTheMonth>
              <life>1213158206</life>
              <month>July</month>
              <recurring>true</recurring>
              <startProbe>At</startProbe>
              <startTime>SampleString_123</startTime>
            </schedule-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 schedule 1 life 1213158206 start-time SampleString_123 July 25 recurring ageout 1458636


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaScheduler sys/sla/inst/sender/operation-1/schedule
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 NameData TypeDescriptionValues
idscalar: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]


slaScheduler Properties

The following table contains information about the slaScheduler 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 NameData TypeDescriptionValues
ageOutscalar:Uint32
How long to keep this probe, when inactive (in seconds)
RANGE: [0 , 2073600]
DEFAULT: 0
dayOfTheMonthscalar:Uint16
At which day of the configured month, the probe is to be started.Setting the value as zero means current day of the time. This property is applicable only when the startProbe proeprty is set as At
RANGE: [0 , 31]
DEFAULT: 0
lifescalar:Uint64
Length of time to execute in seconds
RANGE: [0 , 2147483647]
DEFAULT: 3600
monthscalar:Enum8
At which month, the probe is to be started. This property is applicable only when the startProbe proeprty is set as At
DEFAULT: None
recurringscalar:Bool
Probe to be scheduled automatically every daySELECTION: true or false
DEFAULT: false
startProbescalar:Enum8
When the probe is to be started
DEFAULT: Pending
startTimestring:Basic
When to start this probe on a given day and month in Hour(s):Minute(s):Second(s) i.e in (H:M:S) format. This property is applicable only when the startProbe proeprty is set as At or After.A sequence of characters


Related Documentation

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

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

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

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

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

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

Deleting How long to Keep this Entry When Inactive

Deleting How long to Keep this Entry When Inactive 

POST http://<mgmt0_IP>/api/mo/sys/sla/inst/sender.json

{
  "slaSender": {
    "children": [
      {
        "slaProbe": {
          "attributes": {
            "id": "1"
          },
          "children": [
            {
              "slaScheduler": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <sla-items>
    <inst-items>
      <sender-items>
        <operation-items>
          <Probe-list>
            <id>1</id>
            <schedule-items nc:operation="delete">
            </schedule-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 schedule 1 life 1213158206 start-time SampleString_123 July 25 recurring ageout 1458636


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.

MODN
slaProbe sys/sla/inst/sender/operation-1
slaScheduler sys/sla/inst/sender/operation-1/schedule
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 NameData TypeDescriptionValues
idscalar: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]


slaScheduler Properties

The following table contains information about the slaScheduler 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 NameData TypeDescriptionValues
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

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

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

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

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

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

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