dellemc.openmanage.ome_application_alerts_syslog (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 configure syslog forwarding settings on OpenManage Enterprise and OpenManage Enterprise Modular.

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Configure single server to forward syslog
  dellemc.openmanage.ome_application_alerts_syslog:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    syslog_servers:
      - id: 1
        enabled: true
        destination_address: 192.168.0.2
        port_number: 514

Scanned by Steampunk Spotter

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

- name: Configure multiple server to forward syslog
  dellemc.openmanage.ome_application_alerts_syslog:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    syslog_servers:
      - id: 1
        port_number: 523
      - id: 2
        enabled: true
        destination_address: sysloghost1.lab.com
      - id: 3
        enabled: false
      - id: 4
        enabled: true
        destination_address: 192.168.0.4
        port_number: 514

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

syslog_servers:
    description: List of servers to forward syslog.
    elements: dict
    suboptions:
      destination_address:
        description:
        - The IP address, FQDN or hostname of the syslog server.
        - This is required if I(enabled) is C(true).
        type: str
      enabled:
        description: Enable or disable syslog forwarding.
        type: bool
      id:
        choices:
        - 1
        - 2
        - 3
        - 4
        description: The ID of the syslog server.
        required: true
        type: int
      port_number:
        description: The UDP port number of the syslog server.
        type: int
    type: list

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

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to update the Syslog settings because the request contains
          an invalid number of configurations. The request must contain no more than
          4 configurations but contains 5.
        MessageArgs:
        - '4'
        - '5'
        MessageId: CAPP1108
        RelatedProperties: []
        Resolution: Enter only the required number of configurations as identified
          in the message and retry the operation.
        Severity: Warning
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Overall status of the syslog forwarding operation.
  returned: always
  sample: Successfully updated the syslog forwarding settings.
  type: str
syslog_details:
  description: Syslog forwarding settings list applied.
  returned: on success
  sample:
  - DestinationAddress: 192.168.10.43
    Enabled: false
    Id: 1
    PortNumber: 514
  - DestinationAddress: 192.168.10.46
    Enabled: true
    Id: 2
    PortNumber: 514
  - DestinationAddress: 192.168.10.44
    Enabled: true
    Id: 3
    PortNumber: 514
  - DestinationAddress: 192.168.10.42
    Enabled: true
    Id: 4
    PortNumber: 515
  type: list