Spec-Zone.ru › Ansible

community.general.ipa_group модуль – Управление группой FreeIPA

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

  • Обзор
  • Параметры
  • Атрибуты
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр

Комментарии

append

boolean

added in community.general 4.0.0

Если true, добавить указанные user и group в члены группы.

Если false, только указанные user и group будут членами группы, удалив всех остальных членов.

Варианты:

  • false ← (default)
  • true

cn

aliases: name

string / required

Каноническое имя.

Не может быть изменено, так как является уникальным идентификатором.

description

string

Описание группы.

external

boolean

Разрешить добавление внешних членов, не являющихся членами IPA, из доверенных доменов.

Варианты:

  • false
  • true

external_user

list / elements=string

added in community.general 6.3.0

Список внешних пользователей, назначенных этой группе.

Ведет себя идентично user относительно атрибута append.

Записи списка могут быть в формате DOMAIN\\username или SID.

Если не указаны SID, модуль всегда будет пытаться внести изменения, даже если группа уже содержит всех пользователей. Это связано с тем, что запрос IPA возвращает только SID.

external=true необходим для работы этой опции.

gidnumber

aliases: gid

string

GID (используйте этот параметр для его ручной установки).

group

list / elements=string

Список имен групп, назначенных этой группе.

Если append=false и передан пустой список, все группы будут удалены из этой группы.

Группы, которые уже назначены, но не переданы, будут удалены.

Если append=true, указанные группы будут назначены без удаления других групп.

Если параметр опущен, назначенные группы не будут проверяться или изменяться.

ipa_host

string

IP-адрес или имя хоста сервера IPA.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_HOST.

Если и переменная окружения IPA_HOST, и значение не указаны в задаче, то будет использоваться DNS для попытки обнаружения сервера FreeIPA.

Необходимая запись в FreeIPA - это запись ipa-ca.

Если недоступны ни запись DNS, ни переменная окружения IPA_HOST, ни значение в задаче, то будет использовано значение по умолчанию.

По умолчанию: "ipa.example.com"

ipa_pass

string

Пароль административного пользователя.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_PASS.

Обратите внимание, что если доступна библиотека urllib_gssapi, можно использовать GSSAPI для аутентификации в FreeIPA.

Если доступна переменная окружения KRB5CCNAME, модуль будет использовать этот кеш учетных данных Kerberos для аутентификации на сервере FreeIPA.

Если доступна переменная окружения KRB5_CLIENT_KTNAME, а KRB5CCNAME нет; модуль будет использовать этот ключ Kerberos для аутентификации.

Если GSSAPI недоступен, требуется использование ipa_pass.

ipa_port

integer

Порт сервера FreeIPA / IPA.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_PORT.

Если и переменная окружения IPA_PORT, и значение не указаны в задаче, то будет установлено значение по умолчанию.

По умолчанию: 443

ipa_prot

string

Протокол, используемый сервером IPA.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_PROT.

Если и переменная окружения IPA_PROT, и значение не указаны в задаче, то будет установлено значение по умолчанию.

Варианты:

  • "http"
  • "https" ← (default)

ipa_timeout

integer

Указывает время ожидания бездействия (в секундах) для соединения.

Для массовых операций может потребоваться увеличение этого значения во избежание тайм-аута со стороны сервера IPA.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_TIMEOUT.

Если и переменная окружения IPA_TIMEOUT, и значение не указаны в задаче, то будет установлено значение по умолчанию.

По умолчанию: 10

ipa_user

string

Административная учетная запись, используемая на сервере IPA.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения IPA_USER.

Если и переменная окружения IPA_USER, и значение не указаны в задаче, то будет установлено значение по умолчанию.

По умолчанию: "admin"

nonposix

boolean

Создать как не-POSIX группу.

Варианты:

  • false
  • true

state

string

Состояние для обеспечения

Варианты:

  • "absent"
  • "present" ← (default)

user

список / элементы=строка

Список имён пользователей, назначенных этой группе.

Если append=false и передан пустой список, все пользователи будут удалены из этой группы.

Пользователи, которые уже назначены, но не переданы, будут удалены.

Если append=true перечисленные пользователи будут назначены без удаления других пользователей.

Если параметр опущен, назначенные пользователи не будут проверены или изменены.

validate_certs

булево

Это применимо только если ipa_prot равен https.

Если установлено false, сертификаты SSL не будут проверены.

Это следует устанавливать только в false случае использования на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз изменения состояния без изменения целевого объекта.

diff_mode

Поддержка: отсутствует

Вернёт подробности о том, что изменилось (или, возможно, должно измениться в check_mode), когда режим diff включен.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipa_group_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API