netapp_e_auditlog – NetApp E-Series manage audit-log configuration
New in version 2.7.
Synopsis
- This module allows an e-series storage system owner to set audit-log configuration parameters.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
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. Example https://prod-1.wahoo.acme.com/devmgr/v2 | |
api_username - / required | The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. | |
force boolean |
| Forces the audit-log configuration to delete log history when log messages fullness cause immediate warning or full condition. Warning! This will cause any existing audit-log messages to be deleted. This is only applicable for full_policy=preventSystemAccess. |
full_policy - |
| Specifies what audit-log should do once the number of entries approach the record limit. |
log_level - |
| Filters the log messages according to the specified log level selection. |
log_path - | A local path to a file to be used for debug logging. | |
max_records - | Default: 50000 | The maximum number log messages audit-log will retain. Max records must be between and including 100 and 50000. |
ssid - | Default: 1 | The ID of the array to manage. This value must be unique for each array. |
threshold - | Default: 90 | This is the memory full percent threshold that audit-log will start issuing warning messages. Percent range must be between and including 60 and 90. |
validate_certs boolean |
| Should https certificates be validated? |
Notes
Note
- Check mode is supported.
- This module is currently only supported with the Embedded Web Services API v3.0 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: Define audit-log to prevent system access if records exceed 50000 with warnings occurring at 60% capacity. netapp_e_auditlog: api_url: "https://{{ netapp_e_api_host }}/devmgr/v2" api_username: "{{ netapp_e_api_username }}" api_password: "{{ netapp_e_api_password }}" ssid: "{{ netapp_e_ssid }}" validate_certs: no max_records: 50000 log_level: all full_policy: preventSystemAccess threshold: 60 log_path: /path/to/log_file.log - name: Define audit-log utilize the default values. netapp_e_auditlog: api_url: "https://{{ netapp_e_api_host }}/devmgr/v2" api_username: "{{ netapp_e_api_username }}" api_password: "{{ netapp_e_api_password }}" ssid: "{{ netapp_e_ssid }}" - name: Force audit-log configuration when full or warning conditions occur while enacting preventSystemAccess policy. netapp_e_auditlog: api_url: "https://{{ netapp_e_api_host }}/devmgr/v2" api_username: "{{ netapp_e_api_username }}" api_password: "{{ netapp_e_api_password }}" ssid: "{{ netapp_e_ssid }}" max_records: 5000 log_level: all full_policy: preventSystemAccess threshold: 60 force: yes
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. |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Nathan Swartz (@ndswartz)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/netapp_e_auditlog_module.html