Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

cn

aliases: name

string / required

Имя роли.

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

description

string

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

group

list / elements=string

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

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

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

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

host

list / elements=string

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

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

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

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

hostgroup

list / elements=string

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

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

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

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

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" ← (по умолчанию)

ipa_timeout

integer

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

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

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

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

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

ipa_user

string

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

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

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

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

privilege

list / elements=string

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

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

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

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

service

list / elements=string

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

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

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

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

state

string

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

Варианты:

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

user

list / elements=string

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

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

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

validate_certs

boolean

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

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

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

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

Вернет подробную информацию о том, что изменилось (или, возможно, должно измениться в check_mode), при работе в режиме сравнения.

Примеры

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

Spec-Zone.ru

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