hitachivantara.vspone_block.sds_block.hv_sds_block_storage_external_auth_server_setting_facts module – Get external authentication server 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_external_auth_server_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 external authentication server settings.
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_external_auth_server_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

external_auth_server_settings

dictionary

External authentication server configuration settings.

Returned: success

auth_protocol

string

Authentication protocol used by the external authentication server.

Returned: success

Sample: "LDAP"

is_enabled

boolean

Indicates whether external authentication is enabled.

Returned: success

Sample: false

ldap_setting

dictionary

LDAP-specific configuration settings.

Returned: success

base_dn

string

Base distinguished name used for LDAP searches.

Returned: success

Sample: "dc=example,dc=com"

bind_dn

string

Distinguished name used to bind to the LDAP server.

Returned: success

Sample: "cn=admin,dc=example,dc=com"

external_group_name_attribute

string

LDAP attribute used as the external group name.

Returned: success

Sample: "cn"

is_start_tls_enabled

boolean

Indicates whether STARTTLS is enabled for LDAP connections.

Returned: success

Sample: false

mapping_mode

string

Mapping mode used for LDAP user and group mapping.

Returned: success

Sample: "User"

max_retries

integer

Maximum number of retry attempts for LDAP connections.

Returned: success

Sample: 1

primary_ldap_server_url

string

URL of the primary LDAP server.

Returned: success

Sample: "ldap://ldap-primary.example.com"

retry_interval_milliseconds

integer

Interval between retry attempts in milliseconds.

Returned: success

Sample: 100

secondary_ldap_server_url

string

URL of the secondary LDAP server.

Returned: success

Sample: "ldap://ldap-secondary.example.com"

timeout_seconds

integer

LDAP connection timeout in seconds.

Returned: success

Sample: 7

user_group_object_class

string

LDAP object class used for user groups.

Returned: success

Sample: "group"

user_group_tree_dn

string

Distinguished name for the LDAP user group search tree.

Returned: success

Sample: "ou=groups,dc=example,dc=com"

user_id_attribute

string

LDAP attribute used as the user identifier.

Returned: success

Sample: "cn"

user_object_class

string

LDAP object class used for user entries.

Returned: success

Sample: "person"

user_tree_dn

string

Distinguished name for the LDAP user search tree.

Returned: success

Sample: "ou=users,dc=example,dc=com"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)