hitachivantara.vspone_block.sds_block.hv_sds_block_license_setting module – Manage license settings for 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.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Modify license warning threshold settings for 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.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: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	License setting specifications.
allow_over_capacity boolean	This option is valid only for the AWS cloud model. It specifies whether to allow overcapacity when the license capacity is exceeded. Choices: `false` `true`
warning_threshold_setting dictionary	Warning threshold settings for license monitoring.
remaining_days integer	Number of days remaining until license expiration warning. Use -1 to disable the warning. Valid range is -1 to 60.
total_pool_capacity_rate integer	Pool capacity usage rate threshold for warning (percentage). Use -1 to disable the warning. Valid range is -1 or 0 to 100.
state string	The desired state of the license settings. Choices: `"present"` ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Modify license warning threshold settings
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      warning_threshold_setting:
        remaining_days: -1
        total_pool_capacity_rate: -1

- name: Set license capacity warning at 80%
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      warning_threshold_setting:
        remaining_days: -1
        total_pool_capacity_rate: 80

Return Values

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

Key	Description
license_setting dictionary	The updated license setting information. Returned: always
overcapacityAllowed boolean	Whether overcapacity is allowed. Returned: success
warningThresholdSetting dictionary	Warning threshold settings. Returned: success
remainingDays integer	Remaining days until license expiration warning. Returned: success Sample: `-1`
totalPoolCapacityRate integer	Total pool capacity rate threshold. Returned: success Sample: `80`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

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_module.html