Spec-Zone.ru › Ansible

Модуль community.general.ipa_host – Управление хостом FreeIPA

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 ← (default)

fqdn

aliases: name

string / required

Полностью квалифицированное доменное имя.

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

ip_address

string

Добавить хост в DNS с этим IP-адресом.

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" ← (default)

ipa_timeout

integer

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

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

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

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

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

ipa_user

string

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

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

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

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

mac_address

aliases: macaddress

list / elements=string

Список аппаратных MAC-адресов этого хоста.

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

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

MAC-адреса, которые уже назначены, но не переданы, будут удалены.

ns_hardware_platform

aliases: nshardwareplatform

string

Аппаратная платформа хоста (например, «Lenovo T61»)

ns_host_location

aliases: nshostlocation

string

Местоположение хоста (например, «Лаборатория 2»)

ns_os_version

aliases: nsosversion

string

Операционная система и версия хоста (например, «Fedora 9»)

random_password

boolean

Сгенерировать случайный пароль для использования в массовой регистрации.

Варианты:

  • false
  • true

state

string

Состояние для обеспечения.

Выборы:

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

update_dns

boolean

Если установлено true с state=absent, тогда удаляет записи DNS хоста, управляемого FreeIPA DNS.

Этот параметр не имеет эффекта для состояний, отличных от «отсутствующего».

Выборы:

  • false
  • true

user_certificate

aliases: usercertificate

list / elements=string

Список серверных сертификатов в кодировке Base-64.

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

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

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

validate_certs

boolean

Это относится только в том случае, если ipa_prot является https.

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

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

Выборы:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

diff_mode

Поддержка: нет

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

Примеры

- name: Ensure host is present
  community.general.ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    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

словарь

Хост, как возвращается API IPA.

Возвращено: всегда

host_diff

список / элементы=строка

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

Возвращено: если режим проверки и обнаружено различие

Авторы

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

Spec-Zone.ru

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