hitachivantara.vspone_block.vsp.hv_troubleshooting_facts module – Collects the log bundles for Hitachi ansible modules host.

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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Attributes
Notes
Examples
Returned Facts

Synopsis

This module collects all logs from the different services and all the relevant configuration files for further troubleshooting. The log bundle is a zip archive that contains this information.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/tools/logbundle_direct_connection.yml

Requirements

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

python >= 3.9

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: Collect log bundle
  hitachivantara.vspone_block.vsp.hv_troubleshooting_facts:
  # no_log: 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
filename string	Path to the log bundle created. Returned: success Sample: `"$HOME/logs/hitachivantara/ansible/vspone_block/log_bundles/ansible_log_bundle_2024_05_23_13_15_36.zip"`
msg string	Success or failure message. Returned: success Sample: `"LogBundle with direct connection logs"`

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_troubleshooting_facts_module.html