check_point.mgmt.cp_mgmt_resource_tcp module – Manages resource-tcp objects on Checkpoint 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_resource_tcp.

New in check_point.mgmt 6.5.0

Synopsis

  • Manages resource-tcp objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R82 JHF 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

color

string

Color of the object. Should be one of existing colors.

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"

comments

string

Comments string.

cvp_settings

dictionary

CVP settings.

allowed_to_modify_content

boolean

Configures the CVP server to inspect but not modify content.

Choices:

  • false

  • true

reply_order

string

Designates when the CVP server returns data to the Security Gateway security server.

Choices:

  • "return_data_after_content_is_approved"

  • "return_data_before_content_is_approved"

server

string

CVP server identified by name or UID. The CVP server must already be defined as an OPSEC Application.

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"

domains_to_process

list / elements=string

Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

exception_track

string

Configures how to track connections that match this rule but fail the content security checks. An example of an exception is a connection with an unsupported scheme or method.

Choices:

  • "none"

  • "exception log"

  • "exception alert"

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

name

string / required

Object name.

resource_type

string

The type of the TCP resource.

Choices:

  • "cvp"

  • "ufp"

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=string

Collection of tag identifiers.

ufp_settings

dictionary

UFP settings.

caching_control

string

Specifies if and how caching is to be enabled.

Choices:

  • "security_gateway_one_request"

  • "security_gateway_two_requests"

  • "no_caching"

  • "ufp_server"

ignore_ufp_server_after_failure

boolean

The UFP server will be ignored after numerous UFP server connections were unsuccessful.

Choices:

  • false

  • true

number_of_failures_before_ignore

integer

Signifies at what point the UFP server should be ignored, Applicable only if ‘ignore after fail’ is enabled.

server

string

UFP server identified by name or UID. The UFP server must already be defined as an OPSEC Application.

timeout_before_reconnecting

integer

The amount of time, in seconds, that must pass before a UFP server connection should be attempted, Applicable only if ‘ignore after fail’ is enabled.

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-resource-tcp
  cp_mgmt_resource_tcp:
    name: newTcpResource
    state: present
    ufp_settings:
      caching_control: security_gateway_one_request
      ignore_ufp_server_after_failure: true
      number_of_failures_before_ignore: 3
      server: ufpServer

- name: set-resource-tcp
  cp_mgmt_resource_tcp:
    cvp_settings:
      server: cvpServer
    name: newTcpResource
    state: present
    ufp_settings:
      caching_control: ufp_server
      ignore_ufp_server_after_failure: false
      number_of_failures_before_ignore: 0

- name: delete-resource-tcp
  cp_mgmt_resource_tcp:
    name: tcpResource
    state: absent

Return Values

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

Key

Description

cp_mgmt_resource_tcp

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Dor Berenstein (@chkp-dorbe)