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

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

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

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

Обзор

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

Псевдонимы: network.avi.avi_errorpagebody

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi, которая должна использоваться для Avi API и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, которая должна использоваться при использовании avi_api_update_method как исправление. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	По умолчанию метод обновления объекта — HTTP PUT. Установка значения на patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Токен csrf API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере Avi.
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: `""`
tenant строка	Тенент контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact булево	Отключает кеширование информации о сессии avi как факта. Варианты: `false` ← (по умолчанию) `true`
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 string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя абонента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа абонента. Поле добавлено в версии 17.2.4.
tenant_uuid string	UUID абонента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url string	URL контроллера Avi для объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid string	Поле добавлено в версии 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) Возвращается: успех, изменено

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

© 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_errorpagebody_module.html