check_point.gaia.cp_gaia_user_facts (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

Show the users currently configured.

Usage examples

Scanned by Steampunk Spotter

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

- name: Show users
  check_point.gaia.cp_gaia_user_facts:

Scanned by Steampunk Spotter

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

- name: Show user by specifying it's name
  check_point.gaia.cp_gaia_user_facts:
    name: admin

Inputs

    
name:
    description: User name to show. If not specified, all users information is returned.
    required: false
    type: str

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

Outputs

ansible_facts:
  contains:
    objects:
      contains:
        allow_access_using:
          description:
          - The access-mechanisms available for a user. Valid values CLI, Web-UI,
            Gaia-API (supported from R81.10). Default [CLI, Web-UI].
          elements: str
          returned: always
          type: list
        homedir:
          description:
          - User home directory.
          returned: always
          type: str
        locked:
          description:
          - If the user has been locked out.
          returned: always
          type: bool
        must_change_password:
          description:
          - Must_change_password.
          returned: always
          type: bool
        name:
          description:
          - User name.
          returned: always
          type: str
        primary_system_group_id:
          description:
          - User primary system group id.
          returned: always
          type: int
        real_name:
          description:
          - User real name.
          returned: always
          type: str
        roles:
          description:
          - User roles.
          elements: str
          returned: always
          type: list
        secondary_system_groups:
          description:
          - User secondary system groups.
          elements: str
          returned: always
          type: list
        shell:
          description:
          - User shell.
          returned: always
          type: str
        uid:
          description:
          - User UID.
          returned: always
          type: int
      description:
      - List of users.
      elements: dict
      returned: always
      type: list
  description: The user/s facts.
  returned: always.
  type: dict