check_point.mgmt.cp_mgmt_update_provisioned_satellites module – Executes the update-provisioned-satellites on center gateways of VPN communities.

Note

This module is part of the check_point.mgmt collection (version 5.1.1).

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_update_provisioned_satellites.

New in check_point.mgmt 3.0.0

Synopsis

  • Executes the update-provisioned-satellites on center gateways of VPN communities.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

version

string

Version of checkpoint. If not given one, the latest version taken.

vpn_center_gateways

list / elements=string

On what targets to execute this command. Targets may be identified by their name, or object unique identifier. The targets should be a corporate gateways.

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: update-provisioned-satellites
  cp_mgmt_update_provisioned_satellites:
    vpn_center_gateways:
    - co_gateway

Return Values

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

Key

Description

cp_mgmt_update_provisioned_satellites

dictionary

The checkpoint update-provisioned-satellites output.

Returned: always.

Authors

  • Shiran Golzar (@chkp-shirango)