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

Примечание

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

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

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

Для использования в плейбуке укажите: community.network.avi_gslbservice_patch_member.

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

Описание

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
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-запроса для узла службы GSLB в формате YAML или JSON.
name строка / обязательно	Имя службы GSLB
params строка	Параметры запроса, передаваемые в HTTP-API.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`
state строка	Состояние, которое должно быть применено к узлу. Узел идентифицируется по полю member.ip.addr. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant строка	Имя домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`

END_OF_DOCUMENT_MARKER

tenant_uuid string	UUID клиента, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.

Примечания

Примечание

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

Примеры

- name: Patch GSLB Service to add a new member and group
  community.network.avi_gslbservice_patch_member:
    controller: "{{ controller }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: gs-3
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        priority: 60
        members:
          - enabled: true
            ip:
              addr:  10.30.10.66
              type: V4
            ratio: 3
- name: Patch GSLB Service to delete an existing member
  community.network.avi_gslbservice_patch_member:
    controller: "{{ controller }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: gs-3
    state: absent
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        members:
          - enabled: true
            ip:
              addr:  10.30.10.68
              type: V4
            ratio: 3
- name: Update priority of GSLB Service Pool
  community.network.avi_gslbservice_patch_member:
    controller: ""
    username: ""
    password: ""
    name: gs-3
    state: present
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        priority: 42

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
obj словарь	Ресурс Avi REST Возвращается: успех, изменено

Авторы

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_gslbservice_patch_member_module.html