Spec-Zone.ru › Ansible

dellemc.openmanage.idrac_diagnostics модуль – Запуск и экспорт диагностики iDRAC

Примечание

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

Вы, возможно, уже установили эту коллекцию, если используете пакет 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

string

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

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

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

Варианты:

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

ip_address

string

IP-адрес сетевого общего ресурса.

ip_address требуется, когда share_type равен nfs, cifs, http или https.

password

string

Пароль к сетевому общему ресурсу.

password требуется, когда share_type равен cifs.

proxy_password

string

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

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

proxy_port

integer

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

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

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

proxy_server

string

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

proxy_server требуется, когда proxy_support равен parameters_proxy.

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

proxy_support

string

Указывает, необходимо ли использовать прокси-сервер.

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

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

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

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

Варианты:

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

proxy_type

string

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

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

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

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

Варианты:

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

proxy_username

string

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

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

share_name

string

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

share_type

string

Тип общего ресурса.

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

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

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

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

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

Варианты:

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

username

string

Имя пользователя сетевого общего ресурса.

username требуется, когда share_type равен cifs.

workgroup

string

Группа рабочих станций сетевого общего ресурса.

workgroup применим только при share_type равен cifs.

timeout

integer

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

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

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

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

Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

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

Примеры

---
- 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."

Авторы

  • Шивам Шарма(@ShivamSh3)

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

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

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

Spec-Zone.ru

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