hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting module – Manages Hitachi SDS block storage system audit log settings.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.6.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.sds_block.hv_sds_block_audit_log_setting.

New in hitachivantara.vspone_block 4.6.0

Synopsis

• This module allows for the configuration of audit log settings.

• It supports updating syslog forwarding settings and server configurations.

• For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/audit_log_setting.yml

Requirements

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

• python >= 3.9

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.
connection_type string	Type of connection to the storage system. Choices: "direct" ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for the audit log settings task.
audit_log_file_location string	The directory where the audit log file will be downloaded. This is a required field when the state field is download_audit_log.
refresh boolean	Whether to create the audit log file on the storage system before downloading. This is a valid field when the state field is download_audit_log. Choices: false ← (default) true
syslog_forwarding_setting dictionary	Syslog forwarding configuration.
location_name string	Location name for syslog forwarding.
syslog_servers list / elements=dictionary	List of syslog servers configuration.
index integer / required	Index of the syslog server. Choices: 1 2
is_enabled boolean	Whether the syslog server is enabled. Choices: false true
port integer	Syslog server port number.
server_name string	Syslog server name or IP address.
transport_protocol string	Transport protocol for syslog server. Choices: "UDP"
state string	The level of the audit log settings task. Choices are present and download_audit_log. Choices: "present" ← (default) "download_audit_log"

Attributes

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

Examples

- name: Configure audit log settings with syslog forwarding
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "syslog.example.com"
            port: 514
            transport_protocol: "UDP"
          - index: 2
            is_enabled: false
            server_name: "backup-syslog.example.com"
            port: 514
            transport_protocol: "UDP"

- name: Update syslog server configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "new-syslog.example.com"
            port: 1514
            transport_protocol: "UDP"

- name: Download audit log file
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: download_audit_log
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      audit_log_file_location: "/tmp/audit_logs"

- name: Create and download audit log file
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: download_audit_log
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      audit_log_file_location: "/tmp/audit_logs"
      refresh: true

Return Values

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

Key	Description
audit_log_settings dictionary	Dictionary containing the configured audit log settings. Returned: always
syslog_forwarding_setting dictionary	Syslog forwarding configuration details. Returned: success
location_name string	Location name for syslog forwarding. Returned: success Sample: "datacenter1"
syslog_servers list / elements=dictionary	List of configured syslog servers. Returned: success
index integer	Index of the syslog server. Returned: success Sample: 1
is_enabled boolean	Whether the syslog server is enabled. Returned: success Sample: true
port integer	Syslog server port number. Returned: success Sample: 514
server_name string	Syslog server name or IP address. Returned: success Sample: "syslog.example.com"
transport_protocol string	Transport protocol for syslog server. Returned: success Sample: "UDP"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)