openafs_contrib.openafs.openafs_user (1.9.0) — module

Create an OpenAFS user

Authors: Michael Meffie

preview | supported by community

Install collection

Install with ansible-galaxy collection install openafs_contrib.openafs:==1.9.0


Add to requirements.yml

  collections:
    - name: openafs_contrib.openafs
      version: 1.9.0

Description

Create or remove a user.

Optionally create new groups and add the user to groups.

Localauth authentication may be used on server nodes, running as root.

Keytab based authentication may be used on client nodes. This requires a keytab for a user in the system:adminstrators group and a member of the UserList on all of the database servers.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create users
  openafs_contrib.openafs.openafs_user:
     name: "{{ item }}"
     group: tester
  with_items:
    - alice
    - bob
    - charlie

Inputs

    
id:
    default: 0
    description:
    - The OpenAFS pts id.
    - The next available id will be selected if omitted or 0.
    required: false
    type: int

user:
    description: The OpenAFS username.
    required: true
    type: str

state:
    default: present
    description:
    - C(present) create user and groups when not present
    - C(absent) remove user when not present
    type: str

groups:
    aliases:
    - group
    description:
    - The OpenAFS group names the user is a member.
    - Non-system groups will be created.
    required: false
    type: list

auth_user:
    default: admin
    description:
    - The afs user name to be used when C(localauth) is False.
    - The user must be a member of the C(system:administrators) group and must be a server
      superuser, that is, set in the C(UserList) file on each server in the cell.
    - Old kerberos 4 '.' separators are automatically converted to modern '/' separators.
    - This option may only be used if a client is installed on the remote node.
    type: str

localauth:
    default: false
    description:
    - Indicates if the C(-localauth) option is to be used for authentication.
    - This option should only be used when running on a server.
    type: bool

auth_keytab:
    default: admin.keytab
    description:
    - The path on the remote host to the keytab file to be used to authenticate.
    - The keytab file must already be present on the remote host.
    - This option may only be used if a client is installed on the remote node.
    type: str

Outputs

user:
  description: User information.
  type: dictionary