cp_mgmt_trusted_client
Manages trusted-client 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_trusted_client
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages trusted-client 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. | ||
| domains_assignment | list | Domains to be added to this profile. Use domain name only. See example below, “add-trusted-client (with domain)”. | ||
| 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. | ||
| ip_address | str | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. | ||
| ip_address_first | str | First IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead. | ||
| ip_address_last | str | Last IP address in the range. If both IPv4 and IPv6 address ranges are required, use the ipv4-address-first and the ipv6-address-first fields instead. | ||
| ipv4_address | str | IPv4 address. | ||
| ipv4_address_first | str | First IPv4 address in the range. | ||
| ipv4_address_last | str | Last IPv4 address in the range. | ||
| ipv6_address | str | IPv6 address. | ||
| ipv6_address_first | str | First IPv6 address in the range. | ||
| ipv6_address_last | str | Last IPv6 address in the range. | ||
| mask_length | int | IPv4 or IPv6 mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. | ||
| mask_length4 | int | IPv4 mask length. | ||
| mask_length6 | int | IPv6 mask length. | ||
| multi_domain_server_trusted_client | bool | Let this trusted client connect to all Multi-Domain Servers in the deployment. | ||
| name | str | yes | Object name. | |
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| type | str | Trusted client type. | ||
| 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. | |
| wild_card | str | IP wild card (e.g. 192.0.2.*). |
Example
yaml
- name: add-trusted-client
check_point.mgmt.cp_mgmt_trusted_client:
name: my client
state: present
type: any
- name: set-trusted-client
check_point.mgmt.cp_mgmt_trusted_client:
ip_address: 192.0.2.1
mask_length: '24'
name: my client
state: present
type: ipv4 netmask
- name: delete-trusted-client
check_point.mgmt.cp_mgmt_trusted_client:
name: my client
state: absent