ripclawffb.helix_core.helix_core_configurable module – This module will allow you to set config options 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_configurable.

Synopsis

  • Configurables allow you to customize a Perforce service. Configurable settings might affect the server, the client, or a proxy.

  • 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

charset

aliases: p4charset

string

Character set used for translation of unicode files

Can also use ‘P4CHARSET’ environment variable

Default: “none”

name

string / required

The name of the configurable that needs to be set

password

aliases: p4passwd

string / required

The super 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

serverid

string

The server ID of the helix server

Default: “any”

state

string

Determines if the configurable is set or removed

Choices:

  • present ← (default)

  • absent

user

aliases: p4user

string / required

A user with super user access

Can also use ‘P4USER’ environment variable

value

string / required

The value of named configurable

See Also

See also

Helix Core Configurables

List of supported configurables

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Set auth.id configurable for any server
- name: Set auth.id
  helix_core_configurable:
    state: present
    name: auth.id
    value: master.1
    server: '1666'
    user: bruno
    charset: none
    password: ''
# Unset auth.id configurable for specific server
- name: Unset auth.id
  helix_core_configurable:
    state: absent
    name: auth.id
    value: master.1
    serverid: master.1
    server: '1666'
    user: bruno
    password: ''
    charset: auto

Authors

  • Asif Shaikh (@ripclawffb)