cp_mgmt_user_template
Manages user-template 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_template
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages user-template objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| allowed_locations | dict | User allowed locations. | ||
| authentication_method | str | Authentication method. | ||
| 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. | ||
| connect_daily | bool | Connect every day. | ||
| connect_on_days | list | Days users allow to connect. | ||
| 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. | ||
| encryption | dict | User encryption. | ||
| expiration_by_global_properties | bool | Expiration date according to global properties. | ||
| expiration_date | str | Expiration date in format, yyyy-MM-dd. | ||
| from_hour | str | Allow users connect from hour. | ||
| 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. | |
| radius_server | str | RADIUS server object identified by the name or UID. Must be set when “authentication-method” was selected to be “RADIUS”. | ||
| state | str | present | Desired object presence. | |
| tacacs_server | str | TACACS server object identified by the name or UID. Must be set when “authentication-method” was selected to be “TACACS”. | ||
| tags | list | Collection of tag identifiers. | ||
| to_hour | str | Allow users connect until hour. | ||
| 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-template
check_point.mgmt.cp_mgmt_user_template:
expiration_by_global_properties: 'False'
expiration_date: '2030-05-30'
name: myusertemplate
state: present
- name: set-user-template
check_point.mgmt.cp_mgmt_user_template:
expiration_by_global_properties: 'True'
name: myusertemplate
state: present
- name: delete-user-template
check_point.mgmt.cp_mgmt_user_template:
name: myusertemplate
state: absent