Spec-Zone.ru › Ansible

Модуль community.network.avi_useraccountprofile — Модуль для настройки объекта UserAccountProfile Avi RESTful

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные условия. Подробнее см. Требования.

Чтобы использовать его в playbook, укажите: community.network.avi_useraccountprofile.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль используется для настройки объекта UserAccountProfile.
  • Дополнительные примеры см. на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_useraccountprofile

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором будет выполняться этот модуль.

  • avisdk
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

account_lock_timeout

строка

Срок блокировки аккаунта (в минутах).

По умолчанию 30 минут.

По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как 30.

api_context

словарь

Контекст API Avi, который включает текущий идентификатор сеанса и токен CSRF.

Это позволяет пользователю выполнить одно входное подключение и повторно использовать сеанс.

api_version

строка

Версия API Avi для использования с Avi API и объектами.

По умолчанию: "16.4.4"

avi_api_patch_op

строка

Операция исправления, используемая при использовании avi_api_update_method как patch.

Варианты:

  • "add"
  • "replace"
  • "delete"

avi_api_update_method

строка

Метод по умолчанию для обновления объекта — HTTP PUT.

Установка на patch переопределяет это поведение, чтобы использовать HTTP PATCH.

Варианты:

  • "put" ← (по умолчанию)
  • "patch"

avi_credentials

словарь

Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в систему контроллера Avi.

api_version

строка

Версия контроллера Avi

По умолчанию: "16.4.4"

controller

строка

IP-адрес или SQDN контроллера

csrftoken

строка

Токен csrf контроллера Avi API для повторного использования существующего сеанса с идентификатором сеанса

По умолчанию: ""

password

строка

Пароль контроллера Avi

port

строка

Порт контроллера Avi

session_id

строка

Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken

По умолчанию: ""

tenant

строка

Тенейнт контроллера Avi

По умолчанию: "admin"

tenant_uuid

строка

UUID тенейнта контроллера Avi

По умолчанию: ""

timeout

строка

Таймаут запроса контроллера Avi

По умолчанию: 300

token

строка

Токен API контроллера Avi

По умолчанию: ""

username

строка

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

логическое

Отключает кэширование информации о сеансе Avi в качестве факта.

Варианты:

  • false ← (по умолчанию)
  • true

controller

строка

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER

credentials_timeout_threshold

строка

Период времени, после которого учетные данные истекают.

По умолчанию 180 дней.

По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как 180.

max_concurrent_sessions

строка

Максимальное количество одновременных сеансов.

По умолчанию сеансов неограниченное количество.

По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как 0.

max_login_failure_count

string

Количество попыток входа в систему перед блокировкой.

По умолчанию 3 попытки.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3.

max_password_history_count

string

Максимальное количество паролей для хранения в истории паролей.

По умолчанию 4 пароля.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.

name

string / обязательно

Имя объекта.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD.

state

string

Состояние, которое должно быть применено к сущности.

Выбор:

  • "absent"
  • "present" ← (по умолчанию)

tenant

string

Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: "admin"

tenant_uuid

string

UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: ""

url

string

URL контроллера Avi для объекта.

username

string

Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.

uuid

string

Уникальный идентификатор объекта.

Примечания

Примечание

  • Дополнительную информацию об использовании 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)

Возвращаемое значение: success, changed

Авторы

  • Gaurav Rastogi (@grastogi23)

Справочные ссылки по коллекции

  • Система отслеживания ошибок
  • Репозиторий (исходные коды)

© 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_useraccountprofile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API