Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: community.general.ipa_host.

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
строка
Описание этого хоста.
force
булево
    Варианты:
  • no
  • yes
Принудительное использование имени хоста, даже если он отсутствует в DNS.
fqdn
строка / обязательно
Полное доменное имя.
Не может быть изменено, так как это уникальный идентификатор.

Псевдонимы: name
ip_address
строка
Добавить хост в DNS с этим IP-адресом.
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
строка
    Варианты:
  • http
  • https ←
Протокол, используемый сервером 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.
mac_address
список / элементы=строка
Список MAC-адресов(ов) оборудования этого хоста.
Если опция опущена, MAC-адреса не будут проверяться или изменять.
Если передается пустой список, все назначенные MAC-адреса будут удалены.
MAC-адреса, которые уже назначены, но не переданы, будут удалены.

Псевдонимы: macaddress
ns_hardware_platform
строка
Платформа оборудования хоста (например, "Lenovo T61")

Псевдонимы: nshardwareplatform
ns_host_location
строка
Расположение хоста (например, "Лаборатория 2")

Псевдонимы: nshostlocation
ns_os_version
строка
Операционная система и версия хоста (например, "Fedora 9")

Псевдонимы: nsosversion
random_password
булево
    Варианты:
  • no
  • yes
Сгенерировать случайный пароль для использования в массовой регистрации.
state
строка
    Варианты:
  • absent
  • disabled
  • enabled
  • present ←
Требуемое состояние.
update_dns
булево
    Варианты:
  • no
  • yes
Если установлено "True", а состояние "absent", удаляет записи DNS хоста, управляемого DNS FreeIPA.
Эта опция не влияет на состояния, отличные от "absent".
user_certificate
список / элементы=строка
Список серверных сертификатов в кодировке Base-64.
Если опция опущена, сертификаты не будут проверяться или изменять.
Если передается пустой список, все назначенные сертификаты будут удалены.
Сертификаты, которые уже назначены, но не переданы, будут удалены.

Псевдонимы: usercertificate
validate_certs
булево
    Варианты:
  • no
  • yes ←
Это применимо только если ipa_prot равно https.
Если установлено no, SSL-сертификаты не будут проверены.
Это должно быть установлено только на лично контролируемых сайтах с использованием самоподписанных сертификатов.

Примеры

- 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
    validate_certs: False
    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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ipa_host_module.html

Spec-Zone.ru

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