cp_mgmt_network_probe

Manages network-probe 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_network_probe

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

Synopsis

Manages network-probe 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.
domains_to_process	list			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.
http_options	dict			Additional options when [protocol] is set to “http”.
icmp_options	dict			Additional options when [protocol] is set to “icmp”.
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.
install_on	list			Collection of Check Point Security Gateways that generate the probe, identified by name or UID.
interval	int			The time interval in the range of 5-300 (seconds) between each probe request. Best Practice - The interval value should be lower than the timeout value.
name	str	yes		Object name.
protocol	str			The probing protocol to use.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
timeout	int			The probe expiration timeout in the range of 5-300 (seconds). If there is not a single reply within this time, the status of the probe changes to “Down”.
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-network-probe
  check_point.mgmt.cp_mgmt_network_probe:
    icmp_options:
      destination: HOST_20.20.20.20
      source: Host_10.10.10.10
    install_on: GW_1
    name: probe_GW1
    state: present

- name: set-network-probe
  check_point.mgmt.cp_mgmt_network_probe:
    icmp_options:
      destination: 2.2.2.2
      source: 1.1.1.1
    name: probe_GW1
    state: present

- name: delete-network-probe
  check_point.mgmt.cp_mgmt_network_probe:
    name: probe_GW1
    state: absent