check_point.mgmt.cp_mgmt_service_sctp – Manages service-sctp objects on Check Point over Web Services API
Note
This plugin is part of the check_point.mgmt collection (version 2.2.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 version 2.9: of check_point.mgmt
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 |
---|---|
Sets short (aggressive) timeouts for idle connections. |
|
Default aggressive aging timeout in seconds. |
|
N/A Choices:
|
|
Aggressive aging timeout in seconds. |
|
N/A Choices:
|
|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments 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:
|
|
Collection of group identifiers. |
|
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:
|
|
Apply changes ignoring warnings. Choices:
|
|
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:
|
|
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:
|
|
Object name. |
|
Port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45. |
|
Time (in seconds) before the session times out. |
|
Source port number. To specify a port range add a hyphen between the lowest and the highest port numbers, for example 44-45. |
|
State of the access rule (present or absent). Defaults to present. Choices:
|
|
Enables state-synchronized High Availability or Load Sharing on a ClusterXL or OPSEC-certified cluster. Choices:
|
|
Collection of tag identifiers. |
|
Use default virtual session timeout. Choices:
|
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
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 |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |
Authors
Or Soffer (@chkp-orso)