check_point.mgmt.cp_mgmt_vsx_run_operation module – Run the VSX operation by its name and parameters.
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install check_point.mgmt
.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_vsx_run_operation
.
New in check_point.mgmt 5.0.0
Synopsis
Run the VSX operation by its name and parameters.
An automatic session publish is part of all the operations in this API.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Parameters for the operation to add a VSX Cluster member. |
|
The IPv4 address of the management interface of the VSX Cluster member. |
|
The IPv4 address of the sync interface of the VSX Cluster member. |
|
Name of the new VSX Cluster member object. |
|
Name of the VSX Cluster object. |
|
UID of the VSX Cluster object. |
|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Parameters for the operation to downgrade a VSX Gateway or VSX Cluster object to a lower version.<br>In case the current version is already the target version, or is lower than the target version, no change is done. |
|
The target version. |
|
Name of the VSX Gateway or VSX Cluster object. |
|
UID of the VSX Gateway or VSX Cluster object. |
|
The name of the operation to run. Each operation has its specific parameters.<br>The available operations are,<ul><li><i>upgrade</i> - Upgrades the VSX Gateway or VSX Cluster object to a higher version</li><li><i>downgrade</i> - Downgrades the VSX Gateway or VSX Cluster object to a lower version</li><li><i>add-member</i> - Adds a new VSX Cluster member object</li><li><i>remove-member</i> - Removes a VSX Cluster member object</li><li><i>reconf-gw</i> - Reconfigures a VSX Gateway after a clean install</li><li><i>reconf-member</i> - Reconfigures a VSX Cluster member after a clean install</li></ul>. Choices:
|
|
Parameters for the operation to reconfigure a VSX Gateway after a clean install. |
|
Number of IPv4 CoreXL Firewall instances on the target VSX Gateway.<br>Valid values,<br><ul><li>To configure CoreXL Firewall instances, enter an integer greater or equal to 2.</li><li>To disable CoreXL, enter 1.</li></ul>. |
|
A password required for establishing a Secure Internal Communication (SIC). Enter the same password you used during the First Time Configuration Wizard on the target VSX Gateway. |
|
Name of the VSX Gateway object. |
|
UID of the VSX Gateway object. |
|
Parameters for the operation to reconfigure a VSX Cluster member after a clean install. |
|
Number of IPv4 CoreXL Firewall instances on the target VSX Cluster member.<br>Valid values,<br><ul><li>To configure CoreXL Firewall instances, enter an integer greater or equal to 2.</li><li>To disable CoreXL, enter 1.</li></ul>Important - The CoreXL configuration must be the same on all the cluster members. |
|
Name of the VSX Cluster member object. |
|
UID of the VSX Cluster member object. |
|
A password required for establishing a Secure Internal Communication (SIC). Enter the same password you used during the First Time Configuration Wizard on the target VSX Cluster member. |
|
Parameters for the operation to remove a VSX Cluster member object. |
|
Name of the VSX Cluster member object. |
|
UID of the VSX Cluster member object. |
|
Parameters for the operation to upgrade a VSX Gateway or VSX Cluster object to a higher version.<br>In case the current version is already the target version, or is higher than the target version, no change is done. |
|
The target version. |
|
Name of the VSX Gateway or VSX Cluster object. |
|
UID of the VSX Gateway or VSX Cluster object. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: vsx-run-operation
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint vsx-run-operation output. Returned: always. |