netapp_eseries.santricity.na_santricity_alerts_syslog – NetApp E-Series manage syslog servers receiving storage system alerts.

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.2.7).

To install it use: ansible-galaxy collection install netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_alerts_syslog.

Synopsis

  • Manage the list of syslog servers that will notifications on potentially critical events.

Parameters

Parameter Choices/Defaults Comments
api_password
string / required
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
api_url
string / required
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
api_username
string / required
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
servers
list / elements=string
List of dictionaries where each dictionary contains a syslog server entry.
address
string / required
Syslog server address can be a fully qualified domain name, IPv4 address, or IPv6 address.
port
string
Default:
514
UDP Port must be a numerical value between 0 and 65535. Typically, the UDP Port for syslog is 514.
ssid
string
Default:
1
The ID of the array to manage. This value must be unique for each array.
test
boolean
    Choices:
  • no ←
  • yes
This forces a test syslog message to be sent to the stated syslog server.
Test will only be issued when a change is made.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

Notes

Note

  • Check mode is supported.

  • This API is currently only supported with the Embedded Web Services API v2.12 (bundled with SANtricity OS 11.40.2) and higher.

  • The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.

  • Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.

  • netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance.

Examples

- name: Add two syslog server configurations to NetApp E-Series storage array.
  na_santricity_alerts_syslog:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    servers:
        - address: "192.168.1.100"
        - address: "192.168.2.100"
          port: 514
        - address: "192.168.3.100"
          port: 1000

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
msg
string
on success
Success message

Sample:
The settings have been updated.


Authors

  • Nathan Swartz (@ndswartz)