check_point.mgmt.cp_mgmt_vpn_community_star module – Manages vpn-community-star objects on Check Point over Web Services API
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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 check_point.mgmt 1.0.0
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 |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Collection of center VPN Gateway and VPN Device objects identified by the name or UID. |
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments string. |
|
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. Choices:
|
|
The encryption method to be used. Choices:
|
|
The encryption suite to be used. Choices:
|
|
VPN granular encryption settings. |
|
The encryption method to be used. Choices:
|
|
The encryption suite to be used. Choices:
|
|
Externally managed or 3rd party gateway identified by name or UID. |
|
Ike Phase 1 settings. Only applicable when the encryption-suite is set to [custom]. |
|
The hash algorithm to be used. Choices:
|
|
The Diffie-Hellman group to be used. Choices:
|
|
The encryption algorithm to be used. Choices:
|
|
Indicates the time interval for IKE phase 1 renegotiation. |
|
Indicates the time unit for [ike-p1-rekey-time-unit] parameter, rounded up to minutes scale. Choices:
|
|
Ike Phase 2 settings. Only applicable when the encryption-suite is set to [custom]. |
|
The hash algorithm to be used. Choices:
|
|
The encryption algorithm to be used. Choices:
|
|
The Diffie-Hellman group to be used. Choices:
|
|
Indicates the time interval for IKE phase 2 renegotiation. |
|
Indicates the time unit for [ike-p2-rekey-time-unit] parameter. Choices:
|
|
Indicates whether Perfect Forward Secrecy (PFS) is being used for IKE phase 2. Choices:
|
|
Internally managed Check Point gateway identified by name or UID, or ‘Any’ for all internal-gateways participants in this community. |
|
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. Choices:
|
|
Apply changes ignoring warnings. Choices:
|
|
Ike Phase 1 settings. Only applicable when the encryption-suite is set to [custom]. |
|
The hash algorithm to be used. Choices:
|
|
The Diffie-Hellman group to be used. Choices:
|
|
The encryption algorithm to be used. Choices:
|
|
Indicates the time interval for IKE phase 1 renegotiation. |
|
Indicates the time unit for [ike-p1-rekey-time-unit] parameter, rounded up to minutes scale. Choices:
|
|
Ike Phase 2 settings. Only applicable when the encryption-suite is set to [custom]. |
|
The hash algorithm to be used. Choices:
|
|
The encryption algorithm to be used. Choices:
|
|
The Diffie-Hellman group to be used. Choices:
|
|
Indicates the time interval for IKE phase 2 renegotiation. |
|
Indicates the time unit for [ike-p2-rekey-time-unit] parameter. Choices:
|
|
Indicates whether Perfect Forward Secrecy (PFS) is being used for IKE phase 2. Choices:
|
|
Indicates whether the meshed community is in center. Choices:
|
|
Object name. |
|
The Overrides VPN Domains of the participants GWs. |
|
Participant gateway in override VPN domain identified by the name or UID. |
|
VPN domain network identified by the name or UID. |
|
Collection of Gateway objects representing satellite gateways identified by the name or UID. |
|
Shared secrets for external gateways. |
|
External gateway identified by the name or UID. |
|
Shared secret. |
|
State of the access rule (present or absent). Choices:
|
|
Collection of tag identifiers. |
|
VPN tunnel sharing option to be used. Choices:
|
|
Indicates whether the shared secret should be used for all external gateways. Choices:
|
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
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 |
Description |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |