ripclawffb.helix_core.helix_core_configurable (1.0.4) — module

Install collection

Install with ansible-galaxy collection install ripclawffb.helix_core:==1.0.4

Add to requirements.yml

  collections:
    - name: ripclawffb.helix_core
      version: 1.0.4

Description

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

• P4Python pip module is required. Tested with 2018.2.1743033

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
name:
    description:
    - The name of the configurable that needs to be set
    required: true
    type: str

user:
    aliases:
    - p4user
    description:
    - A user with super user access
    - Can also use 'P4USER' environment variable
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines if the configurable is set or removed
    type: str

value:
    description:
    - The value of named configurable
    required: true
    type: str

server:
    aliases:
    - p4port
    description:
    - The hostname/ip and port of the server (perforce:1666)
    - Can also use 'P4PORT' environment variable
    required: true
    type: str

charset:
    aliases:
    - p4charset
    default: none
    description:
    - Character set used for translation of unicode files
    - Can also use 'P4CHARSET' environment variable
    required: false
    type: str

password:
    aliases:
    - p4passwd
    description:
    - The super user password
    - Can also use 'P4PASSWD' environment variable
    required: true
    type: str

serverid:
    default: any
    description:
    - The server ID of the helix server
    required: false
    type: str

See also

• Helix Core Configurables: List of supported configurables link
• P4Python Pip Module: Python module to interact with Helix Core link