community.network.avi_useraccountprofile – Модуль для настройки объекта UserAccountProfile Avi RESTful
Примечание
Этот плагин входит в состав коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.avi_useraccountprofile.
Обзор
- Этот модуль используется для настройки объекта UserAccountProfile
- Дополнительные примеры по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| account_lock_timeout строка | Срок блокировки учетной записи (в минутах). По умолчанию 30 минут. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 30. | ||
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования в API Avi и объектах. | |
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как исправление. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер 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 логический тип |
| Отключает кэширование информации о сеансе Avi в качестве факта. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| credentials_timeout_threshold строка | Период времени, по истечении которого учетные данные истекают. По умолчанию 180 дней. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 180. | ||
| max_concurrent_sessions строка | Максимальное количество одновременных сеансов. По умолчанию неограниченное число сеансов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| max_login_failure_count строка | Количество попыток входа до блокировки. По умолчанию 3 попытки. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3. | ||
| max_password_history_count строка | Максимальное количество паролей, сохраняемых в истории паролей. По умолчанию 4 пароля. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4. | ||
| name строка / обязательно | Имя объекта. | ||
| password строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | По умолчанию: "admin" | Имя тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_uuid строка | По умолчанию: "" | UUID тенента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create UserAccountProfile object
community.network.avi_useraccountprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_useraccountprofile
Значения возврата
Общие значения возврата описаны в разделе здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменения | Объект UserAccountProfile (api/useraccountprofile) |
Авторы
- 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_useraccountprofile_module.html