Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.idrac_support_assist — запуск и экспорт журналов сбора SupportAssist iDRAC

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: dellemc.openmanage.idrac_support_assist.

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

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

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

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

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

accept_eula

boolean

Этот параметр подтверждает принятие условий лицензионного соглашения EULA, необходимых для регистрации SupportAssist.

Если условия EULA не приняты, сбор SupportAssist нельзя запустить или экспортировать.

Допустимые значения:

  • false
  • true

ca_path

path

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

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

data_collector

list / элементы=string

Этот параметр позволяет выбрать данные, включаемые в сбор SupportAssist.

По умолчанию в сбор SupportAssist включаются сведения о системе.

hardware_data в сбор SupportAssist включаются данные, относящиеся к оборудованию.

storage_logs в сбор SupportAssist включаются журналы, относящиеся к устройствам хранения данных.

os_app_data в сбор SupportAssist включаются данные, относящиеся к операционной системе и приложениям.

debug_logs в сбор SupportAssist включаются журналы, относящиеся к отладке.

telemetry_reports в сбор SupportAssist включаются отчеты, относящиеся к телеметрии.

gpu_logs в сбор SupportAssist включаются журналы, относящиеся к графическим процессорам.

Допустимые значения:

  • "hardware_data"
  • "storage_logs"
  • "os_app_data"
  • "debug_logs"
  • "telemetry_reports"
  • "gpu_logs"

export

boolean

Экспортирует сбор SupportAssist в указанную сетевую папку.

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

Допустимые значения:

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

filter_data

boolean

Этот параметр позволяет фильтровать данные в целях конфиденциальности. В отфильтрованные данные не входят имя узла, MAC-адрес, температурные данные, журналы и содержимое реестра.

Допустимые значения:

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

idrac_ip

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

IP-адрес iDRAC.

idrac_password

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

string

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

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

Пример: export IDRAC_PASSWORD=password

idrac_port

integer

Порт iDRAC.

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

idrac_user

string

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

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

Пример: export IDRAC_USERNAME=username

job_wait

boolean

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

Допустимые значения:

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

job_wait_timeout

integer

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

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

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

resource_id

string

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

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

run

boolean

Запускает задание SupportAssist на iDRAC с учетом различных типов журналов в сборе.

Допустимые значения:

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

share_parameters

dictionary

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

share_parameters является обязательным, если export имеет значение true.

ignore_certificate_warning

string

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

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

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

Допустимые значения:

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

ip_address

string

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

ip_address является обязательным, если share_type имеет значение nfs, cifs, http или https.

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

password

псевдонимы: share_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_support имеет значение parameters_proxy, параметр proxy_server является обязательным.

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

Путь к сетевой папке или полный локальный путь к каталогу для экспорта файла сбора SupportAssist.

Если share_type имеет значение local, по умолчанию используется текущий каталог.

share_type

string

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

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

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

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

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

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

ftp использует папку FTP для операции export.

Допустимые значения:

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

username

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

string

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

username является обязательным, если share_type имеет значение cifs.

workgroup

string

-(устарело) Рабочая группа сетевой папки. - workgroup применяется только если share_type имеет значение cifs. - Этот аргумент не поддерживается iDRAC9 и iDRAC10.

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

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

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell iDRAC.
  • Этот модуль поддерживает только iDRAC9 и более поздние версии.
  • Этот модуль поддерживает адреса IPv4 и IPv6.
  • local для share_type применяется только в том случае, если run и export имеют значение true.
  • Если для run используется share_type со значением local (и выполняется операция экспорта), параметр job_wait не применяется.

Примеры

---
- name: Accept the EULA and run and export the SupportAssist Collection to local path
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    accept_eula: true
    ca_path: "path/to/ca_file"
    data_collector: ["debug_logs", "hardware_data", "os_app_data", "storage_logs"]
    share_parameters:
      share_type: "local"
      share_path: "/opt/local/support_assist_collections/"

- name: Run the SupportAssist Collection with with custom data_to_collect with filter_data
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "path/to/ca_file"
    export: false
    filter_data: true
    data_collector: ["debug_logs", "hardware_data"]

- name: Run and export the SupportAssist Collection to HTTPS share
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "path/to/ca_file"
    data_collector: ["hardware_data"]
    share_parameters:
      share_type: "https"
      ignore_certificate_warning: "on"
      share_name: "/share_path/support_assist_collections"
      ip_address: "192.168.0.2"

- name: Run and export the SupportAssist Collection to NFS share
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "path/to/ca_file"
    data_collector: ["debug_logs"]
    share_parameters:
      share_type: "nfs"
      share_name: "nfsshare/support_assist_collections/"
      ip_address: "192.168.0.3"

- name: Export the last SupportAssist Collection to CIFS share
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "path/to/ca_file"
    run: false
    share_parameters:
      share_type: "nfs"
      share_name: "/cifsshare/support_assist_collections/"
      ip_address: "192.168.0.4"

- name: Export the last SupportAssist Collection to HTTPS share via proxy
  dellemc.openmanage.idrac_support_assist:
    idrac_ip: "192.168.0.1"
    idrac_user: "username"
    idrac_password: "password"
    ca_path: "path/to/ca_file"
    run: false
    share_parameters:
      share_type: "https"
      share_name: "/share_path/support_assist_collections"
      ignore_certificate_warning: "on"
      ip_address: "192.168.0.2"
      proxy_support: parameters_proxy
      proxy_type: http
      proxy_server: "192.168.0.5"
      proxy_port: 1080
      proxy_username: "proxy_user"
      proxy_password: "proxy_password"

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

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

Ключ

Описание

error_info

dictionary

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

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to start the operation because the SupportAssist End User License Agreement (EULA) is not accepted.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.8.SRV085", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Accept the SupportAssist End User License Agreement (EULA) by navigating to the SupportAssist page on the iDRAC GUI.", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

job_details

dictionary

Возвращает результат с состоянием задания.

Возвращается: при выполнении операций запуска и экспорта

Пример: {"ActualRunningStartTime": "2024-07-08T01:50:54", "ActualRunningStopTime": "2024-07-08T01:56:45", "CompletionTime": "2024-07-08T01:56:45", "Description": "Job Instance", "EndTime": null, "Id": "JID_XXXXXXXXXXXX", "JobState": "Completed", "JobType": "SACollectExportHealthData", "Message": "The SupportAssist Collection and Transmission Operation is completed successfully.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "SRV088", "Name": "SupportAssist Collection", "PercentComplete": 100, "StartTime": "2024-07-08T01:50:54", "TargetSettingsURI": null}

msg

string

Состояние операции SupportAssist.

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

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

Авторы

  • 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_support_assist_module.html

Spec-Zone.ru

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