community.network.avi_cloudconnectoruser – Модуль для настройки объекта CloudConnectorUser Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_cloudconnectoruser.
Обзор
- Этот модуль используется для конфигурации объекта CloudConnectorUser
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования API Avi и объектов. | |
| avi_api_patch_op строка |
| Операция обновления для использования при использовании avi_api_update_method в режиме patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в значение patch переопределяет это поведение для использования HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который может быть использован вместо перечисления данных входа в контроллер Avi. | ||
| 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 |
| Отключает кеширование информации о сессии avi в качестве факта. | |
| azure_serviceprincipal строка | Поле добавлено в 17.2.1. | ||
| azure_userpass строка | Поле добавлено в 17.2.1. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER. | |
| gcp_credentials строка | Данные учетных записей для платформы Google Cloud. Поле добавлено в 18.2.1. | ||
| name строка / обязательно | Имя объекта. | ||
| oci_credentials строка | Данные учетных записей для Oracle Cloud Infrastructure. Поле добавлено в 18.2.1, 18.1.3. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| private_key строка | Приватный ключ cloudconnectoruser. | ||
| public_key строка | Публичный ключ cloudconnectoruser. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя теней, используемое для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Ссылка на объект типа tenant. | ||
| tenant_uuid строка | По умолчанию: "" | UUID теней, используемый для всех вызовов API Avi и контекста объекта. | |
| tencent_credentials строка | Данные учетных записей для облака Tencent. Поле добавлено в 18.2.3. | ||
| url строка | URL контроллера Avi объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании 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 словарь | success, changed | Объект CloudConnectorUser (api/cloudconnectoruser) |
Авторы
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_cloudconnectoruser_module.html
