check_point.mgmt.cp_mgmt_service_sctp module – Manages service-sctp objects on Check Point over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.0.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_service_sctp.

New in check_point.mgmt 1.0.0

Synopsis

  • Manages service-sctp objects on Check Point devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

aggressive_aging

dictionary

Sets short (aggressive) timeouts for idle connections.

default_timeout

integer

Default aggressive aging timeout in seconds.

enable

boolean

N/A

Choices:

  • false

  • true

timeout

integer

Aggressive aging timeout in seconds.

use_default_timeout

boolean

N/A

Choices:

  • false

  • true

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.

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"

groups

list / elements=string

Collection of group identifiers.

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

keep_connections_open_after_policy_installation

boolean

Keep connections open after policy has been installed even if they are not allowed under the new policy. This overrides the settings in the Connection Persistence page. If you change this property, the change will not affect open connections, but only future connections.

Choices:

  • false

  • true

match_for_any

boolean

Indicates whether this service is used when ‘Any’ is set as the rule’s service and there are several service objects with the same source port and protocol.

Choices:

  • false

  • true

name

string / required

Object name.

port

string

Port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45.

session_timeout

integer

Time (in seconds) before the session times out.

source_port

string

Source port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45.

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

sync_connections_on_cluster

boolean

Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.

Choices:

  • false

  • true

tags

list / elements=string

Collection of tag identifiers.

use_default_session_timeout

boolean

Use default virtual session timeout.

Choices:

  • false

  • true

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-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_SCTP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

- name: set-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      default_timeout: 3600
    color: green
    name: New_SCTP_Service_1
    port: 5656
    state: present

- name: delete-service-sctp
  cp_mgmt_service_sctp:
    name: New_SCTP_Service_2
    state: absent

Return Values

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

Key

Description

cp_mgmt_service_sctp

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Or Soffer (@chkp-orso)