avi_api_session – Модуль API Avi
Описание
- Этот модуль можно использовать для вызова любых ресурсов, определенных в 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-контроллер. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN Avi-контроллера | ||
| csrftoken - | CSRF-токен API Avi-контроллера для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль 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 boolean добавлен в 2.6 |
| Отключает кэширование информации о сессии Avi в качестве факта. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| data - | Тело HTTP-запроса в формате YAML или JSON. | ||
| http_method - / обязательно |
| Разрешенные HTTP-методы для REST-служб, поддерживаемых 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 словарь | успех, изменение | REST-ресурс Avi |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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_api_session_module.html