check_point.mgmt.checkpoint_host – Manages host objects on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.2.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.checkpoint_host.

Synopsis

  • Manages host objects on Check Point devices including creating, updating, removing access rules objects. All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_install_policy

boolean

Install the package policy if changes have been performed after the task completes.

Choices:

  • no

  • yes ← (default)

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • no

  • yes ← (default)

ip_address

string

IP address of the host object.

name

string / required

Name of the access rule.

policy_package

string

Package policy name to be installed.

Default: “standard”

state

string

State of the access rule (present or absent). Defaults to present.

Default: “present”

targets

list / elements=string

Targets to install the package policy on.

Examples

- name: Create host object
  checkpoint_host:
    name: attacker
    ip_address: 192.168.0.15

- name: Delete host object
  checkpoint_host:
    name: attacker
    state: absent

Return Values

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

Key

Description

checkpoint_hosts

list / elements=string

The checkpoint host object created or updated.

Returned: always, except when deleting the host.

Authors

  • Ansible by Red Hat (@rcarrillocruz)