hitachi.raidcom.volume (0.5.0) — module

Manage Hitachi VSP Storage volumes

| "added in version" 0.5.0 of hitachi.raidcom"

Authors: Giacomo Chiapparini (@gchiapparini-hv) raidcomansible@hitachivantara.com

preview | supported by community

Install collection

Install with ansible-galaxy collection install hitachi.raidcom:==0.5.0


Add to requirements.yml

  collections:
    - name: hitachi.raidcom
      version: 0.5.0

Description

Use this module to manage Hitachi VSP storage volumes. This module allows you to create volumes, update, or delete them.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: get volume information
    volume:
      #connectivity
      horcm_inst: "1"
      storage_serial: "495101"
      #properties
      state: query
      volume_id: "100"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: create or expand volume
    volume:
      #connectivity
      horcm_inst: "1"
      storage_serial: "495101"
      #properties
      state: present
      volume_id: "100"
      volume_size: 200 GB
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: delete volume
    volume:
      #connectivity
      horcm_inst: "1"
      storage_serial: "495101"
      #properties
      state: absent
      volume_id: "100"

Inputs

    
alua:
    choices:
    - disabled
    - enabled
    default: disabled
    description:
    - Wheter ALUA multipathing feature should be enabled or disable for this volume on
      this storage.
    - When unset, this parameter defaults to disabled.
    - NOTE this feature is not yet implemented, alua is always disabled.
    required: false
    type: str

state:
    choices:
    - absent
    - present
    - query
    description:
    - Either create/expand(present) or delete(absent) or query a volume.
    required: true
    type: str

pool_id:
    default: '0'
    description:
    - The specific ID in decimal that selects the pool where the volume is in.
    - Required if I(state=present).
    required: false
    type: str

volume_id:
    description:
    - The specific ID in decimal that should be modified/queried.
    - This parameter is always required.
    - NOTE currently only decimal format (e.g 100) is accepted not hexadecimal (e.g 00:00:64).
    required: true
    type: str

horcm_inst:
    description:
    - ID for the HORCM instance.
    - HORCM inst can be created manually or by horcm-start.py.
    required: true
    type: int

volume_name:
    default: ''
    description:
    - The specific volume_name.
    - When unset, this parameter defaults to empty string.
    - NOTE currently volume_name can not be used to select a volume for midification,
      use I(volume_id).
    required: false
    type: str

volume_size:
    description:
    - The specific volume size.
    - Required if I(state=present).
    - Capacity can be set in blocks (blank number) or as KB,K,MB,M,TB,T,PB,P (e.g 100GB).
    - NOTE currently KB or Kb or K is always KB = 1024.
    required: false
    type: str

volume_type:
    choices:
    - thin
    default: thin
    description:
    - Wheter this is a thin allocated volume or not.
    - When unset, this parameter defaults to thin.
    - NOTE this feature is not yet implemented, all volumes are thin.
    required: false
    type: str

storage_serial:
    description:
    - storage serial ID. (e.g 495101).
    required: false
    type: int

data_saving_type:
    choices:
    - ''
    - disabled
    - compression
    - deduplication_and_compression
    default: disabled
    description:
    - Wheter capacity saving should be disabled or enabled.
    - When unset, this parameter defaults to disabled (Former storage systems do not support
      this feature.).
    - NOTE this feature is not yet implemented.
    required: false
    type: str

tiering_policy_id:
    choices:
    - '0'
    - '1'
    - '2'
    - '3'
    - '4'
    - '5'
    - '6'
    - '7'
    - '8'
    - '9'
    description:
    - The specific tiering policiy id this volume should be assigned. Takes only effect
      if POOL is a Hitachi Dynamic Tiering (HDT) pool.
    - When unset, this parameter defaults to 0.
    required: false
    type: str

Outputs

changed:
  description: wheter or not the resouruce was changed
  returned: always
  type: bool
diff:
  description: status "before" and "after"
  returned: when -D is used
  type: dict
facts:
  description: response as return number, stderr and stdout
  returned: when a call is needed
  type: dict
invocation.module_args:
  description: all properties sent
  returned: always
  type: dict
item:
  description: volume id
  returned: always
  type: int
message:
  description: status and activity
  returned: always
  type: str