avi_api_session - Модуль API Avi
Новый в версии 2.3.
Обзор
- Этот модуль можно использовать для вызова любых ресурсов, определённых в API Avi REST. https://avinetworks.com/
- Этот модуль полезен для вызова методов HTTP Patch и доступа к ресурсам, не имеющим связанного с ними объекта REST.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлен в 2.5) | Контекст API Avi, включающий текущий ID сеанса и CSRF-токен. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version | По умолчанию: 16.4.4 | Версия API Avi, используемая для API Avi и объектов. |
| avi_credentials (добавлен в 2.5) | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в контроллер 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 | По умолчанию: 60 | Время ожидания (в секундах) для вызовов API Avi. |
| username | По умолчанию: | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- 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 dict | успех, изменено | Ресурс Avi REST |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/avi_api_session_module.html