avi_errorpageprofile – Модуль для настройки ErrorPageProfile Avi RESTful объекта
Новая версия 2.5.
Обзор
- Этот модуль используется для конфигурации объекта ErrorPageProfile
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлено в 2.5 | Контекст Avi API, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия Avi API для использования с Avi API и объектами. | |
| app_name - | Имя виртуальной службы, сгенерировавшей страницу ошибки. Поле устарело в 18.1.1. Поле введено в 17.2.4. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как имя VS. | ||
| avi_api_patch_op - добавлено в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method в качестве исправления. | |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлено в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | Маркер csrf контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса | ||
| password - | Пароль пользователя Avi в контроллере Avi | ||
| port - | Порт контроллера Avi | ||
| session_id - | Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant - | Значение по умолчанию: "admin" | Тенд контроллера Avi | |
| tenant_uuid - | UUID арендатора контроллера Avi | ||
| timeout - | Значение по умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token - | Токен API контроллера Avi | ||
| username - | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact boolean добавлено в 2.6 |
| Отключает кеширование информации о сеансе 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. | ||
| name - / обязательно | Поле введено в 17.2.4. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state - |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | Значение по умолчанию: "admin" | Имя арендатора, используемого для всех вызовов Avi API и контекста объекта. | |
| tenant_ref - | Ссылка на объект типа арендатора. Поле введено в 17.2.4. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID арендатора, используемого для всех вызовов Avi API и контекста объекта. | |
| 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 словарь | success, changed | Объект ErrorPageProfile (api/errorpageprofile) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (@grastogi23) <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.9/modules/avi_errorpageprofile_module.html
