Spec-Zone.ru › Ansible

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

Примечание

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

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

Этот параметр предоставляет выбор данных для сохранения в сборе SupportAssist.

Информация о системе доступна в сборе SupportAssist по умолчанию.

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

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

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

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

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

gpu_logs, сбор SupportAssist включает логи, относящиеся к GPU.

Варианты:

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

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

Путь к сетевой папке или полному локальному пути к каталогу для экспорта файла сбора 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

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

Примечания

Примечание

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

Примеры

---
- name: Accept the EULA and run and export the SupportAssist Collection to local path
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    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:
    hostname: "192.168.0.1"
    username: "username"
    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:
    hostname: "192.168.0.1"
    username: "username"
    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:
    hostname: "192.168.0.1"
    username: "username"
    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:
    hostname: "192.168.0.1"
    username: "username"
    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:
    hostname: "192.168.0.1"
    username: "username"
    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

словарь

Подробности 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

словарь

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

Возвращается: для операций run и export

Пример: {"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

строка

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

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

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

Авторы

  • Шивам Шарма(@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_support_assist_module.html

Spec-Zone.ru

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