dellemc.powerstore.remote_support_contact (3.2.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

Performs all Remote Support Contact operations on a PowerStore Storage system. This module supports get details and you can modify a Remote Support Contact with supported parameters.

Requirements

• A Dell PowerStore storage system version 3.0.0.0 or later.
• Ansible-core 2.14 or later.
• PyPowerStore 3.1.0.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get details of remote support contact
  dellemc.powerstore.remote_support_contact:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    contact_id: 0
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify remote support contact
  dellemc.powerstore.remote_support_contact:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    contact_id: 0
    first_name: "abc"
    last_name: "xyz"
    phone: "111-222-333-444"
    email: "abc_xyz@dell.com"
    state: "present"

Inputs

    
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

email:
    description:
    - The email address of the support contact for this system.
    type: str

phone:
    description:
    - The phone number of this support contact for this system.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - The state of the remote support contact 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

last_name:
    description:
    - The last name of the support contact for this system.
    type: str

contact_id:
    description:
    - Unique identifier of the remote support contact.
    required: true
    type: int

first_name:
    description:
    - The first name of the support contact for this system.
    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

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
remote_support_contact_details:
  contains:
    email:
      description: The email address of the support contact for this system.
      type: str
    first_name:
      description: The first name of the support contact for this system.
      type: str
    id:
      description: Unique identifier of remote support contact.
      type: int
    last_name:
      description: The last name of the support contact for this system.
      type: str
    phone:
      description: The phone number of this support contact for this system.
      type: str
  description: Details of the remote support contact.
  returned: When remote support contact exists.
  sample:
    email: ''
    first_name: sample
    id: '0'
    last_name: contact
    phone: '0123213423'
  type: complex