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

Примечание

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

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

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

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

Обзор

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

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
api_context словарь			Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка		По умолчанию: "16.4.4"	Версия API Avi, используемая для API Avi и объектов.
avi_api_patch_op строка		Варианты: add replace delete	Операция исправления, используемая при использовании avi_api_update_method в качестве исправления.
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 строка		Маркер csrf контроллера API Avi для повторного использования существующего сеанса с идентификатором сеанса
	password строка		Пароль пользователя контроллера Avi
	port строка		Порт контроллера Avi
	session_id строка		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с маркером csrf
	tenant строка	По умолчанию: "admin"	Тенейнт контроллера Avi
	tenant_uuid строка		UUID тенейнта контроллера Avi
	timeout строка	По умолчанию: 300	Таймаут запроса контроллера Avi
	token строка		Токен API контроллера Avi
	username строка		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact булево		Варианты: нет ← да	Отключает кеширование информации о сеансе avi как факта.
controller строка		По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
error_page_body строка			Текст тела страницы ошибки, отправляемый клиенту при совпадении. Поле введено в 17.2.4.
format строка			Формат тела страницы ошибки html или json. Варианты перечисления — ERROR_PAGE_FORMAT_HTML, ERROR_PAGE_FORMAT_JSON. Поле введено в 18.2.3. Значение по умолчанию при отсутствии в API или модуле интерпретируется контроллером Avi как ERROR_PAGE_FORMAT_HTML.
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 см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Example to create ErrorPageBody object
  community.network.avi_errorpagebody:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_errorpagebody

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

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

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

Авторы

Гौरव रस्तोगी (@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_errorpagebody_module.html