ripclawffb.helix_core.helix_core_group (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

Add or delete users from a group, or set the maxresults, maxscanrows, maxlocktime, and timeout limits for the members of a group

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.

# Create a group
- name: Create a new group
  helix_core_group:
    state: present
    name: group1
    users:
        - root
    server: '1666'
    user: bruno
    charset: none
    password: ''

Scanned by Steampunk Spotter

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

# Delete a group
- name: Delete a group
  helix_core_group:
    state: absent
    name: new_user
    server: '1666'
    user: bruno
    charset: none
    password: ''

Inputs

    
name:
    aliases:
    - group
    description:
    - The name of the group that needs to be managed
    required: true
    type: str

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines if the group is present or deleted
    type: str

users:
    description:
    - The Helix server usernames of the group members
    elements: str
    type: list

owners:
    description:
    - Names of other Helix server users
    elements: str
    type: list

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

timeout:
    default: 43200
    description:
    - The duration (in seconds) of the validity of a session ticket created by p4 login
    type: str

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

subgroups:
    description:
    - Names of other Helix server groups
    elements: str
    type: list

ldapconfig:
    description:
    - "The LDAP configuration to use when populating the group\u2019s user list from an\
      \ LDAP query"
    type: str

maxresults:
    default: unset
    description:
    - The maximum number of results that members of this group can access from the service
      from a single command
    type: str

maxlocktime:
    default: unset
    description:
    - The maximum length of time (in milliseconds) that any one operation can lock any
      database table when scanning data
    type: str

maxscanrows:
    default: unset
    description:
    - The maximum number of rows that members of this group can scan from the service
      from a single command
    type: str

maxopenfiles:
    default: unset
    description:
    - The maximum number of files that a member of a group can open using a single command
    type: str

ldapsearchquery:
    description:
    - The LDAP query used to identify the members of the group
    type: str

passwordtimeout:
    default: unset
    description:
    - The length of time (in seconds) for which passwords for users in this group remain
      valid
    type: str

ldapuserattribute:
    description:
    - "The LDAP attribute that represents the user\u2019s username"
    type: str

See also

• Helix Core Group: Add or delete users from a group, or set the maxresults, maxscanrows, maxlocktime, and timeout limits for the members of a group link
• P4Python Pip Module: Python module to interact with Helix Core link