Модуль community.network.avi_useraccount — Модуль Avi UserAccount
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: community.network.avi_useraccount.
Описание
- Этот модуль может использоваться для обновления пароля пользователя.
- Этот модуль полезен для установки администраторского пароля для загрузки контроллера.
Псевдонимы: network.avi.avi_useraccount
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
Параметр | Комментарии |
|---|---|
api_context словарь | Контекст Avi API, включающий текущий идентификатор сессии и CSRF-токен. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию. |
api_version строка | Версия Avi API для использования с Avi API и объектами. По умолчанию: |
avi_credentials словарь | Словарь Avi учетных данных, который можно использовать вместо перечисления данных входа в Avi контроллер. |
|
api_version строка |
Версия контроллера Avi По умолчанию: |
|
controller строка |
IP-адрес или SQDN контроллера Avi |
|
csrftoken строка |
CSRF-токен API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: |
|
password строка |
Пароль контроллера Avi |
|
port строка |
Порт контроллера Avi |
|
session_id строка |
Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: |
|
tenant строка |
Тенент контроллера Avi По умолчанию: |
|
tenant_uuid строка |
UUID тенента контроллера Avi По умолчанию: |
|
timeout строка |
Таймаут запроса контроллера Avi По умолчанию: |
|
token строка |
Токен API контроллера Avi По умолчанию: |
|
username строка |
Имя пользователя для доступа к контроллеру Avi |
avi_disable_session_cache_as_fact булево | Отключает кэширование информации о сессии Avi в качестве факта. Варианты:
|
controller строка | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды |
force_change строка | Если явно установлено в true, то сначала будет проверено старое имя пользователя/пароль, а затем — новое. Если этот флаг не указан, то сначала будет проверено новое имя пользователя/пароль. По умолчанию: |
old_password строка | Старый пароль для обновления или пароль по умолчанию для инициализации. |
password строка | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды |
tenant строка | Имя тенента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
tenant_uuid строка | UUID тенента, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: |
username строка | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды |
Примечания
Примечание
- Дополнительную информацию о работе с Ansible для управления устройствами Avi Network см. на сайте https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Update user password
community.network.avi_useraccount:
controller: ""
username: ""
password: new_password
old_password: ""
api_version: ""
force_change: false
- name: Update user password using avi_credentials
community.network.avi_useraccount:
avi_credentials: ""
old_password: ""
force_change: false
Значения возврата
Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
obj словарь | Ресурс Avi REST Возвращено: успешно, изменено |
Ссылки на коллекции
© 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_useraccount_module.html