Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_configuration_compliance_baseline — создание, изменение и удаление базовой конфигурации соответствия требованиям и устранение несоответствий на устройствах в OpenManage Enterprise

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет создавать, изменять и удалять базовую конфигурацию соответствия требованиям в OpenManage Enterprise. Модуль также позволяет устранять несоответствия устройств базовой конфигурации, изменяя атрибуты устройств в соответствии с атрибутами связанной базовой конфигурации.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

command

строка

create создает базовую конфигурацию из существующего шаблона соответствия требованиям.create поддерживает check_mode или проверку идемпотентности только для имен.

modify изменяет существующую базовую конфигурацию.Изменять можно только имена, описание, идентификаторы устройств, сервисные теги устройств и имена групп устройств.

ПРЕДУПРЕЖДЕНИЕ При изменении базовой конфигурации указанные device_ids, device_group_names и device_service_tags заменяют устройства, которые ранее входили в базовую конфигурацию.

delete удаляет список базовых конфигураций соответствия требованиям по имени базовой конфигурации. Недопустимые имена базовых конфигураций игнорируются.

remediate устраняет несоответствия устройств базовой конфигурации, изменяя атрибуты устройств в соответствии с атрибутами связанной базовой конфигурации.

remediate выполняется для всех устройств, не соответствующих требованиям, если не указаны device_ids или device_service_tags.

Варианты:

  • "create" ← (по умолчанию)
  • "modify"
  • "delete"
  • "remediate"

cron

строка

Укажите выражение cron в формате Quartz cron.

Формат времени: “%S %M %H %d %m ? %Y”.

Применяется, если run_later — true.

description

строка

Описание базовой конфигурации соответствия требованиям.

Этот параметр применяется, если command — create или modify.

device_group_names

список / элементы=строка

Имя целевой группы устройств.

Этот параметр применяется, если command — create или modify, и является взаимоисключающим с device_ids и device_service_tag.

device_ids

список / элементы=целое число

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

Этот параметр применяется, если command — create, modify или remediate, и является взаимоисключающим с device_service_tag и device_group_names.

device_service_tags

список / элементы=строка

Сервисный тег целевого устройства.

Этот параметр применяется, если command — create, modify или remediate, и является взаимоисключающим с device_ids и device_group_names.

hostname

строка / обязательный

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

job_wait

логический

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

Этот параметр применяется, если command — create, modify или remediate.

Варианты:

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

job_wait_timeout

целое число

Максимальное время ожидания job_wait в секундах. Отслеживание задания выполняется только в течение этого времени.

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

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

names

список / элементы=строка / обязательный

Имя (имена) базовой конфигурации соответствия требованиям.

Этот параметр применяется, если command — create, modify или delete.

Если command — delete, укажите список имен поддерживаемых базовых конфигураций соответствия требованиям.

new_name

строка

Новое имя изменяемой базовой конфигурации соответствия требованиям.

Этот параметр применяется, если command — modify.

password

строка

Пароль OpenManage Enterprise.

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

Пример: export OME_PASSWORD=password

port

целое число

HTTPS-порт OpenManage Enterprise.

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

run_later

логический

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

Применяется, если command — remediate.

Если run_later — true, параметр staged_at_reboot игнорируется.

Если run_later — true, параметр job_wait не применяется.

Если run_later — true, необходимо указать cron.

Варианты:

  • false
  • true

staged_at_reboot

логический

Указывает, следует ли выполнять устранение несоответствий при следующей перезагрузке.

Если staged_at_reboot — true, устранение несоответствий произойдет во время следующей перезагрузки.

Варианты:

  • false
  • true

template_id

целое число

Идентификатор шаблона развертывания, используемого для создания базовой конфигурации соответствия требованиям.

Этот параметр применяется, если command — create, и является взаимоисключающим с template_name.

template_name

строка

Имя шаблона соответствия требованиям, используемого для создания базовой конфигурации (конфигураций) соответствия требованиям.

Имя шаблона развертывания, используемого для создания базовой конфигурации соответствия требованиям.

Этот параметр применяется, если command — create, и является взаимоисключающим с template_id.

timeout

целое число

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

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

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

username

строка

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

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

Примечания

Примечание

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

Примеры

