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

From Get docs
Ansible/docs/2.10/collections/check point/mgmt/checkpoint host module


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 1.0.6).

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 Choices/Defaults Comments

auto_install_policy

boolean

  • no
  • yes

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

auto_publish_session

boolean

  • no
  • yes

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

ip_address

string

IP address of the host object.

name

string / required

Name of the access rule.

policy_package

string

Default:

"standard"

Package policy name to be installed.

state

string

Default:

"present"

State of the access rule (present or absent). Defaults to 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 Returned Description

checkpoint_hosts

list / elements=string

always, except when deleting the host.

The checkpoint host object created or updated.





Authors

  • Ansible by Red Hat (@rcarrillocruz)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/check_point/mgmt/checkpoint_host_module.html