New in version 2.7.
Parameter | Choices/Defaults | Comments |
---|---|---|
address |
The syslog server's IPv4 address or a fully qualified hostname.
All existing syslog configurations will be removed when state=absent and address=None.
|
|
api_password
required |
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_url
required |
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
api_username
required |
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
components |
Default: ['auditLog']
|
The e-series logging components define the specific logs to transfer to the syslog server.
At the time of writing, 'auditLog' is the only logging component but more may become available.
|
log_path |
This argument specifies a local path for logging purposes.
|
|
port |
Default: 514
|
This is the port the syslog server is using.
|
protocol |
|
This is the transmission protocol the syslog server's using to receive syslog messages.
|
ssid
required |
The ID of the array to manage. This value must be unique for each array.
|
|
state |
|
Add or remove the syslog server configuration for E-Series storage array.
Existing syslog server configuration will be removed or updated when its address matches address.
Fully qualified hostname that resolve to an IPv4 address that matches address will not be treated as a match.
|
test
bool |
|
This forces a test syslog message to be sent to the stated syslog server.
Only attempts transmission when state=present.
|
validate_certs
bool |
|
Should https certificates be validated?
|
Note
- name: Add two syslog server configurations to NetApp E-Series storage array.
netapp_e_syslog:
state: present
address: "{{ item }}"
port: 514
protocol: tcp
component: "auditLog"
api_url: "10.1.1.1:8443"
api_username: "admin"
api_password: "myPass"
loop:
- "192.168.1.1"
- "192.168.1.100"
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.
|
syslog
bool
|
on success |
True if syslog server configuration has been added to e-series storage array.
Sample:
True
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.