community.network.avi_scheduler модуль — Модуль для настройки объекта Scheduler Avi RESTful
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.
Для использования в playbook укажите: community.network.avi_scheduler.
Описание
- Этот модуль используется для конфигурации объекта Scheduler
- больше примеров на https://github.com/avinetworks/devops
Псевдонимы: network.avi.avi_scheduler
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. |
api_version строка | Версия API Avi для использования с API Avi и объектами. По умолчанию: |
avi_api_patch_op строка | Операция исправления, используемая при использовании avi_api_update_method как patch. Доступные значения:
|
avi_api_update_method строка | Метод по умолчанию для обновления объекта — HTTP PUT. Установка значения на patch переопределит это поведение, используя HTTP PATCH. Доступные значения:
|
avi_credentials словарь | Словарь учетных данных Avi, который может быть использован вместо перечисления данных входа в систему контроллера Avi. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
csrftoken строка |
Токен csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken По умолчанию: |
|
tenant строка |
Теней контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID теней контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя контроллера Avi |
avi_disable_session_cache_as_fact логическое значение | Отключает кеширование информации о сеансе avi в качестве факта. Доступные значения:
|
backup_config_ref строка | Конфигурация резервного копирования, которая будет выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration. |
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
enabled логическое значение | Логический флаг для установки состояния включения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Доступные значения:
|
end_date_time строка | Дата и время завершения планировщика. |
frequency строка | Частота, с которой будет выполняться пользовательский планировщик. Допустимые значения — от 0 до 60. |
frequency_unit string | Единица времени, в которой будет работать пользовательский планировщик. Варианты перечисления - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. |
name string / обязательно | Имя планировщика. |
password string | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения |
run_mode string | Режим работы планировщика. Варианты перечисления - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. |
run_script_ref string | Скрипт управления, который должен быть выполнен этим планировщиком. Это ссылка на объект типа alertscriptconfig. |
scheduler_action string | Определение действия планировщика. Варианты перечисления - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SCHEDULER_ACTION_BACKUP. |
start_date_time string | Дата и время запуска планировщика. |
state string | Состояние, которое должно быть применено к объекту. Варианты:
|
tenant string | Имя домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
tenant_ref string | Ссылка на объект типа tenant. |
tenant_uuid string | UUID домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: |
url string | URL контроллера Avi для объекта. |
username string | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения |
uuid string | Уникальный идентификатор объекта. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create Scheduler object
community.network.avi_scheduler:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_scheduler
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
obj словарь | Объект планировщика (api/scheduler) Возвращается: success, changed |
Ссылки на сборки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_scheduler_module.html
