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, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| 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 см. на странице 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) |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Более подробная информация приведена на странице Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/avi_errorpagebody_module.html
