cp_mgmt_set_ha_state
Switch domain server high availability state through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_set_ha_state
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Switch domain server high availability state 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. | |
| ignore_errors | bool | Apply changes ignoring errors. Available from R81.20 management version. | ||
| new_state | str | Domain server new state. | ||
| 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-ha-state
check_point.mgmt.cp_mgmt_set_ha_state:
new_state: active