cp_mgmt_log_exporter

Manages log-exporter objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_log_exporter

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

Synopsis

Manages log-exporter objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
attachments	dict			Log exporter attachments.
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.
data_manipulation	dict			Log exporter data manipulation.
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.
domains_to_process	list			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.
enabled	bool			Indicates whether to enable export.
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.
name	str	yes		Object name.
protocol	str			Protocol used to send logs to the target server.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
target_port	int			Port number of the target server.
target_server	str			Target server port to which logs are exported.
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-log-exporter
  check_point.mgmt.cp_mgmt_log_exporter:
    attachments:
      add_link_to_log_attachment: true
    name: newLogExporter
    protocol: tcp
    state: present
    target_port: 1234
    target_server: 1.2.3.4

- name: set-log-exporter
  check_point.mgmt.cp_mgmt_log_exporter:
    data_manipulation:
      format: json
    name: newLogExporter
    state: present
    target_port: 999

- name: delete-log-exporter
  check_point.mgmt.cp_mgmt_log_exporter:
    name: newLogExporter
    state: absent