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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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 added in dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
community_string boolean	Включить использование строк сообщества SNMP для получения ловушек SNMP с помощью параметров приложения в OpenManage Enterprise. Эта опция доступна только для обнаруженных серверов iDRAC и шасси MX7000. Варианты: `false` ← (default) `true`
cron string	Укажите выражение cron на основе формата cron Quartz.
discovery_config_targets list / elements=dictionary	Укажите список целевых объектов обнаружения. Каждый целевой объект обнаружения представляет собой набор network_address_detail, device_types и одного или нескольких учетных данных протокола. Это обязательно, когда state имеет значение `present`. `WARNING` Изменение этого поля не поддерживается, это поле перезаписывается каждый раз. Убедитесь, что вы предоставили все необходимые данные для этого поля.
device_types list / elements=string / required	Укажите тип устройств, которые необходимо обнаружить. Допустимые типы: SERVER, CHASSIS, NETWORK SWITCH и STORAGE. Можно указать комбинацию или все из вышеперечисленных. Поддерживаемые протоколы для каждого типа устройства: SERVER - wsman, redfish, snmp, ipmi, ssh и vmware. CHASSIS - wsman и redfish. NETWORK SWITCH - snmp. STORAGE - storage и snmp.
ipmi dictionary	Intelligent Platform Management Interface (IPMI)
kgkey string	KgKey для протокола IPMI.
password string / required	Укажите пароль для протокола.
retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. По умолчанию: `3`
timeout integer	Введите время в секундах, по истечении которого работа должна быть остановлена. По умолчанию: `60`
username string / required	Укажите имя пользователя для протокола.
network_address_detail list / elements=string / required	Укажите список 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-адресов ограничен 16385 (0x4001). `NOTE` Поддерживаются как форматы IPv6, так и IPv6 CIDR.
redfish dictionary	Протокол REDFISH.
ca_check boolean	Включить проверку Центра сертификации (CA). Варианты: `false` ← (default) `true`
certificate_data string	Укажите данные сертификата для проверки CA.
cn_check boolean	Включить проверку общего имени (CN). Варианты: `false` ← (default) `true`
domain string	Укажите домен для протокола.
password string / required	Укажите пароль для протокола.
port integer	Введите номер порта, который работа должна использовать для обнаружения устройств. По умолчанию: `443`

retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. Default: `3`
timeout integer	Введите время в секундах, по истечении которого работа должна быть остановлена. Default: `60`
username string / required	Укажите имя пользователя для протокола.
snmp dictionary	Простой протокол управления сетью (SNMP).
community string / required	Строка сообщества для протокола SNMP.
port integer	Введите номер порта, который задача должна использовать для обнаружения устройств. Default: `161`
retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. Default: `3`
timeout integer	Введите время в секундах, по истечении которого работа должна быть остановлена. Default: `3`
ssh dictionary	Secure Shell (SSH).
check_known_hosts boolean	Проверить известный ключ хоста. Choices: `false` ← (default) `true`
is_sudo_user boolean	Использовать опцию SUDO. Choices: `false` ← (default) `true`
password string / required	Укажите пароль для протокола.
port integer	Введите номер порта, который задача должна использовать для обнаружения устройств. Default: `22`
retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. Default: `3`
timeout integer	Введите время в секундах, по истечении которого работа должна быть остановлена. Default: `60`
username string / required	Укажите имя пользователя для протокола.
storage dictionary	HTTPS протокол хранения.
ca_check boolean	Включить проверку Центра сертификации (CA). Choices: `false` ← (default) `true`
certificate_data string	Укажите данные сертификата для проверки CA.
cn_check boolean	Включить проверку общего имени (CN). Choices: `false` ← (default) `true`
domain string	Укажите домен для протокола.

