hitachivantara.vspone_block.vsp.hv_audit_log_transfer_dest_facts module – Retrieves about the settings related to the transfer of audit log files 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_facts.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves about the settings related to the transfer of audit log files 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_facts.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.

Attributes

Attribute	Support	Description
check_mode	Support: full	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: Get about the settings related to the transfer of audit log files to the syslog servers.
  hitachivantara.vspone_block.vsp.hv_audit_log_transfer_dest_facts:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
audit_log_transfer_dest_info dictionary	Details about the audit log transfer settings. Returned: success
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
retries boolean	Whether retries for syslog transfer are enabled. Returned: always
retry_interval integer	Interval between retries (seconds). 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_facts_module.html