cp_mgmt_set_api_settings
Edit API settings, the changes will be applied after publish followed by running 'api restart' command through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_set_api_settings
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Edit API settings, the changes will be applied after publish followed by running ‘api restart’ command through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| accepted_api_calls_from | str | Clients allowed to connect to the API Server. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| 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-api-settings
check_point.mgmt.cp_mgmt_set_api_settings:
accepted_api_calls_from: 'all ip addresses'