avi_gslbservice_patch_member – Модуль API Avi
Новое в версии 2.5.
Описание
- Этот модуль можно использовать для вызова любых ресурсов, определенных в API Avi REST. https://avinetworks.com/
- Этот модуль полезен для вызова HTTP-методов PATCH и доступа к ресурсам, у которых нет связанного с ними REST-объекта.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь добавлено в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi для использования в Avi API и объектах. | |
| avi_credentials словарь добавлено в 2.5 | Словарь Avi Credentials, который может быть использован вместо перечисления данных для входа в Avi Controller. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN Avi контроллера | ||
| csrftoken - | CSRF-токен API Avi контроллера для повторного использования существующего сеанса с идентификатором сеанса | ||
| password - | Пароль пользователя Avi в Avi контроллере | ||
| port - | Порт Avi контроллера | ||
| session_id - | Идентификатор сеанса API Avi контроллера для повторного использования существующего сеанса с csrftoken | ||
| tenant - | Значение по умолчанию: "admin" | Тенент Avi контроллера | |
| tenant_uuid - | UUID тенента Avi контроллера | ||
| timeout - | Значение по умолчанию: 300 | Таймаут запроса Avi контроллера | |
| token - | Токен API Avi контроллера | ||
| username - | Имя пользователя Avi контроллера | ||
| avi_disable_session_cache_as_fact логическое добавлено в 2.6 |
| Отключает кеширование информации о сеансе 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" | Имя тенента, используемого для всех вызовов Avi API и контекста объекта. | |
| tenant_uuid строка | Значение по умолчанию: "" | UUID тенента, используемого для всех вызовов Avi API и контекста объекта. | |
| 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 словарь | успех, изменения | Avi REST-ресурс |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (@grastogi23) <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.9/modules/avi_gslbservice_patch_member_module.html