check_point.mgmt.cp_mgmt_set_ha_state (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Switch domain server high availability state. </br>After switching domain server to standby state, the session expires and you need to login again. <br/>You can run this command from a user or global domain on Multi Domain Server and from the user domain on Security Management Server.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set-ha-state
  cp_mgmt_set_ha_state:
    new_state: active

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

new_state:
    choices:
    - active
    - standby
    description:
    - Domain server new state.
    type: str

ignore_errors:
    description:
    - Apply changes ignoring errors.
    type: bool

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_set_ha_state:
  description: The checkpoint set-ha-state output.
  returned: always.
  type: dict