community.network.avi_cluster модуль — Модуль для настройки объекта кластера Avi RESTful

Примечание

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

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

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

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

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

Обзор

Этот модуль используется для конфигурации объекта кластера
Дополнительные примеры на https://github.com/avinetworks/devops

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

Требования

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

avisdk

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка в значение patch переопределит это поведение на использование HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который может быть использован вместо перечисления деталей входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера.
csrftoken строка	Маркер csrf контроллера API Avi для повторного использования существующей сессии с идентификатором сессии. По умолчанию: `""`
password строка	Пароль пользователя Avi в контроллере 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`.
name строка / обязательно	Имя объекта.
nodes строка	Список узлов кластера.
password строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
rejoin_nodes_automatically булево	Автоматически присоединить узлы кластера в случае сброса одного из узлов до заводских настроек. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. Варианты: `false` `true`

состояние строка	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
арендатор строка	Название арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
ссылка_арендатора строка	Ссылка на объект типа арендатор.
uuid_арендатора строка	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url строка	URL контроллера Avi для объекта.
имя_пользователя строка	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid строка	Уникальный идентификатор объекта.
виртуальный_ip строка	Виртуальный IP-адрес. Этот IP-адрес будет динамически переконфигурирован так, чтобы всегда соответствовать IP-адресу лидера кластера.

Примечания

Примечание

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

Примеры

- name: Example to create Cluster object
  community.network.avi_cluster:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_cluster

Значения возврата

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

Ключ	Описание
obj словарь	Объект кластера (api/cluster) Возвращаемое значение: успех, изменения

Авторы

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