cp_mgmt_vpn_community_star

Manages vpn-community-star objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_vpn_community_star

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages vpn-community-star objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
advanced_properties	dict			Advanced properties. Available from R82 JHF management version.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
center_gateways	list			Collection of center VPN Gateway and VPN Device objects identified by the name or UID.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
details_level	str			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.
disable_nat	bool			Indicates whether to disable NAT inside the VPN Community. Available from R82 JHF management version.
disable_nat_on	str			Indicates on which gateways to disable NAT inside the VPN Community. Available from R82 JHF management version.
encrypted_traffic	dict			Encrypted traffic settings. Available from R82 JHF management version.
encryption_method	str			The encryption method to be used. Available from R80.10 management version.
encryption_suite	str			The encryption suite to be used. Available from R80.10 management version.
excluded_services	list			Collection of services that are excluded from the community identified by the name or UID. Connections with these services will not be encrypted and will not match rules specifying the community in the VPN community. Available from R82 JHF management version.
granular_encryptions	list			VPN granular encryption settings. Available from R81 management version.
ignore_errors	bool			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	bool			Apply changes ignoring warnings.
ike_phase_1	dict			Ike Phase 1 settings. Only applicable when the encryption-suite is set to [custom]. Available from R80.10 management version.
ike_phase_2	dict			Ike Phase 2 settings. Only applicable when the encryption-suite is set to [custom]. Available from R80.10 management version.
mep	dict			Multiple Entry Point properties. Available from R82 JHF management version.
mesh_center_gateways	bool			Indicates whether the meshed community is in center.
name	str	yes		Object name.
override_vpn_domains	list			The Overrides VPN Domains of the participants GWs. Available from R80.40 management version.
permanent_tunnels	dict			Permanent tunnels properties. Available from R82 JHF management version.
routing_mode	str			VPN Community Routing Mode. Available from R82 JHF management version.
satellite_gateways	list			Collection of Gateway objects representing satellite gateways identified by the name or UID.
shared_secrets	list			Shared secrets for external gateways. Available from R80.10 management version.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
tunnel_granularity	str			VPN tunnel sharing option to be used. Available from R81 management version.
use_shared_secret	bool			Indicates whether the shared secret should be used for all external gateways. Available from R80.10 management version.
version	str			Management API version path; omitted uses the default API version.
vpn_routing	str			Enable VPN routing to satellites. Available from R82 JHF management version.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.
wire_mode	dict			VPN Community Wire mode properties. Available from R82 JHF management version.

Example

yaml

- name: add-vpn-community-star
  check_point.mgmt.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
  check_point.mgmt.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
  check_point.mgmt.cp_mgmt_vpn_community_star:
    name: New_VPN_Community_Star_1
    state: absent