---
- name: Create a configuration compliance baseline using device IDs
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    names: "baseline1"
    template_name: "template1"
    description: "description of baseline"
    device_ids:
      - 1111
      - 2222

- name: Create a configuration compliance baseline using device service tags
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    names: "baseline1"
    template_id: 1234
    description: "description of baseline"
    device_service_tags:
      - "SVCTAG1"
      - "SVCTAG2"

- name: Create a configuration compliance baseline using group names
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    names: "baseline2"
    template_id: 2
    job_wait_timeout: 1000
    description: "description of baseline"
    device_group_names:
      - "Group1"
      - "Group2"

- name: Delete the configuration compliance baselines
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: delete
    names:
      - baseline1
      - baseline2

- name: Modify a configuration compliance baseline using group names
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: modify
    names: "baseline1"
    new_name: "baseline_update"
    template_name: "template2"
    description: "new description of baseline"
    job_wait_timeout: 1000
    device_group_names:
      - Group1

- name: Remediate specific non-compliant devices to a configuration compliance baseline using device IDs
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "remediate"
    names: "baseline1"
    device_ids:
      - 1111

- name: Remediate specific non-compliant devices to a configuration compliance baseline using device service tags
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "remediate"
    names: "baseline1"
    device_service_tags:
      - "SVCTAG1"
      - "SVCTAG2"

- name: Remediate all the non-compliant devices to a configuration compliance baseline
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "remediate"
    names: "baseline1"

- name: Remediate specific non-compliant devices to a configuration compliance baseline using device IDs at scheduled time
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "remediate"
    names: "baseline1"
    device_ids:
      - 1111
    run_later: true
    cron: "0 10 11 14 02 ? 2032"  # Feb 14,2032 11:10:00

- name: Remediate specific non-compliant devices to a configuration compliance baseline using device service tags on next reboot
  dellemc.openmanage.ome_configuration_compliance_baseline:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "remediate"
    names: "baseline1"
    device_service_tags:
      - "SVCTAG1"
      - "SVCTAG2"
    staged_at_reboot: true

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

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

Ключ

Описание

compliance_status

словарь

Состояние операции с базовой конфигурацией соответствия требованиям.

Возвращается: если command — create или modify

Пример: {"BaselineTargets": [{"Id": 1111, "Type": {"Id": 1000, "Name": "DEVICE"}}], "ConfigComplianceSummary": {"ComplianceStatus": "OK", "NumberOfCritical": 0, "NumberOfIncomplete": 0, "NumberOfNormal": 0, "NumberOfWarning": 0}, "Description": null, "Id": 13, "LastRun": "2021-02-27 13:15:13.751", "Name": "baseline1", "PercentageComplete": "100", "TaskId": 26584, "TaskStatus": 2070, "TemplateId": 102, "TemplateName": "one", "TemplateType": 2}

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

incompatible_devices

список / элементы=строка

Сведения об устройствах, которые нельзя использовать для выполнения операций проверки соответствия базовой конфигурации.

Возвращается: если device_service_tags или device_ids содержит несовместимые устройства для create или modify

Пример: [1234, 5678]

job_details

список / элементы=строка

Сведения о завершившемся с ошибкой задании.

Возвращается: при сбое задания

Пример: [{"ElapsedTime": "00:22:17", "EndTime": "2024-06-19 13:42:41.285", "ExecutionHistoryId": 797320, "Id": 14123, "IdBaseEntity": 19559, "JobStatus": {"Id": 2070, "Name": "Failed"}, "Key": "SVCTAG1", "Progress": "100", "StartTime": "2024-06-19 13:20:23.495", "Value": "Starting Pre-checks....LC status is : InUse, wait for 30 seconds and retry ...(1)"}]

job_id

целое число

Идентификатор задачи, созданной при значении command remediate.

Возвращается: если command — remediate

Пример: 14123

msg

строка

Общий статус операции с базовой конфигурацией соответствия требованиям.

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

Пример: "Successfully created the configuration compliance baseline."

Авторы

  • Sajna Shetty(@Sajna-Shetty)
  • Abhishek Sinha(@Abhishek-Dell)
  • Shivam Sharma(@ShivamSh3)
  • Meenakshi Dembi(@meenakshidembi691)

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

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

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

Spec-Zone.ru

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