vsx_util

Description

Performs various VSX maintenance tasks.

You run this command from the Expert mode on the Management Server (Security Management Server, or a Main Domain Management Server on Multi-Domain Server).

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 clients. Failure to do so may result in a database lock error.
On a Multi-Domain Security Management Server, you must switch to the context of the Main Domain Management Server that manages the VSX Gateway / VSX Cluster object.

Use the command "mdsenv <IP Address or Name of Domain Management Server>".

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 or VSX Cluster object.
`-m <Name of VSX Cluster Member>`	Specifies the name of the VSX Gateway or VSX Cluster Member 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. 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 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 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-R82/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-R82/customers/<Name of Domain Management Server>/CPsuite-R82/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.