Spec-Zone.ru › Ansible

dellemc.openmanage.ome_diagnostics модуль — Экспорт журналов технической поддержки (TSR) в сетевую папку

Примечание

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

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

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

Для использования в книге задач укажите: dellemc.openmanage.ome_diagnostics.

Новинка в dellemc.openmanage 3.6.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет экспортировать журналы SupportAssist из OpenManage Enterprise и OpenManage Enterprise Modular, а также журналы приложений из OpenManage Enterprise Modular в сетевую папку CIFS или NFS.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

added in dellemc.openmanage 5.0.0

Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, который будет использоваться для проверки.

device_group_name

string

Имя группы устройств для экспорта support_assist_collection или supportassist_collection журналов всех устройств в группе.

Это применимо к support_assist_collection и supportassist_collection журналам.

Этот параметр не применим для OpenManage Enterprise Modular.

Этот параметр взаимоисключающий с device_ids и device_service_tags.

device_ids

list / elements=integer

Список идентификаторов целевых устройств.

Это применимо к support_assist_collection и supportassist_collection журналам.

Этот параметр взаимоисключающий с device_service_tags и device_group_name.

device_service_tags

list / elements=string

Список идентификаторов целевого объекта.

Это применимо к support_assist_collection и supportassist_collection журналам.

Этот параметр взаимоисключающий с device_ids и device_group_name.

hostname

string / required

IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.

job_wait

boolean

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

Максимальное время ожидания — job_wait_timeout.

Варианты:

  • false
  • true ← (default)

job_wait_timeout

integer

Максимальное время ожидания job_wait в минутах.

Этот параметр применим, если job_wait имеет значение true.

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

lead_chassis_only

boolean

Извлечь журналы только из ведущего шасси.

lead_chassis_only применим только когда log_type — application в OpenManage Enterprise Modular.

Варианты:

  • false ← (default)
  • true

log_selectors

list / elements=string

По умолчанию журналы SupportAssist содержат только журналы оборудования. Чтобы собрать дополнительные журналы, такие как журналы ОС, журналы RAID или отладочные журналы, укажите типы журналов, которые необходимо собрать, в списке вариантов.

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

OS_LOGS для сбора журналов ОС.

RAID_LOGS для сбора журналов контроллера RAID.

DEBUG_LOGS для сбора отладочных журналов.

Этот параметр применим только для support_assist_collection и supportassist_collection log_type.

Варианты:

  • "OS_LOGS"
  • "RAID_LOGS"
  • "DEBUG_LOGS"

log_type

string

application применим для OpenManage Enterprise Modular для экспорта пакета журналов приложения.

support_assist_collection и supportassist_collection применимы для одного или нескольких устройств для экспорта журналов SupportAssist.

support_assist_collection и supportassist_collection поддерживают как OpenManage Enterprise, так и OpenManage Enterprise Modular.

support_assist_collection и supportassist_collection не поддерживают экспорт OS_LOGS из OpenManage Enterprise. При попытке экспорта задачи завершатся с ошибками, и модуль завершится с ошибкой.

Варианты:

  • "application"
  • "support_assist_collection" ← (default)
  • "supportassist_collection"

mask_sensitive_info

boolean

Выберите этот параметр, чтобы замаскировать личную информацию, такую как IP-адрес, DNS, назначение оповещения, электронная почта, шлюз, inet6, Mac-адрес, маска сети и т. д.

Этот параметр применим для application log_type.

Варианты:

  • false ← (default)
  • true

password

string

Пароль OpenManage Enterprise или OpenManage Enterprise Modular.

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

Пример: export OME_PASSWORD=password

port

integer

Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular.

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

share_address

string / required

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

share_domain

string

Имя домена сетевого ресурса.

Этот параметр применим для CIFS, если share_type.

share_name

string / required

Путь к сетевому ресурсу.

Имя файла создается автоматически и не должно указываться как часть share_name.

share_password

string

Пароль к сетевой папке

Этот параметр применим для CIFS share_type.

share_type

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

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

Варианты:

  • "NFS"
  • "CIFS"

share_user

string

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

Этот параметр применим для CIFS share_type.

test_connection

boolean

Проверить доступность расположения сетевой папки.

Параметры job_wait и job_wait_timeout не применимы для test_connection.

Варианты:

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

timeout

integer

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

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

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

username

string

Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular.

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

Пример: export OME_USERNAME=username

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

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Запускайте этот модуль с системы, имеющей прямой доступ к OpenManage Enterprise.
  • Этот модуль выполняет проверку подключения и валидацию устройства. Он не создает задание для копирования журналов в режиме проверки и всегда сообщает о найденных изменениях.
  • Этот модуль поддерживает check_mode.

Примеры

---
- name: Export application log using CIFS share location
  dellemc.openmanage.ome_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    share_type: CIFS
    share_address: "192.168.0.2"
    share_user: share_username
    share_password: share_password
    share_name: cifs_share
    log_type: application
    mask_sensitive_info: false
    test_connection: true

- name: Export application log using NFS share location
  dellemc.openmanage.ome_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    share_address: "192.168.0.3"
    share_type: NFS
    share_name: nfs_share
    log_type: application
    mask_sensitive_info: true
    test_connection: true

- name: Export SupportAssist log using CIFS share location
  dellemc.openmanage.ome_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    share_address: "192.168.0.3"
    share_user: share_username
    share_password: share_password
    share_name: cifs_share
    share_type: CIFS
    log_type: support_assist_collection
    device_ids: [10011, 10022]
    log_selectors: [OS_LOGS]
    test_connection: true

- name: Export SupportAssist log using NFS share location
  dellemc.openmanage.ome_diagnostics:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    share_address: "192.168.0.3"
    share_type: NFS
    share_name: nfs_share
    log_type: support_assist_collection
    device_group_name: group_name
    test_connection: true

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

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

Ключ

Описание

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

jog_status

словарь

Подробности о статусе операции экспорта журнала.

Возвращается: успех

Пример: {"Builtin": false, "CreatedBy": "root", "Editable": true, "EndTime": "None", "Id": 12778, "JobDescription": "Export device log", "JobName": "Export Log", "JobStatus": {"Id": 2080, "Name": "New"}, "JobType": {"Id": 18, "Internal": false, "Name": "DebugLogs_Task"}, "LastRun": "2021-07-06 10:52:50.519", "LastRunStatus": {"Id": 2060, "Name": "Completed"}, "NextRun": "None", "Params": [{"JobId": 12778, "Key": "maskSensitiveInfo", "Value": "FALSE"}, {"JobId": 12778, "Key": "password", "Value": "tY86w7q92u0QzvykuF0gQQ"}, {"JobId": 12778, "Key": "userName", "Value": "administrator"}, {"JobId": 12778, "Key": "shareName", "Value": "iso"}, {"JobId": 12778, "Key": "OPERATION_NAME", "Value": "EXTRACT_LOGS"}, {"JobId": 12778, "Key": "shareType", "Value": "CIFS"}, {"JobId": 12778, "Key": "shareAddress", "Value": "100.96.32.142"}], "Schedule": "startnow", "StartTime": "None", "State": "Enabled", "Targets": [{"Data": "", "Id": 10053, "JobId": 12778, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": "None", "UserGenerated": true, "Visible": true}

msg

строка

Общий статус экспорта журнала.

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

Пример: "Export log job completed successfully."

Авторы

  • Felix Stephen (@felixs88)
  • Sachin Apagundi(@sachin-apa)

Ссылки на сборку

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

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

Spec-Zone.ru

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