octupus.o4n_checkpoint_modules.o4n_cp_set_threat_rules (1.1.8) — module

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

Set threat rules of the selected layer.

All operations are performed over Web Services API.

Requirements

• ansible >= 2.10

Inputs

    
layers:
    elements: dict
    required: true
    suboptions:
      name:
        description:
        - Layer identified by the name or UID.
        required: true
        type: str
      rules:
        description:
        - Layer identified by the name or UID.
        elements: dict
        required: false
        suboptions:
          action:
            description:
            - a "Bypass" or "Inspect".
            required: false
            type: str
          comments:
            description:
            - Comments string.
            type: str
          destination:
            description:
            - Collection of Network objects identified by the name or UID.
            required: false
            suboptions:
              add:
                description:
                - Adds to collection of values
                type: str, list
              remove:
                description:
                - Adds to collection of values
                type: str, list
            type: str, list, dict
          enabled:
            description:
            - Enable/Disable the rule.
            required: false
            type: boolean
          install_on:
            description:
            - Which Gateways identified by the name or UID to install the policy on.
            required: false
            suboptions:
              add:
                description:
                - Adds to collection of values
                type: str, list
              remove:
                description:
                - Adds to collection of values
                type: str, list
            type: str, list, dict
          name:
            description:
            - Object name.
            required: true
            type: str
          new-name:
            description:
            - New name of the object.
            required: true
            type: str
          new_position:
            description:
            - New position in the rulebase.
            required: false
            type: integer
          protected_scope:
            description:
            - Collection of Site Categories objects identified by the name or UID.
            suboptions:
              add:
                description:
                - Adds to collection of values
                type: str, list
              remove:
                description:
                - Adds to collection of values
                type: str, list
            type: str, list, dict
          rule_number:
            description:
            - Rule number.
            required: true
            type: integer
          service:
            description:
            - Collection of Network objects identified by the name or UID.
            required: false
            suboptions:
              add:
                description:
                - Adds to collection of values
                type: str, list
              remove:
                description:
                - Adds to collection of values
                type: str, list
            type: str, list, dict
          source:
            description:
            - Collection of Network objects identified by the name or UID.
            required: false
            suboptions:
              add:
                description:
                - Adds to collection of values
                type: str, list
              remove:
                description:
                - Adds to collection of values
                type: str, list
            type: str, list, dict
          track:
            choices:
            - None
            - Log
            - Alert
            - Mail
            - SNMP trap
            - Mail
            - User Alert 1
            - User Alert 2
            - User Alert 3
            description:
            - Layer identified by the name or UID.
            required: false
            type: dict
          track_settings:
            description:
            - Track Settings.
            suboptions:
              packet_capture:
                description:
                - Packet capture
                type: bool
            type: dict
          uid:
            description:
            - Object unique identifier.
            required: true
            type: str
        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 Set 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 modificado 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