huawei.enterprise.hw_enterprise_storage_info module – Query Storage Information On 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_storage_info.
Synopsis
Query Storage Information On huawei Enterprise Storage
Parameters
Parameter |
Comments |
|---|---|
Required parameters for querying associated host info, associated objects id list. |
|
Required parameters for querying associated host info, associated object type. Choices:
|
|
Required parameters for querying batch performance data info, begin time(unix time stamp)(ms). |
|
Required parameters for querying clone cg and protect cg lun diff number, clone consistency group id, mutually exclusive with clone_cg_name. |
|
Required parameters for querying clone cg and protect cg lun diff number, clone consistency group name, mutually exclusive with clone_cg_id. |
|
Required parameters for querying batch performance data info, returned data mode, default Choices:
|
|
Required parameters for querying disk info, query the list of id. |
|
Required parameters for querying batch performance data info, end time(unix time stamp)(ms). |
|
The feature_key parameter must be selected from one of the following enumerated values. Choices:
|
|
Parameter required for all query operations. The response will include the storage parameters that match the indicate filter criteria. Choices:
|
|
Required parameters for querying performance data info, enumeration number of a performance indicator. Choices:
|
|
Required parameters for querying logic disk, query the set of logical drive types stored. Choices:
|
|
Required parameters for querying associated mapping info, mapping associated objects id list. |
|
Required parameters for querying associated mapping info, mapping associated object type. Choices:
|
|
Required parameters for querying performance data info, object id list. |
|
Required parameters for querying performance data and querying batch performance data info, querying performance data select one from the following enumerated values: Choices:
|
|
Query the required storage information based on the enumerated value. Choices:
|
|
Required parameters for querying clone cg and protect cg lun diff number, protect consistency group id, mutually exclusive with protect_cg_name. |
|
Required parameters for querying clone cg and protect cg lun diff number, protect consistency group name, mutually exclusive with protect_cg_id. |
|
Required parameters for querying remote device, need to query the SN set of the storage device. |
|
Query scenario set to present. |
Examples
---
tasks:
- name: Query License Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "license"
feature_key: "<HyperSnap | HyperClone | SmartMigration | SmartQoS | HyperReplication | SmartThin | HyperMetro>"
state: "present"
- name: Query Logic Disk Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "logic_disks"
logic_types:
- free_drive
- member_drive
- hot_spare_drive
- cache_drive
filter:
- id
- location
- health_status
- running_status
- disk_type
- sector_size
- manu_capacity
- pool_name
- logic_type
- abrasion_rate
- remain_life
- item
- serial_number
- erase_progess
- encrypt_disk_type
- auto_lock_status
- model
- temperature
state: "present"
- name: Query Remote Device Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "remote_device"
remote_sn:
- "<storage_sn1>"
- "<storage_sn2>"
filter:
- name
- id
- sn
- health_status
- running_status
- array_type
- wwn
- vendor
- compress_algorithm
- compress_status
state: "present"
- name: Query Storage Status Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "device_status"
state: "present"
- name: Query Storage Basic Information Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "basic_info"
filter:
- name
- id
- wwn
- product_mode
- health_status
- running_status
- product_version
- total_capacity
- used_capacity
- user_free_capacity
state: "present"
- name: Query Application Type Number Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "application_type_number"
state: "present"
- name: Query Lun Number Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "lun_number"
state: "present"
- name: Query Disk Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "disk_info"
disk_ids:
- "<id1>"
- "<id2>"
filter:
- id
- location
- health_status
- running_status
- disk_type
- sector_size
- manu_capacity
- pool_name
- logic_type
- abrasion_rate
- remain_life
- item
- serial_number
- erase_progess
- encrypt_disk_type
- auto_lock_status
- model
- temperature
state: "present"
- name: Query Clone CG And Protect CG Lun Diff Number Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "diff_lun_info"
protect_cg_id: "< protect_cg_id >"
protect_cg_name: "< protect_cg_name >"
clone_cg_id: "< clone_cg_id >"
clone_cg_name: "< clone_cg_name >"
state: "present"
- name: Query Associated Mapping Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "associated_mapping_info"
mapping_object_id: "< associated_object_id >"
mapping_object_type: "< lun | host_group | host | lun_group >"
filter:
- id
- name
- host_name
- lun_name
- host_group_name
- lun_group_name
- port_group_name
- vstore_id
- vstore_name
state: "present"
- name: Query Associated Host Detail
register: storage_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "associated_host_info"
associated_host_id: "< associated_object_id >"
associated_host_type: "< lun | host_group | snapshot | lun_group | mapping_view >"
filter:
- id
- name
- health_status
- running_status
- ip
- capacity
- allocated_capacity
- parent_name
state: "present"
- name: Query Performance Data Detail
register: performance_data_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "performance_data_info"
object_type: "< lun | controller >"
indicators:
- block_bandwidth
- iops
- avg_io_response_time
object_list:
- "< object_id1 >"
- "< object_id2 >"
- "< object_id3 >"
state: "present"
- name: Query Batch Performance Data Detail
register: batch_performance_data_info
huawei.enterprise.hw_enterprise_storage_info:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
valid_certs: "{{ valid_certs }}"
socket_timeout: "{{ socket_timeout }}"
storage_port: "{{ storage_port }}"
use_log: "{{ use_log }}"
operation: "batch_performance_data_info"
object_list :
- "< object_id1 >"
- "< object_id2 >"
- "< object_id3 >"
object_type: "< lun | host | controller >"
indicators:
- block_bandwidth
- iops
- avg_io_response_time
end_time: "< 1640995200000 >"
begin_time: "< 1640390400000 >"
compute_mode: "avg"
state: "present"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
playbook action lists Returned: always Sample: |
|
Whether or not the resource has changed. Returned: always Sample: |
|
Detail of the disk. Returned: When disk exists Sample: |
|
Disk id. Returned: always |
|
location of the disk. Returned: always |
|
task execute remark Returned: always |