octupus.o4n_checkpoint_modules.o4n_cp_add_threat_rules (1.1.8) — module

Manages threat-rules objects on Check Point over Web Services API

| "added in version" 1.0 of octupus.o4n_checkpoint_modules"

Authors: Randy Rozo

preview | supported by octupus

Install collection

Install with ansible-galaxy collection install octupus.o4n_checkpoint_modules:==1.1.8


Add to requirements.yml

  collections:
    - name: octupus.o4n_checkpoint_modules
      version: 1.1.8

Description

Manages threat rule objects in Check Point devices, including creation and updating if the rule to be created matches another,

it will add missing sources or destinations

All operations are performed over Web Services API.


Requirements

Inputs

    
layers:
    description:
    - Layer that the rule belongs to identified by the name or UID.
    elements: dict
    required: true
    suboptions:
      name:
        description:
        - Object name.
        required: true
        type: str
      rules:
        description:
        - List of rules.
        elements: dict
        required: true
        suboptions:
          action:
            description:
            - a "Bypass" or "Inspect".
            type: str
          comments:
            description:
            - Comments string.
            type: str
          destination:
            description:
            - Collection of Network objects identified by the name or UID.
            elements: str
            type: list
          enabled:
            description:
            - Enable/Disable the rule.
            type: bool
          install_on:
            description:
            - Which Gateways identified by the name or UID to install the policy on.
            elements: str
            type: list
          name:
            description:
            - Object name.
            type: str
          position:
            description:
            - Position in the rulebase.
            required: true
            type: str, int, dict
          protected_scope:
            description:
            - Collection of objects defining Protected Scope identified by the name or
              UID.
            elements: str
            type: list
          service:
            description:
            - Collection of Network objects identified by the name or UID.
            elements: str
            type: list
          source:
            description:
            - Collection of Network objects identified by the name or UID.
            elements: str
            type: list
          track:
            choices:
            - None
            - Log
            - Alert
            - Mail
            - SNMP trap
            - Mail
            - User Alert 1
            - User Alert 2
            - User Alert 3
            description:
            - Track Settings.
            type: str
          track_settings:
            description:
            - Track Settings.
            suboptions:
              packet_capture:
                description:
                - Packet capture
                type: bool
            type: dict
        type: list
    type: list

provider:
    elements: dict
    required: true
    suboptions:
      domain:
        required: true
        type: str
      host:
        required: true
        type: str
      password:
        required: true
        type: str
      port:
        required: true
        type: integer
      user:
        required: true
        type: str
      validate_certs:
        required: true
        type: boolean
    type: dic

Outputs

output:
  description: The checkpoint add threat rules output
  returned: allways
  sample:
    output:
      changed: false
      content:
      - layer_name:
        - action: Basic
          destination:
          - Test2
          enabled: true
          install-on:
          - Policy Targets
          number: 2
          protected_scope:
          - Test1
          - All_Internet
          service:
          - Any
          source:
          - Any
          state: set
          track: None
          track-settings: true
          uid: 6c68c39f-4fca-43f2-8097-0d0539a5b80b
      discard: []
      failed: false
      logout: OK
      msg:
        layer_name: Se han agregado 1 reglas.
      publish:
        progress-percentage: 100
        status: succeeded
        suppressed: false
        task-details:
        - publishResponse:
            mode: async
            numberOfPublishedChanges: 1
          revision: 4330f-0ddf-4bb4-92a6-1d73b9f
        task-id: 04567-89ab-cdef-87f4-5730958
        task-name: Publish operation
  type: dict