cp_mgmt_limit

Manages limit 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_limit

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

Synopsis

Manages limit 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.
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.
download_rate	int			The Rate for the maximum permitted bandwidth.
download_unit	str			The Unit for the maximum permitted bandwidth.
enable_download	bool			Enable throughput limit for downloads from the internet to the organization.
enable_upload	bool			Enable throughput limit for uploads from the organization to the internet.
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.
name	str	yes		Object name.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
upload_rate	int			The Rate for the maximum permitted bandwidth.
upload_unit	str			The Unit for the maximum permitted bandwidth.
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-limit
  check_point.mgmt.cp_mgmt_limit:
    download_rate: '3'
    download_unit: gbps
    enable_download: 'true'
    name: limit_obj
    state: present

- name: set-limit
  check_point.mgmt.cp_mgmt_limit:
    download_rate: 50
    download_unit: kbps
    name: limit_obj
    state: present

- name: delete-limit
  check_point.mgmt.cp_mgmt_limit:
    name: limit_obj_Clone
    state: absent