ipa_role – Управление ролью FreeIPA

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cn - / обязательно		Имя роли. Не может быть изменено, так как это уникальный идентификатор. псевдонимы: name
description -		Описание этой группы ролей.
group -		Список имен групп, назначаемых этой роли. Если передан пустой список, все назначенные группы будут сняты с роли. Если параметр опущен, группы не будут проверяться или изменятьс. Если параметр передан, все назначенные группы, которые не перечислены, будут сняты с роли.
host -		Список имен хостов для назначения. Если передан пустой список, все назначенные хосты будут сняты с роли. Если параметр опущен, хосты не будут проверяться или изменятьс. Если параметр передан, все назначенные хосты, которые не перечислены, будут сняты с роли.
hostgroup -		Список имен групп хостов для назначения. Если передан пустой список, все назначенные группы хостов будут удалены с роли. Если параметр опущен, группы хостов не будут проверяться или изменятьс. Если параметр передан, все назначенные группы хостов, которые не перечислены, будут сняты с роли.
ipa_host строка	По умолчанию: "ipa.example.com"	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_HOST`. Если ни переменная среды `IPA_HOST`, ни значение не указаны в задаче, тогда DNS будет использоваться для попытки обнаружить сервер FreeIPA. Необходимая запись в FreeIPA — это запись 'ipa-ca'. Если ни запись в DNS, ни переменная среды `IPA_HOST`, ни значение не доступны в задаче, то будет использовано значение по умолчанию. Механизм обратного вызова переменных среды добавлен в Ansible 2.5.
ipa_pass строка / обязательно		Пароль административного пользователя. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PASS`. Обратите внимание, что если доступна библиотека 'urllib_gssapi', то для аутентификации в FreeIPA можно использовать GSSAPI. Если доступна переменная среды `KRB5CCNAME`, модуль будет использовать этот кеш учетных данных Kerberos для аутентификации на сервере FreeIPA. Если доступна переменная среды `KRB5_CLIENT_KTNAME`, и `KRB5CCNAME` недоступна; модуль будет использовать этот ключ Kerberos для аутентификации. Если GSSAPI недоступен, использование 'ipa_pass' обязательно. Механизм обратного вызова переменных среды добавлен в Ansible 2.5.
ipa_port целое число	По умолчанию: 443	Порт сервера FreeIPA / IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PORT`. Если ни переменная среды `IPA_PORT`, ни значение не указаны в задаче, то будет установлено значение по умолчанию. Механизм обратного вызова переменных среды добавлен в Ansible 2.5.
ipa_prot строка	Варианты: http https ←	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PROT`. Если ни переменная среды `IPA_PROT`, ни значение не указаны в задаче, то будет установлено значение по умолчанию. Механизм обратного вызова переменных среды добавлен в Ansible 2.5.
ipa_timeout целое число добавлено в 2.7	По умолчанию: 10	Устанавливает таймаут бездействия (в секундах) для подключения. Для массовых операций может потребоваться увеличить это значение, чтобы избежать таймаута от сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_TIMEOUT`. Если ни переменная среды `IPA_TIMEOUT`, ни значение не указаны в задаче, то будет установлено значение по умолчанию.

ipa_user string	Значение по умолчанию: "admin"	Административная учетная запись, используемая на сервере IPA. Если значение не указано в задаче, будет использовано значение переменной среды `IPA_USER`. Если переменная среды `IPA_USER` и значение не указаны в задаче, используется значение по умолчанию. Механизм обратного вызова переменных среды добавлен в Ansible 2.5.
privilege - добавлено в 2.4		Список привилегий, предоставленных роли. Если передан пустой список, все назначенные привилегии будут удалены. Если опция опущена, привилегии не будут проверены или изменены. Если опция передана, все назначенные привилегии, которые не были переданы, будут удалены.
service -		Список имён служб для назначения. Если передан пустой список, все назначенные службы будут удалены из роли. Если опция опущена, службы не будут проверены или изменены. Если опция передана, все назначенные службы, которые не были переданы, будут удалены из роли.
state -	Варианты: present ← absent	Состояние, которое нужно гарантировать
user -		Список имён пользователей для назначения. Если передан пустой список, все назначенные пользователи будут удалены из роли. Если опция опущена, пользователи не будут проверены или изменены.
validate_certs boolean	Варианты: no yes ←	Это применимо только если `ipa_prot` равно https. Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только для `no`, используемых на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов.

Примеры

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

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

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

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

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

Ключ	Возвращённое значение	Описание
role dictionary	всегда	Роль, возвращённая API IPA.

Статус

Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Thomas Krahn (@Nosmoht)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ipa_role_module.html