Try SpotterManage users on the PowerScale Storage System
| "added in version" 1.2.0 of dellemc.powerscale"
Authors: P Srinivas Rao (@srinivas-rao5) <ansible.team@dell.com>
preview | supported by community
Install with ansible-galaxy collection install dellemc.powerscale:==1.4.0
collections:
- name: dellemc.powerscale
version: 1.4.0Managing Users on the PowerScale Storage System includes create user, delete user, update user, get user, add role and remove role.
- name: Get User Details using user name
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
access_zone: "{{access_zone}}"
provider_type: "{{provider_type}}"
user_name: "{{account_name}}"
state: "present"
- name: Create User
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
access_zone: "{{access_zone}}"
provider_type: "{{provider_type}}"
user_name: "{{account_name}}"
password: "{{account_password}}"
primary_group: "{{primary_group}}"
enabled: "{{enabled}}"
email: "{{email}}"
full_name: "{{full_name}}"
home_directory: "{{home_directory}}"
shell: "{{shell}}"
role_name: "{{role_name}}"
role_state: "present-for-user"
state: "present"
- name: Update User's Full Name and email using user name
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
access_zone: "{{access_zone}}"
provider_type: "{{provider_type}}"
user_name: "{{account_name}}"
email: "{{new_email}}"
full_name: "{{full_name}}"
state: "present"
- name: Disable User Account using User Id
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
access_zone: "{{access_zone}}"
provider_type: "{{provider_type}}"
user_id: "{{id}}"
enabled: "False"
state: "present"
- name: Add user to a role using Username
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
user_name: "{{account_name}}"
provider_type: "{{provider_type}}"
role_name: "{{role_name}}"
role_state: "present-for-user"
state: "present"
- name: Remove user from a role using User id
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
user_id: "{{id}}"
role_name: "{{role_name}}"
role_state: "absent-for-user"
state: "present"
- name: Delete User using user name
dellemc_powerscale_user:
onefs_host: "{{onefs_host}}"
port_no: "{{port_no}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
access_zone: "{{access_zone}}"
provider_type: "{{provider_type}}"
user_name: "{{account_name}}"
state: "absent"
email:
description:
- The email id of the user can be added using email option.
- The email id can be set at the time of creation and modified later.
type: str
shell:
description:
- This option is for choosing the type of shell for the user account.
type: str
state:
choices:
- absent
- present
description:
- The state option is used to mention the existence of the user account.
required: true
type: str
enabled:
description:
- Enabled is a bool variable which is used to enable or disable the user account.
type: bool
port_no:
default: '8080'
description:
- Port number of the PowerScale cluster.It defaults to 8080 if not specified.
required: false
type: str
user_id:
description:
- The user_id is auto generated at the time of creation.
- For all other operations either user_name or user_id is needed.
type: str
api_user:
description:
- username of the PowerScale cluster.
required: true
type: str
password:
description:
- The password for the user account.
- Required only in the creation of a user account.
- If given in other operations then the password will be ignored.
type: str
full_name:
description:
- The additional information about the user can be provided using full_name option.
type: str
role_name:
description:
- The name of the role which a user will be assigned.
- User can be added to multiple roles.
type: str
user_name:
description:
- The name of the user account.
- Required at the time of user creation, for rest of the operations either user_name
or user_id is required.
type: str
onefs_host:
description:
- IP address or FQDN of the PowerScale cluster.
required: true
type: str
role_state:
choices:
- present-for-user
- absent-for-user
description:
- The role_state option is used to mention the existence of the role for a particular
user.
- It is required when a role is added or removed from user.
type: str
verify_ssl:
choices:
- true
- false
description:
- boolean variable to specify whether to validate SSL certificate or not.
- True - indicates that the SSL certificate should be verified.
- False - indicates that the SSL certificate should not be verified.
required: true
type: bool
access_zone:
default: system
description:
- This option mentions the zone in which a user is created.
- For creation, access_zone acts as an attribute for the user.
- For all other operations access_zone acts as a filter.
type: str
api_password:
description:
- the password of the PowerScale cluster.
required: true
type: str
primary_group:
description:
- A user can be member of multiple groups of which one group has to be assigned as
primary group.
- This group will be used for access checks and can also be used when creating files.
- A user can be added to the group using Group Name.
type: str
provider_type:
choices:
- local
- file
- ldap
- ads
default: local
description:
- This option defines the type which will be used to authenticate the user.
- Creation, Modification and Deletion is allowed for local users.
- Adding and removing roles is allowed for all users of the system access zone.
- Getting user details is allowed for all users.
- If the provider_type is 'ads' then domain name of the Active Directory Server has
to be mentioned in the user_name. The format for the user_name should be 'DOMAIN_NAME\user_name'
or "DOMAIN_NAME\\user_name".
- This option acts as a filter for all operations except creation.
type: str
home_directory:
description:
- The path specified in this option acts as a home directory for the user.
- The directory which is given should not be already in use.
- For a user in a system access zone, the absolute path has to be given.
- For users in a non-system access zone, the path relative to the non-system Access
Zone's base directory has to be given.
type: str
changed:
description: Whether or not the resource has changed
returned: always
type: bool
user_details:
contains:
email:
description: The email of the user.
type: str
enabled:
description: Enabled is a bool variable which is used to enable or disable the
user account.
type: bool
gecos:
description: The full description of the user.
type: str
gid:
contains:
id:
description: The id of the primary group.
type: str
name:
description: The name of the primary group.
type: str
type:
description: The resource's type is mentioned.
type: str
description: The details of the primary group for the user.
type: complex
home_directory:
description: The directory path acts as the home directory for the user's account.
type: str
name:
description: The name of the user.
type: str
provider:
description: The provider contains the provider type and access zone.
type: str
roles:
description: The list of all the roles of which user is a member.
returned: For all users in system access zone.
type: list
shell:
description: The type of shell for the user account.
type: str
uid:
contains:
id:
description: The id of the user.
type: str
name:
description: The name of the user.
type: str
type:
description: The resource's type is mentioned.
type: str
description: Details about the id and name of the user.
type: complex
description: Details of the user.
returned: When user exists
type: complex