cp_mgmt_set_vpn_community_remote_access

Edit existing Remote Access object. Using object name or uid is optional through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_set_vpn_community_remote_access

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

Synopsis

Edit existing Remote Access object. Using object name or uid is optional through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Default	Description
auto_publish_session	bool	`false`	Publish this owned session explicitly after the operation; default false.
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.
gateways	list		Collection of Gateway objects identified by the name or UID.
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.
name	str		Object name.
override_vpn_domains	list		The Overrides VPN Domains of the participants GWs. Available from R82 JHF management version.
tags	list		Collection of tag identifiers.
user_groups	list		Collection of User group objects identified by the name or UID.
version	str		Management API version path; omitted uses the default API 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.

Example

yaml

- name: set-vpn-community-remote-access
  check_point.mgmt.cp_mgmt_set_vpn_community_remote_access:
    gateways:
      - mygateway
    user_groups:
      - myusergroup