Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.idrac_diagnostics — запуск и экспорт диагностики iDRAC

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет запускать и экспортировать диагностику iDRAC.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

export

логический

Экспортирует диагностические данные в указанную общую папку.

Для этой операции требуется share_parameters.

Задание на запуск диагностики выполняется только в том случае, если run имеет значение true, а job_wait — false. Параметр export игнорируется.

Варианты:

  • false
  • true

idrac_ip

строка / обязательный

IP-адрес iDRAC.

idrac_password

псевдонимы: idrac_pwd

строка

Пароль пользователя iDRAC.

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

Пример: export IDRAC_PASSWORD=password

idrac_port

целое число

Порт iDRAC.

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

idrac_user

строка

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

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

Пример: export IDRAC_USERNAME=username

job_wait

логический

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

Применяется, если run имеет значение true, а reboot_type — power_cycle.

Применяется только для запуска задания диагностики.

Варианты:

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

job_wait_timeout

целое число

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

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

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

reboot_type

строка

Этот параметр позволяет выбрать немедленную перезагрузку узла для запуска диагностики.

Применяется, если run имеет значение true.

force Принудительное корректное завершение работы дает операционной системе команду выключиться и ожидает десять минут. Если операционная система не выключится, iDRAC выполнит цикл питания системы.

graceful Корректное завершение работы ожидает выключения операционной системы и перезапуска системы.

power_cycle выполняет цикл питания для аппаратного сброса устройства.

Варианты:

  • "force"
  • "graceful" ← (по умолчанию)
  • "power_cycle"

resource_id

строка

Идентификатор ресурса.

Если идентификатор ресурса не указан, модуль выбирает первый доступный идентификатор из списка системных ресурсов, возвращаемого iDRAC.

run

логический

Запускает задание диагностики в iDRAC.

Запускает задание диагностики с учетом параметра run_mode и сохраняет отчет во внутреннем хранилище. Применяется параметр reboot_type.

Варианты:

  • false
  • true

run_mode

строка

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

express Экспресс-диагностика запускает пакет тестов для каждой подсистемы сервера. Однако она не запускает полный набор доступных в пакете тестов для каждой подсистемы.

extended Расширенная диагностика запускает все доступные тесты из каждого пакета тестов для всех подсистем.

long_run Длительная диагностика запускает экспресс-тесты и расширенные тесты.

Варианты:

  • "express" ← (по умолчанию)
  • "extended"
  • "long_run"

scheduled_end_time

строка

Запускает диагностику до указанной даты и времени завершения после scheduled_start_time.

Допустимые форматы: yyyymmddhhmmss и YYYY-MM-DDThh:mm:ss+HH:MM.

Если операция запуска не завершится до указанного времени, она завершится с ошибкой.

Применяется, если run имеет значение True, а reboot_type — power_cycle.

scheduled_start_time

строка

Планирует выполнение задания на указанное время.

Допустимые форматы: yyyymmddhhmmss и YYYY-MM-DDThh:mm:ss+HH:MM.

Применяется, если run имеет значение true, а reboot_type — power_cycle.

share_parameters

словарь

Параметры, необходимые для экспорта диагностики.

share_parameters требуется, если export имеет значение true.

file_name

строка

Имя файла диагностики для операции export.

ignore_certificate_warning

строка

Игнорирует предупреждение о сертификате при подключении к общей папке. Применяется только, если share_type имеет значение https.

on игнорирует предупреждение о сертификате.

off не игнорирует предупреждение о сертификате.

Варианты:

  • "off" ← (по умолчанию)
  • "on"

ip_address

строка

IP-адрес сетевой общей папки.

ip_address требуется, если share_type имеет значение nfs, cifs, http или https.

password

строка

Пароль сетевой общей папки.

password требуется, если share_type имеет значение cifs.

proxy_password

строка

Пароль прокси-сервера.

proxy_password применяется только, если share_type имеет значение http или https, а proxy_support — parameters_proxy.

proxy_port

целое число

Порт прокси-сервера.

proxy_port применяется только, если share_type имеет значение http или https, а proxy_support — parameters_proxy.

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

proxy_server

строка

IP-адрес прокси-сервера.

proxy_server требуется, если proxy_support имеет значение parameters_proxy.

proxy_server применяется только, если share_type имеет значение http или https, а proxy_support — parameters_proxy.

proxy_support

строка

Указывает, следует ли использовать поддержку прокси-сервера.

off не использует настройки прокси-сервера.

default_proxy использует настройки прокси-сервера по умолчанию.

parameters_proxy использует указанные настройки прокси-сервера. Если proxy_support имеет значение parameters_proxy, требуется proxy_server.

proxy_support применяется только, если share_type имеет значение http или https.

Варианты:

  • "off" ← (по умолчанию)
  • "default_proxy"
  • "parameters_proxy"

proxy_type

строка

Тип прокси-сервера.

http для выбора прокси HTTP.

