cp_mgmt_access_role

Manages access-role 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_access_role

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

Synopsis

Manages access-role objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	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.
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.
machines	str			Any or All Identified.
machines_list	list			Machines that can access the system.
name	str	yes		Object name.
networks	list			Collection of Network objects identified by the name or UID that can access the system.
remote_access_clients	str			Remote access clients identified by name or UID.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
users	str			Any or All Identified.
users_list	list			Users that can access the system.
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-role
  check_point.mgmt.cp_mgmt_access_role:
    name: New Access Role 1
    networks: any
    remote_access_clients: any
    state: present
    users: any

- name: set-access-role
  check_point.mgmt.cp_mgmt_access_role:
    users_list:
      - source: "Internal User Groups"
        selection: usersGroup
    name: New Access Role 1
    state: present

- name: delete-access-role
  check_point.mgmt.cp_mgmt_access_role:
    name: New Access Role 1
    state: absent