Try SpotterRemote Support operations on a PowerStore storage system
| "added in version" 1.5.0 of dellemc.powerstore"
Authors: Trisha Datta (@Trisha_Datta) <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 Support operations on a PowerStore Storage System. This module supports getting details of an existing Remote Support configuration.
This module also supports modifying an existing Remote Support configuration. Verify a remote support configuration. You can send a test alert through the remote support configuration.
- name: Get details of remote support configuration
dellemc.powerstore.remote_support:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
remote_support_id: 0
state: "present"
- name: Modify remote support configuration - SRS_Gateway_Tier2
dellemc.powerstore.remote_support:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
remote_support_id: 0
support_type: "SRS_Gateway_Tier2"
remote_support_servers:
- address: "10.XX.XX.XX"
port: 9443
is_primary: true
- address: "10.XX.XX.YY"
port: 9443
is_primary: false
server_state: "present-in-server"
is_rsc_enabled: true
is_cloudiq_enabled: false
timeout: 300
state: "present"
- name: Modify remote support configuration - SRS_Integrated_Tier2
dellemc.powerstore.remote_support:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
remote_support_id: 0
support_type: "SRS_Integrated_Tier2"
proxy_address: "10.XX.XX.ZZ"
proxy_port: 3128
proxy_username: "user"
proxy_password: "password"
timeout: 300
state: "present"
- name: Verify remote support configuration
dellemc.powerstore.remote_support:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
remote_support_id: 0
support_type: "SRS_Integrated_Tier3"
timeout: 300
verify_connection: true
state: "present"
- name: Send a test alert
dellemc.powerstore.remote_support:
array_ip: "{{array_ip}}"
user: "{{user}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
remote_support_id: 0
send_test_alert: true
state: "present"
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 support configuration after the task is performed.
- For Delete operation only, it should be set to C(absent).
- For get/modify operation 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
proxy_port:
description:
- Proxy server port number.
type: int
server_state:
choices:
- present-in-server
- absent-in-server
description:
- Indicates the state of the remote_support_servers.
- Required with I(remote_support_servers).
type: str
support_type:
choices:
- SRS_Gateway
- SRS_Gateway_Tier2
- SRS_Gateway_Tier3
- SRS_Integrated_Tier2
- SRS_Integrated_Tier3
- Disabled
description:
- The type of remote support that is configured.
- Mandatory for modify and verify operation.
- C(SRS_Gateway), I(support_type) is only supported for verify operation.
type: str
proxy_address:
description:
- Proxy server IP address (IPv4).
type: str
is_rsc_enabled:
description:
- Indicates whether support for Remote Service Credentials is enabled.
type: bool
proxy_password:
description:
- Password for proxy server access.
type: str
proxy_username:
description:
- User name for proxy server access.
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
send_test_alert:
default: false
description:
- Indicates whether to send a test alert or not.
type: bool
is_icw_configured:
description:
- Client already configured ICW.
type: bool
remote_support_id:
description:
- Unique identifier of the remote support configuration.
required: true
type: int
verify_connection:
default: false
description:
- Indicates whether to perform the verify call or not.
type: bool
is_cloudiq_enabled:
description:
- Indicates whether support for CloudIQ is enabled.
type: bool
wait_for_completion:
default: false
description:
- Flag to indicate if the operation should be run synchronously or asynchronously.
C(true) signifies synchronous execution. By default, modify operation will run asynchronously.
type: bool
remote_support_servers:
description:
- One or two remote support servers.
elements: dict
suboptions:
address:
description:
- Gateway server IP address (IPv4).
- The address is a mandatory key.
required: true
type: str
is_primary:
description:
- Indicates whether the server is acting as the primary.
- One server must be set to C(false) when two servers are configured.
type: bool
port:
description:
- Gateway server port.
type: int
type: list
return_support_license_text:
default: false
description:
- Indicates whether to return support license agreement text or not.
type: bool
is_support_assist_license_accepted:
description:
- Indicates whether user has accepted remote support license agreement before enabling
the Support Assist on the system for the first time.
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: The job details.
returned: When asynchronous task is performed.
sample:
description_l10n: Modify SupportAssist configuration.
end_time: '2022-02-24T04:41:56.852+00:00'
estimated_completion_time: null
id: 24e3f881-87f1-49f6-8764-13df4906eb2f
parent_id: null
phase: Completed
phase_l10n: Completed
progress_percentage: 100
resource_action: modify
resource_action_l10n: modify
resource_id: '0'
resource_name: null
resource_type: remote_support
resource_type_l10n: remote support
response_body: null
response_status: '204'
response_status_l10n: '204'
root_id: 24e3f881-87f1-49f6-8764-13df4906eb2f
start_time: '2022-02-24T04:41:38.146+00:00'
state: COMPLETED
state_l10n: Completed
step_order: 64871764
user: admin
type: complex
remote_support_details:
contains:
id:
description: Unique identifier of remote support configuration.
type: int
is_cloudiq_enabled:
description: Indicates whether support for CloudIQ is enabled.
type: bool
is_rsc_enabled:
description: Indicates whether support for Remote Service Credentials is enabled.
type: bool
is_support_assist_license_accepted:
description: Indicates whether user has accepted remote support license agreement
before enabling the Support Assist on the system for the first time.
type: bool
proxy_address:
description: Proxy server IP address (IPv4).
type: str
proxy_password:
description: Password for proxy server access.
type: str
proxy_port:
description: Proxy server port number.
type: int
proxy_username:
description: User name for proxy server access.
type: str
remote_support_servers:
contains:
address:
description: Gateway server IP address (IPv4).
type: str
id:
description: Unique identifier of the remote support server.
type: str
is_primary:
description: Indicates whether the server is acting as the primary.
type: bool
port:
description: Gateway server port.
type: int
description:
- Details of two remote support servers.
type: complex
support_assist_license_agreement_text:
description: The support assist license agreement text.
type: str
type:
description: The type of remote support that is configured.
type: str
description: Details of the remote support configuration.
returned: When remote support configuration exists.
sample:
connectivity_status: Unavailable
connectivity_status_l10n: Unavailable
id: '0'
is_cloudiq_enabled: true
is_rsc_enabled: false
is_support_assist_license_accepted: true
last_update: '2022-02-11T11:16:39.134+00:00'
policy_manager_address: null
policy_manager_port: null
proxy_address: null
proxy_port: null
proxy_username: null
remote_support_servers:
- address: localhost
connectivity_qos:
- appliance_id: A1
connectivity_qos: connectivity_qos
connectivity_qos_priority: 2
connectivity_qos_value: -1.0
id: dc326198-2d92-4ff4-a774-324b00ca8818
last_update: '2022-02-11T11:16:39.888+00:00'
remote_support_servers_id: '0'
id: '0'
is_primary: true
port: '9443'
remote_support_id: '0'
- address: localhost
connectivity_qos: []
id: '1'
is_primary: false
port: 'null'
remote_support_id: '0'
support_assist_license_agreement_text: license string
type: SRS_Integrated_Tier3
type_l10n: SRS Integrated with Remote Access
type: complex