socks для выбора прокси SOCKS.

proxy_type применяется только, если share_type имеет значение http или https, а proxy_support — parameters_proxy.

Варианты:

  • "http" ← (по умолчанию)
  • "socks"

proxy_username

строка

Имя пользователя прокси-сервера.

proxy_username применяется только, если share_type имеет значение http или https, а proxy_support — parameters_proxy.

share_name

строка

Сетевая общая папка или локальный путь к файлу диагностики.

share_type

строка

Тип сетевой общей папки.

local использует локальный путь для операции export.

nfs использует общую папку NFS для операции export.

cifs использует общую папку CIFS для операции export.

http использует общую папку HTTP для операции export.

https использует общую папку HTTPS для операции export.

Варианты:

  • "local" ← (по умолчанию)
  • "nfs"
  • "cifs"
  • "http"
  • "https"

username

строка

Имя пользователя сетевой общей папки.

username требуется, если share_type имеет значение cifs.

workgroup

строка

Рабочая группа сетевой общей папки.

workgroup применяется только, если share_type имеет значение cifs.

timeout

целое число

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

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

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

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 не указан, используется переменная среды IDRAC_X_AUTH_TOKEN.

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell iDRAC.
  • Этот модуль поддерживает только iDRAC9 и более поздние версии.
  • Этот модуль поддерживает адреса IPv4 и IPv6.
  • Этот модуль поддерживает check_mode.
  • Для работы этого модуля на сервере должен присутствовать пакет микропрограммы «Dell Diagnostics».
  • Если для операции export параметр share_type имеет значение local, сведения о задании не отображаются.

Примеры

---
- name: Run and export the diagnostics to local path
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: true
    export: true
    share_parameters:
      share_type: "local"
      share_path: "/opt/local/diagnostics/"
      file_name: "diagnostics.txt"

- name: Run the diagnostics with power cycle reboot on schedule
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: true
    run_mode: "express"
    reboot_type: "power_cycle"
    scheduled_start_time: 20240101101015

- name: Run and export the diagnostics to HTTPS share
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: true
    export: true
    share_parameters:
      share_type: "HTTPS"
      ignore_certificate_warning: "on"
      share_name: "/share_path/diagnostics_collection_path"
      ip_address: "192.168.0.2"
      file_name: "diagnostics.txt"

- name: Run and export the diagnostics to NFS share
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: true
    export: true
    share_parameters:
      share_type: "NFS"
      share_name: "nfsshare/diagnostics_collection_path/"
      ip_address: "192.168.0.3"
      file_name: "diagnostics.txt"

- name: Export the diagnostics to CIFS share
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    export: true
    share_parameters:
      share_type: "CIFS"
      share_name: "/cifsshare/diagnostics_collection_path/"
      ip_address: "192.168.0.4"
      file_name: "diagnostics.txt"

- name: Export the diagnostics to HTTPS share via proxy
  dellemc.openmanage.idrac_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    export: true
    share_parameters:
      share_type: "HTTPS"
      share_name: "/share_path/diagnostics_collection_path"
      ignore_certificate_warning: "on"
      ip_address: "192.168.0.2"
      file_name: "diagnostics.txt"
      proxy_support: parameters_proxy
      proxy_type: http
      proxy_server: "192.168.0.5"
      proxy_port: 1080
      proxy_username: "proxy_user"
      proxy_password: "proxy_password"

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

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

Ключ

Описание

diagnostics_file_path

строка

Возвращает полный путь к файлу диагностики.

Возвращается: при операции экспорта

Пример: "/share_path/diagnostics_collection_path/diagnostics.txt"

error_info

словарь

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

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "A Remote Diagnostic (ePSA) job already exists.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.9.SYS098", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "A response action is not required if the scheduled start time of the existing Remote Diagnostic (ePSA) job is ok. Else, delete the existing Diagnostics (ePSA) job and recreate another with an appropriate start time.", "Severity": "Informational"}], "code": "Base.1.12.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

job_details

словарь

Возвращает данные о состоянии задания.

Возвращается: при операциях запуска и экспорта

Пример: {"ActualRunningStartTime": "2024-01-10T10:14:31", "ActualRunningStopTime": "2024-01-10T10:26:34", "CompletionTime": "2024-01-10T10:26:34", "Description": "Job Instance", "EndTime": "2024-01-10T10:30:15", "Id": "JID_XXXXXXXXXXXX", "JobState": "Completed", "JobType": "RemoteDiagnostics", "Message": "Job completed successfully.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "SYS018", "Name": "Remote Diagnostics", "PercentComplete": 100, "StartTime": "2024-01-10T10:12:15", "TargetSettingsURI": null}

msg

строка

Состояние операции диагностики.

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

Пример: "Successfully ran and exported the diagnostics."

Авторы

  • Shivam Sharma(@ShivamSh3)

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

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

© 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/idrac_diagnostics_module.html

Spec-Zone.ru

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