cp_mgmt_if_map_server

Manages if-map-server 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_if_map_server

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

Synopsis

Manages if-map-server objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
authentication	dict			Authentication configuration for the IF-MAP server.
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.
host	str			Host that is IF-MAP server. Identified by name or UID.
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.
monitored_ips	list			IP ranges to be monitored by the IF-MAP client.
name	str	yes		Object name.
path	str			N/A
port	int			IF-MAP server port number.
query_whole_ranges	bool			Indicate whether to query whole ranges instead of single IP.
server_version	str			IF-MAP version.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
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-if-map-server
  check_point.mgmt.cp_mgmt_if_map_server:
    authentication:
      authentication_method: certificate_based
    host: TestHost
    monitored_ips:
    - first_ip: 1.1.1.1
      last_ip: 1.1.1.2
    - first_ip: 2.1.1.1
      last_ip: 2.1.1.2
    name: TestIfMapServer
    path: path
    port: 1
    state: present
    version: 2

- name: set-if-map-server
  check_point.mgmt.cp_mgmt_if_map_server:
    host: TestHost2
    monitored_ips:
    - first_ip: 3.1.1.1
      last_ip: 3.1.1.2
    name: TestIfMapServer
    path: newPath
    port: 2
    query_whole_ranges: false
    state: present
    version: 1.1

- name: delete-if-map-server
  check_point.mgmt.cp_mgmt_if_map_server:
    name: TestIdp
    state: absent