Try SpotterRemote system operations on a PowerStore storage system
| "added in version" 1.4.0 of dellemc.powerstore"
Authors: P Srinivas Rao (@srinivas-rao5) <ansible.team@dell.com>
Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0
collections:
- name: dellemc.powerstore
version: 3.2.0Performs all remote system operations on a PowerStore Storage System.
This module supports get details of a remote systems, create/Add new remote system for all supported parameters, modify remote system with supported parameters and delete/remove a remote system.
- name: Add a new remote system
dellemc.powerstore.remotesystem:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
user: "{{user}}"
password: "{{password}}"
remote_address: "xxx.xxx.xxx.xxx"
remote_user: "admin"
remote_password: "{{remote_password}}"
remote_port: 443
network_latency: "Low"
decription: "Adding a new remote system"
state: "present"
- name: Modify attributes of remote system using remote_id
dellemc.powerstore.remotesystem:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
user: "{{user}}"
password: "{{password}}"
remote_id: "7d7e7917-735b-3eef-8cc3-1302001c08e7"
remote_address: "xxx.xxx.xxx.xxx"
network_latency: "Low"
wait_for_completion: true
timeout: 300
decription: "Updating the description"
state: "present"
- name: Get details of remote system using remote_id
dellemc.powerstore.remotesystem:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
user: "{{user}}"
password: "{{password}}"
remote_id: "D7d7e7917-735b-3eef-8cc3-1302001c08e7"
state: "present"
- name: Delete remote system using remote_id
dellemc.powerstore.remotesystem:
array_ip: "{{array_ip}}"
validate_certs: "{{validate_certs}}"
user: "{{user}}"
password: "{{password}}"
remote_id: "D7d7e7917-735b-3eef-8cc3-1302001c08e7"
state: "absent"
port:
description:
- Port number for the PowerStore array.
- If not passed, it will take 443 as default.
type: int
user:
description:
- The username of the PowerStore host.
required: true
type: str
state:
choices:
- present
- absent
description:
- The state of the remote system after the task is performed.
- For Delete operation only, it should be set to C(absent).
- For all Create, Modify or Get details operations it should be set to C(present).
required: true
type: str
timeout:
default: 120
description:
- Time after which the connection will get terminated.
- It is to be mentioned in seconds.
type: int
array_ip:
description:
- IP or FQDN of the PowerStore management system.
required: true
type: str
password:
description:
- The password of the PowerStore host.
required: true
type: str
remote_id:
description:
- ID of the remote system.
- ID for the remote system is autogenerated, cannot be passed during creation of a
remote system.
- Parameter I(remote_id) and I(remote_address) are mutually exclusive.
type: str
description:
description:
- Additional information about the remote system.
- To remove the description empty string is to be passed.
type: str
remote_name:
description:
- Name of the remote system.
- Parameter I(remote_name) cannot be mentioned during addition of a new remote system.
type: str
remote_port:
default: 443
description:
- Remote system's port number.
- It can be mentioned only during creation of the remote system.
type: int
remote_user:
description:
- Username used in basic authentication to remote PowerStore cluster.
- It can be mentioned only during creation of the remote system.
type: str
remote_address:
description:
- Management IP of the remote system.
- Parameter I(remote_id) and I(remote_address) are mutually exclusive.
type: str
validate_certs:
aliases:
- verifycert
default: true
description:
- Boolean variable to specify whether to validate SSL certificate or not.
- C(true) - indicates that the SSL certificate should be verified. Set the environment
variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
- C(false) - indicates that the SSL certificate should not be verified.
type: bool
network_latency:
choices:
- Low
- High
description:
- Replication traffic can be tuned for higher efficiency depending on the expected
network latency.
- Setting to low will have latency of less than five milliseconds.
- Setting to high will have latency of more than five milliseconds.
type: str
remote_password:
description:
- Password used in basic authentication to remote PowerStore cluster.
- It can be mentioned only during creation of the remote system.
type: str
new_remote_address:
description:
- New management IP of the remote system.
type: str
wait_for_completion:
choices:
- true
- false
default: false
description:
- Flag to indicate if the operation should be run synchronously or asynchronously.
- C(true) signifies synchronous execution.
- By default, modify and delete operation will run asynchronously.
type: bool
changed:
description: Whether or not the resource has changed.
returned: always
sample: 'false'
type: bool
job_details:
contains:
id:
description: The id of the job.
type: str
description: Details of the job.
returned: When wait_for_completion is not set to True.
sample:
description_l10n: Modify network parameters.
end_time: '2022-01-06T07:39:05.846+00:00'
estimated_completion_time: null
id: be0d099c-a6cf-44e8-88d7-9be80ccae369
parent_id: null
phase: Completed
phase_l10n: Completed
progress_percentage: 100
resource_action: modify
resource_action_l10n: modify
resource_id: nw6
resource_name: null
resource_type: network
resource_type_l10n: network
response_body: null
response_status: null
response_status_l10n: null
root_id: be0d099c-a6cf-44e8-88d7-9be80ccae369
start_time: '2022-01-06T07:39:05.47+00:00'
state: COMPLETED
state_l10n: Completed
step_order: 23792565
user: admin
type: complex
remote_system_details:
contains:
data_connection_state:
description: Data connection states of a remote system.
type: str
data_connections:
contains:
initiator_address:
description: Initiating address from the local node.
type: str
node_id:
description: Unique identifier of the local, initiating node.
type: str
status:
description: Possible transit connection statuses.
type: str
target_address:
description: Target address from the remote system.
type: str
description:
- List of data connections from each appliance in the local cluster to iSCSI
target IP address.
type: complex
data_network_latency:
description:
- Network latency choices for a remote system. Replication traffic can be tuned
for higher efficiency depending on the expected network latency.
- This will only be used when the remote system type is PowerStore.
type: str
description:
description: User-specified description of the remote system instance.
type: str
discovery_chap_mode:
description: Challenge Handshake Authentication Protocol (CHAP) statu.
type: str
id:
description: The system generated ID of the remote system.
type: str
management_address:
description: The management cluster IP address of the remote system.
type: str
name:
description: Name of the remote system.
type: str
serial_number:
description: Serial number of the remote system instance.
type: str
session_chap_mode:
description: Challenge Handshake Authentication Protocol (CHAP) status.
type: str
state:
description:
- Possible remote system states.
- OK, Normal conditions.
- Update_Needed, Verify and update needed to handle network configuration changes
on the systems.
- Management_Connection_Lost, Management connection to the remote peer is lost.
type: str
type:
description: Remote system connection type between the local system.
type: str
user_name:
description: Username used to access the non-PowerStore remote systems.
type: str
version:
description:
- Version of the remote system.
- It was added in PowerStore version 2.0.0.0.
type: str
description: Details of the remote system.
returned: When remote system exists
sample:
data_connection_state: Initializing
data_connection_state_l10n: Initializing
data_connections: null
data_network_latency: Low
data_network_latency_l10n: Low
description: Adding remote system
discovery_chap_mode: Disabled
discovery_chap_mode_l10n: Disabled
id: aaa3cc6b-455b-4bde-aa75-a1edf61bbe0b
import_sessions: []
iscsi_addresses:
- xx.xx.xx.xx
- xx.xx.xx.xx
management_address: xx.xx.xx.xx
name: RT-D0100
replication_sessions: []
serial_number: PSeba1a5c63d46
session_chap_mode: Disabled
session_chap_mode_l10n: Disabled
state: Ok
state_l10n: Ok
type: PowerStore
type_l10n: PowerStore
user_name: ''
type: complex