ripclawffb.helix_core.helix_core_configurable module – Set configurables 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_configurable.

New in ripclawffb.helix_core 1.0.0

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

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

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 access to perform this operation

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

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 configurable.

Returned: always

Sample: true

changes

list / elements=dictionary

List of fields that were changed.

Returned: always

Sample: [{"after": "new_val", "before": "old_val", "field": "value"}]

configurable

dictionary

The configurable after the operation.

Returned: always

Sample: {"name": "auth.id", "serverid": "any", "value": "master.1"}

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

Authors

  • Asif Shaikh (@ripclawffb)