check_point.mgmt.cp_mgmt_check_network_feed module – Check if a target can reach or parse a network feed; can work with an existing feed object or with a new one (by providing all relevant feed parameters).

Note

This module is part of the check_point.mgmt collection (version 6.2.1).

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_check_network_feed.

New in check_point.mgmt 3.0.0

Synopsis

  • Check if a target can reach or parse a network feed; can work with an existing feed object or with a new one (by providing all relevant feed parameters).

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

network_feed

dictionary

network feed parameters.

certificate_id

string

Certificate SHA-1 fingerprint to access the feed.

custom_header

list / elements=dictionary

Headers to allow different authentication methods with the URL.

header_name

string

The name of the HTTP header we wish to add.

header_value

string

The name of the HTTP value we wish to add.

data_column

integer

Number of the column that contains the feed’s data.

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.

feed_format

string

Feed file format.

Choices:

  • "Flat List"

  • "JSON"

feed_type

string

Feed type to be enforced.

Choices:

  • "Domain"

  • "IP Address"

  • "IP Address/Domain"

feed_url

string

URL of the feed. URL should be written as http or https.

fields_delimiter

string

The delimiter that separates between the columns in the feed.

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_lines_that_start_with

string

A prefix that will determine which lines to ignore.

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • false

  • true

json_query

string

JQ query to be parsed.

name

string

Object name.

password

string

password for authenticating with the URL.

update_interval

integer

Interval in minutes for updating the feed on the Security Gateway.

use_gateway_proxy

boolean

Use the gateway’s proxy for retrieving the feed.

Choices:

  • false

  • true

username

string

username for authenticating with the URL.

targets

list / elements=string

On what targets to execute this command. Targets may be identified by their name, or object unique identifier.

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: check-network-feed
  cp_mgmt_check_network_feed:
    network_feed:
      name: existing_feed
    targets: corporate-gateway

Return Values

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

Key

Description

cp_mgmt_check_network_feed

dictionary

The checkpoint check-network-feed output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)