PUT /scheduler/{uuid}

• Scheduler

/scheduler/{uuid}

Request

URI

PUT

https://api_host/api/scheduler/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-Avi-Version

Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

---

Request Body

Scheduler of type(s) application/json

Optional

{
    "_last_modified": "string",
    "backup_config_ref": "string",
    "configpb_attributes": {
        "version": 0
    },
    "enabled": false,
    "end_date_time": "string",
    "frequency": 0,
    "frequency_unit": "string",
    "name": "string",
    "run_mode": "string",
    "run_script_ref": "string",
    "scheduler_action": "string",
    "start_date_time": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

backup_config_ref

Optional

Backup Configuration to be executed by this scheduler. It is a reference to an object of type BackupConfiguration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

boolean

enabled

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

end_date_time

Optional

Scheduler end date and time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

frequency

Optional

Frequency at which CUSTOM scheduler will run. Allowed values are 0-60. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

frequency_unit

Optional

Unit at which CUSTOM scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Required

Name of scheduler. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

run_mode

Optional

Scheduler Run Mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

run_script_ref

Optional

Control script to be executed by this scheduler. It is a reference to an object of type AlertScriptConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

scheduler_action

Optional

Define Scheduler Action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

start_date_time

Optional

Scheduler start date and time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Responses

200

Hide Details

OK

Returns Scheduler of type(s) application/json

{
    "_last_modified": "string",
    "backup_config_ref": "string",
    "configpb_attributes": {
        "version": 0
    },
    "enabled": false,
    "end_date_time": "string",
    "frequency": 0,
    "frequency_unit": "string",
    "name": "string",
    "run_mode": "string",
    "run_script_ref": "string",
    "scheduler_action": "string",
    "start_date_time": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

backup_config_ref

Optional

Backup Configuration to be executed by this scheduler. It is a reference to an object of type BackupConfiguration. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

boolean

enabled

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

end_date_time

Optional

Scheduler end date and time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

frequency

Optional

Frequency at which CUSTOM scheduler will run. Allowed values are 0-60. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

frequency_unit

Optional

Unit at which CUSTOM scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Required

Name of scheduler. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

run_mode

Optional

Scheduler Run Mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

run_script_ref

Optional

Control script to be executed by this scheduler. It is a reference to an object of type AlertScriptConfig. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

scheduler_action

Optional

Define Scheduler Action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

start_date_time

Optional

Scheduler start date and time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

401

Hide Details

log in failed

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Query Parameters

Header Parameters

Request Body

Response

200 Response Body

Errors

Scheduler Operations

DELETE

DELETE /scheduler/{uuid}

GET

GET /scheduler

GET

GET /scheduler/{uuid}

PATCH

PATCH /scheduler/{uuid}

POST

POST /scheduler

PUT

PUT /scheduler/{uuid}