avi_scheduler - Модуль для настройки объекта Scheduler Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта Планировщик.
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлено в 2.5) | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | |
| api_version | Значение по умолчанию: 16.4.4 | Версия API Avi для использования в Avi API и объектах. |
| 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 Controller. | |
| backup_config_ref | Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration. | |
| controller | Значение по умолчанию: | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. |
| enabled |
| Логический флаг для установки включения. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 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 Controller как 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 Network см. на странице 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, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- Гроув Растоги (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.5/modules/avi_scheduler_module.html