check_point.mgmt.cp_mgmt_vpn_community_star – Manages vpn-community-star objects on Check Point over Web Services API

Note

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

New in version 2.9: of check_point.mgmt

Synopsis
Parameters
Examples
Return Values

Synopsis

Manages vpn-community-star objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.

Parameters

Parameter		Choices/Defaults	Comments
auto_publish_session boolean		Choices: no yes	Publish the current session if changes have been performed after task completes.
center_gateways list / elements=string			Collection of Gateway objects representing center gateways identified by the name or UID.
color string		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	Color of the object. Should be one of existing colors.
comments string			Comments string.
details_level string		Choices: uid standard full	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.
encryption_method string		Choices: prefer ikev2 but support ikev1 ikev2 only ikev1 for ipv4 and ikev2 for ipv6 only	The encryption method to be used.
encryption_suite string		Choices: suite-b-gcm-256 custom vpn b vpn a suite-b-gcm-128	The encryption suite to be used.
ignore_errors boolean		Choices: no yes	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.
ignore_warnings boolean		Choices: no yes	Apply changes ignoring warnings.
ike_phase_1 dictionary			Ike Phase 1 settings. Only applicable when the encryption-suite is set to [custom].
	data_integrity string	Choices: aes-xcbc sha1 sha256 sha384 md5	The hash algorithm to be used.
	diffie_hellman_group string	Choices: group-1 group-2 group-5 group-14 group-19 group-20	The Diffie-Hellman group to be used.
	encryption_algorithm string	Choices: cast aes-256 des aes-128 3des	The encryption algorithm to be used.
ike_phase_2 dictionary			Ike Phase 2 settings. Only applicable when the encryption-suite is set to [custom].
	data_integrity string	Choices: aes-xcbc sha1 sha256 sha384 md5	The hash algorithm to be used.
	encryption_algorithm string	Choices: cast aes-gcm-256 cast-40 aes-256 des aes-128 3des des-40cp aes-gcm-128 none	The encryption algorithm to be used.
mesh_center_gateways boolean		Choices: no yes	Indicates whether the meshed community is in center.
name string / required			Object name.
satellite_gateways list / elements=string			Collection of Gateway objects representing satellite gateways identified by the name or UID.
shared_secrets list / elements=string			Shared secrets for external gateways.
	external_gateway string		External gateway identified by the name or UID.
	shared_secret string		Shared secret.
state string		Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
tags list / elements=string			Collection of tag identifiers.
use_shared_secret boolean		Choices: no yes	Indicates whether the shared secret should be used for all external gateways.
version string			Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean		Choices: no yes ←	Wait for the task to end. Such as publish task.
wait_for_task_timeout integer		Default: 30	How many minutes to wait until throwing a timeout error.

Examples

- name: add-vpn-community-star
  cp_mgmt_vpn_community_star:
    center_gateways: Second_Security_Gateway
    encryption_method: prefer ikev2 but support ikev1
    encryption_suite: custom
    ike_phase_1:
      data_integrity: sha1
      diffie_hellman_group: group 19
      encryption_algorithm: aes-128
    ike_phase_2:
      data_integrity: aes-xcbc
      encryption_algorithm: aes-gcm-128
    name: New_VPN_Community_Star_1
    state: present

- name: set-vpn-community-star
  cp_mgmt_vpn_community_star:
    encryption_method: ikev2 only
    encryption_suite: custom
    ike_phase_1:
      data_integrity: sha1
      diffie_hellman_group: group 19
      encryption_algorithm: aes-128
    ike_phase_2:
      data_integrity: aes-xcbc
      encryption_algorithm: aes-gcm-128
    name: New_VPN_Community_Star_1
    state: present

- name: delete-vpn-community-star
  cp_mgmt_vpn_community_star:
    name: New_VPN_Community_Star_1
    state: absent

Return Values

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

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

Authors

Or Soffer (@chkp-orso)

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