cp_mgmt_service_sctp

Manages service-sctp objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_service_sctp

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages service-sctp objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
aggressive_aging	dict			Sets short (aggressive) timeouts for idle connections.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
details_level	str			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.
groups	list			Collection of group identifiers.
ignore_errors	bool			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.
ignore_warnings	bool			Apply changes ignoring warnings.
keep_connections_open_after_policy_installation	bool			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.
match_for_any	bool			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.
name	str	yes		Object name.
port	str			Port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45.
session_timeout	int			Time (in seconds) before the session times out.
source_port	str			Source port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45.
state	str		`present`	Desired object presence.
sync_connections_on_cluster	bool			Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster.
tags	list			Collection of tag identifiers.
use_default_session_timeout	bool			Use default virtual session timeout. Available from R80.10 management version.
version	str			Management API version path; omitted uses the default API version.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: add-service-sctp
  check_point.mgmt.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
  check_point.mgmt.cp_mgmt_service_sctp:
    aggressive_aging:
      default_timeout: 3600
    color: dark green
    name: New_SCTP_Service_1
    port: 5656
    state: present

- name: delete-service-sctp
  check_point.mgmt.cp_mgmt_service_sctp:
    name: New_SCTP_Service_2
    state: absent