cp_mgmt_set_gateway_global_use
Enable or disable global usage on a specific target through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_set_gateway_global_use
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Enable or disable global usage on a specific target 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. | |
| enabled | bool | yes | Indicates whether global use is enabled on the target. | |
| target | str | yes | On what target to execute this command. Target may be identified by its object name, or object unique identifier. | |
| 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: set-gateway-global-use
check_point.mgmt.cp_mgmt_set_gateway_global_use:
enabled: true
target: vpn_gw