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

Note

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

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

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	Returned	Description
msg string	on success	Success message Sample: The settings have been updated.

Authors

Nathan Swartz (@ndswartz)

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