cp_mgmt_service_udp

Manages service-udp 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_udp

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

Synopsis

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

Parameters

Name	Type	Required	Default	Description
accept_replies	bool			N/A
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_by_protocol_signature	bool			A value of true enables matching by the selected protocol’s signature - the signature identifies the protocol as genuine. Select this option to limit the port to the specified protocol. If the selected protocol does not support matching by signature, this field cannot be set to true. Available from R80.10 management version.
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.
override_default_settings	bool			Indicates whether this service is a Data Domain service which has been overridden. Available from R80.10 management version.
port	str			The number of the port used to provide this service. To specify a port range, place a hyphen between the lowest and highest port numbers, for example 44-55.
protocol	str			Select the protocol type associated with the service, and by implication, the management server (if any) that enforces Content Security and Authentication for the service. Selecting a Protocol Type invokes the specific protocol handlers for each protocol type, thus enabling higher level of security by parsing the protocol, and higher level of connectivity by tracking dynamic actions (such as opening of ports). Available from R80.10 management version.
session_timeout	int			Time (in seconds) before the session times out.
source_port	str			Port number for the client side service. If specified, only those Source port Numbers will be Accepted, Dropped, or Rejected during packet inspection. Otherwise, the source port is not inspected.
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-udp
  check_point.mgmt.cp_mgmt_service_udp:
    accept_replies: false
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_UDP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

- name: set-service-udp
  check_point.mgmt.cp_mgmt_service_udp:
    accept_replies: true
    aggressive_aging:
      default_timeout: 3600
    color: dark green
    name: New_UDP_Service_1
    port: 5656
    state: present

- name: delete-service-udp
  check_point.mgmt.cp_mgmt_service_udp:
    name: New_UDP_Service_2
    state: absent