avi_authprofile — Модуль для настройки объекта AuthProfile Avi RESTful
Новый в версии 2.4.
Обзор
- Этот модуль используется для настройки объекта AuthProfile.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлен в 2.5) | Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version | По умолчанию: "16.4.4" | Версия API Avi для использования с API Avi и объектами. |
| avi_api_patch_op (добавлен в 2.5) |
| Операция патча для использования при использовании avi_api_update_method как патча. |
| avi_api_update_method (добавлен в 2.5) |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение на использование HTTP PATCH. |
| avi_credentials (добавлен в 2.5) | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| controller | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| description | Пользовательское описание объекта. | |
| http | Параметры аутентификации пользователя HTTP. | |
| ldap | Настройки сервера и каталога LDAP. | |
| name обязательно | Имя профиля аутентификации. | |
| password | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| saml (добавлен в 2.5) | Настройки SAML. Поле введено в 17.2.3. | |
| state |
| Состояние, которое должно быть применено к сущности. |
| tacacs_plus | Настройки TACACS+. | |
| tenant | По умолчанию: "admin" | Имя тенанта, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Ссылка на объект типа tenant. | |
| tenant_uuid | По умолчанию: "" | UUID тенанта, используемого для всех вызовов API Avi и контекста объекта. |
| type обязательно | Тип профиля аутентификации. Варианты перечисления — AUTH_PROFILE_LDAP, AUTH_PROFILE_TACACS_PLUS, AUTH_PROFILE_SAML. | |
| url | URL контроллера Avi объекта. | |
| username | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid | UUID профиля аутентификации. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create user authorization profile based on the LDAP
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 dict | success, changed | Объект AuthProfile (api/authprofile) |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. в Поддержка модулей и техническое обслуживание.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Гaurav Rastogi (grastogi@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.6/modules/avi_authprofile_module.html