Модуль community.general.utm_aaa_group – создание, обновление или удаление объекта группы AAA в Sophos UTM
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать коллекцию в плейбуке, укажите: community.general.utm_aaa_group.
Краткое описание
- Создание, обновление или удаление объекта группы AAA в Sophos UTM.
- Для работы этого модуля необходимо активировать REST API UTM.
Параметры
Параметр | Комментарии |
|---|---|
adirectory_groups list / elements=string | Список строк с именами групп adirectory. По умолчанию: |
adirectory_groups_sids dictionary | Словарь SID групп. По умолчанию: |
backend_match string | Серверная система для группы. Варианты:
|
comment string | Комментарий с описанием группы AAA. По умолчанию: |
dynamic string | Тип группы. Если ничего не выбрано, группа является статической. Варианты:
|
edirectory_groups list / elements=string | Список строк с именами групп edirectory. По умолчанию: |
headers dictionary | Словарь дополнительных заголовков, которые отправляются в запросах POST и PUT. Требуется для некоторых модулей. По умолчанию: |
ipsec_dn string | Строка ipsec dn. По умолчанию: |
ldap_attribute string | Атрибут LDAP для проверки. По умолчанию: |
ldap_attribute_value string | Значение атрибута LDAP для проверки. По умолчанию: |
members list / elements=string | Список ссылочных имен пользователей (aaa/user). По умолчанию: |
name string / обязательный | Имя объекта, идентифицирующее запись. |
network string | Ссылочное имя сети. Объект содержит известные IP-адреса для объекта аутентификации (network/aaa). По умолчанию: |
radius_groups list / elements=string | Список строк с именами групп radius. По умолчанию: |
state string | Требуемое состояние объекта.
Варианты:
|
tacacs_groups list / elements=string | Список строк с именами групп tacacs. По умолчанию: |
utm_host string / обязательный | Конечная точка REST API Sophos UTM. |
utm_port integer | Порт интерфейса REST. По умолчанию: |
utm_protocol string | Протокол конечной точки REST API. Варианты:
|
utm_token string / обязательный | Токен для идентификации в REST API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 2.4.2. |
validate_certs boolean | Проверять ли SSL-сертификат интерфейса REST. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Может выполняться в режиме |
diff_mode | Поддержка: нет | В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в |
Примеры
- name: Create UTM aaa_group
community.general.utm_aaa_group:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAAAGroupEntry
backend_match: ldap
dynamic: directory_groups
ldap_attributes: memberof
ldap_attributes_value: "cn=groupname,ou=Groups,dc=mydomain,dc=com"
network: REF_OBJECT_STRING
state: present
- name: Remove UTM aaa_group
community.general.utm_aaa_group:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAAAGroupEntry
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
result complex | Созданный объект UTM. Возвращается: при успехе |
|
_locked boolean |
Заблокирован ли объект в данный момент. Возвращается: при успехе |
|
_ref string |
Ссылочное имя объекта. Возвращается: при успехе |
|
_type string |
Тип объекта. Возвращается: при успехе |
|
adirectory_groups string |
Список групп Active Directory. Возвращается: при успехе |
|
adirectory_groups_sids list / elements=string |
Список SID групп Active Directory. Возвращается: при успехе |
|
backend_match string |
Используемая серверная система. Возвращается: при успехе |
|
comment string |
Строка комментария. Возвращается: при успехе |
|
dynamic string |
Соответствует ли группа значению ipsec_dn или directory_group. Возвращается: при успехе |
|
edirectory_groups string |
Список групп eDirectory. Возвращается: при успехе |
|
ipsec_dn string |
Идентификатор ipsec_dn для сопоставления. Возвращается: при успехе |
|
ldap_attribute string |
Атрибут LDAP для сопоставления. Возвращается: при успехе |
|
ldap_attribute_value string |
Значение атрибута LDAP для сопоставления. Возвращается: при успехе |
|
members list / elements=string |
Список идентификаторов участников группы. Возвращается: при успехе |
|
name string |
Имя объекта. Возвращается: при успехе |
|
network string |
Идентификатор сети (network/aaa). Возвращается: при успехе |
|
radius_group string |
Идентификатор группы radius. Возвращается: при успехе |
|
tacacs_group string |
Идентификатор группы tacacs. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/utm_aaa_group_module.html