avi_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		Варианты: add replace delete	Операция изменения (patch) для использования при использовании avi_api_update_method как patch.
avi_api_update_method - добавлен в 2.5		Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределяет это поведение, чтобы использовать HTTP PATCH.
avi_credentials словарь добавлен в 2.5			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi контроллер.
	api_version -	По умолчанию: "16.4.4"	Версия контроллера Avi
	controller -		IP-адрес или SQDN контроллера Avi
	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 булево добавлен в 2.6		Варианты: no yes	Отключает кэширование информации о сессии Avi в качестве факта.
backup_config_ref -			Конфигурация резервного копирования, которая должна быть выполнена этим планировщиком. Это ссылка на объект типа backupconfiguration.
controller строка		По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
enabled булево		Варианты: no yes	Флаг булевого типа для установки включения. Значение по умолчанию, если оно не указано в 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 см. 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	Объект планировщика (api/scheduler)

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Gaurav Rastogi (@grastogi23) <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.9/modules/avi_scheduler_module.html