huawei.enterprise.hw_enterprise_workload_type module – Workload Type 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.

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

Synopsis

• Supports the provisioning operations on a workload type such as create, modify, delete and get the details of a workload type.

Parameters

Parameter	Comments
compression_enabled boolean	Compression enabled or not, Required for create operation. Can set when need modify exist workload type Choices: false true
dedup_enabled boolean	Whether to enable deduplication, Required for create operation. Can set when need modify exist workload type Choices: false true
filter list / elements=string	Parameter required for all query operations. The response will include the storage parameters that match the indicate filter criteria. Choices: "name" "id" "io_size" "compression_enabled" "dedup_enabled"
id string	Workload Type unique id, Mutually exclusive with “name”, Priority is higher than name.
io_size string	Application request size, Required for create and modify operation. Choices: "4KB" "8KB" "16KB" "32KB" "64KB" ">64KB"
name string	Workload Type unique name, Required for create operation. Mutually exclusive with id.
new_name string	Workload Type new unique name, Required for modify operation.
state string / required	Define whether the Workload Type should exist or not. Choices: "absent" "present"
vstore_id string	Id of storage vstore. Vstore id default to 0:System Vstore if not specified. Required for vstore user.

Notes

Note

• The check_mode is not supported.

Examples

---
  tasks:
    - name: Create Workload Type
      register: workload_type_info
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        name: "< workload_type_name >"
        io_size: "< 4KB | 8KB | 16KB | 32KB | 64KB | >64KB >"
        dedup_enabled: "< true | false >"
        compression_enabled: "< true | false >"
        state: "present"

    - name: Modify Workload Type By Id
      register: workload_type_info
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        id: "{{ workload_type_info.workload_type_detail.id }}"
        new_name: "< workload_type_new_name >"
        io_size: "< 4KB | 8KB | 16KB | 32KB | 64KB | >64KB >"
        dedup_enabled: "< true | false >"
        compression_enabled: "< true | false >"
        state: "present"

    - name: Modify Workload Type By Name
      register: workload_type_info
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        name: "< workload_type_old_name >"
        new_name: "< workload_type_new_name >"
        io_size: "< 4KB | 8KB | 16KB | 32KB | 64KB | >64KB >"
        dedup_enabled: "< true | false >"
        compression_enabled: "< true | false >"
        state: "present"

    - name: Query Workload Type Detail By Name
      register: workload_type_info
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        name: "< workload_type_name >"
        vstore_id: "< vstore_id >"
        filter:
          - id
          - name
          - io_size
          - compression_enabled
          - dedup_enabled
        state: "present"

    - name: Query Workload Type Detail By Id
      register: query_workload_type_info_by_id
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        id: "{{ query_workload_type_info_by_name.workload_type_detail.id }}"
        vstore_id: "< vstore_id >"
        filter:
          - id
          - name
          - io_size
          - compression_enabled
          - dedup_enabled
        state: "present"

    - name: Query All Workload Type Detail
      register: all_workload_type
      huawei.enterprise.hw_enterprise_workload_type:
        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
          - io_size
          - compression_enabled
          - dedup_enabled
        state: "present"

    - name: Delete Workload Type Detail By Name
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        name: "< workload_type_name >"
        state: "absent"

    - name: Delete Workload Type Detail By Id
      huawei.enterprise.hw_enterprise_workload_type:
        hostname: "{{ hostname }}"
        username: "{{ username }}"
        password: "{{ password }}"
        valid_certs: "{{ valid_certs }}"
        socket_timeout: "{{ socket_timeout }}"
        storage_port: "{{ storage_port }}"
        use_log: "{{ use_log }}"
        id: "{{ workload_type_info.workload_type_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: "Workload Type sample_workload_type create successfully"
workload_type_detail complex	Details of the Workload Type. Returned: When workload type exists Sample: {"compression_enabled": false, "dedup_enabled": true, "id": "1", "io_size": "4KB", "name": "sample_workload_type"}
compression_enabled boolean	Compression enabled or not. Returned: always
dedup_enabled boolean	Whether to enable deduplication. Returned: always
id string	The system generated ID given to the Workload Type. Returned: always
io_size string	Application request size. Returned: always
name string	Name of the Workload Type. Returned: always

Authors

• Huawei eSDK Ansible Team