community.network.avi_scheduler module – Module for setup of Scheduler Avi RESTful Object
Note
This module is part of the community.network collection (version 5.0.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.avi_scheduler
.
Synopsis
This module is used to configure Scheduler object
more examples at https://github.com/avinetworks/devops
Aliases: network.avi.avi_scheduler
Requirements
The below requirements are needed on the host that executes this module.
avisdk
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id Default: |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken Default: |
|
Avi controller tenant Default: |
|
Avi controller tenant UUID Default: |
|
Avi controller request timeout Default: |
|
Avi controller API token Default: |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. |
|
IP address or hostname of the controller. The default value is the environment variable |
|
Boolean flag to set enabled. Default value when not specified in API or module is interpreted by Avi Controller as True. Choices:
|
|
Scheduler end date and time. |
|
Frequency at which custom scheduler will run. Allowed values are 0-60. |
|
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 of scheduler. |
|
Password of Avi user in Avi controller. The default value is the environment variable |
|
Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. |
|
Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. |
|
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. |
|
Scheduler start date and time. |
|
The state that should be applied on the entity. Choices:
|
|
Name of tenant used for all Avi API calls and context of object. Default: |
|
It is a reference to an object of type tenant. |
|
UUID of tenant used for all Avi API calls and context of object. Default: |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable |
|
Unique object identifier of the object. |
Notes
Note
For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Example to create Scheduler object
community.network.avi_scheduler:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_scheduler
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Scheduler (api/scheduler) object Returned: success, changed |