Spec-Zone.ru › Ansible

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

Примечание

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

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

path

added in dellemc.openmanage 5.0.0

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

command

string

create creates a configuration baseline from an existing compliance template.create supports check_mode or idempotency checking for only names.

modify modifies an existing baseline.Only names, description, device_ids, device_service_tags, and device_group_names can be modified

WARNING When a baseline is modified, the provided device_ids, device_group_names, and device_service_tags replaces the devices previously present in the baseline.

delete deletes the list of configuration compliance baselines based on the baseline name. Invalid baseline names are ignored.

remediate remediates devices that are non-compliant with the baseline by changing the attributes of devices to match with the associated baseline attributes.

remediate is performed on all the non-compliant devices if either device_ids, or device_service_tags is not provided.

Choices:

  • "create" ← (default)
  • "modify"
  • "delete"
  • "remediate"

cron

string

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

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

Это применимо, когда run_later имеет значение true.

description

string

Описание базового уровня соответствия.

Эта опция применима, когда command имеет значение create, или modify.

device_group_names

list / elements=string

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

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

device_ids

list / elements=integer

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

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

device_service_tags

list / elements=string

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

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

hostname

string / required

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

job_wait

boolean

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

Эта опция применима, когда command имеет значение create, modify, или remediate.

Choices:

  • false
  • true ← (default)

job_wait_timeout

integer

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

Эта опция применима, когда job_wait имеет значение true.

Default: 10800

names

list / elements=string / required

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

Эта опция применима, когда command имеет значение create, modify, или delete.

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

new_name

string

Новое имя базового уровня соответствия, которое будет изменено.

Эта опция применима, когда command имеет значение modify.

password

string

Пароль OpenManage Enterprise.

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

Пример: export OME_PASSWORD=password

port

integer

Порт HTTPS OpenManage Enterprise.

Default: 443

run_later

boolean

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

Это применимо, когда command имеет значение remediate.

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

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

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

Choices:

  • false
  • true

staged_at_reboot

boolean

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

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

Варианты:

  • false
  • true

template_id

integer

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

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

template_name

string

Имя шаблона соответствия для создания эталона соответствия.

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

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

timeout

integer

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

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

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

username

string

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

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

Примечания

Примечание

  • Этот модуль поддерживает 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)

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

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

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

Spec-Zone.ru

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