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
|
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/avi_gslbservice_patch_member_module.html
