hitachivantara.vspone_block.vsp.hv_journal module – Create, update, expand, shrink, delete journal 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.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module creates, update, expand, shrink, delete journal from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/journal.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 creating Journal.
copy_pace string	Copy pace. Required for the Update a Journal using more details task. Default: `"3"`
data_overflow_watch_in_seconds aliases: data_overflow_watchIn_seconds integer	Data overflow watch in seconds. Required for the Update a Journal using more details task.
end_ldev_id aliases: endLdevId string	End LDEV ID of the Journal.
is_cache_mode_enabled boolean	Cache mode enabled or not. Required for the Update a Journal using more details task. Choices: `false` `true`
journal_id integer	Journal ID of the Journal. Required for the Create a Journal using required details /Update a Journal using more details /Expand journal /Shrink journal /Delete Journal by ID tasks.
ldev_ids list / elements=string	List of LDEVs. Can be decimal or hexadecimal. Required for the Create a Journal using required details /Expand journal /Shrink journal task.
mirror_unit_number integer	Mirror unit number. Required for the Update a Journal using more details task.
mp_blade_id integer	MP Blade ID of the Journal. Required for the Update a Journal using more details task.
path_blockade_watch_in_minutes integer	Path blockade watch in minutes. Required for the Update a Journal using more details task.
start_ldev_id aliases: startLdevId string	Start LDEV ID of the Journal.
state string	State of the Journal. Choices: `"present"` ← (default) `"absent"` `"update"` `"expand_journal"` `"shrink_journal"`
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: none	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: Create a Journal
  hitachivantara.vspone_block.vsp.hv_journal:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      journal_id: 37
      ldev_ids: [1993, 1994]

Return Values

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

Key	Description
data dictionary	Dictionary containing the discovered properties of the Journal. Returned: always
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: `116`
journal_status string	Status of the Journal. Returned: success Sample: `"SMPL"`
ldev_ids list / elements=integer	List of LDEV IDs. Returned: success Sample: `[142]`
ldev_ids_hex list / elements=string	List of LDEV IDs in hexadecimal format. Returned: success Sample: `["00:00:8E"]`
mirrors list / elements=dictionary	List of mirror units. Returned: success
active_path_count integer	Number of active paths. Returned: success Sample: `-1`
active_path_watch_seconds integer	Active path watch in seconds. Returned: success Sample: `-1`
consistency_group_id integer	Consistency group ID. Returned: success Sample: `0`
copy_pace string	Copy pace setting. 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 unit status. Returned: success Sample: `"SMPL"`
transfer_speed_mbps integer	Transfer speed in Mbps. Returned: success Sample: `256`
mp_blade_id integer	MP Blade ID of the Journal. Returned: success Sample: `1`
timer_type string	Timer type configuration. Returned: success Sample: `""`
total_capacity string	Total capacity with units. Returned: success Sample: `"29.03 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_module.html