cp_mgmt_network_feed
Manages network-feed 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_network_feed
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages network-feed objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| certificate_id | str | Certificate SHA-1 fingerprint to access the feed. | ||
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| custom_header | list | Headers to allow different authentication methods with the URL. | ||
| data_column | int | Number of the column that contains the feed’s data. | ||
| 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. | ||
| feed_format | str | Feed file format. | ||
| feed_type | str | Feed type to be enforced. | ||
| feed_url | str | URL of the feed. URL should be written as http or https. | ||
| fields_delimiter | str | The delimiter that separates between the columns in the feed. | ||
| 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_lines_that_start_with | str | A prefix that will determine which lines to ignore. | ||
| ignore_warnings | bool | Apply changes ignoring warnings. | ||
| json_query | str | JQ query to be parsed. | ||
| name | str | yes | Object name. | |
| password | str | password for authenticating with the URL. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| update_interval | int | Interval in minutes for updating the feed on the Security Gateway. | ||
| use_gateway_proxy | bool | Use the gateway’s proxy for retrieving the feed. | ||
| username | str | username for authenticating with the URL. | ||
| 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-network-feed
check_point.mgmt.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: "\t"
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
check_point.mgmt.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
check_point.mgmt.cp_mgmt_network_feed:
name: network_feed
state: absent