dellemc.powerstore.role (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 role in PowerStore storage system includes getting the details of a role.

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 the details of role by name
  dellemc.powerstore.role:
    array_ip: "{{array_ip}}"
    validate_certs: "{{verify_cert}}"
    user: "{{user}}"
    password: "{{password}}"
    role_name: "Administrator"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Get the details of role by id
  dellemc.powerstore.role:
    array_ip: "{{array_ip}}"
    validate_certs: "{{verify_cert}}"
    user: "{{user}}"
    password: "{{password}}"
    role_id: "1"
    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

state:
    choices:
    - absent
    - present
    description:
    - Define whether the role should exist or not.
    - Value C(present), indicates that the role should exist on the system.
    - Value C(absent), indicates that the role should not exist on the system.
    required: true
    type: str

role_id:
    description:
    - Id of the role.
    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

role_name:
    description:
    - Name of the role.
    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: true
  type: bool
role_details:
  contains:
    description:
      description: Description of the role.
      type: str
    id:
      description: The ID of the role.
      type: str
    is_built_in:
      description: Indicates whether the role is built-in.
      type: bool
    name:
      description: The name of the role.
      type: str
  description: The role details.
  returned: When role exists.
  sample:
    description: Can view status and performance information
    id: '1'
    is_built_in: true
    name: Administrator
  type: complex