Модуль community.network.avi_api_session – Модуль API Avi

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.network.avi_api_session.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль можно использовать для вызова любых ресурсов, определённых в REST API Avi. https://avinetworks.com/
Этот модуль полезен для вызова HTTP Patch методов и доступа к ресурсам, для которых нет связанного REST объекта.

Псевдонимы: network.avi.avi_api_session

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст Avi API, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия Avi API для использования с Avi API и объектами. Значение по умолчанию: `"16.4.4"`
avi_credentials словарь	Словарь Avi Credentials, который можно использовать вместо перечисления учетных данных входа в Avi Controller.
api_version строка	Версия контроллера Avi Значение по умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера Avi
csrftoken строка	Токен csrf API контроллера Avi для повторного использования существующей сессии с идентификатором сессии Значение по умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken Значение по умолчанию: `""`
tenant строка	Домен контроллера Avi Значение по умолчанию: `"admin"`
tenant_uuid строка	UUID домена контроллера Avi Значение по умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi Значение по умолчанию: `300`
token строка	Токен API контроллера Avi Значение по умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логический	Отключает кэширование информации о сессии Avi в качестве факта. Варианты: `false` ← (значение по умолчанию) `true`
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
data строка	Тело HTTP в формате YAML или JSON.
http_method строка / обязательно	Разрешенные HTTP-методы для RESTful-сервисов, поддерживаемые контроллером Avi. Варианты: `"get"` `"put"` `"post"` `"patch"` `"delete"`
params строка	Параметры запроса, передаваемые в HTTP-API.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
path строка	Путь к ресурсу Avi API. Например, `path: virtualservice` будет переведено в `api/virtualserivce`.
tenant строка	Имя домена, используемого для всех вызовов Avi API и контекста объекта. Значение по умолчанию: `"admin"`
tenant_uuid строка	UUID домена, используемого для всех вызовов Avi API и контекста объекта. Значение по умолчанию: `""`

timeout string	Время ожидания (в секундах) для вызовов API Avi. По умолчанию: `60`
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Get Pool Information using avi_api_session
  community.network.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
  community.network.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
  community.network.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 API Avi Возвращается: успех, изменение

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_api_session_module.html