cp_mgmt_vsx_run_operation

Run the VSX operation by its name and parameters through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_vsx_run_operation

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Run the VSX operation by its name and parameters through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Default	Description
add_member_params	dict		Parameters for the operation to add a VSX Cluster member.
auto_publish_session	bool	`false`	Publish this owned session explicitly after the operation; default false.
downgrade_params	dict		Parameters for the operation to downgrade a VSX Gateway or VSX Cluster object to a lower version. In case the current version is already the target version, or is lower than the target version, no change is done.
operation	str		The name of the operation to run. Each operation has its specific parameters. The available operations are, upgrade - Upgrades the VSX Gateway or VSX Cluster object to a higher version downgrade - Downgrades the VSX Gateway or VSX Cluster object to a lower version add-member - Adds a new VSX Cluster member object remove-member - Removes a VSX Cluster member object reconf-gw - Reconfigures a VSX Gateway after a clean install reconf-member - Reconfigures a VSX Cluster member after a clean install .
reconf_gw_params	dict		Parameters for the operation to reconfigure a VSX Gateway after a clean install.
reconf_member_params	dict		Parameters for the operation to reconfigure a VSX Cluster member after a clean install.
remove_member_params	dict		Parameters for the operation to remove a VSX Cluster member object.
upgrade_params	dict		Parameters for the operation to upgrade a VSX Gateway or VSX Cluster object to a higher version. In case the current version is already the target version, or is higher than the target version, no change is done.
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: vsx-run-operation
  check_point.mgmt.cp_mgmt_vsx_run_operation:
    add_member_params:
      ipv4_address: 25.25.25.223
      ipv4_sync_address: 20.20.20.223
      member_name: Mem3
      vsx_name: VSX_CLUSTER
    operation: add-member