netapp.storagegrid.na_sg_grid_user (21.12.0) — module

Install collection

Install with ansible-galaxy collection install netapp.storagegrid:==21.12.0

Add to requirements.yml

  collections:
    - name: netapp.storagegrid
      version: 21.12.0

Description

Create, Update, Delete Administrative Users within NetApp StorageGRID.

Usage examples

Scanned by Steampunk Spotter

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

  - name: create a user
    netapp.storagegrid.na_sg_grid_user:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: present
      full_name: ansibleuser100
      unique_name: user/ansibleuser100
      member_of: "group/ansiblegroup100"
      disable: false

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified user should exist or not.
    type: str

api_url:
    description:
    - The url to the StorageGRID Admin Node REST API.
    required: true
    type: str

disable:
    description:
    - Disable the user from signing in. Does not apply to federated users.
    type: bool

password:
    description:
    - Set a password for a local user. Does not apply to federated users.
    - Requires root privilege.
    required: false
    type: str

full_name:
    description:
    - Full Name of the user.
    - Required for create operation
    type: str

member_of:
    description:
    - List of C(unique_groups) that the user is a member of.
    elements: str
    type: list

auth_token:
    description:
    - The authorization token for the API request
    required: true
    type: str

unique_name:
    description:
    - Unique Name for the user. Must begin with C(user/) or C(federated-user/)
    - Required for create, modify or delete operation.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false
    type: bool

update_password:
    choices:
    - on_create
    - always
    default: on_create
    description:
    - Choose when to update the password.
    - When set to C(always), the password will always be updated.
    - When set to C(on_create), the password will only be set upon a new user creation.
    type: str

Outputs

resp:
  description: Returns information about the StorageGRID Grid user.
  returned: always
  sample:
    accountId: '0'
    disable: false
    federated: false
    fullName: Example User
    id: 00000000-0000-0000-0000-000000000000
    memberOf:
    - 00000000-0000-0000-0000-000000000000
    uniqueName: user/Example
    userURN: urn:sgws:identity::0:user/Example
  type: dict