avi_api_session - Модуль API Avi
Новый в версии 2.3.
Описание
- Этот модуль можно использовать для вызова любых ресурсов, определенных в REST API Avi. https://avinetworks.com/
- Этот модуль полезен для вызова методов HTTP Patch и доступа к ресурсам, не имеющим связанного с ними REST-объекта.
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязателен | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi, используемая для API Avi и объектов. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | ||
| data | нет | Тело HTTP в формате YAML или JSON. | ||
| http_method | да |
| Допустимые HTTP-методы для RESTful-служб, поддерживаемые контроллером Avi. | |
| params | нет | Параметры запроса, передаваемые в HTTP-API. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | ||
| path | нет | Путь к ресурсу API Avi. Например, path: virtualservice будет переведено в api/virtualserivce. | ||
| tenant | нет | admin | Имя тенената, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid | нет | UUID тенената, используемого для всех вызовов API Avi и контекста объекта. | ||
| timeout | нет | Таймаут (в секундах) для вызовов API Avi. | ||
| username | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
Примеры
- name: Get Pool Information using avi_api_session
avi_api_session:
controller: "{{ controller }}"
username: "{{ username }}"
password: "{{ password }}"
http_method: get
path: pool
params:
name: "{{ pool_name }}"
api_version: 16.4
register: pool_results
- name: Patch Pool with list of servers
avi_api_session:
controller: "{{ controller }}"
username: "{{ username }}"
password: "{{ password }}"
http_method: patch
path: "{{ pool_path }}"
api_version: 16.4
data:
add:
servers:
- ip:
addr: 10.10.10.10
type: V4
- ip:
addr: 20.20.20.20
type: V4
register: updated_pool
- name: Fetch Pool metrics bandwidth and connections rate
avi_api_session:
controller: "{{ controller }}"
username: "{{ username }}"
password: "{{ password }}"
http_method: get
path: analytics/metrics/pool
api_version: 16.4
params:
name: "{{ pool_name }}"
metric_id: l4_server.avg_bandwidth,l4_server.avg_complete_conns
step: 300
limit: 10
register: pool_metrics
Значения возврата
Общие значения возврата документированы здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | REST-ресурс Avi | успех, изменение | dict |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместим.
Для получения помощи в разработке модулей ознакомьтесь с Справочной информацией сообщества и участием, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_api_session_module.html