hitachivantara.vspone_block.sds_block.hv_sds_block_dump_log_file module – Dumps log information from SDS Block storage system.

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.sds_block.hv_sds_block_dump_log_file.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Retrieve and dump log information from SDS Block storage system
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_dump_log_file.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 / required	Specification for dumping log information.
file_name string	The name of the log file.
file_path string	The path where the log file will be saved.
label string	The label of the log file.
mode string	The mode of the log file, options are “Base”, “Memory”,”Monitor” and “All” , case insensitive.
split_files_index integer	The index of the split file.
state string	The desired state of the storage pool. Choices: `"present"` ← (default) `"absent"` `"download"`

Attributes

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

Examples

- name: Dump log information with a specific label
  hitachivantara.vspone_block.hv_sds_block_dump_log_file:
    connection_info:
      address: 10.10.10.10
      username: admin
      password: password
    spec:
      label: "log_label_001"

- name: Download a log file with specific configuration
  hitachivantara.vspone_block.hv_sds_block_dump_log_file:
    connection_info:
      address: 10.10.10.10
      username: admin
      password: password
    state: download
    spec:
      file_path: "/tmp/"
      file_name: "sds_log_dump.tgz"
      split_files_index: 1

Return Values

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

Key	Description
message string	Log message content. Returned: always Sample: `"Dump file generated successfully"`

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/sds_block.hv_sds_block_dump_log_file_module.html