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

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_dump_log_status_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis

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 dumping log status information.

include_all_status

boolean

Get all dump log status information including completed, in-progress, and failed.

Choices:

  • false

  • true

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Dump log status facts
  hitachivantara.vspone_block.sds_block.hv_sds_block_dump_log_status_facts:
    connection_info:
        address: sdsb.company.com
        username: "admin"
        password: "password"
    spec:
        include_all_status: true

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

dump_status

list / elements=dictionary

List of dump log status information.

Returned: always

completed_time

string

The time when the dump log completed.

Returned: success

error

dictionary

Error information if the dump log failed.

Returned: success

file_name

string

Name of the dump log file.

Returned: success

label

string

Label of the dump log.

Returned: success

mode

string

Mode of the dump log.

Returned: success

number_of_split_files

integer

Number of split files.

Returned: success

size

integer

Size of the dump log file.

Returned: success

started_time

string

The time when the dump log started.

Returned: success

status

string

Status of the dump log.

Returned: success

trigger_type

string

Trigger type of the dump log.

Returned: success

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)