Spec-Zone.ru › Ansible 2.10

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

Примечание

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

Для его установки используйте: 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-сертификаты не будут проверены.
Это следует установить на no только для сайтов, контролируемых лично, использующих самозаверенные сертификаты.

Примеры

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

Spec-Zone.ru

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