ripclawffb.helix_core.helix_core_depot module – This module will allow you to manage depots on Perforce Helix Core

Note

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

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

Synopsis

  • Create or edit a depot specification.

  • This module supports check mode.

Requirements

The below requirements are needed on the host that executes this module.

  • P4Python pip module is required. Tested with 2018.2.1743033

Parameters

Parameter

Comments

address

string

If the Type is remote, the address should be the P4PORT address of the remote server

charset

aliases: p4charset

string

Character set used for translation of unicode files

Can also use ‘P4CHARSET’ environment variable

Default: “none”

depot

string / required

The name of the depot that needs to be managed

description

string

A textual description of the depot

Default: “Created by user.”

map

string

For a local depot, the Map field specifies the filesystem location of the archive contents for files in the depot

password

aliases: p4passwd

string / required

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

specmap

string

For spec depots, an optional description of which specs should be saved, expressed as a view

state

string

Determines if the depot is present or deleted

Choices:

  • present ← (default)

  • absent

streamdepth

string

The default is one level below the name of the depot

Default: “1”

suffix

string / required

If the Type is spec, this field holds an optional suffix for generated paths to objects in the spec depot

Default: “.p4s”

type

string

The type of depot

Choices:

  • local ← (default)

  • remote

  • stream

  • spec

  • unload

  • archive

  • tangent

  • graph

user

aliases: p4user

string / required

A user with access to create depots

Can also use ‘P4USER’ environment variable

See Also

See also

Helix Core Depot

Create or edit a depot

P4Python Pip Module

Python module to interact with Helix Core

Examples

# Create a depot
- name: Create a new depot
  helix_core_depot:
    state: present
    name: bruno_new_depot
    description: 'New depot for Bruno'
    server: '1666'
    user: bruno
    charset: none
    password: ''
# Delete a depot
- name: Delete a depot
  helix_core_depot:
    state: absent
    name: bruno_new_depot
    server: '1666'
    user: bruno
    charset: none
    password: ''

Authors

  • Asif Shaikh (@ripclawffb)