hitachivantara.vspone_block.sds_block.hv_sds_block_storage_user_auth_setting module – Manages external authentication server settings on VSP One SDS Block and Cloud systems.
Note
This module is part of the hitachivantara.vspone_block collection (version 4.8.2).
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_storage_user_auth_setting.
New in hitachivantara.vspone_block 4.6.0
Synopsis
This module allows to configure external authentication server settings.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/user_auth_setting.yml
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
Information required to establish a connection to the storage system. |
|
IP address or hostname of the storage system. |
|
Type of connection to the storage system. Choices:
|
|
Password for authentication. This is a required field. |
|
Username for authentication. This is a required field. |
|
Specification for user authentication settings. |
|
Account lockout policy configuration. Applicable to users whose authentication is local. |
|
Duration of the account lockout in seconds. Valid range, 60 - 600. |
|
Maximum number of failed login attempts before the account is locked. 0 means that the function is disabled (the user can be unsuccessful an unlimited number of times). Valid range, 0 - 10. |
|
Password aging policy configuration. Applicable to users whose authentication is local. |
|
Maximum number of days a password remains valid. 0 means that this limit is disabled (the user can use the password indefinitely). Valid range, 0 - 365. |
|
Minimum number of days before a password can be changed. 0 means that the expiration time is disabled (the user can change the password immediately). Valid range, 0 - 10. |
|
Whether users are required to reset their password on first login. Choices:
|
|
Password complexity policy configuration. Applicable to users whose authentication is local. |
|
Minimum required length of the password. Valid range, 1 - 256. |
|
Minimum number of lowercase characters required. Valid range, 0 - 16. |
|
Minimum number of numeric characters required. Valid range, 0 - 16. |
|
Minimum number of symbol characters required. Valid range, 0 - 16. |
|
Minimum number of uppercase characters required. Valid range, 0 - 16. |
|
Number of previously used passwords that cannot be reused. 1 means that this limit is disabled (the user can set the same password as a past one). Valid range, 1 - 10. |
|
User session timeout configuration. |
|
Maximum idle time before the session expires, in seconds. Valid range, 300 - 86400. |
|
Maximum allowed session lifetime in seconds. Valid range, 1800 - 604800. |
|
State of the user authentication settings. Choices:
|
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: none |
Determines if the module should run in check mode. |
Examples
- name: Update user auth settings
hitachivantara.vspone_block.sds_block.hv_sds_block_storage_user_auth_setting:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
spec:
password_age_setting:
max_age_days: 42
min_age_days: 0
requires_initial_password_reset: true
password_complexity_setting:
min_length: 8
min_number_of_lower_case_chars: 1
min_number_of_numerals: 1
min_number_of_symbols: 1
min_number_of_upper_case_chars: 1
number_of_password_history: 1
lockout_setting:
max_attempts: 5
lockout_seconds: 600
session_setting:
max_lifetime_seconds: 86400
max_idle_seconds: 1800
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
User authentication and security policy settings. Returned: success |
|
Account lockout policy configuration. Returned: success |
|
Duration of account lockout in seconds after exceeding maximum login attempts. Returned: success Sample: |
|
Maximum number of failed login attempts before the account is locked. Returned: success Sample: |
|
Password aging policy configuration. Returned: success |
|
Maximum number of days a password is valid. Returned: success Sample: |
|
Minimum number of days before a password can be changed. Returned: success Sample: |
|
Indicates whether an initial password reset is required. Returned: success Sample: |
|
Password complexity policy configuration. Returned: success |
|
Minimum required length of the password. Returned: success Sample: |
|
Minimum number of lowercase characters required. Returned: success Sample: |
|
Minimum number of numeric characters required. Returned: success Sample: |
|
Minimum number of symbol characters required. Returned: success Sample: |
|
Minimum number of uppercase characters required. Returned: success Sample: |
|
Number of previously used passwords that cannot be reused. Returned: success Sample: |
|
User session timeout configuration. Returned: success |
|
Maximum idle time before the session expires, in seconds. Returned: success Sample: |
|
Maximum allowed session lifetime, in seconds. Returned: success Sample: |