Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

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

DME

YANG

Copy
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"
}}}]}}
Response
{
    imdata:[]
}

Copy
<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>

Configuring an IP SLA Group Schedule

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

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.

MO	DN
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 Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep the probes, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
frequency	sla:Frequency (scalar:Uint32)	Group operation frequency (in seconds) using which the probes are scheduled.	RANGE: [0 , 604800] DEFAULT: 0
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
life	scalar:Uint32	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
probeList	string: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-f	A sequence of characters
schedulePeriod	scalar: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
startProbe	scalar:Enum8	When the probe is to be started	DEFAULT: Pending
startTime	string: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

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

CLI Commands

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

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time now

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep the probes, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
frequency	sla:Frequency (scalar:Uint32)	Group operation frequency (in seconds) using which the probes are scheduled.	RANGE: [0 , 604800] DEFAULT: 0
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
life	scalar:Uint32	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
probeList	string: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-f	A sequence of characters
schedulePeriod	scalar: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
startProbe	scalar: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

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

CLI Commands

no ip sla group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time now

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time pending

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep the probes, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
frequency	sla:Frequency (scalar:Uint32)	Group operation frequency (in seconds) using which the probes are scheduled.	RANGE: [0 , 604800] DEFAULT: 0
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
life	scalar:Uint32	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
probeList	string: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-f	A sequence of characters
schedulePeriod	scalar: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
startProbe	scalar: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

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

CLI Commands

no ip sla group schedule 1 SampleString_123 schedule-period 74276 ageout 1633369 frequency 74276 life 1625150179 start-time pending

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

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

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep the probes, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
dayOfTheMonth	scalar: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
frequency	sla:Frequency (scalar:Uint32)	Group operation frequency (in seconds) using which the probes are scheduled.	RANGE: [0 , 604800] DEFAULT: 0
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
life	scalar:Uint32	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
month	scalar: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
probeList	string: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-f	A sequence of characters
schedulePeriod	scalar: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
startProbe	scalar:Enum8	When the probe is to be started	DEFAULT: Pending
startTime	string: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

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

CLI Commands

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

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

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

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep the probes, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
dayOfTheMonth	scalar: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
frequency	sla:Frequency (scalar:Uint32)	Group operation frequency (in seconds) using which the probes are scheduled.	RANGE: [0 , 604800] DEFAULT: 0
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
life	scalar:Uint32	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
month	scalar: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
probeList	string: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-f	A sequence of characters
schedulePeriod	scalar: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
startProbe	scalar:Enum8	When the probe is to be started	DEFAULT: Pending
startTime	string: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

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

CLI Commands

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

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla group schedule 1 add SampleString_123

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
probeList	string: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-f	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 Add Probes to Existing Group

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

CLI Commands

no ip sla group schedule 1 add SampleString_123

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla group schedule 1 delete SampleString_123

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
modifyGrpSchedule	scalar:Enum8	modify the existing group schedule	DEFAULT: create
probeList	string: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-f	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 Probe Deletion From Existing Group

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

CLI Commands

no ip sla group schedule 1 delete SampleString_123

Verifying a DME Configuration

MO	DN
slaGrpScheduler	sys/sla/inst/sender/groupschedule-1
slaSender	sys/sla/inst/sender

slaGrpScheduler Properties

Property Name	Data Type	Description	Values
grpSchedulerId	scalar:Uint32	Group scheduler index	RANGE: [1 , 65535]
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla schedule 1 life 1213158206 start-time SampleString_123 April 25 recurring ageout 1458636

Verifying a DME Configuration

MO	DN
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 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]

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 Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep this probe, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
dayOfTheMonth	scalar: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
life	scalar:Uint64	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
month	scalar: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
recurring	scalar:Bool	Probe to be scheduled automatically every day	SELECTION: true or false DEFAULT: false
startProbe	scalar:Enum8	When the probe is to be started	DEFAULT: Pending
startTime	string: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

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

CLI Commands

no ip sla schedule 1 life 1213158206 start-time SampleString_123 April 25 recurring ageout 1458636

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaScheduler	sys/sla/inst/sender/operation-1/schedule
slaSender	sys/sla/inst/sender

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar:Uint32	Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.	RANGE: [0, 4294967295]

slaScheduler Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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

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

CLI Commands

ip sla schedule 1 life 1213158206 start-time SampleString_123 July 25 recurring ageout 1458636

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaScheduler	sys/sla/inst/sender/operation-1/schedule
slaSender	sys/sla/inst/sender

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar:Uint32	Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.	RANGE: [0, 4294967295]

slaScheduler Properties

Property Name	Data Type	Description	Values
ageOut	scalar:Uint32	How long to keep this probe, when inactive (in seconds)	RANGE: [0 , 2073600] DEFAULT: 0
dayOfTheMonth	scalar: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
life	scalar:Uint64	Length of time to execute in seconds	RANGE: [0 , 2147483647] DEFAULT: 3600
month	scalar: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
recurring	scalar:Bool	Probe to be scheduled automatically every day	SELECTION: true or false DEFAULT: false
startProbe	scalar:Enum8	When the probe is to be started	DEFAULT: Pending
startTime	string: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

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

CLI Commands

no ip sla schedule 1 life 1213158206 start-time SampleString_123 July 25 recurring ageout 1458636

Verifying a DME Configuration

MO	DN
slaProbe	sys/sla/inst/sender/operation-1
slaScheduler	sys/sla/inst/sender/operation-1/schedule
slaSender	sys/sla/inst/sender

slaProbe Properties

Property Name	Data Type	Description	Values
id	scalar:Uint32	Operation index which is unique for each probe, all the probe related configs and the statistics are displayed using this index.	RANGE: [0, 4294967295]

slaScheduler Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	Modification status	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:

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