ripclawffb.helix_core.helix_core_configurable_info module – Get configurable settings from 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_info.

New in ripclawffb.helix_core 1.2.0

Synopsis

  • Retrieves configurable settings from Perforce Helix Core.

  • When name is provided, returns the value of a specific configurable.

  • When name is omitted, returns all configurable settings.

  • This is a read-only module that does not make any changes.

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

The name of the configurable to retrieve.

If omitted, all configurables are returned.

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 to filter configurables by.

Defaults to any which shows all server IDs.

Default: "any"

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 Configurables

List of supported configurables

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Get a specific configurable
- name: Get auth.id configurable
  ripclawffb.helix_core.helix_core_configurable_info:
    name: auth.id
    server: '1666'
    user: bruno
    charset: auto
    password: ''
  register: config_info

# Get all configurables
- name: Get all configurables
  ripclawffb.helix_core.helix_core_configurable_info:
    server: '1666'
    user: bruno
    charset: auto
    password: ''
  register: all_configs

# Get configurables for a specific server
- name: Get configurables for master.1
  ripclawffb.helix_core.helix_core_configurable_info:
    serverid: master.1
    server: '1666'
    user: bruno
    charset: auto
    password: ''
  register: server_configs

Return Values

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

Key

Description

changed

boolean

Always False as this is a read-only module.

Returned: always

Sample: false

info

list / elements=dictionary

When name is provided, a list of matching configurable entries.

When name is omitted, a list of all configurable entries.

Each entry contains Name, Value, and ServerName.

Returned: success

Authors

  • Asif Shaikh (@ripclawffb)