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

Modify role.

Requirements

• supported starting from gaia_api >= 1.7

Usage examples

Scanned by Steampunk Spotter

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

- name: Add new role
  check_point.gaia.cp_gaia_role:
    name: myrole
    extended_commands: ['LSMenabler']
    features: [{"name": "dhcp", "permission": "read-write"},
               {"name": "ntp", "permission": "read-write"},
               {"name": "syslog", "permission": "read-write"},
               {"name": "backup", "permission": "read-only"}]

Inputs

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

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

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

features:
    description: Specifies which features will be assigned to the role.
    elements: dict
    required: false
    suboptions:
      name:
        description: Feature name. Valid values are feature name as shown in cp_gaia_features_facts
          or C(all) to specify all features.
        required: false
        type: str
      permission:
        choices:
        - read-write
        - read-only
        description: Feature permission. Valid values are C(read-write) C(read-only).
        required: false
        type: str
    type: list

extended_commands:
    description:
    - Specifies which extended commands will be assigned to the role. Valid values are
      extended commands as shown in cp_gaia_extended_commands_facts API output.
    elements: str
    required: false
    type: list

Outputs

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