New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
api_context
(added in 2.5) |
|
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
|
api_version
|
Default:
16.4.4
|
Avi API version of to use for Avi API and objects.
|
avi_api_patch_op
(added in 2.5) |
|
Patch operation to use when using avi_api_update_method as patch.
|
avi_api_update_method
(added in 2.5) |
|
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
|
avi_credentials
(added in 2.5) |
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
|
backup_config_ref
|
|
Backup configuration to be executed by this scheduler.
It is a reference to an object of type backupconfiguration.
|
controller
|
Default:
|
IP address or hostname of the controller. The default value is the environment variable
AVI_CONTROLLER . |
enabled
|
|
Boolean flag to set enabled.
Default value when not specified in API or module is interpreted by Avi Controller as True.
|
end_date_time
|
|
Scheduler end date and time.
|
frequency
|
|
Frequency at which custom scheduler will run.
Allowed values are 0-60.
|
frequency_unit
|
|
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
required |
|
Name of scheduler.
|
password
|
Default:
|
Password of Avi user in Avi controller. The default value is the environment variable
AVI_PASSWORD . |
run_mode
|
|
Scheduler run mode.
Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW.
|
run_script_ref
|
|
Control script to be executed by this scheduler.
It is a reference to an object of type alertscriptconfig.
|
scheduler_action
|
|
Define scheduler action.
Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP.
Default value when not specified in API or module is interpreted by Avi Controller as SCHEDULER_ACTION_BACKUP.
|
start_date_time
|
|
Scheduler start date and time.
|
state
|
|
The state that should be applied on the entity.
|
tenant
|
Default:
admin
|
Name of tenant used for all Avi API calls and context of object.
|
tenant_ref
|
|
It is a reference to an object of type tenant.
|
tenant_uuid
|
Default:
|
UUID of tenant used for all Avi API calls and context of object.
|
url
|
|
Avi controller URL of the object.
|
username
|
Default:
|
Username used for accessing Avi controller. The default value is the environment variable
AVI_USERNAME . |
uuid
|
|
Unique object identifier of the object.
|
Note
- name: Example to create Scheduler object
avi_scheduler:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_scheduler
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
obj
dict
|
success, changed |
Scheduler (api/scheduler) object
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.