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

Примечание

Этот плагин входит в состав коллекции community.network (версия 1.3.0).

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

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

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

Обзор

Этот модуль используется для настройки объекта ErrorPageProfile
больше примеров по адресу https://github.com/avinetworks/devops

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка		Значение по умолчанию: "16.4.4"	Версия API Avi для использования с API Avi и объектами.
app_name строка			Имя виртуальной службы, которая сгенерировала страницу ошибки. Поле устарело в версии 18.1.1. Поле введено в версии 17.2.4. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как имя VS.
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
	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 булево		Варианты: нет ← да	Отключает кэширование информации о сеансе avi в качестве факта.
company_name строка			Имя компании, которое будет отображаться на странице ошибки. Поле устарело в версии 18.1.1. Поле введено в версии 17.2.4. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как Avi Networks.
controller строка		Значение по умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
error_pages строка			Определённые страницы ошибок для кодов состояния HTTP. Поле введено в версии 17.2.4.
host_name строка			Полное доменное имя, для которого генерируется страница ошибки. Поле устарело в версии 18.1.1. Поле введено в версии 17.2.4. Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как Host Header.
name строка / обязательно			Поле введено в версии 17.2.4.
password строка		Значение по умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`
state строка		Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant строка		Значение по умолчанию: "admin"	Имя тенента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref строка			Это ссылка на объект типа tenant. Поле введено в версии 17.2.4.
tenant_uuid строка		Значение по умолчанию: ""	UUID тенента, используемого для всех вызовов API Avi и контекста объекта.
url строка			URL контроллера Avi объекта.
username строка		Значение по умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`
uuid строка			Поле введено в версии 17.2.4.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create ErrorPageProfile object
  community.network.avi_errorpageprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_errorpageprofile

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

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

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

Авторы

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.10/collections/community/network/avi_errorpageprofile_module.html