check_point.mgmt.cp_mgmt_logical_server module – Manages logical-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_logical_server.

New in check_point.mgmt 6.7.0

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages logical-server objects on Checkpoint devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Available from R82.10 management version.

Parameters

Parameter	Comments
auto_publish_session boolean	Publish the current session if changes have been performed after task completes. Choices: `false` ← (default) `true`
balance_method string	Load balancing method for the logical server. Choices: `"random"` `"round_trip"` `"domain"` `"server_load"` `"round_robin"`
color string	Color of the object. Should be one of existing colors. Choices: `"aquamarine"` `"black"` `"blue"` `"crete blue"` `"burlywood"` `"cyan"` `"dark green"` `"khaki"` `"orchid"` `"dark orange"` `"dark sea green"` `"pink"` `"turquoise"` `"dark blue"` `"firebrick"` `"brown"` `"forest green"` `"gold"` `"dark gold"` `"gray"` `"dark gray"` `"light green"` `"lemon chiffon"` `"coral"` `"sea green"` `"sky blue"` `"magenta"` `"purple"` `"slate blue"` `"violet red"` `"navy blue"` `"olive"` `"orange"` `"red"` `"sienna"` `"yellow"`
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: `"uid"` `"standard"` `"full"`
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: `false` `true`
ignore_warnings boolean	Apply changes ignoring warnings. Choices: `false` `true`
ip_address string	IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
ipv4_address string	IPv4 address.
ipv6_address string	IPv6 address.
name string / required	Object name.
persistence_mode boolean	Indicates if persistence mode is enabled for the logical server. Choices: `false` `true`
persistency_type string	Persistency type for the logical server. Choices: `"by_server"` `"by_service"`
server_group string	Server group associated with the logical server.Identified by name or UID.
server_type string	Type of server for the logical server. Choices: `"other"` `"http"`
state string	State of the access rule (present or absent). Choices: `"present"` ← (default) `"absent"`
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: `false` `true` ← (default)
wait_for_task_timeout integer	How many minutes to wait until throwing a timeout error. Default: `30`

Examples

- name: add-logical-server
  cp_mgmt_logical_server:
    balance_method: domain
    ip_address: 1.1.1.1
    name: logicalServer1
    persistence_mode: true
    persistency_type: by_server
    server_group: testGroup
    server_type: other
    state: present

- name: set-logical-server
  cp_mgmt_logical_server:
    name: logicalServer1
    server_type: http
    state: present

- name: delete-logical-server
  cp_mgmt_logical_server:
    name: logicalServer1
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
cp_mgmt_logical_server dictionary	The checkpoint object created or updated. Returned: always, except when deleting the object.

Authors

Eden Brillant (@chkp-edenbr)

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_logical_server_module.html