API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing job-scheduler configurations

The job scheduler feature facilitates us to schedule a job to be
executed in the near future. Currently, only non-interactive enable
and configuration commands are allowed to be configured as a job.
Schedules can be configured to be triggered periodically or at a specific
calendar date and time. They are categorized into periodic schedules,
calendar schedules, and one-shot schedules. Periodic schedules are based
on the fixed time interval between the two triggers.

Calendar schedules are based on the specified days of the week and days
of the month. Calendar schedules are therefore aware of the notion of
months, days, weekdays, hours, and minutes.

One-shot schedules are similar to the calendar schedule but they will
automatically disable themselves after one trigger.

This feature is useful to schedule a toggling port, check the system
health status, clear the statistics or some clean-up activities,
QoS policy changes, save the configurations, and other similar jobs.

While updating trigger-type other parameter must set to null, which are
not applicable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json