avi_errorpageprofile – Модуль для настройки ErrorPageProfile Avi RESTful объекта
Новая версия 2.5.
Обзор
- Этот модуль используется для настройки объекта ErrorPageProfile
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | |
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. |
| app_name - | Имя виртуальной службы, которая сгенерировала страницу ошибки. Поле введено в 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как имя VS. | |
| avi_api_patch_op - добавлен в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method в качестве patch. |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установкой в patch будет переопределено это поведение для использования HTTP PATCH. |
| avi_credentials словарь добавлен в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| company_name - | Имя компании, которое нужно отобразить на странице ошибки. Поле введено в 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Avi Networks. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| error_pages - | Определенные страницы ошибок для кодов состояния HTTP. Поле введено в 17.2.4. | |
| host_name - | Полное доменное имя, для которого генерируется страница ошибки. Поле введено в 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как заголовок Host. | |
| name - / обязательно | Поле введено в 17.2.4. | |
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| state - |
| Состояние, которое должно быть применено к сущности. |
| 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 словарь | успех, изменение | Объект ErrorPageProfile (api/errorpageprofile) |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/avi_errorpageprofile_module.html
