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 Service Member в формате YAML или JSON. |
|
| name требуется |
Имя GSLB Service. |
|
| 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 см. на странице 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
dict
|
success, changed | Ресурс Avi REST
|
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Г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_gslbservice_patch_member_module.html