hitachivantara.vspone_block.sds_block.hv_sds_block_license_setting_facts module – Get license setting from 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_license_setting_facts.
New in hitachivantara.vspone_block 4.6.0
Synopsis
- Get license setting from SDS Block storage system.
- For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_license_setting_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:
|
|
password string / required |
Password for authentication. This is a required field. |
|
username string / required |
Username for authentication. This is a required field. |
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Determines if the module should run in check mode. |
Examples
- name: Retrieve license setting information
hitachivantara.vspone_block.sds_block.hv_sds_block_license_setting_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
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 |
|---|---|
license_setting dictionary | License setting information. Returned: success |
|
overcapacity_allowed boolean |
Whether overcapacity is allowed. Returned: success |
|
warning_threshold_setting dictionary |
Warning threshold settings. Returned: success |
|
remaining_days integer |
Remaining days until license expiration warning. Returned: success Sample: |
|
total_pool_capacity_rate integer |
Total pool capacity rate threshold. Returned: success Sample: |
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_license_setting_facts_module.html
