avi_scheduler - Модуль для настройки RESTful объекта Планировщика Avi
Новое в версии 2.4.
Обзор
- Этот модуль используется для конфигурации объекта Планировщика
- Дополнительные примеры по адресу 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, который может быть использован вместо перечисления данных входа в контроллер Avi. | |
| backup_config_ref | Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration. | |
| controller | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. |
| enabled bool |
| Булево значение для установки 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 dict | success, changed | Объект Планировщик (api/scheduler) |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в Раздел по поддержке и техническому обслуживанию модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/avi_scheduler_module.html
