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 |
| Операция PATCH, используемая при использовании 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" | Имя домена, используемое для всех вызовов 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 ErrorPageBody object
avi_errorpagebody:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_errorpagebody
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | Объект ErrorPageBody (api/errorpagebody) |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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_errorpagebody_module.html
