cp_mgmt_access_point_name

Manages access-point-name objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_access_point_name

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

Synopsis

Manages access-point-name objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
apn	str			APN name.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
block_traffic_other_end_user_domains	bool			Block MS to MS traffic between this and other APN end user domains.
block_traffic_this_end_user_domain	bool			Block MS to MS traffic within this end user domain.
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.
end_user_domain	str			End user domain name or UID.
enforce_end_user_domain	bool			Enable enforce end user domain.
groups	list			Collection of group identifiers.
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	yes		Object name.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
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: add-access-point-name
  check_point.mgmt.cp_mgmt_access_point_name:
    name: myaccesspointname
    apn: apnname
    end_user_domain: All_Internet
    enforce_end_user_domain: 'True'
    state: present

- name: set-access-point-name
  check_point.mgmt.cp_mgmt_access_point_name:
    name: myaccesspointname
    block_traffic_other_end_user_domains: 'False'
    block_traffic_this_end_user_domain: 'False'
    enforce_end_user_domain: 'True'
    state: present

- name: delete-access-point-name
  check_point.mgmt.cp_mgmt_access_point_name:
    name: myaccesspointname
    state: absent