avi_errorpagebody - Модуль для настройки объекта Avi RESTful ErrorPageBody
Новая версия с 2.5.
Обзор
- Этот модуль используется для настройки объекта ErrorPageBody.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже приведены требования, которые необходимы на хосте, выполняющем этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлено в 2.5) | Контекст API Avi, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | |
| api_version | Значение по умолчанию: 16.4.4 | Версия API Avi для использования с API Avi и объектами. |
| 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 | Ссылка на объект типа домена. Поле введено в 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 ErrorPageBody object
avi_errorpagebody:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_errorpagebody
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj dict | success, changed | Объект ErrorPageBody (api/errorpagebody) |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Гaurav 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.5/modules/avi_errorpagebody_module.html