ripclawffb.helix_core.helix_core_client_info module – Get client workspace information 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_client_info.

New in ripclawffb.helix_core 1.2.0

Synopsis

  • Retrieves client workspace specifications from Perforce Helix Core.

  • When name is provided, returns a single client spec.

  • When name is omitted, returns a list of all clients.

  • 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 client workspace to retrieve.

If omitted, all clients are listed.

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

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 Client

Manage client workspaces

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Get a specific client
- name: Get client info
  ripclawffb.helix_core.helix_core_client_info:
    name: my_client
    server: '1666'
    user: bruno
    charset: auto
    password: ''
  register: client_info

- name: Display client info
  ansible.builtin.debug:
    var: client_info.info

# List all clients
- name: List all clients
  ripclawffb.helix_core.helix_core_client_info:
    server: '1666'
    user: bruno
    charset: auto
    password: ''
  register: all_clients

- name: Display all clients
  ansible.builtin.debug:
    var: all_clients.info

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

any

When name is provided, a dict with the client spec fields.

When name is omitted, a list of client summary dicts.

Returned: success

Authors

  • Asif Shaikh (@ripclawffb)