check_point.mgmt.cp_mgmt_check_network_feed (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: check-network-feed
  cp_mgmt_check_network_feed:
    network_feed:
      name: existing_feed
    targets: corporate-gateway

Inputs

    
targets:
    description:
    - On what targets to execute this command. Targets may be identified by their name,
      or object unique identifier.
    elements: str
    type: list

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

network_feed:
    description:
    - network feed parameters.
    suboptions:
      certificate_id:
        description:
        - Certificate SHA-1 fingerprint to access the feed.
        type: str
      custom_header:
        description:
        - Headers to allow different authentication methods with the URL.
        elements: dict
        suboptions:
          header_name:
            description:
            - The name of the HTTP header we wish to add.
            type: str
          header_value:
            description:
            - The name of the HTTP value we wish to add.
            type: str
        type: list
      data_column:
        description:
        - Number of the column that contains the feed's data.
        type: int
      details_level:
        choices:
        - uid
        - standard
        - full
        description:
        - 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.
        type: str
      domains_to_process:
        description:
        - 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.
        elements: str
        type: list
      feed_format:
        choices:
        - Flat List
        - JSON
        description:
        - Feed file format.
        type: str
      feed_type:
        choices:
        - Domain
        - IP Address
        - IP Address/Domain
        description:
        - Feed type to be enforced.
        type: str
      feed_url:
        description:
        - URL of the feed. URL should be written as http or https.
        type: str
      fields_delimiter:
        description:
        - The delimiter that separates between the columns in the feed.
        type: str
      ignore_errors:
        description:
        - 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.
        type: bool
      ignore_lines_that_start_with:
        description:
        - A prefix that will determine which lines to ignore.
        type: str
      ignore_warnings:
        description:
        - Apply changes ignoring warnings.
        type: bool
      json_query:
        description:
        - JQ query to be parsed.
        type: str
      name:
        description:
        - Object name.
        type: str
      password:
        description:
        - password for authenticating with the URL.
        type: str
      update_interval:
        description:
        - Interval in minutes for updating the feed on the Security Gateway.
        type: int
      use_gateway_proxy:
        description:
        - Use the gateway's proxy for retrieving the feed.
        type: bool
      username:
        description:
        - username for authenticating with the URL.
        type: str
    type: dict

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_check_network_feed:
  description: The checkpoint check-network-feed output.
  returned: always.
  type: dict