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

Примечание

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

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

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

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

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

Обзор

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования с Avi API и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method в режиме исправления. Возможные значения: `"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 контроллера Avi API для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: `""`
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`
azure_serviceprincipal строка	Поле введено в 17.2.1.
azure_userpass строка	Поле введено в 17.2.1.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
gcp_credentials строка	Учетные данные для платформы Google Cloud. Поле введено в 18.2.1.
name строка / обязательно	Имя объекта.

oci_credentials string	Данные для входа в oracle cloud infrastructure. Поле добавлено в 18.2.1, 18.1.3.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
private_key string	Закрытый ключ cloudconnectoruser.
public_key string	Открытый ключ cloudconnectoruser.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя арендатора, используемое для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Ссылка на объект типа арендатор.
tenant_uuid string	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
tencent_credentials string	Данные для входа в tencent cloud. Поле добавлено в 18.2.3.
url string	URL контроллера Avi для объекта.
username string	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

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

Примеры

- name: Create a Cloud connector user that is used for integration into cloud platforms
  community.network.avi_cloudconnectoruser:
    controller: '{{ controller }}'
    name: root
    password: '{{ password }}'
    private_key: |
      -----BEGIN RSA PRIVATE KEY-----
      -----END RSA PRIVATE KEY-----'
    public_key: 'ssh-rsa ...'
    tenant_ref: admin
    username: '{{ username }}'

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

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

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

Авторы

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