Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_discovery — создание, изменение или удаление задачи обнаружения в OpenManage Enterprise

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: dellemc.openmanage.ome_discovery.

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

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

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

  • Этот модуль позволяет создавать, изменять или удалять задачу обнаружения.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

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

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

community_string

boolean

Включить использование строк сообщества SNMP для получения SNMP-ловушек с помощью параметров приложения в OpenManage Enterprise. Этот параметр доступен только для обнаруженных серверов iDRAC и шасси MX7000.

Возможные значения:

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

cron

string

Укажите выражение cron в формате Quartz cron.

discovery_config_targets

list / elements=dictionary

Укажите список целевых объектов обнаружения.

Каждый целевой объект обнаружения представляет собой набор из network_address_detail, device_types и одного или нескольких учетных данных протокола.

Это обязательный параметр, если значение state равно present.

WARNING Изменение этого поля не поддерживается; оно перезаписывается при каждом запуске. Убедитесь, что указали все необходимые сведения для этого поля.

device_types

list / elements=string / обязательный

Укажите типы обнаруживаемых устройств.

Допустимые типы: SERVER, CHASSIS, NETWORK SWITCH и STORAGE.

Можно указать любой набор или все перечисленные типы.

Поддерживаемые протоколы для каждого типа устройства:

SERVER — wsman, redfish, snmp, ipmi, ssh и vmware.

CHASSIS — wsman и redfish.

NETWORK SWITCH — snmp.

STORAGE — storage и snmp.

ipmi

dictionary

Интерфейс управления интеллектуальной платформой (IPMI)

kgkey

string

Ключ KgKey для протокола IPMI.

password

string / обязательный

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательный

Укажите имя пользователя для протокола.

network_address_detail

list / elements=string / обязательный

Укажите список IP-адресов, имен узлов или диапазонов IP-адресов устройств, которые нужно обнаружить или включить.

Примеры допустимых форматов диапазонов IP-адресов

192.35.0.0

192.36.0.0-10.36.0.255

192.37.0.0/24

2345:f2b1:f083:135::5500/118

2345:f2b1:f083:135::a500-2607:f2b1:f083:135::a600

hostname.domain.tld

hostname

2345:f2b1:f083:139::22a

Примеры недопустимых форматов диапазонов IP-адресов

192.35.0.*

192.36.0.0-255

192.35.0.0/255.255.255.0

NOTE Размер диапазона по количеству IP-адресов ограничен значением 16 385 (0x4001).

NOTE Поддерживаются форматы IPv6 и IPv6 CIDR.

redfish

dictionary

Протокол REDFISH.

ca_check

boolean

Включить проверку центра сертификации (CA).

Возможные значения:

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

certificate_data

string

Укажите данные сертификата для проверки CA.

cn_check

boolean

Включить проверку общего имени (CN).

Возможные значения:

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

domain

string

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

password

string / обязательный

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

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательный

Укажите имя пользователя для протокола.

snmp

dictionary

Простой протокол сетевого управления (SNMP).

community

string / обязательный

Строка сообщества для протокола SNMP.

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

ssh

dictionary

Защищенная оболочка (SSH).

check_known_hosts

boolean

Проверить ключ известного узла.

Возможные значения:

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

is_sudo_user

boolean

Использовать параметр SUDO.

Возможные значения:

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

password

string / обязательный

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

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательный

Укажите имя пользователя для протокола.

storage

dictionary

Протокол HTTPS Storage.

ca_check

boolean

Включить проверку центра сертификации (CA).

Возможные значения:

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

certificate_data

string

Укажите данные сертификата для проверки CA.

cn_check

boolean

Включить проверку общего имени (CN).

Возможные значения:

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

domain

string

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

password

string / обязательный

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

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательный

Укажите имя пользователя для протокола.

vmware

dictionary

Протокол VMWARE.

ca_check

boolean

Включить проверку центра сертификации (CA).

Возможные значения:

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

certificate_data

string

Укажите данные сертификата для проверки CA.

cn_check

boolean

Включить проверку общего имени (CN).

Возможные значения:

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

