hitachivantara.vspone_block.sds_block.hv_sds_block_storage_user_auth_setting_facts module – Get user authentication settings from the storage system.

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_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis

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.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve information about user authentication settings.
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_user_auth_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

lockout_setting

dictionary

Account lockout policy settings.

Returned: success

lockout_seconds

integer

Duration of account lockout in seconds.

Returned: success

Sample: 600

max_attempts

integer

Maximum number of failed login attempts before lockout.

Returned: success

Sample: 3

password_age_setting

dictionary

Password aging policy settings.

Returned: success

max_age_days

integer

Maximum number of days a password is valid.

Returned: success

Sample: 42

min_age_days

integer

Minimum number of days before a password can be changed.

Returned: success

Sample: 0

requires_initial_password_reset

boolean

Whether an initial password reset is required.

Returned: success

Sample: true

password_complexity_setting

dictionary

Password complexity configuration settings.

Returned: success

min_length

integer

Minimum required length of the password.

Returned: success

Sample: 8

min_number_of_lower_case_chars

integer

Minimum number of lowercase characters required.

Returned: success

Sample: 0

min_number_of_numerals

integer

Minimum number of numeric characters required.

Returned: success

Sample: 0

min_number_of_symbols

integer

Minimum number of symbol characters required.

Returned: success

Sample: 0

min_number_of_upper_case_chars

integer

Minimum number of uppercase characters required.

Returned: success

Sample: 0

number_of_password_history

integer

Number of previous passwords that cannot be reused.

Returned: success

Sample: 1

session_setting

dictionary

User session timeout settings.

Returned: success

max_idle_seconds

integer

Maximum allowed idle time before session timeout in seconds.

Returned: success

Sample: 1800

max_lifetime_seconds

integer

Maximum allowed session lifetime in seconds.

Returned: success

Sample: 86400

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)