hitachivantara.vspone_block.sds_block.hv_sds_block_web_server module – Manages the web server access setting for VSP One SDS Block and Cloud systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.5.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_web_server.

New in hitachivantara.vspone_block 4.5.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.

spec

dictionary / required

Specification for the web server settings.

client_address_allowlist

list / elements=string

List of client addresses for the allowlist.

enable_client_address_allowlist

boolean

Enable or disable the client address allowlist.

Choices:

  • false

  • true

server_certificate_file_path

string

Path to the server certificate file(Required when state is ‘import_certificate’).

server_certificate_secret_key_file_path

string

Path to the server certificate secret key file (Required when state is ‘import_certificate’).

state

string

Desired state of the web server settings.

Choices:

  • "present" ← (default)

  • "import_certificate"

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Configure web server client address allowlist
  hitachivantara.vspone_block.sds_block.hv_sds_block_web_server:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      enable_client_address_allowlist: true
      client_address_allowlist:
        - "192.168.1.0/24"
        - "10.0.0.100"

- name: Import server certificate
  hitachivantara.vspone_block.sds_block.hv_sds_block_web_server:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: import_certificate
    spec:
      server_certificate_file_path: "/path/to/server.crt"
      server_certificate_secret_key_file_path: "/path/to/server.key"

- name: Disable client address allowlist
  hitachivantara.vspone_block.sds_block.hv_sds_block_web_server:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      enable_client_address_allowlist: false

Return Values

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

Key

Description

web_server_setting

dictionary

Web server access settings

Returned: always

allowlist_setting

dictionary

Allowlist configuration settings

Returned: always

client_names

list / elements=string

List of client IP addresses or host names in the allowlist

Returned: always

is_enabled

boolean

Whether the allowlist is enabled

Returned: always

whitelist_setting

dictionary

Whitelist configuration settings

Returned: always

client_names

list / elements=string

List of client IP addresses or host names in the whitelist

Returned: always

is_enabled

boolean

Whether the whitelist is enabled

Returned: always

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)