domain

string

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

password

string / обязательный

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

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательный

Укажите имя пользователя для протокола.

wsman

dictionary

Управление веб-службами (WS-Man).

ca_check

boolean

Включить проверку центра сертификации (CA).

Варианты:

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

certificate_data

string

Укажите данные сертификата для проверки CA.

cn_check

boolean

Включить проверку общего имени (CN).

Варианты:

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

domain

string

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

password

string / обязательно

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

port

integer

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

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

retries

integer

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

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

timeout

integer

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

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

username

string / обязательно

Укажите имя пользователя для протокола.

discovery_id

integer

Идентификатор группы конфигурации обнаружения.

Это значение DiscoveryConfigGroupId в возвращаемых значениях параметра discovery_status.

Несовместим с параметром discovery_job_name.

discovery_job_name

string

Имя задания конфигурации обнаружения.

Несовместим с параметром discovery_id.

email_recipient

string

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

hostname

string / обязательно

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

ignore_partial_failure

boolean

Позволяет игнорировать частичные сбои. Частичные сбои возникают, когда обнаружены не все IP-адреса.

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

Если true, частичный сбой игнорируется.

Этот параметр применяется только в том случае, если job_wait имеет значение true.

Варианты:

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

job_wait

boolean

Позволяет дождаться завершения задания.

Этот параметр применяется, если state имеет значение present.

Варианты:

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

job_wait_timeout

integer

Максимальное время ожидания для параметра job_wait в секундах. Задание отслеживается только в течение этого времени.

Этот параметр применяется, если job_wait имеет значение true.

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

new_name

string

Новое имя задания конфигурации обнаружения.

password

string

Пароль OpenManage Enterprise.

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

Пример: export OME_PASSWORD=password

port

integer

HTTPS-порт OpenManage Enterprise.

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

schedule

string

Позволяет запланировать задание обнаружения.

Если выбран вариант RunLater, необходимо указать cron.

Варианты:

  • "RunNow" ← (по умолчанию)
  • "RunLater"

state

string

present создает задание обнаружения или изменяет существующее задание обнаружения.

Для создания нового задания обнаружения необходимо указать discovery_job_name.

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

absent удаляет существующее задание (задания) обнаружения с указанным именем discovery_job_name.

Варианты:

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

timeout

integer

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

Тайм-аут на уровне сокета в секундах.

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

trap_destination

boolean

Разрешить OpenManage Enterprise принимать входящие SNMP-ловушки от обнаруженных устройств.

Применяется только к серверам, обнаруженным через интерфейс iDRAC.

Варианты:

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

username

string

Имя пользователя OpenManage Enterprise.

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

Пример: export OME_USERNAME=username

validate_certs

boolean

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

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

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

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

Варианты:

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

x_auth_token

string

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

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

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

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise.
  • Этот модуль не поддерживает check_mode.
  • Если state имеет значение present, идемпотентность не поддерживается.

Примеры

---
- name: Discover servers in a range
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discovery_server_1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.1-192.96.24.255
        device_types:
          - SERVER
        wsman:
          username: user
          password: password

- name: Discover chassis in a range
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discovery_chassis_1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.1-192.96.24.255
        device_types:
          - CHASSIS
        wsman:
          username: user
          password: password

- name: Discover switches in a range
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discover_switch_1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.1-192.96.24.255
        device_types:
          - NETWORK SWITCH
        snmp:
          community: snmp_creds

- name: Discover storage in a range
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discover_storage_1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.1-192.96.24.255
        device_types:
          - STORAGE
        storage:
          username: user
          password: password
        snmp:
          community: snmp_creds

- name: Delete a discovery job
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    discovery_job_name: "Discovery-123"

