avi_user – Модуль пользователя Avi

Новый в версии 2.9.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Краткое описание

Этот модуль может использоваться для создания, обновления и удаления пользователя.

Требования

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

avisdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access список			Настройки доступа (запись, чтение или отсутствие доступа) для каждого типа ресурса в Vantage.
api_context словарь добавлено в 2.5			Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить одно входное действие и повторно использовать сеанс.
api_version строка		Значение по умолчанию: "16.4.4"	Версия API Avi, используемая для API Avi и объектов.
avi_api_patch_op строка		Варианты: add replace delete	Операция обновления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method строка		Варианты: post put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение для использования HTTP PATCH.
avi_credentials словарь добавлено в 2.5			Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
	api_version -	Значение по умолчанию: "16.4.4"	Версия контроллера Avi
	controller -		IP-адрес или SQDN контроллера
	csrftoken -		CSRF-токен API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса.
	password -		Пароль контроллера Avi
	port -		Порт контроллера Avi
	session_id -		Идентификатор сеанса API контроллера Avi для повторного использования существующего сеанса с CSRF-токен.
	tenant -	Значение по умолчанию: "admin"	Тенант контроллера Avi
	tenant_uuid -		UUID тенанта контроллера Avi
	timeout -	Значение по умолчанию: 300	Время ожидания запроса контроллера Avi
	token -		Токен API контроллера Avi
	username -		Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact boolean добавлено в 2.6		Варианты: no yes	Отключает кэширование информации о сеансе Avi в качестве факта.
controller строка		Значение по умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
default_tenant_ref строка		Значение по умолчанию: "/api/tenant?name=admin"	Справочная информация по тенанту по умолчанию. Это также может быть полный URI, такой же, как в ответе payload.
email строка			Адрес электронной почты пользователя. Это поле используется, когда пользователь теряет свой пароль и запрашивает сброс. См. Восстановление пароля.
is_active boolean		Варианты: no yes	Активирует текущую учетную запись пользователя.
is_superuser boolean		Варианты: no yes	Если пользователю потребуются те же привилегии, что и у учетной записи администратора, установите значение в true.
name строка / обязательно			Полное имя пользователя.
obj_password строка / обязательно			Вы можете ввести пароль в этом поле для нового или существующего пользователя.
obj_username строка / обязательно			Имя пользователя, которое пользователь будет вводить при входе в Avi Vantage, например, jdoe или jdoe@avinetworks.com.
password строка		Значение по умолчанию: ""	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state строка		Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant строка		Значение по умолчанию: "admin"	Имя тенанта, используемое для всех вызовов API Avi и контекста объекта.
tenant_uuid строка		Значение по умолчанию: ""	UUID тенанта, используемого для всех вызовов API Avi и контекста объекта.
user_profile_ref строка			Ссылка на профиль пользователя. Это также может быть полный URI, такой же, как в ответе payload.
username строка		Значение по умолчанию: ""	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: user creation
  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
  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 словарь	success, changed	Ресурс Avi REST

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Shrikant Chaudhari (@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.9/modules/avi_user_module.html