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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации для проверки.
device_group_name строка	Имя группы устройств для экспорта журналов `support_assist_collection` или `supportassist_collection` всех устройств в группе. Применяется к журналам `support_assist_collection` и `supportassist_collection`. Этот параметр не применим к OpenManage Enterprise Modular. Этот параметр несовместим с параметрами device_ids и device_service_tags.
device_ids список / элементы=целое число	Список идентификаторов целевых устройств. Применяется к журналам `support_assist_collection` и `supportassist_collection`. Этот параметр несовместим с параметрами device_service_tags и device_group_name.
device_service_tags список / элементы=строка	Список идентификаторов целевых устройств. Применяется к журналам `support_assist_collection` и `supportassist_collection`. Этот параметр несовместим с параметрами device_ids и device_group_name.
hostname строка / обязательный	IP-адрес или имя узла OpenManage Enterprise либо OpenManage Enterprise Modular.
job_wait логический	Ожидать ли завершения задания. Максимальное время ожидания задается параметром job_wait_timeout. Варианты: `false` `true` ← (по умолчанию)
job_wait_timeout целое число	Максимальное время ожидания, задаваемое параметром job_wait, в минутах. Этот параметр применяется, если значение job_wait равно true. По умолчанию: `60`
lead_chassis_only логический	Извлекать журналы только из ведущего шасси. lead_chassis_only применяется только в том случае, если для log_type задано значение `application` в OpenManage Enterprise Modular. Варианты: `false` ← (по умолчанию) `true`
log_selectors список / элементы=строка	По умолчанию журналы SupportAssist содержат только аппаратные журналы. Чтобы собрать дополнительные журналы, например журналы ОС, RAID или отладки, укажите в списке вариантов типы журналов для сбора. Если типы журналов не указаны, экспортируются только аппаратные журналы. `OS_LOGS` для сбора журналов ОС. `RAID_LOGS` для сбора журналов RAID-контроллера. `DEBUG_LOGS` для сбора журналов отладки. Этот параметр применим только для `support_assist_collection` и `supportassist_collection` параметра log_type. Варианты: `"OS_LOGS"` `"RAID_LOGS"` `"DEBUG_LOGS"`
log_type строка	`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"` ← (по умолчанию) `"supportassist_collection"`
mask_sensitive_info логический	Выберите этот параметр, чтобы скрыть персональные идентификационные данные, например IP-адреса, DNS, адреса назначения оповещений, адреса электронной почты, шлюзы, inet6, MAC-адреса, маски подсети и т. д. Этот параметр применим для `application` параметра log_type. Варианты: `false` ← (по умолчанию) `true`
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
share_address строка / обязательный	IP-адрес сетевой папки.
share_domain строка	Имя домена сетевой папки. Этот параметр применяется для `CIFS` параметра share_type.
share_name строка / обязательный	Путь к сетевой папке. Имя файла создается автоматически, поэтому его не следует указывать в параметре share_name.
share_password строка	Пароль сетевой папки Этот параметр применяется для `CIFS` параметра share_type.
share_type строка / обязательный	Тип сетевой папки Варианты: `"NFS"` `"CIFS"`
share_user строка	Имя пользователя сетевой папки. Этот параметр применяется для `CIFS` параметра share_type.
test_connection логический	Проверить доступность сетевой папки. Параметры job_wait и job_wait_timeout не применяются к параметру test_connection. Варианты: `false` ← (по умолчанию) `true`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
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 не указан, используется переменная среды `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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/ome_diagnostics_module.html