ansible.builtin.cp_mgmt_exception_group (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Manages exception-group objects on Check Point devices including creating, updating and removing objects.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

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

- name: add-exception-group
  cp_mgmt_exception_group:
    applied_threat_rules.0.layer: MyLayer
    applied_threat_rules.0.name: MyThreatRule
    apply_on: manually-select-threat-rules
    name: exception_group_2
    state: present

Scanned by Steampunk Spotter

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

- name: set-exception-group
  cp_mgmt_exception_group:
    apply_on: all-threat-rules
    name: exception_group_2
    state: present
    tags: tag3

Scanned by Steampunk Spotter

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

- name: delete-exception-group
  cp_mgmt_exception_group:
    name: exception_group_2
    state: absent

Inputs

    
name:
    description:
    - Object name.
    required: true
    type: str

tags:
    description:
    - Collection of tag identifiers.
    type: list

color:
    choices:
    - aquamarine
    - black
    - blue
    - crete blue
    - burlywood
    - cyan
    - dark green
    - khaki
    - orchid
    - dark orange
    - dark sea green
    - pink
    - turquoise
    - dark blue
    - firebrick
    - brown
    - forest green
    - gold
    - dark gold
    - gray
    - dark gray
    - light green
    - lemon chiffon
    - coral
    - sea green
    - sky blue
    - magenta
    - purple
    - slate blue
    - violet red
    - navy blue
    - olive
    - orange
    - red
    - sienna
    - yellow
    description:
    - Color of the object. Should be one of existing colors.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the access rule (present or absent).
    type: str

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

apply_on:
    choices:
    - all-threat-rules
    - all-threat-rules-with-specific-profile
    - manually-select-threat-rules
    description:
    - An exception group can be set to apply on all threat rules, all threat rules which
      have a specific profile, or those rules manually chosen by the user.
    type: str

comments:
    description:
    - Comments string.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - The level of detail for some of the fields in the response can vary from showing
      only the UID value of the object to a fully detailed representation of the object.
    type: str

ignore_errors:
    description:
    - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings
      flag was omitted - warnings will also be ignored.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

applied_profile:
    description:
    - The threat profile to apply this group to in the case of apply-on threat-rules-with-specific-profile.
    type: str

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

applied_threat_rules:
    description:
    - The threat rules to apply this group on in the case of apply-on manually-select-threat-rules.
    suboptions:
      add:
        description:
        - Adds to collection of values
        suboptions:
          layer:
            description:
            - The layer of the threat rule to which the group is to be attached.
            type: str
          name:
            description:
            - The name of the threat rule to which the group is to be attached.
            type: str
          position:
            description:
            - Position in the rulebase.
            type: str
          rule_number:
            description:
            - The rule-number of the threat rule to which the group is to be attached.
            type: str
        type: list
    type: dict

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_exception_group:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict