cp_mgmt_user_group
Manages user-group 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_user_group
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages user-group objects on Checkpoint 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. | ||
| str | Email Address. | |||
| 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. | ||
| members | list | Collection of User Group objects identified by the name or UID. | ||
| 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-user-group
check_point.mgmt.cp_mgmt_user_group:
email: myusergroup@email.com
members:
- myuser
name: myusergroup
state: present
- name: set-user-group
check_point.mgmt.cp_mgmt_user_group:
email: myusergroup123@email.com
name: myusergroup
state: present
- name: delete-user-group
check_point.mgmt.cp_mgmt_user_group:
name: myusergroup
state: absent