community.general.ipa_role – Управление ролью FreeIPA
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: 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 и значение не указаны в задаче, для поиска сервера FreeIPA будет использован DNS.Необходимая запись в 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ipa_role_module.html