W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_journal_volume_facts module – Retrieves information about Journal Volumes from Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.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_volume_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 Hitachi VSP 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	This field is used to pass the value of the lock token 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 if api_token is not provided.
username string	Username for authentication. This is a required field if api_token is not provided.
spec dictionary	Specification for retrieving Journal Volume information.
free_journal_pool_id_count integer	Number of free journal id to get. Default: `1`
is_free_journal_pool_id boolean	Whether to get free journal id. Choices: `false` ← (default) `true`
is_mirror_not_used boolean	Whether to get mirror not used. Choices: `false` ← (default) `true`
journal_id integer	Journal ID of the Journal Volume.
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_volume_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_volume_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_volumes list / elements=dictionary	List of Journal Volumes managed by the module. Returned: success
data_overflow_watch_seconds integer	Data overflow watch in seconds. Returned: success Sample: `60`
first_ldev_id integer	First LDEV ID of the Journal Volume. Returned: success Sample: `1992`
is_cache_mode_enabled boolean	Indicates if cache mode is enabled. Returned: success Sample: `true`
is_inflow_control_enabled boolean	Indicates if inflow control is enabled. Returned: success Sample: `false`
journal_id integer	Journal ID of the Journal Volume. Returned: success Sample: `37`
journal_status string	Status of the Journal Volume. Returned: success Sample: `"PJNN"`
mirror_unit_ids list / elements=dictionary	List of mirror unit IDs. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `0`
copy_pace string	Copy pace. Returned: success Sample: `"L"`
copy_speed integer	Copy speed. Returned: success Sample: `256`
is_data_copying boolean	Indicates if data copying is in progress. Returned: success Sample: `true`
journal_status string	Status of the journal. Returned: success Sample: `"SMPL"`
mu_number integer	Mirror unit number. Returned: success Sample: `0`
path_blockade_watch_in_minutes integer	Path blockade watch in minutes. Returned: success Sample: `5`
mp_blade_id integer	MP Blade ID of the Journal Volume. Returned: success Sample: `1`
num_of_active_paths integer	Number of active paths. Returned: success Sample: `2`
num_of_ldevs integer	Number of LDEVs. Returned: success Sample: `1`
q_count integer	Queue count. Returned: success Sample: `0`
q_marker string	Queue marker. Returned: success Sample: `"00000002"`
total_capacity_mb integer	Total capacity in MB. Returned: success Sample: `19`
usage_rate integer	Usage rate. Returned: success Sample: `0`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_journal_volume_facts_module.html