hitachivantara.vspone_block.sds_block.hv_sds_block_journal module – Create and update Journals from storage system

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.sds_block.hv_sds_block_journal.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Create and update Journals from storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sds_block_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.
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 the journal to be added to or updated in storage.
data_overflow_watch_in_sec integer	Monitoring time for data overflow (unit in seconds).
enable_cache_mode boolean	Specifies whether to enable the cache mode setting. Choices: `false` `true`
enable_inflow_control boolean	Specifies whether to restrict update I/O inflow to a journal volume (by delaying response to host I/Os). Choices: `false` `true`
id string	The ID of the journal.
mirror_unit dictionary	Mirror unit configuration for the journal.
copy_pace string	Copy pace setting for the mirror unit. Choices: `"L"` `"M"` `"H"`
data_transfer_speed_bps string	Data transfer speed in bytes per second. Choices: `"3M"` `"10M"` `"100M"` `"256M"`
number integer / required	Mirror unit number.
number integer	Journal number to be created or updated.
volume_ids list / elements=string	A list of IDs of the volumes to be added to a journal.
vps_id string	The ID of the operation-target virtual private storage (VPS).
vps_name string	The name of the operation-target virtual private storage (VPS).
state string	The level of the journal task. Choices: `"present"` ← (default) `"update"` `"absent"` `"shrink_journal"` `"expand_journal"`

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Examples

- name: Creates a journal and adds a journal volume to the journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      number: 3
      volume_ids:
        - "537be416-6d0d-4da6-98cd-fccb76bb3451"
      data_overflow_watch_in_sec: 60
      enable_inflow_control: false
      enable_cache_mode: false
      vps_id: "system"
- name: Update a existing journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: ""
      number: 3
      data_overflow_watch_in_sec: 150
      enable_inflow_control: false
      enable_cache_mode: true
      vps_id: "system"
      vps_name: "system"
      mirror_unit:
        number: 0
        copy_pace: "M"
        data_transfer_speed_bps: "3M"

- name: Get journal info by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: "id-of-journal"
      number: 3

- name: Delete a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      id: "id-of-journal"
      number: 3

- name: Expand add volume to a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: expand_journal
    spec:
      id: "id-of-journal"
      number: 3
      volume_ids:
        - "ad58c370-7a55-4bd5-91ce-70ed71050835"
      vps_id: "system"
      vps_name: "system"

- name: Shrink (delete volume from) a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: shrink_journal
    spec:
      id: "id-of-journal"
      number: 3
      volume_ids:
        - "1322e160-fac4-4ac7-9b71-5c1c1ea294ca"
      vps_id: "system"
      vps_name: "system"

Return Values

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

Key	Description
journals dictionary	Dictionary containing journal information discovered or managed on the system. Returned: always
data list / elements=dictionary	List of journal entries. Returned: success
block_capacity integer	Block capacity of the journal. Returned: success Sample: `23068672`
capacity integer	Capacity of the journal in megabytes or relevant unit. Returned: success Sample: `11264`
data_overflow_watch_in_seconds integer	Threshold (in seconds) for detecting data overflow in the journal. Returned: success Sample: `60`
id string	Unique identifier of the journal. Returned: success Sample: `"551a8c21-caae-4d4f-8f5f-c4f3dbc5374f"`
is_cache_mode_enabled boolean	Indicates if cache mode is enabled for the journal. Returned: success Sample: `true`
is_inflow_control_enabled boolean	Indicates if inflow control is enabled for the journal. Returned: success Sample: `true`
journal_number integer	Journal number assigned by the system. Returned: success Sample: `0`
mirror_units list / elements=dictionary	List of mirror units associated with the journal. Returned: success
consistency_group_id integer	Identifier of the consistency group the mirror unit belongs to. Returned: success Sample: `-1`
copy_pace string	Copy pace setting for the mirror unit (e.g., L, M, H). Returned: success Sample: `"L"`
copy_speed string	Copy speed configured for the mirror unit. Returned: success Sample: `"256M"`
journal_status string	Current status of the mirror unit. Returned: success Sample: `"SMPL"`
mu_number integer	Mirror unit number. Returned: success Sample: `2`
number_of_active_paths string	Number of active data paths for the mirror unit. Returned: success Sample: `""`
q_count string	Queue count information, if available. Returned: success Sample: `""`
q_marker string	Queue marker information, if available. Returned: success Sample: `""`
status string	Current operational status of the journal. Returned: success Sample: `"Normal"`
storage_controller_id string	Identifier of the associated storage controller. Returned: success Sample: `"f330c421-5c9b-4f3a-8b4f-12268053dc60"`
usage_rate string	Current usage rate of the journal. Returned: success Sample: `""`
volume_ids list / elements=string	List of associated journal volume IDs. Returned: success Sample: `["2a0fa47c-2343-418b-b60f-18580cd86d67"]`
vps_id string	VPS identifier associated with the journal. Returned: success Sample: `"(system)"`
vps_name string	VPS name associated with the journal. Returned: success Sample: `"(system)"`

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/sds_block.hv_sds_block_journal_module.html