community.general.ipa_role – Управление ролью FreeIPA
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.ipa_role.
Описание
- Добавление, изменение и удаление роли на сервере 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' доступна, можно использовать GSSAPI для аутентификации в FreeIPA. Если доступна переменная окружения 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 строка |
| Протокол, используемый сервером IPA. Если значение не указано в задаче, используется значение переменной окружения IPA_PROT. Если ни переменная окружения IPA_PROT, ни значение не указаны в задаче, то устанавливается значение по умолчанию.Функциональность обратной замены переменных окружения добавлена в Ansible 2.5. |
| ipa_timeout целое число | По умолчанию: 10 | Устанавливает таймаут бездействия (в секундах) для подключения. Для массовых операций может потребоваться увеличить это значение, чтобы избежать таймаута со стороны сервера IPA. Если значение не указано в задаче, используется значение переменной окружения IPA_TIMEOUT. Если ни переменная окружения IPA_TIMEOUT, ни значение не указаны в задаче, то устанавливается значение по умолчанию. |
| ipa_user строка | По умолчанию: "admin" | Используемый административный аккаунт на сервере IPA. Если значение не указано в задаче, используется значение переменной окружения IPA_USER. Если ни переменная окружения IPA_USER, ни значение не указаны в задаче, то устанавливается значение по умолчанию.Функциональность обратной замены переменных окружения добавлена в Ansible 2.5. |
| privilege список / элементы=строка | Список привилегий, предоставляемых роли. Если передан пустой список, все назначенные привилегии будут удалены. Если параметр опущен, привилегии не будут проверяться или изменяться. Если параметр передан, все назначенные привилегии, которые не указаны, будут удалены. | |
| service список / элементы=строка | Список имён служб для назначения. Если передан пустой список, все назначенные службы будут удалены из роли. Если параметр опущен, службы не будут проверяться или изменяться. Если параметр передан, все назначенные службы, которые не указаны, будут удалены из роли. | |
| state строка |
| Требуемое состояние. |
| user список / элементы=строка | Список имён пользователей для назначения. Если передан пустой список, все назначенные пользователи будут удалены из роли. Если параметр опущен, пользователи не будут проверяться или изменяться. | |
| validate_certs логический тип |
| Это применимо только если ipa_prot равно https.Если установлено значение no, сертификаты SSL не будут проверены.Это следует устанавливать в значение no только для сайтов, контролируемых лично, использующих самозаверенные сертификаты. |
Примеры
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ipa_role_module.html