W3cubDocs

/Ansible

avi_scheduler - Module for setup of Scheduler Avi RESTful Object

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
backup_config_ref
 no
Backup configuration to be executed by this scheduler.
It is a reference to an object of type backupconfiguration.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
enabled
 no
Boolean flag to set enabled.
Default value when not specified in API or module is interpreted by Avi Controller as True.
end_date_time
 no
Scheduler end date and time.
frequency
 no
Frequency at which custom scheduler will run.
Allowed values are 0-60.
frequency_unit
 no
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
 yes
Name of scheduler.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
run_mode
 no
Scheduler run mode.
Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW.
run_script_ref
 no
Control script to be executed by this scheduler.
It is a reference to an object of type alertscriptconfig.
scheduler_action
 no
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
 no
Scheduler start date and time.
state
 no present
  • absent
  • present
The state that should be applied on the entity.
tenant
 no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
 no
It is a reference to an object of type tenant.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
url
 no
Avi controller URL of the object.
username
 no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
 no
Unique object identifier of the object.

Examples

- name: Example to create Scheduler object
  avi_scheduler:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_scheduler

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
Scheduler (api/scheduler) object
 success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/avi_scheduler_module.html