hitachivantara.vspone_block.sds_block.hv_sds_block_compute_port_authentication module – Manages Hitachi SDS block storage system compute port authentication mode settings.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.4.0).

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

New in hitachivantara.vspone_block 3.0.0

Synopsis

• This module manages compute port authentication mode settings.

• For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/port_auth.yml

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

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.
username string / required	Username for authentication.
spec dictionary / required	Specification for the compute port authentication task.
authentication_mode string	Authentication mode. Choices: "CHAP" "CHAP_complying_with_initiator_setting" "None"
is_discovery_chap_authentication boolean	When true is specified, CHAP authentication at the time of discovery is enabled. Choices: false true
port_name string	Port name.
state string	The state of the port authorization task. Choices: "add_chap_user" "remove_chap_user"
target_chap_users list / elements=string	List of target CHAP user name.
state string	The level of the compute port authentication task. Choices are present and absent. Choices: "present" ← (default) "absent"

Attributes

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

Examples

- name: Set port authentication mode
  hitachivantara.vspone_block.sds_block.hv_sds_block_compute_port_authentication:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      port_name: "iqn.1994-04.jp.co.hitachi:rsd.sph.t.0a85a.000"
      authentication_mode: "CHAP"
      target_chap_users: ["chapuser1"]

Return Values

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

Key	Description
data dictionary	The compute port information. Returned: always
chap_users_info list / elements=dictionary	List of CHAP users information. Returned: success
id string	Unique identifier for the CHAP user. Returned: success Sample: "a083ca8f-e925-474a-b63b-d9b06b2d02ad"
initiator_chap_user_name string	Initiator CHAP user name. Returned: success Sample: ""
target_chap_user_name string	Target CHAP user name. Returned: success Sample: "RD-chap-user-1"
port_auth_info dictionary	Port authentication information. Returned: success
auth_mode string	Authentication mode. Returned: success Sample: "CHAP"
id string	Unique identifier for the port authentication. Returned: success Sample: "0f13e320-53e7-4088-aa11-418636b58376"
is_discovery_chap_auth boolean	Indicates if discovery CHAP authentication is enabled. Returned: success Sample: false
is_mutual_chap_auth boolean	Indicates if mutual CHAP authentication is enabled. Returned: success Sample: true
port_info dictionary	Port information. Returned: success
configured_port_speed string	Configured port speed. Returned: success Sample: "Auto"
fc_information dictionary	Fibre Channel information. Returned: success
id string	Unique identifier for the port. Returned: success Sample: "0f13e320-53e7-4088-aa11-418636b58376"
interface_name string	Interface name. Returned: success Sample: "eth2"
iscsi_information dictionary	iSCSI information. Returned: success
delayed_ack boolean	Indicates if delayed ACK is enabled. Returned: success Sample: true
ip_mode string	IP mode. Returned: success Sample: "ipv4"
ipv4_information dictionary	IPv4 information. Returned: success
address string	IPv4 address. Returned: success Sample: "10.76.34.52"
default_gateway string	Default gateway. Returned: success Sample: "10.76.34.1"
subnet_mask string	Subnet mask. Returned: success Sample: "255.255.255.0"
ipv6_information dictionary	IPv6 information. Returned: success
default_gateway string	Default gateway. Returned: success Sample: ""
global_address1 string	Global address 1. Returned: success Sample: ""
global_address_mode string	Global address mode. Returned: success Sample: "Manual"
linklocal_address string	Link-local address. Returned: success Sample: ""
linklocal_address_mode string	Link-local address mode. Returned: success Sample: "Auto"
subnet_prefix_length1 integer	Subnet prefix length. Returned: success Sample: 0
is_isns_client_enabled boolean	Indicates if iSNS client is enabled. Returned: success Sample: false
isns_servers list / elements=dictionary	List of iSNS servers. Returned: success
index integer	Index of the iSNS server. Returned: success Sample: 1
port integer	Port of the iSNS server. Returned: success Sample: 3205
server_name string	Name of the iSNS server. Returned: success Sample: ""
mac_address string	MAC address. Returned: success Sample: "b4:96:91:c8:76:0c"
mtu_size integer	MTU size. Returned: success Sample: 9000
name string	Port name. Returned: success Sample: "iqn.1994-04.jp.co.hitachi:rsd.sph.t.0a85a.001"
nickname string	Port nickname. Returned: success Sample: "001-iSCSI-001"
nvme_tcp_information dictionary	NVMe over TCP information. Returned: success
port_speed string	Port speed. Returned: success Sample: "25G"
port_speed_duplex string	Port speed duplex. Returned: success Sample: "25Gbps Full"
protection_domain_id string	Protection domain ID. Returned: success Sample: "645c36b6-da9e-44bb-b711-430e06c7ad2b"
protocol string	Protocol. Returned: success Sample: "iSCSI"
status string	Port status. Returned: success Sample: "Normal"
status_summary string	Port status summary. Returned: success Sample: "Normal"
storage_node_id string	Storage node ID. Returned: success Sample: "c3be292d-fe72-48c9-8780-3a0cbb5fbff6"
type string	Port type. Returned: success Sample: "Universal"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)