check_point.mgmt.cp_mgmt_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

Manages network-feed objects on Checkpoint devices including creating, updating and removing objects.

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: 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- name: delete-network-feed
  cp_mgmt_network_feed:
    name: network_feed
    state: absent

Inputs

    
name:
    description:
    - Object name.
    required: true
    type: str

tags:
    description:
    - Collection of tag identifiers.
    elements: str
    type: list

color:
    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
    description:
    - Color of the object. Should be one of existing colors.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the access rule (present or absent).
    type: str

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

comments:
    description:
    - Comments string.
    type: str

feed_url:
    description:
    - URL of the feed. URL should be written as http or https.
    type: str

password:
    description:
    - password for authenticating with the URL.
    type: str

username:
    description:
    - username for authenticating with the URL.
    type: str

feed_type:
    choices:
    - Domain
    - IP Address
    - IP Address/Domain
    description:
    - Feed type to be enforced.
    type: str

json_query:
    description:
    - JQ query to be parsed.
    type: str

data_column:
    description:
    - Number of the column that contains the feed's data.
    type: int

feed_format:
    choices:
    - Flat List
    - JSON
    description:
    - Feed file format.
    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

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

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

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

certificate_id:
    description:
    - Certificate SHA-1 fingerprint to access the feed.
    type: str

ignore_warnings:
    description:
    - Apply changes ignoring warnings.
    type: bool

update_interval:
    description:
    - Interval in minutes for updating the feed on the Security Gateway.
    type: int

fields_delimiter:
    description:
    - The delimiter that separates between the columns in the feed.
    type: str

use_gateway_proxy:
    description:
    - Use the gateway's proxy for retrieving the feed.
    type: bool

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

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

ignore_lines_that_start_with:
    description:
    - A prefix that will determine which lines to ignore.
    type: str

Outputs

cp_mgmt_network_feed:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict