Модуль community.general.ipa_host — управление узлом FreeIPA

Примечание

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

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

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

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

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

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

Добавление, изменение и удаление узла IPA с помощью API IPA.

Параметры

Параметр	Комментарии
description string	Описание этого узла.
force boolean	Принудительно использовать имя узла, даже если его нет в DNS. Варианты: `false` `true`
force_creation boolean добавлено в community.general 9.5.0	Создать узел, если `state=disabled` или `state=enabled`, но он отсутствует. Варианты: `false` `true` ← (по умолчанию)
fqdn псевдонимы: name string / обязательный	Полное доменное имя. Не может быть изменено, так как является уникальным идентификатором.
ip_address string	Добавить узел в DNS с этим IP-адресом.
ipa_host string	IP-адрес или имя узла сервера IPA. Если значение не указано в задаче, вместо него используется значение переменной среды `IPA_HOST`. Если в задаче не указаны ни переменная среды `IPA_HOST`, ни значение, для обнаружения сервера FreeIPA используется DNS. Соответствующая запись, необходимая в FreeIPA, — это запись `ipa-ca`. Если в задаче недоступны ни запись DNS, ни переменная среды `IPA_HOST`, ни значение, используется значение по умолчанию. По умолчанию: `"ipa.example.com"`
ipa_pass string	Пароль пользователя-администратора. Если значение не указано в задаче, вместо него используется значение переменной среды `IPA_PASS`. Обратите внимание: если доступна библиотека `urllib_gssapi`, для аутентификации в FreeIPA можно использовать GSSAPI. Если переменная среды `KRB5CCNAME` доступна, модуль использует этот кэш учётных данных Kerberos для аутентификации на сервере FreeIPA. Если переменная среды `KRB5_CLIENT_KTNAME` доступна, а `KRB5CCNAME` — нет, модуль использует этот keytab 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"`
l псевдонимы: locality string добавлено в community.general 12.0.0	Местоположение узла (например, `Baltimore, MD`).
mac_address псевдонимы: macaddress list / elements=string	Список MAC-адресов оборудования этого узла. Если параметр опущен, MAC-адреса не проверяются и не изменяются. Если передан пустой список, удаляются все назначенные MAC-адреса. Назначенные MAC-адреса, которые не переданы, удаляются.
ns_hardware_platform псевдонимы: nshardwareplatform string	Аппаратная платформа узла (например, `Lenovo T61"`).
ns_host_location псевдонимы: nshostlocation string	Расположение узла (например, `Lab 2`).
ns_os_version псевдонимы: nsosversion string	Операционная система узла и её версия (например, `Fedora 9`).
random_password boolean	Сгенерировать случайный пароль для массовой регистрации. Варианты: `false` `true`
state string	Требуемое состояние. Варианты: `"absent"` `"disabled"` `"enabled"` `"present"` ← (по умолчанию)
update_dns boolean	Если задано `true` вместе с `state=absent`, удаляет записи DNS узла, которыми управляет DNS FreeIPA. Этот параметр не влияет на состояния, отличные от `absent`. Варианты: `false` `true`
user_certificate псевдонимы: usercertificate list / elements=string	Список сертификатов сервера, закодированных в Base64. Если параметр опущен, сертификаты не проверяются и не изменяются. Если передан пустой список, удаляются все назначенные сертификаты. Уже назначенные сертификаты, которые не переданы, удаляются.
userclass string добавлено в community.general 12.0.0	Категория узла (семантика этого атрибута определяется локально).
validate_certs boolean	Применяется только если `ipa_prot` имеет значение `https`. Если установлено значение `false`, SSL-сертификаты не проверяются. Устанавливайте значение `false` только для сайтов под личным контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

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

Примеры

- name: Ensure host is present
  community.general.ipa_host:
    name: host01.example.com
    description: Example host
    userclass: Server
    ip_address: 192.168.0.123
    locality: Baltimore, MD
    ns_host_location: Lab
    ns_os_version: CentOS 7
    ns_hardware_platform: Lenovo T61
    mac_address:
      - "08:00:27:E3:B1:2D"
      - "52:54:00:BD:97:1E"
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Generate a random password for bulk enrolment
  community.general.ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    random_password: true

- name: Ensure host is disabled
  community.general.ipa_host:
    name: host01.example.com
    state: disabled
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure that all user certificates are removed
  community.general.ipa_host:
    name: host01.example.com
    user_certificate: []
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure host is absent
  community.general.ipa_host:
    name: host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure host and its DNS record is absent
  community.general.ipa_host:
    name: host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    update_dns: true

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

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

Ключ	Описание
host dictionary	Узел в формате, возвращаемом API IPA. Возвращается: всегда
host_diff list / elements=string	Список параметров, значения которых отличаются и будут изменены. Возвращается: если включён режим проверки и обнаружены различия

Авторы

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_host_module.html