W3cubDocs

/Ansible

netapp_eseries.santricity.na_santricity_auditlog module – NetApp E-Series manage audit-log configuration

Note

This module is part of the netapp_eseries.santricity collection (version 1.4.1).

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_auditlog.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module allows an e-series storage system owner to set audit-log configuration parameters.

Parameters

Parameter	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.
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. Choices: `false` ← (default) `true`
full_policy string	Specifies what audit-log should do once the number of entries approach the record limit. Choices: `"overWrite"` ← (default) `"preventSystemAccess"`
log_level string	Filters the log messages according to the specified log level selection. Choices: `"all"` `"writeOnly"` ← (default)
max_records integer	The maximum number log messages audit-log will retain. Max records must be between and including 100 and 50000. Default: `50000`
ssid string	The ID of the array to manage. This value must be unique for each array. Default: `"1"`
threshold integer	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. Default: `90`
validate_certs boolean	Should https certificates be validated? Choices: `false` `true` ← (default)

Notes

Note

Check mode is supported.
Use ssid==”0” or ssid==”proxy” to configure SANtricity Web Services Proxy auditlog settings otherwise.
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_eseries.santricity.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.
  na_santricity_auditlog:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    max_records: 50000
    log_level: all
    full_policy: preventSystemAccess
    threshold: 60

Return Values

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

Key	Description
msg string	Success message Returned: on success Sample: `"The settings have been updated."`

Authors

Nathan Swartz (@ndswartz)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/na_santricity_auditlog_module.html