avi_scheduler – Модуль для настройки объекта Scheduler Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта Scheduler.
- Дополнительные примеры на странице https://github.com/avinetworks/devops
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - Добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version - | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. |
| avi_api_patch_op - Добавлен в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method как patch. |
| avi_api_update_method - Добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch изменит это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials - Добавлен в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| backup_config_ref - | Конфигурация резервного копирования, которая будет выполняться этим планировщиком. Это ссылка на объект типа backupconfiguration. | |
| controller - | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| enabled boolean |
| Флаг Boolean для установки 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 - |
| Состояние, которое должно быть применено к сущности. |
| tenant - | Значение по умолчанию: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Это ссылка на объект типа tenant. | |
| tenant_uuid - | Значение по умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. |
| url - | URL контроллера Avi для объекта. | |
| username - | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid - | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create Scheduler object
avi_scheduler:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_scheduler
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект Scheduler (api/scheduler) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_scheduler_module.html