avi_errorpagebody – Модуль для настройки ErrorPageBody Avi RESTful объекта
Новое в версии 2.5.
Обзор
- Этот модуль используется для конфигурации объекта ErrorPageBody
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - добавлено в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version - | Значение по умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. |
| 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 Controller. | |
| controller - | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| error_page_body - | Тело страницы ошибки, отправляемой клиенту при совпадении. Поле добавлено в 17.2.4. | |
| 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 см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create ErrorPageBody object
avi_errorpagebody:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_errorpagebody
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменено | Объект ErrorPageBody (api/errorpagebody) |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный просмотр]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav 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.7/modules/avi_errorpagebody_module.html
