cp_mgmt_domain_permissions_profile
Manages domain-permissions-profile 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_domain_permissions_profile
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages domain-permissions-profile objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access_control | dict | Access Control permissions. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| 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. | ||
| edit_common_objects | bool | Define and manage objects in the Check Point database, Network Objects, Services, Custom Application Site, VPN Community, Users, Servers, Resources, Time, UserCheck, and Limit. Only a ‘Customized’ permission-type profile can edit this permission. | ||
| endpoint | dict | Endpoint permissions. Not supported for Multi-Domain Servers. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| events_and_reports | dict | Events and Reports permissions. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| gateways | dict | Gateways permissions. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| 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. | ||
| management | dict | Management permissions. | ||
| monitoring_and_logging | dict | Monitoring and Logging permissions. ‘Customized’ permission-type profile can edit all these permissions. “Read Write All” permission-type can edit only dlp-logs-including-confidential-fields and manage-dlp-messages permissions. | ||
| name | str | yes | Object name. | |
| others | dict | Additional permissions. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| permission_type | str | The type of the Permissions Profile. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| threat_prevention | dict | Threat Prevention permissions. Only a ‘Customized’ permission-type profile can edit these permissions. | ||
| 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-domain-permissions-profile
check_point.mgmt.cp_mgmt_domain_permissions_profile:
name: customized profile
state: present
- name: set-domain-permissions-profile
check_point.mgmt.cp_mgmt_domain_permissions_profile:
access_control:
policy_layers:
edit_layers: By Selected Profile In A Layer Editor
name: read profile
permission_type: customized
state: present
- name: delete-domain-permissions-profile
check_point.mgmt.cp_mgmt_domain_permissions_profile:
name: profile
state: absent