netapp_eseries.santricity.na_santricity_alerts_syslog module – NetApp E-Series manage syslog servers receiving storage system alerts.
Note
This module is part of the netapp_eseries.santricity collection (version 1.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 |
Comments |
---|---|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API. |
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
List of dictionaries where each dictionary contains a syslog server entry. |
|
Syslog server address can be a fully qualified domain name, IPv4 address, or IPv6 address. |
|
UDP Port must be a numerical value between 0 and 65535. Typically, the UDP Port for syslog is 514. Default: |
|
The ID of the array to manage. This value must be unique for each array. Default: |
|
This forces a test syslog message to be sent to the stated syslog server. Test will only be issued when a change is made. Choices:
|
|
Should https certificates be validated? Choices:
|
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.
ERROR while parsing
M('netapp_e_storage_system')
: parameter ‘netapp_e_storage_system’ is not a FQCN 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 |
Description |
---|---|
Success message Returned: on success Sample: |