cp_mgmt_vsx_provisioning_tool

Run the VSX provisioning tool with the specified parameters through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_vsx_provisioning_tool

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

Synopsis

Run the VSX provisioning tool with the specified parameters through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Default	Description
add_physical_interface_params	dict		Parameters for the operation to add a physical interface to a VSX gateway or VSX Cluster.
add_route_params	dict		Parameters for the operation to add a route to a Virtual System or Virtual Router.
add_vd_interface_params	dict		Parameters for the operation to add a new interface to a Virtual Device.
add_vd_params	dict		Parameters for the operation to add a new Virtual Device (VS/VSB/VSW/VR).
add_vsx_cluster_params	dict		Parameters for the operation to add a new VSX Cluster.
add_vsx_gateway_params	dict		Parameters for the operation to add a new VSX Gateway.
attach_bridge_params	dict		Parameters for the operation to attach a new bridge interface to a Virtual System.
auto_publish_session	bool	`false`	Publish this owned session explicitly after the operation; default false.
operation	str		The name of the provisioning operation to run. Each operation has its own specific parameters. The available operations are, add-vsx-gateway - Adds a new VSX gateway add-vsx-cluster - Adds a new VSX cluster* add-vsx-cluster-member - Adds a new VSX cluster member* add-vd - Adds a new Virtual Device (VS/VSB/VSW/VR) to a VSX gateway or VSX cluster add-vd-interface - Adds a new virtual interface to a Virtual Device add-physical-interface - Adds a physical interface to a VSX gateway or VSX cluster add-route - Adds a route to a Virtual Device attach-bridge - Attaches a bridge interface to a Virtual System remove-vsx - Removes a VSX gateway or VSX cluster remove-vd - Removes a Virtual Device remove-vd-interface - Removes an interface from a Virtual Device remove-physical-interface - Removes a physical interface from a VSX gateway or VSX cluster remove-route - Removes a route from a Virtual Device set-vd - Modifies a Virtual Device set-vd-interface - Modifies an interface on a Virtual Device set-physical-interface - Modifies a physical interface on a VSX cluster or VSX gateway * When adding a VSX Cluster, you must also add at least 2 cluster members * Adding cluster members is only allowed when adding a new VSX cluster * To add members to an existing cluster, use vsx-run-operation.
remove_physical_interface_params	dict		Parameters for the operation to remove a physical interface from a VSX (Gateway or Cluster).
remove_route_params	dict		Parameters for the operation to remove a route from a Virtual System or Virtual Router.
remove_vd_interface_params	dict		Parameters for the operation to remove a logical interface from a Virtual Device.
remove_vd_params	dict		Parameters for the operation to remove a Virtual Device.
remove_vsx_params	dict		Parameters for the operation to remove a VSX Gateway or VSX Cluster.
set_physical_interface_params	dict		Parameters for the operation to change the configuration of a physical interface.
set_vd_interface_params	dict		Parameters for the operation to change the configuration of a logical interface.
set_vd_params	dict		Parameters for the operation to change the configuration of a Virtual Device.
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-provisioning-tool
  check_point.mgmt.cp_mgmt_vsx_provisioning_tool:
    add_vsx_cluster_params:
      cluster_type: vsls
      ipv4_address: 10.1.1.15
      members:
        - ipv4_address: 10.1.1.1
          name: VSX1
          sic_otp: sicotp123
          sync_ip: 192.168.1.1
        - ipv4_address: 10.1.1.2
          name: VSX2
          sic_otp: sicotp123
          sync_ip: 192.168.1.2
      rule_drop: enable
      rule_ping: enable
      sync_if_name: eth3
      sync_netmask: 255.255.255.0
      vsx_version: R81.10
      vsx_name: VSX_CLUSTER
    operation: add-vsx-cluster