dellemc.openmanage.ome_configuration_compliance_info (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module allows the generation of a compliance report of a specific or all of devices in a configuration compliance baseline.

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Retrieve the compliance report of all of the devices in the specified configuration compliance baseline.
  dellemc.openmanage.ome_configuration_compliance_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline: baseline_name

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve the compliance report for a specific device associated with the baseline using the device ID.
  dellemc.openmanage.ome_configuration_compliance_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline: baseline_name
    device_id: 10001

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve the compliance report for a specific device associated with the baseline using the device service tag.
  dellemc.openmanage.ome_configuration_compliance_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    baseline: baseline_name
    device_service_tag: 2HFGH3

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

baseline:
    description:
    - The name of the created baseline.
    - A compliance report is generated even when the template is not associated with the
      baseline.
    required: true
    type: str

hostname:
    description: OpenManage Enterprise IP address or hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

device_id:
    description:
    - The ID of the target device which is associated with the I(baseline).
    required: false
    type: int

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

device_service_tag:
    description:
    - The device service tag of the target device associated with the I(baseline).
    - I(device_service_tag) is mutually exclusive with I(device_id).
    required: false
    type: str

Outputs

compliance_info:
  description: Returns the compliance report information.
  returned: success
  sample:
  - ComplianceAttributeGroups:
    - Attributes: []
      ComplianceReason: One or more attributes on the target device(s) does not match
        the compliance template.
      ComplianceStatus: 2
      ComplianceSubAttributeGroups:
      - Attributes:
        - AttributeId: 75369
          ComplianceReason: Attribute has different value from template
          ComplianceStatus: 3
          CustomId: 0
          Description: null
          DisplayName: Workload Profile
          ExpectedValue: HpcProfile
          Value: NotAvailable
        ComplianceReason: One or more attributes on the target device(s) does not
          match the compliance template.
        ComplianceStatus: 2
        ComplianceSubAttributeGroups: []
        DisplayName: System Profile Settings
        GroupNameId: 1
      DisplayName: BIOS
      GroupNameId: 1
    ComplianceStatus: NONCOMPLIANT
    DeviceName: WIN-PLOV8MPIP40
    DeviceType: 1000
    Id: 25011
    InventoryTime: '2021-03-18 00:01:57.809771'
    Model: PowerEdge R7525
    ServiceTag: JHMBX53
  type: dict
error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    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.
  type: dict
msg:
  description: Over all compliance report status.
  returned: on error
  sample: Unable to complete the operation because the entered target baseline name
    'baseline' is invalid.
  type: str