huawei.enterprise.hw_enterprise_vstore module – vstore operations for Huawei Enterprise Storage

Note

This module is part of the huawei.enterprise collection (version 2.0.0).

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 huawei.enterprise. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: huawei.enterprise.hw_enterprise_vstore.

Synopsis

• Create, delete, modify and get the detail of a vstore

Requirements

The below requirements are needed on the host that executes this module.

• Huawei Dorado v5/v6/v7 and OceanStor v5/v6/v7 Storage

Parameters

Parameter	Comments
custom_vars dictionary	Parameters used to extend those not currently supported by the module. Configuration needs to be based on the REST API documentation for storage. If necessary, you can contact the plugin technical support for assistance.
description string	vstore description.
filter list / elements=string	Parameter required for all query operations. The response will include the storage parameters that match the indicate filter criteria. Choices: "id" "name" "share_path" "vstore_id" "vstore_name" "fs_id" "dtree_id"
hostname string / required	IP or FQDN of the huawei enterprise management system. MultiIP config as ip1,ip2
id string	vstore unique id, Mutually exclusive with “name”, Priority is higher than name.
name string	vstore unique name, Mutually exclusive with id.
password string / required	The password of the PowerStore host.
socket_timeout integer	Huawei Enterprise Storage rest api Timeout time. Default: 60
state string / required	Define whether the vstore should exist or not. Choices: "absent" "present"
storage_port integer	Port number for the Huawei Enterprise array. If not passed, it will take 8088 as default. Default: 8088
use_log boolean	Whether to write plugin log to local filesystem. Choices: false ← (default) true
username string / required	The username of the PowerStore host.
valid_certs string	The path of the SSL certificate variable to specify whether to validate SSL certificate or not. If don’t set means no need to verify ssl cert.

Notes

Note

• The check_mode is not supported.

• The modules present in this collection named as ‘huawei.enterprise’ are built to support the Huawei Enterprise Storage System.

Examples

tasks:
  - name: Create vStore
    register: vstore_info
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< vstore_name >"
      description: "< description >"
      state: "present"

  - name: Modify vStore By Name
    register: vstore_info
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< vstore_name >"
      new_name: "< vstore_new_name >"
      description: "< description >"
      state: "present"

  - name: Modify vStore By ID
    register: vstore_info
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ vstore_info.vstore_detail.id }}"
      new_name: "< vstore_new_name >"
      description: "< description >"
      state: "present"

  - name: Query vStore By Name
    register: vstore_info
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< vstore_name >"
      filter:
        - id
        - name
        - description
      state: "present"

  - name: Query vStore By Id
    register: vstore_info
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ vstore_info.vstore_detail.id }}"
      filter:
        - id
        - name
        - description
      state: "present"

  - name: Query Multi vStore
    register: all_vstore
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      filter:
        - id
        - name
        - description
      state: "present"

  - name: Delete vStore By Name
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< vstore_name >"
      state: "absent"

  - name: Delete vStore By Id
    huawei.enterprise.hw_enterprise_vstore:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ vstore_info.vstore_detail.id }}"
      state: "absent"

Return Values

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

Key	Description
actions list / elements=string	playbook action lists Returned: always Sample: ["create"]
changed boolean	Whether or not the resource has changed. Returned: always Sample: false
remark string	task execute remark Returned: always Sample: "vstore_name create successfully"
vstore_detail complex	Details of the vstore. Returned: When vstore exists Sample: {"description": "", "id": "1", "name": "vstore_name"}
description string	vstore description. Returned: success
id string	vstore unique id, Mutually exclusive with “name”, Priority is higher than name. Returned: success
name string	vstore unique name, Mutually exclusive with id. Returned: success

Authors

• Huawei eSDK Ansible Team