Spec-Zone.ru › Ansible

Модуль community.general.ipa_role — управление ролью FreeIPA

Примечание

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

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

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

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

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

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

  • Добавляет, изменяет и удаляет роль на сервере FreeIPA с помощью API FreeIPA.

Параметры

Параметр

Комментарии

cn

псевдонимы: name

строка / обязательный

Имя роли.

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

description

строка

Описание этой группы ролей.

group

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

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

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

Если параметр не указан, группы не проверяются и не изменяются.

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

host

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

Список имён узлов для назначения.

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

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

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

hostgroup

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

Список имён групп узлов для назначения.

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

Если параметр не указан, группы узлов не проверяются и не изменяются.

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

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"

privilege

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

Список привилегий, предоставленных роли.

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

Если параметр не указан, привилегии не проверяются и не изменяются.

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

service

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

Список имён служб для назначения.

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

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

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

state

строка

Состояние, которое требуется обеспечить.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

user

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

Список имён пользователей для назначения.

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

Если параметр не указан, пользователи не проверяются и не изменяются.

validate_certs

логическое значение

Применяется только в том случае, если ipa_prot имеет значение https.

Если задано значение false, сертификаты SSL не проверяются.

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

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

В режиме сравнения возвращает сведения об изменениях (или возможных изменениях в check_mode).

Примечания

Примечание

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

Примеры

- name: Ensure role is present
  community.general.ipa_role:
    name: dba
    description: Database Administrators
    state: present
    user:
      - pinky
      - brain
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure role with certain details
  community.general.ipa_role:
    name: another-role
    description: Just another role
    group:
      - editors
    host:
      - host01.example.com
    hostgroup:
      - hostgroup01
    privilege:
      - Group Administrators
      - User Administrators
    service:
      - service01

- name: Ensure role is absent
  community.general.ipa_role:
    name: dba
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

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

Ключ

Описание

role

словарь

Роль в том виде, в котором её возвращает 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_role_module.html

Spec-Zone.ru

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