check_point.gaia.cp_gaia_initial_setup (5.0.1) — module

Run First Time Wizard configuration.

| "added in version" 3.0.0 of check_point.gaia"

Authors: Ameer Asli (@chkp-ameera)

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

Run First Time Wizard configuration.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Initial setup
  check_point.gaia.cp_gaia_initial_setup:
    wait_for_task: True
    security_gateway: {cluster_member: False, activation_key: bbbb, dynamically_assigned_ip: False}

Inputs

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

password:
    description: Password of user admin. Required in case default initial password has
      not been changed before.
    required: false
    type: str

wait_for_task:
    default: true
    description: Wait for task or return immediately.
    required: false
    type: bool

security_gateway:
    description: Install Security Gateway.
    required: false
    suboptions:
      activation_key:
        description: Secure Internal Communication key.
        required: false
        type: str
      cluster_member:
        default: false
        description: Enable/Disable ClusterXL.
        required: false
        type: bool
      dynamically_assigned_ip:
        default: false
        description:
        - Enable DAIP (dynamic ip) gateway. Should be false if cluster_member or security_management
          enabled.
        required: false
        type: bool
    type: dict

security_management:
    description: Install Security Management or Multi domain server.
    required: false
    suboptions:
      activation_key:
        description: Secure Internal Communication key, relevant in case of secondary
          or log-server.
        required: false
        type: str
      gui_clients:
        description:
        - Choose which GUI clients can log into the Security Management. fill one of the
          parameters C(range) C(network) C(single-ip), for multi-domain it can be only
          single-ip or can keep the default value.
        required: false
        suboptions:
          network:
            description: IPs from specific network allowed to connect to management.
            required: false
            suboptions:
              address:
                description: IPv4 address of network.
                required: false
                type: str
              mask_length:
                description: Mask length of network.
                required: false
                type: int
            type: dict
          range:
            description: Range of IPs allowed to connect to management.
            required: false
            suboptions:
              first_IPv4_range:
                description: First IP in range.
                required: false
                type: str
              last_IPv4_range:
                description: Last IP in range.
                required: false
                type: str
            type: dict
          single_ip:
            description: In case of a single IP which allowed to connect to management.
            required: false
            type: str
        type: dict
      leading_interface:
        description: Leading multi domain server interface, relevant in case of multi-domain
          enabled.
        required: false
        type: str
      multi_domain:
        default: false
        description: Install Security Multi domain server, it can be C(primary) or C(secondary)
          or C(log-server) according to type parameter.
        required: false
        type: bool
      type:
        choices:
        - primary
        - secondary
        - log-server
        default: primary
        description: Type of security management or multi domain server.
        required: false
        type: str
    type: dict

Outputs

initial_setup:
  description: The checkpoint object updated.
  returned: always.
  type: dict