community.network.avi_user – Модуль пользователя Avi
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_user.
Обзор
- Этот модуль можно использовать для создания, обновления и удаления пользователя.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access список / элементы=строка | Настройки доступа (запись, чтение или отсутствие доступа) для каждого типа ресурса в Vantage. | ||
| 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, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или FQDN контроллера | ||
| csrftoken строка | Маркер csrf API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль контроллера 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 в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| default_tenant_ref строка | По умолчанию: "/api/tenant?name=admin" | Ссылка на тенейт по умолчанию. Также может быть полным URI, таким же, как в ответном пакете. | |
| email строка | Электронный адрес пользователя. Это поле используется, когда пользователь теряет свой пароль и запрашивает его сброс. См. Восстановление пароля. | ||
| is_active boolean |
| Активирует текущую учетную запись пользователя. | |
| is_superuser boolean |
| Если пользователю потребуются те же привилегии, что и у учетной записи администратора, установите его в значение true. | |
| name строка / обязательно | Полное имя пользователя. | ||
| obj_password строка / обязательно | Вы можете ввести чувствительный к регистру пароль в это поле для нового или существующего пользователя. | ||
| obj_username строка / обязательно | Имя, которое пользователь будет указывать при входе в Avi Vantage, например, jdoe или jdoe@avinetworks.com. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенейта, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid строка | По умолчанию: "" | UUID тенейта, используемого для всех вызовов API Avi и контекста объекта. | |
| user_profile_ref строка | Ссылка на профиль пользователя. Также может быть полным URI, таким же, как в ответном пакете. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: User creation
community.network.avi_user:
controller: ""
username: ""
password: ""
api_version: ""
name: "testuser"
obj_username: "testuser"
obj_password: "test123"
email: "test@abc.test"
access:
- role_ref: "/api/role?name=Tenant-Admin"
tenant_ref: "/api/tenant/admin#admin"
user_profile_ref: "/api/useraccountprofile?name=Default-User-Account-Profile"
is_active: true
is_superuser: true
default_tenant_ref: "/api/tenant?name=admin"
- name: User creation
community.network.avi_user:
controller: ""
username: ""
password: ""
api_version: ""
name: "testuser"
obj_username: "testuser2"
obj_password: "password"
email: "testuser2@abc.test"
access:
- role_ref: "https://192.0.2.10/api/role?name=Tenant-Admin"
tenant_ref: "https://192.0.2.10/api/tenant/admin#admin"
user_profile_ref: "https://192.0.2.10/api/useraccountprofile?name=Default-User-Account-Profile"
is_active: true
is_superuser: true
default_tenant_ref: "https://192.0.2.10/api/tenant?name=admin"
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменилось | Ресурс Avi REST |
Авторы
- Шрикан Чаудхари (@gitshrikant) <shrikant.chaudhari@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.10/collections/community/network/avi_user_module.html
