check_point.gaia.cp_gaia_user (5.0.1) — module

Install collection

Install with ansible-galaxy collection install check_point.gaia:==5.0.1

Add to requirements.yml

  collections:
    - name: check_point.gaia
      version: 5.0.1

Description

Change a user's characteristics.

Usage examples

Scanned by Steampunk Spotter

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

- name: Set shell field for the user
  check_point.gaia.cp_gaia_user:
    shell: bash
    name: admin

Inputs

    
uid:
    description: Specifies a numeric user ID used to identify permissions of a user, duplicate
      UIDs are not allowed.
    required: false
    type: int

name:
    description: User name.
    required: true
    type: str

roles:
    description: Roles spesified to the user.
    elements: str
    required: false
    type: list

shell:
    choices:
    - scp-only
    - tcsh
    - csh
    - sh
    - no-login
    - bash
    - cli
    default: cli
    description: Specifies the user's default command line interpreter during login.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: Ansible state which can be C(present) or C(absent).
    required: false
    type: str

unlock:
    description: If the user has been locked out, cancel that. True cancel lock-out. False  do
      nothing.
    required: false
    type: bool

homedir:
    description:
    - Specifies the user's home directory as the full UNIX path name where the user is
      placed on login. If the directory doesn't exist, it is created. Range  Must be under
      '/home' and must not contain colon. Unless set, the default 'homedir' will be '/home/user-name'.
    required: false
    type: str

version:
    description: Gaia API version for example 1.6.
    required: false
    type: str

password:
    description: Specifies new password on command line. Check Point recommends that a
      password be at least eight characters long. A password must contain at least six
      characters. Enforcement level can be modified via 'password control' feature.
    required: false
    type: str

real_name:
    description: Specifies a string describing a user; conventionally it's the user's
      full name. Default is Username, capitalized.
    required: false
    type: str

password_hash:
    description: An encrypted representation of the password. Hash version of a password
      can be generated using the 'grub-md5-crypt' utility.
    required: false
    type: str

allow_access_using:
    choices:
    - CLI
    - Web-UI
    - Gaia-API
    default:
    - CLI
    - Web-UI
    description: Modify the access-mechanisms available for a user. Valid values are C(CLI)
      C(Web-UI) C(Gaia-API) (supported from R81.10).
    elements: str
    required: false
    type: list

must_change_password:
    description:
    - Forcing password change is relevant only when a password is set. When set to 'True'
      Force the user to change their password the next time they log in. If they don't
      log in within the time limit configured in 'set password-controls expiration-lockout-days'
      they may not be able to log in at all. When set to 'False' If the user was being
      forced to change their password, cancel that. If the user was locked out due to
      failure to change their password within the time limit configured in 'set password-controls
      expiration-lockout-days' they will no longer be locked out.
    required: false
    type: bool

primary_system_group_id:
    default: 100
    description: GID. Numeric ID which is used in identifying the primary group to which
      this user belongs.
    required: false
    type: int

secondary_system_groups:
    description: This operation sets the groups of the user. Valid values must be names
      of known groups.
    elements: str
    required: false
    type: list

Outputs

user:
  description: The updated user details.
  returned: always.
  type: dict