check_point.mgmt.cp_mgmt_lsm_gateway module – Manages lsm-gateway objects on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.5.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_lsm_gateway.

New in check_point.mgmt 2.3.0

Synopsis

  • Manages lsm-gateway objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R81.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

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"

device_id

string

added in check_point.mgmt 6.3.0

Device ID.

Available from R81.20 management version.

dynamic_objects

list / elements=dictionary

added in check_point.mgmt 6.3.0

Dynamic Objects.

Available from R81.20 management version.

name

string

Object name. Must be unique in the domain.

resolved_ip_addresses

list / elements=dictionary

Single IP-address or a range of addresses.

ipv4_address

string

IPv4 Address.

ipv4_address_range

dictionary

IPv4 Address range.

from_ipv4_address

string

First IPv4 address of the IP address range.

to_ipv4_address

string

Last IPv4 address of the IP address range.

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

name

string / required

Object name.

provisioning_settings

dictionary

Provisioning settings.

provisioning_profile

string

Provisioning profile.

provisioning_state

string

Provisioning state. By default the state is ‘manual’- enable provisioning but not attach to profile.

If ‘using-profile’ state is provided a provisioning profile must be provided in provisioning-settings.

Choices:

  • "off"

  • "manual"

  • "using-profile"

security_profile

string

LSM profile.

sic

dictionary

Secure Internal Communication.

ip_address

string

IP address. When IP address is provided- initiate trusted communication immediately using this IP address.

one_time_password

string

One-time password. When one-time password is provided without ip-address- trusted communication is automatically initiated when the gateway connects to the Security Management server for the first time.

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

tags

list / elements=string

added in check_point.mgmt 6.3.0

Collection of tag identifiers.

topology

dictionary

added in check_point.mgmt 6.3.0

Topology.

Available from R81.20 management version.

manual_vpn_domain

list / elements=dictionary

A list of IP-addresses ranges, defined the VPN community network.

This field is relevant only when ‘manual’ option of vpn-domain is checked.

comments

string

Comments string.

from_ipv4_address

string

First IPv4 address of the IP address range.

to_ipv4_address

string

Last IPv4 address of the IP address range.

vpn_domain

string

VPN Domain type. ‘external-interfaces-only’ is relevnt only for Gaia devices. ‘hide-behind-gateway-external-ip-address’ is relevant only for SMB devices.

Choices:

  • "not-defined"

  • "external-ip-addresses-only"

  • "hide-behind-gateway-external-ip-address"

  • "all-ip-addresses-behind-the-gateway"

  • "manual"

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-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present

- name: set-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    provisioning_settings:
      provisioning_profile: prv_profile
    provisioning_state: using-profile
    security_profile: lsm_profile
    sic:
      ip_address: 1.2.3.4
      one_time_password: aaaa
    state: present

- name: delete-lsm-gateway
  cp_mgmt_lsm_gateway:
    name: lsm_gateway
    state: absent

Return Values

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

Key

Description

cp_mgmt_lsm_gateway

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Shiran Golzar (@chkp-shirango)