avi_cloudconnectoruser – Модуль для настройки объекта CloudConnectorUser Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта CloudConnectorUser.
- Больше примеров на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь Добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для Avi API и объектов. | |
| avi_api_patch_op - Добавлен в 2.5 |
| Операция обновления (patch), используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method - Добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установление значения в patch переопределяет это поведение на использование HTTP PATCH. | |
| avi_credentials словарь Добавлен в 2.5 | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в Avi Controller. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль пользователя Avi в контроллере 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 в качестве факта. | |
| azure_serviceprincipal - Добавлен в 2.5 | Поле добавлено в 17.2.1. | ||
| azure_userpass - Добавлен в 2.5 | Поле добавлено в 17.2.1. | ||
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| gcp_credentials - Добавлен в 2.9 | Учетные данные для платформы Google Cloud. Поле добавлено в 18.2.1. | ||
| name - / обязательно | Имя объекта. | ||
| oci_credentials - Добавлен в 2.9 | Учетные данные для Oracle Cloud Infrastructure. Поле добавлено в 18.2.1, 18.1.3. | ||
| password строка | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| private_key - | Заключительный ключ cloudconnectoruser. | ||
| public_key - | Открытый ключ cloudconnectoruser. | ||
| state - |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | Значение по умолчанию: "admin" | Имя тенента, используемого для всех вызовов Avi API и контекста объекта. | |
| tenant_ref - | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID тенента, используемого для всех вызовов Avi API и контекста объекта. | |
| tencent_credentials - Добавлен в 2.9 | Учетные данные для облака Tencent. Поле добавлено в 18.2.3. | ||
| url - | URL контроллера Avi объекта. | ||
| username строка | Значение по умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid - | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create a Cloud connector user that is used for integration into cloud platforms
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) |
Статус
- Интерфейс этого модуля не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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_cloudconnectoruser_module.html
