check_point.mgmt.cp_mgmt_set_vpn_community_remote_access module – Edit existing Remote Access object. Using object name or uid is optional.
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_set_vpn_community_remote_access
.
New in check_point.mgmt 5.0.0
Synopsis
Edit existing Remote Access object. Using object name or uid is optional.
Add and Delete API commands for this object are unavailable since there is single object per domain.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
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:
|
|
Collection of Gateway objects identified by the name or UID. |
|
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:
|
|
Object name. |
|
Collection of tag identifiers. |
|
Collection of User group objects identified by the name or UID. |
|
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: set-vpn-community-remote-access
cp_mgmt_set_vpn_community_remote_access:
gateways:
- mygateway
user_groups:
- myusergroup
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint set-vpn-community-remote-access output. Returned: always. |