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

Примечание

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

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

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

Для использования в playbook укажите: community.network.avi_errorpageprofile.

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

Описание

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

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

Требования

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

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования в Avi API и объектах. По умолчанию: `"16.4.4"`
app_name строка	Имя виртуальной службы, которая сгенерировала страницу ошибки. Поле устарело в версии 18.1.1. Поле введено в версии 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как имя VS.
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Варианты: `"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 контроллера Avi
csrftoken строка	CSRF-токен API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль контроллера 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`
company_name строка	Имя компании, отображаемое на странице ошибки. Поле устарело в версии 18.1.1. Поле введено в версии 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Avi Networks.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
error_pages строка	Определенные страницы ошибок для кодов HTTP-статусов. Поле введено в версии 17.2.4.

END_OF_DOCUMENT_MARKER

host_name string	Полное доменное имя, для которого генерируется страница ошибки. Поле устарело в 18.1.1. Поле введено в 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как заголовок Host.
name string / обязательно	Поле введено в 17.2.4.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя клиента, используемого для всех вызовов API Avi и контекста объекта. Значение по умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа tenant. Поле введено в 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 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) Возвращается: success, changed

Авторы

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_errorpageprofile_module.html