Модуль community.network.avi_authprofile – Модуль для настройки объекта AuthProfile Avi RESTful

Примечание

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

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

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

Для использования в книге задач укажите: community.network.avi_authprofile.

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

Обзор

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

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

Требования

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

avisdk

Параметры

Параметр	Комментарии
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 строка	Маркер csrftoken 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`
description строка	Пользовательское описание объекта.
http строка	Параметры аутентификации пользователя HTTP.
ldap строка	Настройки LDAP-сервера и каталога.
name строка / обязательно	Имя профиля аутентификации.
pa_agent_ref строка	UUID агента PingAccess. Это ссылка на объект типа pingaccessagent. Поле введено в 18.2.3.

END_OF_DOCUMENT_MARKER

пароль строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения `AVI_PASSWORD`.
saml строка	Настройки Saml. Поле введено в версии 17.2.3.
состояние строка	Состояние, которое должно быть применено к сущности. Варианты: `"absent"` `"present"` ← (по умолчанию)
tacacs_plus строка	Настройки Tacacs+.
арендатор строка	Название арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
ссылка_арендатора строка	Ссылка на объект типа арендатор.
uuid_арендатора строка	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
тип строка / обязательно	Тип профиля аутентификации. Варианты перечисления - AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML, AUTH_PROFILE_PINGACCESS.
url строка	URL контроллера Avi для объекта.
логин строка	Логин, используемый для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения `AVI_USERNAME`.
uuid строка	Uuid профиля аутентификации.

Примечания

Примечание

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

Примеры

- name: Create user authorization profile based on the LDAP
  community.network.avi_authprofile:
    controller: '{{ controller }}'
    password: '{{ password }}'
    username: '{{ username }}'
    http:
      cache_expiration_time: 5
      group_member_is_full_dn: false
    ldap:
      base_dn: dc=avi,dc=local
      bind_as_administrator: true
      port: 389
      security_mode: AUTH_LDAP_SECURE_NONE
      server:
      - 10.10.0.100
      settings:
        admin_bind_dn: user@avi.local
        group_filter: (objectClass=*)
        group_member_attribute: member
        group_member_is_full_dn: true
        group_search_dn: dc=avi,dc=local
        group_search_scope: AUTH_LDAP_SCOPE_SUBTREE
        ignore_referrals: true
        password: password
        user_id_attribute: samAccountname
        user_search_dn: dc=avi,dc=local
        user_search_scope: AUTH_LDAP_SCOPE_ONE
    name: ProdAuth
    tenant_ref: admin
    type: AUTH_PROFILE_LDAP

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
obj словарь	Объект AuthProfile (api/authprofile) Возвращается: успех, изменено

Авторы

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_authprofile_module.html