hitachivantara.vspone_block.vsp.hv_journal_facts module – Retrieves information about Journal Volumes from VSP block storage systems.

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

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about Journal Volumes from VSP block storage systems.
It provides details such as journalId, journalStatus, and other relevant information..
Forexamples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/journal_volume_facts.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.
api_token string	Token used to operate on locked resources.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving Journal Volume information.
free_journal_pool_id_count integer	Number of free journal id to get. Required for the Get Free Journal IDs task. Default: `1`
is_free_journal_pool_id boolean	Whether to get free journal id. Required for the Get Free Journal IDs task. Choices: `false` ← (default) `true`
is_mirror_not_used boolean	Whether to get mirror not used. Required for the Get Journal data with mirror not used task. Choices: `false` ← (default) `true`
journal_id integer	Journal ID of the Journal Volume. Required for the Get specific Journal task.
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

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: Retrieve information about all Journal Volumes
  hitachivantara.vspone_block.vsp.hv_journal_facts:
    storage_system_info:
      serial: "811150"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about a specific Journal Volume
  hitachivantara.vspone_block.vsp.hv_journal_facts:
    storage_system_info:
      serial: "811150"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      journal_id: 10

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
journal_volume list / elements=dictionary	List of Journal Volume facts. Returned: success
data_overflow_watch_seconds integer	Data overflow watch in seconds. Returned: success Sample: `60`
is_cache_mode_enabled boolean	Indicates if cache mode is enabled. Returned: success Sample: `true`
journal_pool_id integer	Journal pool ID. Returned: success Sample: `0`
journal_status string	Status of the Journal Volume. Returned: success Sample: `"SMPL"`
ldev_ids list / elements=integer	LDEV IDs in the Journal Volume. Returned: success Sample: `[639]`
ldev_ids_hex list / elements=string	LDEV IDs in hex format. Returned: success Sample: `["00:02:7F"]`
mirrors list / elements=dictionary	Mirror information. Returned: success
active_path_count integer	Number of active paths. Returned: success Sample: `-1`
active_path_watch_seconds integer	Active path watch threshold in seconds. Returned: success Sample: `-1`
consistency_group_id integer	Consistency group ID. Returned: success Sample: `0`
copy_pace string	Copy pace. Returned: success Sample: `"LOW"`
is_delta_resync_failure_full_copy boolean	Indicates if delta resync failure triggers full copy. Returned: success
mirror_unit_id integer	Mirror unit ID. Returned: success Sample: `0`
path_blockade_watch_seconds integer	Path blockade watch in seconds. Returned: success Sample: `300`
q_count integer	Queue count. Returned: success Sample: `-1`
q_marker integer	Queue marker. Returned: success Sample: `-1`
status string	Mirror status. Returned: success Sample: `"SMPL"`
transfer_speed_mbps integer	Transfer speed in Mbps. Returned: success Sample: `256`
mp_blade_id integer	MP Blade ID. Returned: success Sample: `0`
timer_type string	Timer type. Returned: success Sample: `""`
total_capacity string	Total capacity with unit. Returned: success Sample: `"9.63 GB"`
type string	Journal type. Returned: success Sample: `""`

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