- name: Schedule the discovery of multiple devices ignoring partial failure and enable trap to receive alerts
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    discovery_job_name: "Discovery-123"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.1-192.96.24.255
          - 192.96.0.0/24
          - 192.96.26.108
        device_types:
          - SERVER
          - CHASSIS
          - STORAGE
          - NETWORK SWITCH
        wsman:
          username: wsman_user
          password: wsman_pwd
        redfish:
          username: redfish_user
          password: redfish_pwd
        snmp:
          community: snmp_community
      - network_address_detail:
          - 192.96.25.1-192.96.25.255
          - ipmihost
          - esxiserver
          - sshserver
        device_types:
          - SERVER
        ssh:
          username: ssh_user
          password: ssh_pwd
        vmware:
          username: vm_user
          password: vmware_pwd
        ipmi:
          username: ipmi_user
          password: ipmi_pwd
    schedule: RunLater
    cron: "0 0 9 ? * MON,WED,FRI *"
    ignore_partial_failure: true
    trap_destination: true
    community_string: true
    email_recipient: test_email@company.com

- name: Discover servers with ca check enabled
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discovery_server_ca1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.108
        device_types:
          - SERVER
        wsman:
          username: user
          password: password
          ca_check: true
          certificate_data: "{{ lookup('ansible.builtin.file', '/path/to/certificate_data_file') }}"

- name: Discover chassis with ca check enabled data
  dellemc.openmanage.ome_discovery:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    discovery_job_name: "Discovery_chassis_ca1"
    discovery_config_targets:
      - network_address_detail:
          - 192.96.24.108
        device_types:
          - CHASSIS
        redfish:
          username: user
          password: password
          ca_check: true
          certificate_data: "-----BEGIN CERTIFICATE-----\r\n
          ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
          ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
          ABCDEFGHIJKLMNOPQRSTUVWXYZaqwertyuiopasdfghjklzxcvbnmasdasagasvv\r\n
          aqwertyuiopasdfghjklzxcvbnmasdasagasvv=\r\n
          -----END CERTIFICATE-----"

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

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

Ключ

Описание

discovery_ids

list / elements=string

Идентификаторы обнаружений с повторяющимися именами.

Возвращается: если для state существуют обнаружения с повторяющимися именами и значение равно present

Пример: [1234, 5678]

discovery_status

dictionary

Сведения о созданном или измененном задании обнаружения.

Если значение job_wait равно true, также перечисляются IP-адреса, обработанные и не обработанные успешно.

Возвращается: если значение state равно present

Пример: {"Completed": ["192.168.24.17", "192.168.24.20", "192.168.24.22"], "DiscoveredDevicesByType": [{"Count": 3, "DeviceType": "SERVER"}], "DiscoveryConfigDiscoveredDeviceCount": 3, "DiscoveryConfigEmailRecipient": "myemail@dell.com", "DiscoveryConfigExpectedDeviceCount": 9, "DiscoveryConfigGroupId": 125, "Failed": ["192.168.24.15", "192.168.24.16", "192.168.24.18", "192.168.24.19", "192.168.24.21", "host123"], "JobDescription": "D1", "JobEnabled": true, "JobEndTime": "2021-01-01 06:27:29.99", "JobId": 12666, "JobName": "D1", "JobNextRun": null, "JobProgress": "100", "JobSchedule": "startnow", "JobStartTime": "2021-01-01 06:24:10.071", "JobStatusId": 2090, "LastUpdateTime": "2021-01-01 06:27:30.001", "UpdatedBy": "admin"}

error_info

dictionary

Сведения об ошибке HTTP.

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

job_detailed_status

list / elements=string

Подробная история последнего выполнения задания.

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

Пример: [{"ElapsedTime": "00:00:00", "EndTime": null, "ExecutionHistoryId": 564873, "Id": 656893, "IdBaseEntity": 0, "JobStatus": {"Id": 2050, "Name": "Running"}, "Key": "192.96.24.1", "Progress": "0", "StartTime": "2023-07-04 06:23:54.008", "Value": "Running\nDiscovery of target 192.96.24.1 started.\nDiscovery target resolved to IP  192.96.24.1 ."}]

msg

string

Общий статус операции обнаружения.

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

Пример: "Successfully deleted 1 discovery job(s)."

Авторы

  • Jagadeesh N V (@jagadeeshnv)
  • Sajna Shetty (@Sajna-Shetty)
  • Abhishek Sinha (@Abhishek-Dell)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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