dellemc.openmanage.ome_alert_policies_category_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 to retrieve all the alert policy categories for OpenManage Enterprise and OpenManage Enterprise Modular.

Requirements

• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Retrieve information about all the OME alert policy categories
  dellemc.openmanage.ome_alert_policies_category_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular 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

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

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular 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 or OpenManage Enterprise Modular 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

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

Outputs

categories:
  description: Information about the alert categories.
  returned: always
  sample:
  - CategoriesDetails:
    - CatalogName: Application
      Id: 5
      Name: Configuration
      SubCategoryDetails:
      - Description: Application
        Id: 85
        Name: Application
      - Description: Users
        Id: 35
        Name: Users
    - CatalogName: Application
      Id: 7
      Name: Miscellaneous
      SubCategoryDetails:
      - Description: Miscellaneous
        Id: 20
        Name: Miscellaneous
    - CatalogName: Application
      Id: 2
      Name: Storage
      SubCategoryDetails:
      - Description: Devices
        Id: 90
        Name: Devices
    - CatalogName: Application
      Id: 3
      Name: Updates
      SubCategoryDetails:
      - Description: Application
        Id: 85
        Name: Application
      - Description: Firmware
        Id: 112
        Name: Firmware
    IsBuiltIn: true
    Name: Application
  - CategoriesDetails:
    - CatalogName: Dell Storage
      Id: 2
      Name: Storage
      SubCategoryDetails:
      - Description: Other
        Id: 7700
        Name: Other
    - CatalogName: Dell Storage
      Id: 1
      Name: System Health
      SubCategoryDetails:
      - Description: Other
        Id: 7700
        Name: Other
      - Description: Storage
        Id: 18
        Name: Storage
    IsBuiltIn: true
    Name: Dell Storage
  - CategoriesDetails:
    - CatalogName: iDRAC
      Id: 4
      Name: Audit
      SubCategoryDetails:
      - Description: Auto System Reset
        Id: 41
        Name: Auto System Reset
      - Description: UEFI Event
        Id: 55
        Name: UEFI Event
      - Description: User Tracking
        Id: 56
        Name: User Tracking
    - CatalogName: iDRAC
      Id: 5
      Name: Configuration
      SubCategoryDetails:
      - Description: Auto-Discovery
        Id: 49
        Name: Auto-Discovery
      - Description: vFlash Event
        Id: 66
        Name: vFlash Event
      - Description: Virtual Console
        Id: 7
        Name: Virtual Console
    - CatalogName: iDRAC
      Id: 2
      Name: Storage
      SubCategoryDetails:
      - Description: Battery Event
        Id: 108
        Name: Battery Event
      - Description: Virtual Disk
        Id: 46
        Name: Virtual Disk
    - CatalogName: iDRAC
      Id: 1
      Name: System Health
      SubCategoryDetails:
      - Description: Amperage
        Id: 67
        Name: Amperage
      - Description: Auto System Reset
        Id: 41
        Name: Auto System Reset
      - Description: Voltage
        Id: 40
        Name: Voltage
    - CatalogName: iDRAC
      Id: 6
      Name: Work Notes
      SubCategoryDetails:
      - Description: BIOS Management
        Id: 54
        Name: BIOS Management
    IsBuiltIn: true
    Name: iDRAC
  type: list
error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to complete the request because the resource URI does not
          exist or is not implemented.
        MessageArgs: []
        MessageId: CGEN1234
        RelatedProperties: []
        Resolution: Check the request resource URI. Refer to the OpenManage Enterprise-Modular
          User's Guide for more information about resource URI and its properties.
        Severity: Critical
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Status of the alert policies category fetch operation.
  returned: always
  sample: Successfully retrieved alert policies category information.
  type: str