dellemc.powerstore.service_config (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

Manage Service config on PowerStore storage systems includes retrieving, and updating Service config.

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 Service config
  dellemc.powerstore.service_config:
    array_ip: "{{ array_ip }}"
    user: "{{ user }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"

Scanned by Steampunk Spotter

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

- name: Update Service config
  dellemc.powerstore.service_config:
    array_ip: "{{ array_ip }}"
    user: "{{ user }}"
    password: "{{ password }}"
    validate_certs: "{{ validate_certs }}"
    service_config:
      - appliance_name: "{{ appliance_name }}"
        is_ssh_enabled: true
      - appliance_id: "A2"
        is_ssh_enabled: true

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

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

service_config:
    description:
    - Specifies the appliance details on which ssh will be enabled/disabled.
    elements: dict
    suboptions:
      appliance_id:
        description:
        - Specifies the appliance id.
        - Mutually exclusive with appliance_name.
        type: str
      appliance_name:
        description:
        - Specifies the name of the appliance.
        - Mutually exclusive with appliance_id.
        type: str
      is_ssh_enabled:
        description:
        - Whether ssh will be enabled/disabled on specified appliance.
        required: true
        type: bool
    type: list

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: A Boolean value indicating if task had to make changes.
  returned: always
  sample: 'true'
  type: bool
service_configs_details:
  contains:
    appliance_id:
      description: Unique identifier of the appliance.
      type: str
    appliance_name:
      description: Name of the appliance.
      type: str
    id:
      description: Unique identifier of the service configuration.
      type: str
    is_ssh_enabled:
      description: Whether the SSH will be enabled/disabled.
      type: bool
  description: The details of Service configurations.
  returned: always
  sample:
  - appliance_id: A1
    appliance_name: Appliance-1
    id: A1
    is_ssh_enabled: false
  type: list