check_point.mgmt.cp_mgmt_vsx_run_operation (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

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.

Usage examples

Scanned by Steampunk Spotter

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

- 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

Inputs

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

operation:
    choices:
    - upgrade
    - downgrade
    - add-member
    - remove-member
    - reconf-gw
    - reconf-member
    description:
    - 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>.
    type: str

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

upgrade_params:
    description:
    - 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.
    suboptions:
      target_version:
        description:
        - The target version.
        type: str
      vsx_name:
        description:
        - Name of the VSX Gateway or VSX Cluster object.
        type: str
      vsx_uid:
        description:
        - UID of the VSX Gateway or VSX Cluster object.
        type: str
    type: dict

downgrade_params:
    description:
    - 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.
    suboptions:
      target_version:
        description:
        - The target version.
        type: str
      vsx_name:
        description:
        - Name of the VSX Gateway or VSX Cluster object.
        type: str
      vsx_uid:
        description:
        - UID of the VSX Gateway or VSX Cluster object.
        type: str
    type: dict

reconf_gw_params:
    description:
    - Parameters for the operation to reconfigure a VSX Gateway after a clean install.
    suboptions:
      ipv4_corexl_number:
        description:
        - 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>.
        type: int
      one_time_password:
        description:
        - 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.
        type: str
      vsx_name:
        description:
        - Name of the VSX Gateway object.
        type: str
      vsx_uid:
        description:
        - UID of the VSX Gateway object.
        type: str
    type: dict

add_member_params:
    description:
    - Parameters for the operation to add a VSX Cluster member.
    suboptions:
      ipv4_address:
        description:
        - The IPv4 address of the management interface of the VSX Cluster member.
        type: str
      ipv4_sync_address:
        description:
        - The IPv4 address of the sync interface of the VSX Cluster member.
        type: str
      member_name:
        description:
        - Name of the new VSX Cluster member object.
        type: str
      vsx_name:
        description:
        - Name of the VSX Cluster object.
        type: str
      vsx_uid:
        description:
        - UID of the VSX Cluster object.
        type: str
    type: dict

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

reconf_member_params:
    description:
    - Parameters for the operation to reconfigure a VSX Cluster member after a clean install.
    suboptions:
      ipv4_corexl_number:
        description:
        - 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.
        type: int
      member_name:
        description:
        - Name of the VSX Cluster member object.
        type: str
      member_uid:
        description:
        - UID of the VSX Cluster member object.
        type: str
      one_time_password:
        description:
        - 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.
        type: str
    type: dict

remove_member_params:
    description:
    - Parameters for the operation to remove a VSX Cluster member object.
    suboptions:
      member_name:
        description:
        - Name of the VSX Cluster member object.
        type: str
      member_uid:
        description:
        - UID of the VSX Cluster member object.
        type: str
    type: dict

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

Outputs

cp_mgmt_vsx_run_operation:
  description: The checkpoint vsx-run-operation output.
  returned: always.
  type: dict