check_point.mgmt.cp_mgmt_access_role – Manages access-role objects on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

To install it use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_access_role.

New in version 2.9: of check_point.mgmt

Synopsis

• Manages access-role objects on Check Point devices including creating, updating and removing objects.

• All operations are performed over Web Services API.

Parameters

Parameter		Choices/Defaults	Comments
auto_publish_session boolean		Choices: no yes	Publish the current session if changes have been performed after task completes.
color string		Choices: aquamarine black blue crete blue burlywood cyan dark green khaki orchid dark orange dark sea green pink turquoise dark blue firebrick brown forest green gold dark gold gray dark gray light green lemon chiffon coral sea green sky blue magenta purple slate blue violet red navy blue olive orange red sienna yellow	Color of the object. Should be one of existing colors.
comments string			Comments string.
details_level string		Choices: uid standard full	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 boolean		Choices: no yes	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 boolean		Choices: no yes	Apply changes ignoring warnings.
machines list / elements=string			Machines that can access the system.
	base_dn string		When source is "Active Directory" use "base-dn" to refine the query in AD database.
	selection list / elements=string		Name or UID of an object selected from source.
	source string		Active Directory name or UID or Identity Tag.
name string / required			Object name.
networks list / elements=string			Collection of Network objects identified by the name or UID that can access the system.
remote_access_clients string			Remote access clients identified by name or UID.
state string		Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
tags list / elements=string			Collection of tag identifiers.
users list / elements=string			Users that can access the system.
	base_dn string		When source is "Active Directory" use "base-dn" to refine the query in AD database.
	selection list / elements=string		Name or UID of an object selected from source.
	source string		Active Directory name or UID or Identity Tag or Internal User Groups or LDAP groups or Guests.
version string			Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean		Choices: no yes ←	Wait for the task to end. Such as publish task.
wait_for_task_timeout integer		Default: 30	How many minutes to wait until throwing a timeout error.

Examples

- name: add-access-role
  cp_mgmt_access_role:
    machines: all identified
    name: New Access Role 1
    networks: any
    remote_access_clients: any
    state: present
    users: any

- name: set-access-role
  cp_mgmt_access_role:
    machines: any
    name: New Access Role 1
    state: present
    users: all identified

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
cp_mgmt_access_role dictionary	always, except when deleting the object.	The checkpoint object created or updated.

Authors

• Or Soffer (@chkp-orso)