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, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера | ||
| csrftoken - | Маркер csrf контроллера API Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password - | Пароль пользователя Avi в контроллере 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 булево добавлен в 2.6 |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная среды AVI_CONTROLLER. | |
| description - | Пользовательское описание для объекта. | ||
| http - | Параметры аутентификации пользователя Http. | ||
| ldap - | Настройки сервера и каталога LDAP. | ||
| name - / обязательно | Имя профиля аутентификации. | ||
| pa_agent_ref - добавлен в 2.9 | UUID pingaccessagent. Это ссылка на объект типа pingaccessagent. Поле введено в 18.2.3. | ||
| 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, AUTH_PROFILE_PINGACCESS. | ||
| 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 словарь | успех, изменение | Объект AuthProfile (api/authprofile) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav Rastogi (@grastogi23) <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.9/modules/avi_authprofile_module.html