hitachivantara.vspone_block.sds_block.hv_sds_block_journal_facts module – Retrieve journal information from storage SDS Block 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_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Collects journal details from the storage SDS Block storage system.
For usage examples, refer to https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_journal_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.
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	Filter criteria for retrieving journal information.
number integer	Journal number to filter journals.
storage_controller_id string	The ID of the storage controller to filter journals.
vps_id string	The ID of the virtual private storage (VPS) to filter journals.
vps_name string	The name of the virtual private storage (VPS) to filter journals.

Attributes

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

Examples

- name: Get all journal
  hitachivantara.vspone_block.sds_block.hv_sds_journal_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get journal by VSP ID
  hitachivantara.vspone_block.sds_block.hv_sds_journal_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      vsp_id: "system"

- name: Get journal by Storage Controller ID
  hitachivantara.vspone_block.sds_block.hv_sds_journal_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      storage_controller_id: "f330c421-5c9b-4f3a-8b4f-12268053dc60"

- name: Get journal by number
  hitachivantara.vspone_block.sds_block.hv_sds_journal_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      number: "0"

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
journals list / elements=dictionary	List of journal. Returned: success
block_capacity integer	The number of journal volume blocks. Returned: success Sample: `23068672`
capacity integer	Journal volume capacity. Returned: success Sample: `11264`
data_overflow_watch_in_seconds integer	Monitoring time for data overflow. Returned: success Sample: `60`
id string	Journal ID. Returned: success Sample: `"551a8c21-caae-4d4f-8f5f-c4f3dbc5374f"`
is_cache_mode_enabled boolean	Indicates whether the cache mode setting is enabled. Returned: success Sample: `true`
is_inflow_control_enabled boolean	Indicates whether to restrict update I/O inflow to a journal volume. Returned: success Sample: `true`
journal_number integer	Journal number. Returned: success Sample: `0`
mirror_units list / elements=dictionary	A list of mirror units of the volumes registered in a journal. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `-1`
copy_pace string	Copy speed. Returned: success Sample: `"L"`
copy_speed string	Data-transfer speed. Returned: success Sample: `"256M"`
journal_status string	The journal status of a mirror. Returned: success Sample: `"SMPL"`
mu_number integer	The mirror number (MU number). Returned: success Sample: `2`
number_of_active_paths integer	The number of paths of an active link. Returned: success Sample: `""`
q_count integer	The number of qMarkers remaining in the master journal volume. Returned: success Sample: `""`
q_marker string	The latest sequence number written to the cache. Returned: success Sample: `""`
status string	Journal status. Returned: success Sample: `"Normal"`
storage_controller_id string	Storage controller ID. Returned: success Sample: `"f330c421-5c9b-4f3a-8b4f-12268053dc60"`
usage_rate integer	Usage of a journal volume. Returned: success Sample: `""`
volume_ids list / elements=string	A list of IDs of the volumes composing a journal volume. Returned: success Sample: `["2a0fa47c-2343-418b-b60f-18580cd86d67"]`
vps_id string	The ID of a virtual private storage (VPS) to which the resource to be obtained belongs. Returned: success Sample: `"(system)"`
vps_name string	The name of the virtual private storage (VPS) to which the resource to be obtained belongs. 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_facts_module.html