Spec-Zone.ru › Ansible

dellemc.openmanage.ome_active_directory модуль – Настройка групп Active Directory для использования с службами каталогов

Примечание

Этот модуль входит в состав коллекции dellemc.openmanage (версия 9.7.0).

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

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в книге задач укажите: dellemc.openmanage.ome_active_directory.

Добавлен в dellemc.openmanage 4.0.0

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

Обзор

  • Этот модуль позволяет добавлять, изменять и удалять подключения OpenManage Enterprise к службе каталогов Active Directory.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

added in dellemc.openmanage 5.0.0

Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, который будет использоваться для проверки.

certificate_file

path

Укажите полный путь к SSL-сертификату.

Сертификат должен быть корневым сертификатом CA, закодированным в формате Base64.

Это применимо, когда validate_certificate имеет значение true.

domain_controller_lookup

string

Выберите метод поиска контроллера домена.

Варианты:

  • "DNS" ← (default)
  • "MANUAL"

domain_controller_port

integer

Порт контроллера домена.

По умолчанию используется номер порта глобального каталога 3269.

Для доступа к контроллеру домена введите 636 в качестве номера порта.

NOTE, Поддерживаются только порты LDAPS.

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

domain_password

string

Укажите пароль домена.

Это применимо, когда test_connection имеет значение true.

domain_server

list / elements=string

Введите имя домена, полное доменное имя (FQDN) или IP-адрес контроллера домена.

Если domain_controller_lookup имеет значение DNS, введите имя домена для запроса DNS для контроллеров домена.

Если domain_controller_lookup имеет значение MANUAL, введите полное доменное имя (FQDN) или IP-адрес контроллера домена. Максимальное количество серверов Active Directory, которые можно добавить, равно трем.

domain_username

string

Укажите имя пользователя домена в формате UPN (username@domain) или NetBIOS (domain\\username).

Это применимо, когда test_connection имеет значение true.

group_domain

string

Укажите домен группы в формате example.com или ou=org, dc=example, dc=com.

hostname

string / required

IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.

id

integer

Укажите ID существующего соединения службы Active Directory.

Это применимо для изменения и удаления.

Взаимоисключающее с name.

name

string

Укажите имя для соединения Active Directory.

Это применимо для создания и удаления.

Взаимоисключающее с name.

network_timeout

integer

Введите время ожидания сети в секундах.

Поддерживаемый диапазон времени ожидания составляет от 15 до 300 секунд.

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

password

string

Пароль OpenManage Enterprise или OpenManage Enterprise Modular.

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

Пример: export OME_PASSWORD=password

port

integer

Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular.

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

search_timeout

integer

Введите время ожидания поиска в секундах.

Поддерживаемый диапазон времени ожидания составляет от 15 до 300 секунд.

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

state

string

present позволяет создать или изменить службу Active Directory.

absent позволяет удалить службу Active Directory.

Варианты:

  • "present" ← (default)
  • "absent"

test_connection

boolean

Включает тестирование соединения с контроллером домена.

Соединение с контроллером домена проверяется с использованием указанных данных службы Active Directory.

Если тест завершится неудачей, модуль выдаст ошибку.

Если true, необходимо указать domain_username и domain_password.

Варианты:

  • false ← (default)
  • true

timeout

integer

added in dellemc.openmanage 5.0.0

Время ожидания на уровне сокета в секундах.

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

логин

строка

Логин OpenManage Enterprise или OpenManage Enterprise Modular.

Если логин не указан, используется переменная окружения OME_USERNAME.

Пример: export OME_USERNAME=логин

validate_certificate

логическое

Включает проверку SSL-сертификата контроллера домена.

Модуль всегда будет сообщать об изменении, когда это true.

Варианты:

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

validate_certs

логическое

добавлено в dellemc.openmanage 5.0.0

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

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

До версии коллекции 5.0.0, validate_certs устанавливался false по умолчанию.

Варианты:

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

x_auth_token

строка

добавлено в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная окружения OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Модуль всегда будет сообщать об изменении, когда validate_certificate равен true.
  • Запускайте этот модуль с системы, имеющей прямой доступ к OpenManage Enterprise.
  • Этот модуль поддерживает check_mode.

Примеры

---
- name: Add Active Directory service using DNS lookup along with the test connection
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad1
    domain_server:
      - domainname.com
    group_domain: domainname.com
    test_connection: true
    domain_username: user@domainname
    domain_password: domain_password

- name: Add Active Directory service using IP address of the domain controller with certificate validation
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    domain_controller_lookup: MANUAL
    domain_server:
      - 192.68.20.181
    group_domain: domainname.com
    validate_certificate: true
    certificate_file: "/path/to/certificate/file.cer"

- name: Modify domain controller IP address, network_timeout and group_domain
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    domain_controller_lookup: MANUAL
    domain_server:
      - 192.68.20.189
    group_domain: newdomain.in
    network_timeout: 150

- name: Delete Active Directory service
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    state: absent

- name: Test connection to existing Active Directory service with certificate validation
  dellemc.openmanage.ome_active_directory:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: my_ad2
    test_connection: true
    domain_username: user@domainname
    domain_password: domain_password
    validate_certificate: true
    certificate_file: "/path/to/certificate/file.cer"

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

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

Ключ

Описание

active_directory

словарь

Активный каталог, добавленный, изменённый или удалённый этим модулем.

Возвращается: при изменении

Пример: {"CertificateValidation": false, "DnsServer": [], "GroupDomain": "dellemcdomain.com", "Id": 21789, "Name": "ad_test", "NetworkTimeOut": 120, "Password": null, "SearchTimeOut": 120, "ServerName": ["192.168.20.181"], "ServerPort": 3269, "ServerType": "MANUAL"}

error_info

словарь

Детали HTTP-ошибки.

Возвращается: при HTTP-ошибке

Пример: {"error_info": {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to connect to the LDAP or AD server because the entered credentials are invalid.", "MessageArgs": [], "MessageId": "CSEC5002", "RelatedProperties": [], "Resolution": "Make sure the server input configuration are valid and retry the operation.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}}

msg

строка

Общий статус операции с Active Directory.

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

Пример: "Successfully renamed the slot(s)."

Авторы

  • Jagadeesh N V(@jagadeeshnv)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

© 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/dellemc/openmanage/ome_active_directory_module.html

Spec-Zone.ru

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