check_point.mgmt.cp_mgmt_log_exporter module – Manages log-exporter objects on Checkpoint over Web Services API

Note

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

New in check_point.mgmt 6.5.0

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages log-exporter objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Available from R82 JHF management version.

Parameters

Parameter	Comments
attachments dictionary	Log exporter attachments.
add_link_to_log_attachment boolean	Indicates whether to add link to log attachment in SmartView. Choices: `false` `true`
add_link_to_log_details boolean	Indicates whether to add link to log details in SmartView. Choices: `false` `true`
add_log_attachment_id boolean	Indicates whether to add log attachment ID. 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.
data_manipulation dictionary	Log exporter data manipulation.
aggregate_log_updates boolean	Indicates whether to aggregate log updates. Choices: `false` `true`
format string	Logs format. Choices: `"syslog"` `"cef"` `"leef"` `"generic"` `"splunk"` `"logrhythm"` `"json"`
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"`
domains_to_process list / elements=string	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 boolean	Indicates whether to enable export. Choices: `false` `true`
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`
name string / required	Object name.
protocol string	Protocol used to send logs to the target server. Choices: `"udp"` `"tcp"`
state string	State of the access rule (present or absent). Choices: `"present"` ← (default) `"absent"`
tags list / elements=string	Collection of tag identifiers.
target_port integer	Port number of the target server.
target_server string	Target server port to which logs are exported.
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-log-exporter
  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
  cp_mgmt_log_exporter:
    data_manipulation:
      format: json
    name: newLogExporter
    state: present
    target_port: 999

- name: delete-log-exporter
  cp_mgmt_log_exporter:
    name: newLogExporter
    state: absent

Return Values

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

Key	Description
cp_mgmt_log_exporter dictionary	The checkpoint object created or updated. Returned: always, except when deleting the object.

Authors

Dor Berenstein (@chkp-dorbe)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/check_point/mgmt/cp_mgmt_log_exporter_module.html