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

Примечание

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

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

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

Для использования в плейбуке укажите: community.network.avi_user.

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

Описание

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
access список / элементы=строка	Настройки доступа (запись, чтение или без доступа) для каждого типа ресурса в Vantage.
api_context словарь	Контекст API Avi, который включает текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version строка	Версия API Avi для использования с API Avi и объектами. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция обновления для использования при использовании avi_api_update_method как patch. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка значения patch переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"post"` `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Токен csrf API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса По умолчанию: `""`
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`.
default_tenant_ref строка	Ссылка на стандартный арендатор. Также может быть полным URI, как в ответе. По умолчанию: `"/api/tenant?name=admin"`
email строка	Электронный адрес пользователя. Это поле используется, когда пользователь теряет свой пароль и запрашивает его сброс. См. Восстановление пароля.
is_active логическое	Активирует текущую учетную запись пользователя. Варианты: `false` `true`

is_superuser boolean	Если пользователю требуется те же привилегии, что и администратору, установите значение true. Варианты: `false` `true`
name string / обязательно	Полное имя пользователя.
obj_password string / обязательно	В этом поле можно ввести пароль для нового или существующего пользователя, чувствительный к регистру.
obj_username string / обязательно	Имя, которое пользователь будет использовать при входе в Avi Vantage, например, jdoe или jdoe@avinetworks.com.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
state string	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tenant string	Имя домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
tenant_uuid string	UUID домена, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
user_profile_ref string	Ссылка на профиль пользователя. Также может быть полным URI, таким же, как в ответном payload.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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 Возвращается: успех, изменено

Авторы

Shrikant Chaudhari (@gitshrikant)

Ссылки на коллекции

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