ripclawffb.helix_core.helix_core_user module – This module will allow you to manage users on Perforce Helix Core

Note

This module is part of the ripclawffb.helix_core collection (version 1.0.4).

To install it, use: ansible-galaxy collection install ripclawffb.helix_core. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ripclawffb.helix_core.helix_core_user.

Synopsis

  • Create or edit Helix server user specifications and preferences

  • This module supports check mode.

Requirements

The below requirements are needed on the host that executes this module.

  • P4Python pip module is required. Tested with 2018.2.1743033

Parameters

Parameter

Comments

authmethod

string

One of the following, perforce or ldap

Choices:

  • perforce ← (default)

  • ldap

charset

aliases: p4charset

string

Character set used for translation of unicode files

Can also use ‘P4CHARSET’ environment variable

Default: “none”

email

string

The user’s email address

Default: “user@hostname”

fullname

string

The user’s full name

Default: “name”

name

string / required

The name of the user that needs to be managed

password

aliases: p4passwd

string / required

The user password

Can also use ‘P4PASSWD’ environment variable

server

aliases: p4port

string / required

The hostname/ip and port of the server (perforce:1666)

Can also use ‘P4PORT’ environment variable

state

string

Determines if the user is present or deleted

Choices:

  • present ← (default)

  • absent

user

aliases: p4user

string / required

A user with access to create users

Can also use ‘P4USER’ environment variable

See Also

See also

Helix Core User

Create, edit, or delete Helix server user specifications and preferences

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Create a user
- name: Create a new user
  helix_core_user:
    state: present
    name: new_user
    email: new_user@perforce.com
    server: '1666'
    user: bruno
    charset: none
    password: ''
# Delete a user
- name: Delete a user
  helix_core_user:
    state: absent
    name: new_user
    server: '1666'
    user: bruno
    charset: none
    password: ''

Authors

  • Asif Shaikh (@ripclawffb)