check_point.mgmt.cp_mgmt_global_assignment module – Manages global-assignment objects on Check Point over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_global_assignment.

New in check_point.mgmt 1.0.0

Synopsis

  • Manages global-assignment objects on Check Point devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R80 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

dependent_domain

string

N/A

details_level

string

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.

Choices:

  • "uid"

  • "standard"

  • "full"

global_access_policy

string

Global domain access policy that is assigned to a dependent domain.

global_domain

string

N/A

global_threat_prevention_policy

string

Global domain threat prevention policy that is assigned to a dependent domain.

ignore_errors

boolean

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.

Choices:

  • false

  • true

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • false

  • true

manage_protection_actions

boolean

N/A

Choices:

  • false

  • true

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: add-global-assignment
  cp_mgmt_global_assignment:
    dependent_domain: domain2
    global_access_policy: standard
    global_domain: Global
    global_threat_prevention_policy: standard
    manage_protection_actions: true
    state: present

- name: set-global-assignment
  cp_mgmt_global_assignment:
    dependent_domain: domain1
    global_domain: Global2
    global_threat_prevention_policy: ''
    manage_protection_actions: false
    state: present

- name: delete-global-assignment
  cp_mgmt_global_assignment:
    dependent_domain: domain1
    global_domain: Global2
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_global_assignment

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Or Soffer (@chkp-orso)