avi_api_session - Модуль Avi API
Новый в версии 2.3.
Описание
- Этот модуль может использоваться для вызова любых ресурсов, определённых в Avi REST API. https://avinetworks.com/
- Этот модуль полезен для вызова методов HTTP Patch и доступа к ресурсам, у которых нет связанного с ними REST-объекта.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлено в 2.5) | Контекст Avi API, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | |
| api_version | Значение по умолчанию: "16.4.4" | Версия Avi API, используемая для Avi API и объектов. |
| avi_credentials (добавлено в 2.5) | Словарь Avi Credentials, который может быть использован вместо перечисления данных для входа в Avi Controller. | |
| controller | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. |
| data | Тело HTTP запроса в формате YAML или JSON. | |
| http_method обязательно |
| Допустимые HTTP-методы для RESTful-сервисов, поддерживаемых Avi Controller. |
| params | Параметры запроса, передаваемые в HTTP API. | |
| password | Значение по умолчанию: "" | Пароль пользователя Avi в Avi контроллере. Значение по умолчанию — переменная окружения AVI_PASSWORD. |
| path | Путь к ресурсу Avi API. Например, path: virtualservice будет переведено в api/virtualserivce. | |
| tenant | Значение по умолчанию: "admin" | Имя клиента, используемое для всех вызовов Avi API и контекста объекта. |
| tenant_uuid | Значение по умолчанию: "" | UUID клиента, используемого для всех вызовов Avi API и контекста объекта. |
| timeout | Значение по умолчанию: 60 | Таймаут (в секундах) для вызовов Avi API. |
| 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 | success, changed | Avi REST-ресурс |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в Разделе технической поддержки модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/avi_api_session_module.html