community.general.utm_aaa_group модуль — Создание, обновление или удаление объекта группы aaa в Sophos UTM

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.utm_aaa_group.

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление или удаление объекта группы aaa в Sophos UTM.
Для работы с этим модулем необходимо активировать REST-возможности UTM.

Параметры

Параметр	Комментарии
adirectory_groups list / elements=string	Список строк групп adirectory. По умолчанию: `[]`
adirectory_groups_sids dictionary	Словарь идентификаторов групп. По умолчанию: `{}`
backend_match string	Бэкенд для группы. Варианты: `"none"` ← (по умолчанию) `"adirectory"` `"edirectory"` `"radius"` `"tacacs"` `"ldap"`
comment string	Комментарий, описывающий группу AAA. По умолчанию: `""`
dynamic string	Тип группы. Статическая, если ничего не выбрано. Варианты: `"none"` ← (по умолчанию) `"ipsec_dn"` `"directory_groups"`
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 / required	Имя объекта. Будет использоваться для идентификации записи.
network string	Имя ссылки на сеть. Объекты содержат известные IP-адреса для объекта аутентификации (network/aaa). По умолчанию: `""`
radius_groups list / elements=string	Список строк групп radius. По умолчанию: `[]`
state string	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он присутствовал. Варианты: `"absent"` `"present"` ← (по умолчанию)
tacacs_groups list / elements=string	Список строк групп tacacs. По умолчанию: `[]`
utm_host string / required	Конечная точка REST Sophos UTM.
utm_port integer	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol string	Протокол конечной точки REST. Варианты: `"http"` `"https"` ← (по умолчанию)

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-интерфейса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может выполняться в `check_mode` и возвращать прогноз состояния изменения без модификации целевого объекта.
diff_mode	Поддержка: нет	Возвратит детали о том, что изменилось (или, возможно, нужно изменить в `check_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, который был создан. Возвращается: success
_locked boolean	Заблокирован ли объект в данный момент. Возвращается: success
_ref string	Имя ссылки на объект. Возвращается: success
_type string	Тип объекта. Возвращается: success
adirectory_groups string	Список групп Active Directory. Возвращается: success
adirectory_groups_sids list / elements=string	Список SID групп Active Directory. Возвращается: success
backend_match string	Бэкэнд для использования. Возвращается: success
comment string	Строка комментария. Возвращается: success
dynamic string	Совпадение группы ipsec_dn или directory_group. Возвращается: success
edirectory_groups string	Список групп eDirectory. Возвращается: success
ipsec_dn string	Идентификатор ipsec_dn для сопоставления. Возвращается: success
ldap_attribute string	Атрибут LDAP для сопоставления. Возвращается: success
ldap_attribute_value string	Значение атрибута LDAP для сопоставления. Возвращается: success
members list / elements=string	Список идентификаторов членов группы. Возвращается: success
name string	Имя объекта. Возвращается: success
network string	Идентификатор сети (network/aaa). Возвращается: success
radius_group string	Идентификатор группы RADIUS. Возвращается: success
tacacs_group string	Идентификатор группы TACACS. Возвращается: success

Авторы

Johannes Brunswicker (@MatrixCrawler)

Ссылки на коллекцию

© 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/general/utm_aaa_group_module.html