avi_gslbservice_patch_member — Модуль API Avi
Новая версия с 2.5.
Обзор
- Этот модуль можно использовать для вызова любых ресурсов, определённых в REST API Avi. https://avinetworks.com/
- Этот модуль полезен для вызова методов HTTP PATCH и доступа к ресурсам, для которых нет связанного REST-объекта.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлен в 2.5) | Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | |
| api_version | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. |
| avi_credentials (добавлен в 2.5) | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| controller | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. |
| data | Тело HTTP-запроса для члена GSLB-службы в формате YAML или JSON. | |
| name обязательно | Имя GSLB-службы | |
| params | Параметры запроса, передаваемые в HTTP API. | |
| password | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. |
| state |
| Состояние, которое должно быть применено к члену. Член идентифицируется по полю member.ip.addr. |
| tenant | Значение по умолчанию: "admin" | Имя домена, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_uuid | Значение по умолчанию: "" | UUID домена, используемого для всех вызовов API Avi и контекста объекта. |
| username | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. в https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Patch GSLB Service to add a new member and group
avi_gslbservice_patch_member:
controller: "{{ controller }}"
username: "{{ username }}"
password: "{{ password }}"
name: gs-3
api_version: 17.2.1
data:
group:
name: newfoo
priority: 60
members:
- enabled: true
ip:
addr: 10.30.10.66
type: V4
ratio: 3
- name: Patch GSLB Service to delete an existing member
avi_gslbservice_patch_member:
controller: "{{ controller }}"
username: "{{ username }}"
password: "{{ password }}"
name: gs-3
state: absent
api_version: 17.2.1
data:
group:
name: newfoo
members:
- enabled: true
ip:
addr: 10.30.10.68
type: V4
ratio: 3
- name: Update priority of GSLB Service Pool
avi_gslbservice_patch_member:
controller: ""
username: ""
password: ""
name: gs-3
state: present
api_version: 17.2.1
data:
group:
name: newfoo
priority: 42
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | success, changed | REST-ресурс Avi |
Статус
Этот модуль помечен как 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_gslbservice_patch_member_module.html
