netapp.storagegrid.na_sg_grid_audit_destination module – Configure audit log destinations on StorageGRID.
Note
This module is part of the netapp.storagegrid collection (version 21.15.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.storagegrid.
To use it in a playbook, specify: netapp.storagegrid.na_sg_grid_audit_destination.
New in netapp.storagegrid 21.15.0
Synopsis
Configure audit log destinations on NetApp StorageGRID.
Parameters
Parameter |
Comments |
|---|---|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
The defaults will be used to configure audit destinations on all nodes which are not in the nodes array. |
|
Configuration for traditional audit log export to admin nodes. |
|
If true, traditional audit log export to admin nodes is enabled. Choices:
|
|
Configuration for sending audit logs to an external syslog server. |
|
Syslog facility to use for application logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send application logs to the external syslog server. Choices:
|
|
Syslog severity to use for application logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for audit logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send audit logs to the external syslog server. Choices:
|
|
Syslog severity to use for audit logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for security events sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send security events to the external syslog server. Choices:
|
|
Syslog severity to use for security events sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Client certificate for authentication to external syslog server (in PEM encoding). |
|
Private key for the client certificate (in PEM encoding). If encrypted, must use traditional format (cannot use PKCS |
|
Passphrase for decrypting the client private key; omit the passphrase if the private key is not encrypted. |
|
If true, the external syslog server destination is enabled. Choices:
|
|
The IP or DNS hostname to send syslog messages to. |
|
Flag to permit insecure Transport Layer Security (TLS) for external syslog server connections. Choices:
|
|
The port number to send syslog messages to. Default: |
|
The IP protocol to use for sending to the external syslog server. Choices:
|
|
One or more trusted CA certificates for verifying the external syslog server (in PEM encoding). If omitted, the operating system CA certificates will be used. |
|
OpenSSL configuration commands, only used when |
|
Configuration for sending audit test messages to an external syslog server. |
|
Syslog facility to use for application logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send application logs to the external syslog server. Choices:
|
|
Syslog severity to use for application logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for audit logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send audit logs to the external syslog server. Choices:
|
|
Syslog severity to use for audit logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for security events sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send security events to the external syslog server. Choices:
|
|
Syslog severity to use for security events sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Client certificate for authentication to external syslog server (in PEM encoding). |
|
Private key for the client certificate (in PEM encoding). If encrypted, must use traditional format (cannot use PKCS |
|
Passphrase for decrypting the client private key; omit the passphrase if the private key is not encrypted. |
|
If true, the external syslog server destination is enabled. Choices:
|
|
The IP or DNS hostname to send syslog messages to. |
|
Flag to permit insecure Transport Layer Security (TLS) for external syslog server connections. Choices:
|
|
The port number to send syslog messages to. Default: |
|
The IP protocol to use for sending to the external syslog server. Choices:
|
|
One or more trusted CA certificates for verifying the external syslog server (in PEM encoding). If omitted, the operating system CA certificates will be used. |
|
OpenSSL configuration commands, only used when |
|
Optional per-node configuration stanzas in the nodes array override the default configuration. |
|
Configuration for traditional audit log export to admin nodes. |
|
If true, traditional audit log export to admin nodes is enabled. Choices:
|
|
An optional map of node UUIDs to their audit log destination configurations. |
|
Configuration for sending audit logs to an external syslog server. |
|
Syslog facility to use for application logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send application logs to the external syslog server. Choices:
|
|
Syslog severity to use for application logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for audit logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send audit logs to the external syslog server. Choices:
|
|
Syslog severity to use for audit logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for security events sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send security events to the external syslog server. Choices:
|
|
Syslog severity to use for security events sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Client certificate for authentication to external syslog server (in PEM encoding). |
|
Private key for the client certificate (in PEM encoding). If encrypted, must use traditional format (cannot use PKCS |
|
Passphrase for decrypting the client private key; omit the passphrase if the private key is not encrypted. |
|
If true, the external syslog server destination is enabled. Choices:
|
|
The IP or DNS hostname to send syslog messages to. |
|
Flag to permit insecure Transport Layer Security (TLS) for external syslog server connections. Choices:
|
|
The port number to send syslog messages to. Default: |
|
The IP protocol to use for sending to the external syslog server. Choices:
|
|
One or more trusted CA certificates for verifying the external syslog server (in PEM encoding). If omitted, the operating system CA certificates will be used. |
|
OpenSSL configuration commands, only used when |
|
Configuration for sending audit test messages to an external syslog server. |
|
Syslog facility to use for application logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send application logs to the external syslog server. Choices:
|
|
Syslog severity to use for application logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for audit logs sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send audit logs to the external syslog server. Choices:
|
|
Syslog severity to use for audit logs sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Syslog facility to use for security events sent to external syslog server, or -1 to preserve the local facility. Default: |
|
If true, send security events to the external syslog server. Choices:
|
|
Syslog severity to use for security events sent to external syslog server, or -1 to preserve the local severity. Default: |
|
Client certificate for authentication to external syslog server (in PEM encoding). |
|
Private key for the client certificate (in PEM encoding). If encrypted, must use traditional format (cannot use PKCS |
|
Passphrase for decrypting the client private key; omit the passphrase if the private key is not encrypted. |
|
If true, the external syslog server destination is enabled. Choices:
|
|
The IP or DNS hostname to send syslog messages to. |
|
Flag to permit insecure Transport Layer Security (TLS) for external syslog server connections. Choices:
|
|
The port number to send syslog messages to. Default: |
|
The IP protocol to use for sending to the external syslog server. Choices:
|
|
One or more trusted CA certificates for verifying the external syslog server (in PEM encoding). If omitted, the operating system CA certificates will be used. |
|
OpenSSL configuration commands, only used when |
|
The audit destination should be present. Choices:
|
|
Should https certificates be validated? Choices:
|
Notes
Note
The modules prefixed with
na_sgare built to manage NetApp StorageGRID.
Examples
- name: Configure audit destination defaults
na_sg_grid_audit_destination:
state: present
api_url: "https://gmi.example.com"
auth_token: "01234567-5678-9abc-78de-9fgabc123def"
validate_certs: false
defaults:
admin_nodes:
enabled: true
remote_syslog_server:
enabled: true
protocol: udp
hostname: "syslog.example.com"
port: 514
auth_events_send: true
auth_events_facility: -1
auth_events_severity: -1
audit_logs_send: true
audit_logs_facility: 23
audit_logs_severity: 6
application_logs_send: true
application_logs_facility: -1
application_logs_severity: -1
- name: Configure audit destination for specific nodes
na_sg_grid_audit_destination:
state: present
api_url: "https://gmi.example.com"
auth_token: "01234567-5678-9abc-78de-9fgabc123def"
validate_certs: false
nodes:
- node_id: "6562d5d8-f218-45ff-a466-5bb39e729288"
admin_nodes:
enabled: true
remote_syslog_server:
enabled: true
protocol: udp
hostname: "syslog.example.com"
port: 514
auth_events_send: true
auth_events_facility: -1
auth_events_severity: -1
audit_logs_send: true
audit_logs_facility: 23
audit_logs_severity: 6
application_logs_send: true
application_logs_facility: -1
application_logs_severity: -1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Returns information about the StorageGRID Audit destination. Returned: If state is ‘present’. Sample: |