password string / required	Укажите пароль для протокола.
port integer	Введите номер порта, который задание должно использовать для обнаружения устройств. Default: `443`
retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. Default: `3`
timeout integer	Введите время в секундах, по истечении которого задание должно прекратить выполнение. Default: `60`
username string / required	Укажите имя пользователя для протокола.
vmware dictionary	Протокол VMWARE.
ca_check boolean	Включить проверку Центра сертификации (CA). Choices: `false` ← (default) `true`
certificate_data string	Укажите данные сертификата для проверки CA.
cn_check boolean	Включить проверку общего имени (CN). Choices: `false` ← (default) `true`
domain string	Укажите домен для протокола.
password string / required	Укажите пароль для протокола.
port integer	Введите номер порта, который задание должно использовать для обнаружения устройств. Default: `443`
retries integer	Введите количество повторных попыток, необходимых для обнаружения устройства. Default: `3`
timeout integer	Введите время в секундах, по истечении которого задание должно прекратить выполнение. Default: `60`
username string / required	Укажите имя пользователя для протокола.
wsman dictionary	Web Services-Management (WS-Man).
ca_check boolean	Включить проверку Центра сертификации (CA). Choices: `false` ← (default) `true`
certificate_data string	Укажите данные сертификата для проверки CA.
cn_check boolean	Включить проверку общего имени (CN). Choices: `false` ← (default) `true`
domain string	Укажите домен для протокола.
password string / required	Укажите пароль для протокола.
port integer	Введите номер порта, который задание должно использовать для обнаружения устройств. Default: `443`

retries целое число	Введите количество повторных попыток обнаружения устройства. По умолчанию: `3`
timeout целое число	Введите время в секундах, по истечении которого задача должна быть остановлена. По умолчанию: `60`
username строка / обязательно	Укажите имя пользователя для протокола.
discovery_id целое число	Идентификатор группы конфигурации обнаружения. Это значение DiscoveryConfigGroupId в возвращаемых значениях в discovery_status. Это взаимоисключающее значение с discovery_job_name.
discovery_job_name строка	Имя задачи конфигурации обнаружения. Это взаимоисключающее значение с discovery_id.
email_recipient строка	Введите адрес электронной почты, на который будут отправляться уведомления о статусе задачи обнаружения. Настройте SMTP-настройки для отправки уведомлений на указанный адрес электронной почты.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise.
ignore_partial_failure булево	Предоставляет возможность игнорировать частичные сбои. Частичные сбои возникают, когда есть сочетание обнаруженных и необнаруженных IP-адресов. Если `false`, то частичный сбой не будет проигнорирован, и модуль выдаст ошибку. Если `true`, то частичный сбой будет проигнорирован. Этот параметр применимо только если job_wait `true`. Варианты: `false` ← (по умолчанию) `true`
job_wait булево	Предоставляет возможность ожидать завершения задачи. Этот параметр применим, когда state `present`. Варианты: `false` `true` ← (по умолчанию)
job_wait_timeout целое число	Максимальное время ожидания job_wait в секундах. Задача отслеживается только в течение этого времени. Этот параметр применим, когда job_wait `true`. По умолчанию: `10800`
new_name строка	Новое имя задачи конфигурации обнаружения.
password строка	Пароль OpenManage Enterprise. Если пароль не указан, то используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=пароль
port целое число	Порт HTTPS OpenManage Enterprise. По умолчанию: `443`
schedule строка	Предоставляет возможность планировать задачу обнаружения. Если выбран `RunLater`, то необходимо указать cron. Варианты: `"RunNow"` ← (по умолчанию) `"RunLater"`
state строка	`present` создает задачу обнаружения или изменяет существующую задачу обнаружения. discovery_job_name обязательно для создания новой задачи обнаружения. Если существуют несколько задач обнаружения с одинаковым именем discovery_job_name, то новая задача обнаружения не будет создана. `absent` удаляет существующую(ие) задачу(и) обнаружения с указанным discovery_job_name. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
trap_destination булево	Включить OpenManage Enterprise для получения входящих SNMP-ловушек от обнаруженных устройств. Это эффективно только для серверов, обнаруженных с помощью их интерфейса iDRAC. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя OpenManage Enterprise. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=имя_пользователя

validate_certs

boolean

added in dellemc.openmanage 5.0.0

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

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

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

Варианты:

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

x_auth_token

string

added in 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 список / элементы=строка	Идентификаторы обнаружений с дублирующимися именами. Возвращается: при наличии обнаружений с дублирующимся именем для state имеет значение `present` Пример: `[1234, 5678]`
discovery_status словарь	Подробности задания обнаружения, созданного или изменённого. Если 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 словарь	Подробности 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 список / элементы=строка	Подробная история последнего выполнения задания. Возвращается: всегда. Пример: `[{"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 строка	Общий статус операции обнаружения. Возвращается: всегда Пример: `"Successfully deleted 1 discovery job(s)."`

Авторы

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

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

© 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_discovery_module.html