ripclawffb.helix_core.helix_core_user module – Manage users on Perforce Helix Core

Note

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

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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.

New in ripclawffb.helix_core 1.0.0

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

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 login 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 perform this operation

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: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

action

string

The action performed on the resource.

Returned: always

Can only return:

  • "created"

  • "updated"

  • "deleted"

  • "unchanged"

Sample: "created"

changed

boolean

Whether any changes were made to the user.

Returned: always

Sample: true

changes

list / elements=dictionary

List of fields that were changed.

Returned: always

Sample: [{"after": "new@example.com", "before": "old@example.com", "field": "Email"}]

diff

dictionary

A dictionary containing ‘before’ and ‘after’ state of the resource.

Returned: when diff mode is enabled

after

string

The state of the resource after the action.

Returned: success

before

string

The state of the resource before the action.

Returned: success

user_spec

dictionary

The user specification after the operation.

Returned: always

Sample: {"Email": "new_user@perforce.com", "FullName": "New User", "User": "new_user"}

Authors

  • Asif Shaikh (@ripclawffb)