community.network.avi_scheduler – Модуль для настройки объекта планировщика Avi RESTful

Примечание

Этот плагин является частью коллекции community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в книге задач, укажите: community.network.avi_scheduler.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для конфигурации объекта планировщика
Дополнительные примеры см. по адресу https://github.com/avinetworks/devops

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка		Значение по умолчанию: "16.4.4"	Версия API Avi, используемая для Avi API и объектов.
avi_api_patch_op строка		Варианты: add replace delete	Операция обновления для использования при использовании avi_api_update_method как patch.
avi_api_update_method строка		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials словарь			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi контроллер.
	api_version строка	Значение по умолчанию: "16.4.4"	Версия контроллера Avi
	controller строка		IP-адрес или SQDN контроллера
	csrftoken строка		Маркер csrftoken API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль пользователя Avi в контроллере Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken
	tenant строка	Значение по умолчанию: "admin"	Тенент контроллера Avi
	tenant_uuid строка		UUID тенента контроллера Avi
	timeout строка	Значение по умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact boolean		Варианты: нет ← да	Отключает кеширование информации о сеансе avi в качестве факта.
backup_config_ref строка			Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration.
controller строка		Значение по умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
enabled boolean		Варианты: нет да	Логический флаг для установки включения. Значение по умолчанию, если не указано в 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 строка		Варианты: absent present ←	Состояние, которое должно быть применено к объекту.
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
  community.network.avi_scheduler:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_scheduler

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ	Возвращаемое значение	Описание
obj словарь	успех, изменение	Объект планировщика (api/scheduler)

Авторы

Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_scheduler_module.html