community.general.utm_aaa_group – Создание, обновление или удаление объекта группы aaa в Sophos UTM.
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.utm_aaa_group.
Обзор
- Создание, обновление или удаление объекта группы aaa в Sophos UTM.
- Для работы этого модуля необходимо включить REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| adirectory_groups список / элементы=строка | Список строк групп Active Directory. | |
| adirectory_groups_sids словарь | Словарь идентификаторов безопасности (SID) групп. | |
| backend_match строка |
| Бэкенд для группы. |
| comment строка | Значение по умолчанию: "" | Комментарий, описывающий группу AAA. |
| dynamic строка |
| Тип группы. Статическая, если выбрано none. |
| edirectory_groups список / элементы=строка | Список строк групп eDirectory. | |
| headers словарь | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей | |
| ipsec_dn строка | Строка ipsec dn. | |
| ldap_attribute строка | Атрибут LDAP для проверки. | |
| ldap_attribute_value строка | Значение атрибута LDAP для проверки. | |
| members список / элементы=строка | Значение по умолчанию: [] | Список имен ссылок на пользователей (aaa/user). |
| name строка / обязательно | Имя объекта. Будет использовано для идентификации записи. | |
| network строка | Значение по умолчанию: "" | Имя ссылки на сеть. Объект содержит известные IP-адреса для объекта аутентификации (network/aaa). |
| radius_groups список / элементы=строка | Значение по умолчанию: [] | Список строк групп radius. |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объектabsent удалит объект, если он был присутствовал |
| tacacs_groups список / элементы=строка | Значение по умолчанию: [] | Список строк групп tacacs. |
| utm_host строка / обязательно | REST-точек доступа Sophos UTM. | |
| utm_port целое число | Значение по умолчанию: 4444 | Порт REST-интерфейса. |
| utm_protocol строка |
| Протокол REST-точек доступа. |
| utm_token строка / обязательно | Токен, используемый для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 2.4.2. | |
| validate_certs логическое значение |
| Требуется ли проверка SSL-сертификата REST-интерфейса. |
Примеры
- 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 сложный | успех | Объект utm, который был создан. | |
| _locked логическое значение | успех | Заблокирован ли объект в данный момент. | |
| _ref строка | успех | Имя ссылки на объект. | |
| _type строка | успех | Тип объекта. | |
| adirectory_groups строка | успех | Список групп Active Directory. | |
| adirectory_groups_sids список / элементы=строка | успех | Список идентификаторов безопасности (SID) групп Active Directory. | |
| backend_match строка | успех | Используемый бэкенд. | |
| comment строка | успех | Строка комментария. | |
| dynamic строка | успех | Соответствует ли группа ipsec_dn или directory_group. | |
| edirectory_groups строка | успех | Список групп eDirectory. | |
| ipsec_dn строка | успех | Идентификатор ipsec_dn для сопоставления. | |
| ldap_attribute строка | успех | Атрибут LDAP для сопоставления. | |
| ldap_attribute_value строка | успех | Значение атрибута LDAP для сопоставления. | |
| members список / элементы=строка | успех | Список идентификаторов членов группы. | |
| name строка | успех | Имя объекта. | |
| network строка | успех | Идентификатор сети (network/aaa). | |
| radius_group строка | успех | Идентификатор группы radius. | |
| tacacs_group строка | успех | Идентификатор группы tacacs. | |
Авторы
- Johannes Brunswicker (@MatrixCrawler)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/utm_aaa_group_module.html