check_point.mgmt.cp_mgmt_network_feed module – Manages network-feed objects on Checkpoint over Web Services API
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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_network_feed
.
New in check_point.mgmt 3.0.0
Synopsis
Manages network-feed objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Certificate SHA-1 fingerprint to access the feed. |
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments string. |
|
Headers to allow different authentication methods with the URL. |
|
The name of the HTTP header we wish to add. |
|
The name of the HTTP value we wish to add. |
|
Number of the column that contains the feed’s data. |
|
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:
|
|
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. |
|
Feed file format. Choices:
|
|
Feed type to be enforced. Choices:
|
|
URL of the feed. URL should be written as http or https. |
|
The delimiter that separates between the columns in the feed. |
|
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:
|
|
A prefix that will determine which lines to ignore. |
|
Apply changes ignoring warnings. Choices:
|
|
JQ query to be parsed. |
|
Object name. |
|
password for authenticating with the URL. |
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
Interval in minutes for updating the feed on the Security Gateway. |
|
Use the gateway’s proxy for retrieving the feed. Choices:
|
|
username for authenticating with the URL. |
|
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: |
Examples
- name: add-network-feed
cp_mgmt_network_feed:
custom_header:
- header_name: header1
header_value: value1
- header_name: header2
header_value: value2
data_column: 1
feed_format: Flat List
feed_type: IP Address
feed_url: https://www.feedsresource.com/resource
fields_delimiter: " "
ignore_lines_that_start_with: '!'
name: network_feed
password: feed_password
state: present
update_interval: 60
use_gateway_proxy: false
username: feed_username
- name: set-network-feed
cp_mgmt_network_feed:
custom_header:
- header_name: new_header
header_value: new_value
data_column: 1
feed_format: Flat List
feed_type: IP Address
feed_url: https://www.feedsresource.com/new_resource
fields_delimiter: ','
ignore_lines_that_start_with: '!'
name: network_feed
password: new_password
state: present
update_interval: 60
use_gateway_proxy: false
username: new_username
- name: delete-network-feed
cp_mgmt_network_feed:
name: network_feed
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. |