Модуль community.general.ipa_group — управление группой FreeIPA

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: community.general.ipa_group.

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

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

Добавление, изменение и удаление групп на сервере IPA.

Параметры

Параметр	Комментарии
append логический добавлено в community.general 4.0.0	Если `true`, добавить указанные `user` и `group` в состав группы. Если `false`, участниками группы становятся только указанные `user` и `group`; все остальные участники удаляются. Варианты: `false` ← (по умолчанию) `true`
cn псевдонимы: name строка / обязательный	Каноническое имя. Не может быть изменено, так как является уникальным идентификатором.
description строка	Описание группы.
external логический	Разрешить добавление внешних участников, не принадлежащих IPA, из доверенных доменов. Варианты: `false` `true`
external_user список / элементы=строка добавлено в community.general 6.3.0	Список внешних пользователей, добавленных в эту группу. Работает так же, как `user`, в отношении атрибута `append`. Элементы списка могут быть указаны в формате `DOMAIN\\username` или SID. Если не указаны SID, модуль всегда пытается внести изменения, даже если группа уже содержит всех пользователей. Это связано с тем, что запрос IPA возвращает только SID. Для работы этого параметра требуется `external=true`.
gidnumber псевдонимы: gid строка	GID (используйте этот параметр, чтобы задать его вручную).
group список / элементы=строка	Список имён групп, добавленных в эту группу. Если `append=false` и передан пустой список, из этой группы удаляются все группы. Уже добавленные группы, которые не указаны в списке, удаляются. Если `append=true`, указанные группы добавляются, а остальные группы сохраняются. Если параметр не указан, назначенные группы не проверяются и не изменяются.
ipa_host строка	IP-адрес или имя узла сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_HOST`. Если в задаче не указаны ни переменная окружения `IPA_HOST`, ни значение, для обнаружения сервера FreeIPA используется DNS. Необходимая запись в FreeIPA — это запись `ipa-ca`. Если в задаче отсутствуют запись DNS, переменная окружения `IPA_HOST` и значение, используется значение по умолчанию. По умолчанию: `"ipa.example.com"`
ipa_pass строка	Пароль пользователя с правами администратора. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PASS`. Если доступна библиотека `urllib_gssapi`, для аутентификации в FreeIPA можно использовать GSSAPI. Если доступна переменная окружения `KRB5CCNAME`, модуль использует указанный в ней кэш учётных данных Kerberos для аутентификации на сервере FreeIPA. Если доступна переменная окружения `KRB5_CLIENT_KTNAME`, а `KRB5CCNAME` — нет, модуль использует указанный в ней файл keytab Kerberos для аутентификации. Если GSSAPI недоступен, необходимо использовать `ipa_pass`.
ipa_port целое число	Порт сервера FreeIPA / IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PORT`. Если в задаче не указаны ни переменная окружения `IPA_PORT`, ни значение, устанавливается значение по умолчанию. По умолчанию: `443`
ipa_prot строка	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_PROT`. Если в задаче не указаны ни переменная окружения `IPA_PROT`, ни значение, устанавливается значение по умолчанию. Варианты: `"http"` `"https"` ← (по умолчанию)
ipa_timeout целое число	Задаёт время ожидания бездействия (в секундах) для подключения. Для массовых операций можно увеличить это значение, чтобы избежать тайм-аута на сервере IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_TIMEOUT`. Если в задаче не указаны ни переменная окружения `IPA_TIMEOUT`, ни значение, устанавливается значение по умолчанию. По умолчанию: `10`
ipa_user строка	Учётная запись администратора, используемая на сервере IPA. Если значение не указано в задаче, вместо него используется значение переменной окружения `IPA_USER`. Если в задаче не указаны ни переменная окружения `IPA_USER`, ни значение, устанавливается значение по умолчанию. По умолчанию: `"admin"`
nonposix логический	Создать группу, не соответствующую POSIX. Варианты: `false` `true`
state строка	Требуемое состояние. Варианты: `"absent"` `"present"` ← (по умолчанию)
user список / элементы=строка	Список имён пользователей, добавленных в эту группу. Если `append=false` и передан пустой список, из этой группы удаляются все пользователи. Уже добавленные пользователи, которые не указаны в списке, удаляются. Если `append=true`, указанные пользователи добавляются, а остальные сохраняются. Если параметр не указан, назначенные пользователи не проверяются и не изменяются.
validate_certs логический	Применяется только в том случае, если `ipa_prot` имеет значение `https`. Если установлено значение `false`, SSL-сертификаты не проверяются. Задавайте значение `false` только для сайтов под личным контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примечания

Примечание

Этот модуль использует JSON-RPC поверх HTTP(S) для взаимодействия с сервером FreeIPA. Если необходимо зарегистрировать управляемый узел в области FreeIPA, рассмотрите возможность использования коллекции freeipa.ansible_freeipa, однако для управления развёртыванием требуется доступ к командной оболочке одного из узлов области.

Примеры

- name: Ensure group is present
  community.general.ipa_group:
    name: oinstall
    gidnumber: '54321'
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure that groups sysops and appops are assigned to ops but no other group
  community.general.ipa_group:
    name: ops
    group:
      - sysops
      - appops
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure that users linus and larry are assign to the group, but no other user
  community.general.ipa_group:
    name: sysops
    user:
      - linus
      - larry
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure that new starter named john is member of the group, without removing other members
  community.general.ipa_group:
    name: developers
    user:
      - john
    append: true
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Add external user to a group
  community.general.ipa_group:
    name: developers
    external: true
    append: true
    external_user:
      - S-1-5-21-123-1234-12345-63421
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Add a user from MYDOMAIN
  community.general.ipa_group:
    name: developers
    external: true
    append: true
    external_user:
      - MYDOMAIN\\john
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure group is absent
  community.general.ipa_group:
    name: sysops
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
group словарь	Группа в формате, возвращаемом API IPA. Возвращается: всегда

Авторы

Thomas Krahn (@Nosmoht)

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

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