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

Новое в версии 2.5.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Требования

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

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_context (добавлен в 2.5)		Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version	По умолчанию: 16.4.4	Версия API Avi для использования в API Avi и объектах.
app_name		Имя виртуальной службы, которая сгенерировала страницу ошибки. Поле добавлено в 17.2.4. Если параметр не указан, контроллер Avi интерпретирует значение как имя VS.
avi_api_patch_op (добавлен в 2.5)	Варианты: add replace delete	Операция обновления при использовании метода avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	По умолчанию метод обновления объекта — HTTP PUT. Установка в patch переопределит это поведение на использование HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь учетных данных Avi, который может быть использован вместо перечисления данных входа в контроллер Avi.
company_name		Название компании, отображаемое на странице ошибки. Поле добавлено в 17.2.4. Если параметр не указан, контроллер Avi интерпретирует значение как Avi Networks.
controller	По умолчанию:	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
error_pages		Определённые страницы ошибок для кодов состояния HTTP. Поле добавлено в 17.2.4.
host_name		Полное доменное имя, для которого генерируется страница ошибки. Поле добавлено в 17.2.4. Если параметр не указан, контроллер Avi интерпретирует значение как Host Header.
name обязательно		Поле добавлено в 17.2.4.
password	По умолчанию:	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state	Варианты: absent present ←	Состояние, которое должно быть применено к объекту.
tenant	По умолчанию: admin	Имя домена, используемое для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа домен. Поле добавлено в 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
  avi_errorpageprofile:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_errorpageprofile

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Автор

Гaurav Rastogi (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.5/modules/avi_errorpageprofile_module.html