ripclawffb.helix_core.helix_core_typemap module – Manage the typemap on Perforce Helix Core

Note

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

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

New in ripclawffb.helix_core 1.1.0

Synopsis

  • The typemap table associates file type modifiers with file patterns.

  • This module manages the entire typemap table as a unit.

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

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 typemap entries are set or cleared

present replaces the typemap with the specified entries

absent clears all entries from the typemap

Choices:

  • "present" ← (default)

  • "absent"

typemap

list / elements=dictionary

List of typemap entries

Each entry must have a type and path key

Required when state is present

path

string / required

The depot path pattern (e.g., //depot/….exe)

type

string / required

The file type to assign (e.g., binary, text+k, binary+l)

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 Typemap

Configure file type mappings

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Set typemap entries
- name: Configure typemap
  ripclawffb.helix_core.helix_core_typemap:
    state: present
    typemap:
      - type: binary+l
        path: //depot/....exe
      - type: binary+l
        path: //depot/....dll
      - type: text+k
        path: //depot/....txt
    server: '1666'
    user: bruno
    charset: auto
    password: ''

# Clear all typemap entries
- name: Clear typemap
  ripclawffb.helix_core.helix_core_typemap:
    state: absent
    server: '1666'
    user: bruno
    charset: auto
    password: ''

Return Values

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

Key

Description

changed

boolean

Whether any changes were made to the typemap.

Returned: always

Sample: true

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)