check_point.mgmt.cp_mgmt_if_map_server module – Manages if-map-server objects on Checkpoint over Web Services API
Note
This module is part of the check_point.mgmt collection (version 6.9.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install check_point.mgmt.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_if_map_server.
New in check_point.mgmt 6.5.0
Synopsis
- Manages if-map-server objects on Checkpoint devices including creating, updating and removing objects.
- All operations are performed over Web Services API.
- Available from R82 JHF management version.
Parameters
Parameter | Comments |
|---|---|
authentication dictionary | Authentication configuration for the IF-MAP server. |
|
authentication_method string |
Authentication method for the IF-MAP server. Choices:
|
|
password string |
Username for the IF-MAP server authentication. <font color=”red”>Required only when</font> ‘authentication-method’ is set to ‘basic’. |
|
username string |
Username for the IF-MAP server authentication. <font color=”red”>Required only when</font> ‘authentication-method’ is set to ‘basic’. |
auto_publish_session boolean | Publish the current session if changes have been performed after task completes. Choices:
|
color string | Color of the object. Should be one of existing colors. Choices:
|
comments string | Comments string. |
details_level string | 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. Choices:
|
domains_to_process list / elements=string | 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 string | Host that is IF-MAP server. Identified by name or UID. |
ignore_errors boolean | 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. Choices:
|
ignore_warnings boolean | Apply changes ignoring warnings. Choices:
|
monitored_ips list / elements=dictionary | IP ranges to be monitored by the IF-MAP client. |
|
first_ip string |
First IPv4 address in the range to be monitored. |
|
last_ip string |
Last IPv4 address in the range to be monitored. |
name string / required | Object name. |
path string | N/A |
port integer | IF-MAP server port number. |
query_whole_ranges boolean | Indicate whether to query whole ranges instead of single IP. Choices:
|
server_version string | IF-MAP version. Choices:
|
state string | State of the access rule (present or absent). Choices:
|
tags list / elements=string | Collection of tag identifiers. |
version string | Version of checkpoint. If not given one, the latest version taken. |
wait_for_task boolean | Wait for the task to end. Such as publish task. Choices:
|
wait_for_task_timeout integer | How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: add-if-map-server
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
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
cp_mgmt_if_map_server:
name: TestIdp
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
cp_mgmt_if_map_server dictionary | The checkpoint object created or updated. Returned: always, except when deleting the object. |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/check_point/mgmt/cp_mgmt_if_map_server_module.html