hitachivantara.vspone_block.vsp.hv_audit_log_transfer_dest module – This module specifies settings related to the transfer of audit log files from a storage system to the syslog servers.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.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 hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.vsp.hv_audit_log_transfer_dest.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

The module specifies settings related to the transfer of audit log files from a storage system to the syslog servers.
For example usage, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/audit_log_transfer_dest.yml

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.8

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
api_token string	Token used to operate on locked resources.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Settings related to audit log transfer and syslog servers.
is_detailed boolean	Whether detailed audit logs are enabled. Choices: `false` `true`
location_name string / required	Name of the location or identifier. Required for Setting the transfer destination tasks.
primary_syslog_server dictionary	Primary syslog server configuration.
client_cert_file_name string	Client certificate file name.
client_cert_file_password string	Password for the client certificate file.
ip_address string	IP address of the primary syslog server. Optional for Setting the transfer destination tasks.
is_enabled boolean / required	Whether the primary syslog server is enabled. Required for Setting the transfer destination tasks. Choices: `false` `true`
port integer	Port used by the primary syslog server. Optional for Setting the transfer destination tasks.
root_cert_file_name string	Root certificate file name.
retries boolean	Number of retries for syslog transfer. Choices: `false` `true`
retry_interval integer	Interval between retries.
secondary_syslog_server dictionary	Secondary syslog server configuration.
client_cert_file_name string	Client certificate file name.
client_cert_file_password string	Password for the client certificate file.
ip_address string	IP address of the secondary syslog server. Optional for Setting the transfer destination tasks.
is_enabled boolean / required	Whether the secondary syslog server is enabled. Required for Setting the transfer destination tasks. Choices: `false` `true`
port integer	Port used by the secondary syslog server. Optional for Setting the transfer destination tasks.
root_cert_file_name string	Root certificate file name.
transfer_protocol string / required	Protocol used for transferring audit logs. Required for Setting the transfer destination tasks. Choices: `"TLS"` `"UDP"`
state string	The state of the audit log transfer destination configuration. Choices: `"present"` ← (default) `"test"`

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Notes

Note

Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Configure audit log transfer settings and syslog servers
  hitachivantara.vspone_block.vsp.hv_audit_log_transfer_dest:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret
    spec:
      transfer_protocol: "TLS"
      location_name: "datacenter1"
      retries: 3
      retry_interval: 60
      is_detailed: true
      primary_syslog_server:
        is_enabled: true
        ip_address: "203.0.113.1"
        port: 514
        client_cert_file_name: "client-cert.pem"
        client_cert_file_password: "CHANGE_ME_SET_YOUR_PASSWORD"
        root_cert_file_name: "root-cert.pem"
      secondary_syslog_server:
        is_enabled: false
        ip_address: "203.0.113.2"
        port: 514
        client_cert_file_name: "client-cert2.pem"
        client_cert_file_password: "CHANGE_ME_SET_YOUR_PASSWORD"
        root_cert_file_name: "root-cert2.pem"

Return Values

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

Key	Description
hv_audit_log_transfer_dest_info dictionary	Audit Logs and related information retrieved from the storage system. Returned: always
is_detailed boolean	Whether detailed audit logs are enabled. Returned: always
location_name string	Name of the location or identifier. Returned: always
primary_syslog_server dictionary	Primary syslog server configuration. Returned: success
ip_address string	IP address of the primary syslog server. Returned: always
is_enabled boolean	Whether the primary syslog server is enabled. Returned: always
port integer	Port used by the primary syslog server. Returned: always
secondary_syslog_server dictionary	Secondary syslog server configuration. Returned: success
ip_address string	IP address of the secondary syslog server. Returned: always
is_enabled boolean	Whether the secondary syslog server is enabled. Returned: always
port integer	Port used by the secondary syslog server. Returned: always
transfer_protocol string	Protocol used for transferring audit logs. Returned: always

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_audit_log_transfer_dest_module.html