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

Enabling Scheduler

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/fm.json
{
  "fmEntity": {
    "children": [
      {
        "fmScheduler": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <fm-items>
    <scheduler-items>
      <adminSt>enabled</adminSt>
    </scheduler-items>
  </fm-items>
</System>

Configuring the Scheduler

The scheduler allows you to define and set a timetable for maintenance activities such as the following:

Quality of service (QoS) policy changes
Data backup
Saving a configuration Jobs consist of a single command or multiple commands that define routine activities. Jobs can be scheduled one time or at periodic intervals. The scheduler defines a job and its timetable as follows:
Job—A routine task or tasks defined as a command list and completed according to a specified schedule.
Schedule—The timetable for completing a job. You can assign multiple jobs to a schedule. A schedule is defined as either periodic or one-time only:
- Periodic mode—A recurring interval that continues until you delete the job. You can configure the following types of intervals:
  - Daily—A job is completed once a day.
  - Weekly—A job is completed once a week.
  - Monthly—A job is completed once a month.
- Delta—A job begins at the specified start time and then at specified intervals (days:hours:minutes).
One-time mode—A job is completed only once at a specified time.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration GuideYou can create a maintenance-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

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

Enabling Scheduler

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

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

feature scheduler

Verifying a DME Configuration

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

MO	DN
fmEntity	sys/fm
fmScheduler	sys/fm/scheduler

fmScheduler Properties

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

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

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

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

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

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

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

Disabling Scheduler