ansible / ansible.builtin / v2.9.3 / module / avi_scheduler Module for setup of Scheduler Avi RESTful Object | "added in version" 2.4 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_scheduler (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure Scheduler object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create Scheduler object avi_scheduler: controller: 10.10.25.42 username: admin password: something state: present name: sample_scheduler
url: description: - Avi controller URL of the object. name: description: - Name of scheduler. required: true uuid: description: - Unique object identifier of the object. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str enabled: description: - Boolean flag to set enabled. - Default value when not specified in API or module is interpreted by Avi Controller as True. type: bool password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str run_mode: description: - Scheduler run mode. - Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str frequency: description: - Frequency at which custom scheduler will run. - Allowed values are 0-60. controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str tenant_ref: description: - It is a reference to an object of type tenant. api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str end_date_time: description: - Scheduler end date and time. frequency_unit: description: - 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. run_script_ref: description: - Control script to be executed by this scheduler. - It is a reference to an object of type alertscriptconfig. avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: description: - Avi controller API token username: description: - Avi controller username type: dict start_date_time: description: - Scheduler start date and time. avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. version_added: '2.5' version_added_collection: ansible.builtin scheduler_action: description: - 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. backup_config_ref: description: - Backup configuration to be executed by this scheduler. - It is a reference to an object of type backupconfiguration. avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. version_added: '2.5' version_added_collection: ansible.builtin avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: Scheduler (api/scheduler) object returned: success, changed type: dict