cp_mgmt_override_categorization

Manages override-categorization 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_override_categorization

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages override-categorization objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
additional_categories	list			Uid or name of the categories to override in the Application and URL Filtering or Threat Prevention.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
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.
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_warnings	bool			Apply changes ignoring warnings.
new_primary_category	str			Uid or name of the primary category based on its most defining aspect.
new_url	str			New name of the object.
risk	str			States the override categorization risk.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
url	str	yes		The URL for which we want to update the category and risk definitions, the URL and the object name are the same for Override Categorization.
url_defined_as_regular_expression	bool			States whether the URL is defined as a Regular Expression or not.
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-override-categorization
  check_point.mgmt.cp_mgmt_override_categorization:
    new_primary_category: Botnets
    risk: low
    state: present
    url: newOverride

- name: set-override-categorization
  check_point.mgmt.cp_mgmt_override_categorization:
    risk: high
    state: present
    url: newOverride

- name: delete-override-categorization
  check_point.mgmt.cp_mgmt_override_categorization:
    state: absent
    url: newOverride