dellemc.powerstore.dellemc_powerstore_local_user (1.3.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Supports the provisioning operations on a Local user such as create, modify, delete and get the details of a local user.

Requirements

• A Dell EMC PowerStore Storage System.
• Ansible 2.9 or 2.10

Usage examples

Scanned by Steampunk Spotter

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

- name: create local user
  dellemc_powerstore_local_user:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    user_name: "ansible_user_1"
    user_password: "Password123#"
    role_name: "role_1"
    is_locked: False
    state: "present"

Scanned by Steampunk Spotter

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

- name: get the details local user with user id
  dellemc_powerstore_local_user:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    user_id: "{{user_id}}"
    state: "present"

Scanned by Steampunk Spotter

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

- name: get the details local user with user name
  dellemc_powerstore_local_user:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    user_name: "ansible_user_1"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Modify attributes of local user
  dellemc_powerstore_local_user:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    user_name: "ansible_user_1"
    user_password: "Password123#"
    new_password: "Ansible123#"
    role_id: 4
    is_locked: True
    state: "present"

Scanned by Steampunk Spotter

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

- name: delete local user
  dellemc_powerstore_local_user:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    user_name: "ansible_user_1"
    state: "absent"

Inputs

    
user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    description:
    - Define whether the local user should exist or not.
    required: true
    type: str

role_id:
    description:
    - The unique identifier of the role to which the local user account will be mapped.
    - It is mutually exclusive with role_name.
    type: int

user_id:
    description:
    - Unique identifier of the local user account.
    - Mutually exclusive with user_name.
    type: str

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

is_locked:
    description:
    - Whether the user account is locked or not.
    - Defaults to false at creation time.
    type: bool

role_name:
    description:
    - The name of the role to which the local user account will be mapped.
    - It is mutually exclusive with role_id.
    type: str

user_name:
    description:
    - Name of the local user account. Mutually exclusive with user_id.
    - Mandatory only for create operation.
    type: str

verifycert:
    choices:
    - true
    - false
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

new_password:
    description:
    - New password for the existing local user account.
    type: str

user_password:
    description:
    - Password for the new local user account to be created.
    - Mandatory only for create operation.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool
local_user_details:
  contains:
    id:
      description: The system generated ID given to the local user.
      type: str
    is_built_in:
      description: Whether the user account is built-in or not.
      type: bool
    is_default_password:
      description: Whether the user account has a default password or not. Only applies
        to default user accounts
      type: bool
    is_locked:
      description: Whether the user account is locked or not. Defaults to false at
        creation time.
      type: bool
    name:
      description: Name of the local user.
      type: str
    role_id:
      description: Unique identifier of the role local user account is mapped to.
      type: str
    role_name:
      description: Name of the role to which local user account is mapped.
      type: str
  description: Details of the local user
  returned: When local user exists
  type: complex