Avi Scheduler Object API

##CLI## ``` - configure scheduler - show scheduler ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /scheduler
  2. post /scheduler
  3. delete /scheduler/{uuid}
  4. get /scheduler/{uuid}
  5. patch /scheduler/{uuid}
  6. put /scheduler/{uuid}
Up
get /scheduler
( schedulerGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SchedulerApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "frequency_unit" : "aeiou",
    "run_script_ref" : "aeiou",
    "scheduler_action" : "aeiou",
    "uuid" : "aeiou",
    "enabled" : true,
    "url" : "aeiou",
    "frequency" : 123,
    "end_date_time" : "aeiou",
    "backup_config_ref" : "aeiou",
    "run_mode" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "start_date_time" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SchedulerApiResponse

401

log in failed

Up
post /scheduler
( schedulerPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Scheduler object creation

Return type

Scheduler

Example data

Content-Type: application/json
{
  "frequency_unit" : "aeiou",
  "run_script_ref" : "aeiou",
  "scheduler_action" : "aeiou",
  "uuid" : "aeiou",
  "enabled" : true,
  "url" : "aeiou",
  "frequency" : 123,
  "end_date_time" : "aeiou",
  "backup_config_ref" : "aeiou",
  "run_mode" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "start_date_time" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Scheduler

401

log in failed

Up
delete /scheduler/{uuid}
( schedulerUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /scheduler/{uuid}
( schedulerUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

Scheduler

Example data

Content-Type: application/json
{
  "frequency_unit" : "aeiou",
  "run_script_ref" : "aeiou",
  "scheduler_action" : "aeiou",
  "uuid" : "aeiou",
  "enabled" : true,
  "url" : "aeiou",
  "frequency" : 123,
  "end_date_time" : "aeiou",
  "backup_config_ref" : "aeiou",
  "run_mode" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "start_date_time" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Scheduler

401

log in failed

Up
patch /scheduler/{uuid}
( schedulerUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Scheduler object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Scheduler

Example data

Content-Type: application/json
{
  "frequency_unit" : "aeiou",
  "run_script_ref" : "aeiou",
  "scheduler_action" : "aeiou",
  "uuid" : "aeiou",
  "enabled" : true,
  "url" : "aeiou",
  "frequency" : 123,
  "end_date_time" : "aeiou",
  "backup_config_ref" : "aeiou",
  "run_mode" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "start_date_time" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Scheduler

401

log in failed

Up
put /scheduler/{uuid}
( schedulerUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — Scheduler object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

Scheduler

Example data

Content-Type: application/json
{
  "frequency_unit" : "aeiou",
  "run_script_ref" : "aeiou",
  "scheduler_action" : "aeiou",
  "uuid" : "aeiou",
  "enabled" : true,
  "url" : "aeiou",
  "frequency" : 123,
  "end_date_time" : "aeiou",
  "backup_config_ref" : "aeiou",
  "run_mode" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "start_date_time" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Scheduler

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Scheduler
  2. SchedulerApiResponse

Scheduler Up

backup_config_ref (optional)
String Backup Configuration to be executed by this scheduler. It is a reference to an object of type BackupConfiguration.
enabled (optional)
Boolean Placeholder for description of property enabled of obj type Scheduler field type str type boolean
end_date_time (optional)
String Scheduler end date and time.
frequency (optional)
Integer Frequency at which CUSTOM scheduler will run. Allowed values are 0-60. format: int32
frequency_unit (optional)
String 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.
name
String Name of scheduler.
run_mode (optional)
String Scheduler Run Mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW.
run_script_ref (optional)
String Control script to be executed by this scheduler. It is a reference to an object of type AlertScriptConfig.
scheduler_action (optional)
String Define Scheduler Action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP.
start_date_time (optional)
String Scheduler start date and time.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

SchedulerApiResponse Up

count
Integer format: int32
results