Scheduler

Description

API


    POST /api/scheduler
    PUT /api/scheduler/&ltkey>
    DELETE /api/scheduler/&ltkey>
    GET /api/scheduler
    GET /api/scheduler/&ltkey>

CLI


    configure scheduler &ltkey>
    show scheduler &ltkey>

Data

Scheduler

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description
Name of scheduler

enabled

Type
bool
Category
optional
Description
Default
True

run_mode

Type
enum
Category
optional
Description
Scheduler Run Mode
Choices
RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW

start_date_time

Type
string
Category
optional
Description
Scheduler start date and time

end_date_time

Type
string
Category
optional
Description
Scheduler end date and time

frequency

Type
uint32
Category
optional
Description
Frequency at which CUSTOM scheduler will run

frequency_unit

Type
enum
Category
optional
Description
Unit at which CUSTOM scheduler will run
Choices
SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH

backup_config_ref

Type
Reference to BackupConfiguration
Category
optional
Description
Backup Configuration to be executed by this scheduler

run_script_ref

Type
Reference to AlertScriptConfig
Category
optional
Description
Control script to be executed by this scheduler

scheduler_action

Type
enum
Category
optional
Description
Define Scheduler Action
Default
SCHEDULER_ACTION_BACKUP
Choices
SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP

tenant_ref

Type
Reference to Tenant
Category
optional
Description

References

AlertScriptConfig Tenant BackupConfiguration

Sub Objects