avi_scheduler - Модуль для настройки объекта планировщика Avi RESTful
Новое в версии 2.4.
Описание
- Этот модуль используется для конфигурирования объекта планировщика
- больше примеров по адресу https://github.com/avinetworks/devops
Требования (к хосту, выполняющему модуль)
- avisdk
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi для использования в API Avi и объектах. | ||
| backup_config_ref | нет | Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | ||
| enabled | нет | Логический флаг для установки значения enabled. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| end_date_time | нет | Дата и время окончания работы планировщика. | ||
| frequency | нет | Частота выполнения пользовательского планировщика. Допустимые значения — от 0 до 60. | ||
| frequency_unit | нет | Единица измерения частоты выполнения пользовательского планировщика. Варианты перечисления — SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. | ||
| name | да | Имя планировщика. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | ||
| run_mode | нет | Режим работы планировщика. Варианты перечисления — RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. | ||
| run_script_ref | нет | Сценарий управления, который должен быть выполнен этим планировщиком. Это ссылка на объект типа alertscriptconfig. | ||
| scheduler_action | нет | Определение действия планировщика. Варианты перечисления — SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SCHEDULER_ACTION_BACKUP. | ||
| start_date_time | нет | Дата и время начала работы планировщика. | ||
| state | нет | present |
| Состояние, которое должно быть применено к сущности. |
| tenant | нет | admin | Название арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref | нет | Это ссылка на объект типа арендатор. | ||
| tenant_uuid | нет | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. | ||
| url | нет | URL-адрес контроллера Avi объекта. | ||
| username | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор объекта. |
Примеры
- name: Example to create Scheduler object
avi_scheduler:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_scheduler
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| obj | Объект планировщика (api/scheduler) | успех, изменение | dict |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_scheduler_module.html
