avi_errorpageprofile - Модуль для настройки объекта Avi RESTful ErrorPageProfile
Новый в версии 2.5.
Описание
- Этот модуль используется для настройки объекта ErrorPageProfile.
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлено в 2.5) | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | |
| api_version | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. |
| 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 | Ссылка на объект типа tenant. Поле добавлено в 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 dict | success, changed | Объект ErrorPageProfile (api/errorpageprofile) |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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_errorpageprofile_module.html
