vsx_util

Description

Performs various VSX Virtual System Extension. Check Point virtual networking solution, hosted on a computer or cluster with virtual abstractions of Check Point Security Gateways and other network devices. These Virtual Devices provide the same functionality as their physical counterparts. maintenance tasks.

You run this command from the Expert mode on the Management Server Check Point Single-Domain Security Management Server or a Multi-Domain Security Management Server. (Security Management Server Dedicated Check Point server that runs Check Point software to manage the objects and policies in a Check Point environment within a single management Domain. Synonym: Single-Domain Security Management Server., or a Main Domain Management Server on Multi-Domain Server Dedicated Check Point server that runs Check Point software to host virtual Security Management Servers called Domain Management Servers. Synonym: Multi-Domain Security Management Server. Acronym: MDS.).

Important - Before you run the vsx_util commands:

Back up the VSX environment. See sk100395: How to backup and restore VSX gateway.
You must close all SmartConsole Check Point GUI application used to manage a Check Point environment - configure Security Policies, configure devices, monitor products and events, install updates, and so on. clients. Failure to do so may result in a database lock error.

Syntax

vsx_util -h

vsx_util <Command> [-s <Mgmt Server>] [-u <UserName>] [-c <Name of VSX Object>] [-m <Name of VSX Cluster Member>]

Parameters

Parameter	Description
`-h`	Shows the built-in usage.
`<Command>`	Specifies the `vsx_util` sub-command. See the table below.
`-s <Mgmt Server>`	Specifies the IP address or resolvable hostname of the Security Management Server, or Main Domain Management Server.
`-u <UserName>`	Specifies the administrator username.
`-c <Name of VSX Object>`	Specifies the name of the VSX Gateway Physical server that hosts VSX virtual networks, including all Virtual Devices that provide the functionality of physical network devices. It holds at least one Virtual System, which is called VS0. or VSX Cluster Two or more Security Gateways that work together in a redundant configuration - High Availability, or Load Sharing. object.
`-m <Name of VSX Cluster Member>`	Specifies the name of the VSX Gateway or VSX Cluster Member Security Gateway that is part of a cluster. object.

Important - The vsx_util command requires you to enter this information:

IP address or Hostname of the Security Management Server, or Main Domain Management Server.
Management Server Administrator user name and password.
The applicable VSX object, on which the command operates.
Most of the vsx_util sub-commands are interactive and require additional user input.

The 'vsx_util' sub-commands

Sub-command	Description
`vsx_util add_member`	Adds a new Cluster Member to a VSX Cluster and pushes the VSX Cluster configuration to the new VSX Cluster Member. See vsx_util add_member. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util change_interfaces`	Automatically replaces designated existing interfaces with new interfaces on all Virtual Devices, to which the existing interfaces connect. See vsx_util change_interfaces. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util change_mgmt_ip`	Changes the VSX Management IP address (within the same subnet) of a VSX Gateway or VSX Cluster Member. See vsx_util change_mgmt_ip. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util change_mgmt_subnet`	Changes (or adds) the VSX Management IP address of a VSX Gateway or VSX Cluster Member to a new subnet. See vsx_util change_mgmt_subnet. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util change_private_net`	Changes the IP address of the Internal Communication Network in a VSX Cluster. See vsx_util change_private_net. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util convert_cluster`	Converts the VSX Cluster mode between High Availability (default) and Virtual System Load Sharing VSX Cluster technology that assigns Virtual System traffic to different Active Cluster Members. Acronym: VSLS.. See vsx_util convert_cluster. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util downgrade`	Downgrades the version of a VSX Gateway or VSX Cluster in the management database. See vsx_util downgrade. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util reconfigure`	Restores VSX configuration on a VSX Gateway or VSX Cluster Member. See vsx_util reconfigure. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util remove_member`	Removes a Cluster Member from a VSX Cluster. See vsx_util remove_member. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util show_interfaces`	Shows configuration of selected interfaces - interface types, connections to Virtual Devices, and IP addresses. See vsx_util show_interfaces. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util upgrade`	Upgrades the version of a VSX Gateway or VSX Cluster in the management database. See vsx_util upgrade. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util view_vs_conf`	Shows configuration of a Virtual Device Logical object that emulates the functionality of a type of physical network object. Virtual Device can be on of these: Virtual Router, Virtual System, or Virtual Switch. on the Management Server versus the VSX Gateway or VSX Cluster. See vsx_util view_vs_conf. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).
`vsx_util vsls`	Shows the configuration menu for Virtual System Virtual Device on a VSX Gateway or VSX Cluster Member that implements the functionality of a Security Gateway. Acronym: VS. Load Sharing - see status, redistribute, export and import configuration. See vsx_util vsls. You run this command from the Expert mode on the Management Server (Security Management Server, or a MainDomain Management Server on Multi-Domain Server).

Notes

This command writes its messages to the vsx_util_YYYYMMDD_HH_MM.log file on the Management Server:

On a Security Management Server:

$FWDIR/log/vsx_util_YYYYMMDD_HH_MM.log

On a Multi-Domain Server - if executed the command in the MDS context:

/opt/CPsuite-R81/fw1/log/vsx_util_YYYYMMDD_HH_MM.log

On a Multi-Domain Server - if executed the command in the context of a Domain Management Server:

/opt/CPmds-R81/customers/<Name of Domain Management Server>/CPsuite-R81/fw1/log/vsx_util_YYYYMMDD_HH_MM.log

If it is necessary to exit from the vsx_util command's menu, press the CTRL C keys.

Important - Do not press these keys, it this command already started to perform a change. If you press these keys during the operation, the command does not save its log file.