community.network.avi_errorpageprofile – Модуль для настройки объекта ErrorPageProfile Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: 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 строка |
| Операция исправления, используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Указание patch изменит поведение на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который может быть использован вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или доменное имя контроллера | ||
| csrftoken строка | Токен csrf контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль пользователя Avi в контроллере 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 в качестве факта. | |
| 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 строка |
| Состояние, которое должно быть применено к сущности. | |
| 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 словарь | success, changed | Объект ErrorPageProfile (api/errorpageprofile) |
Авторы
- Гaurav Rastogi (@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_errorpageprofile_module.html
