Print Download PDF Send Feedback

Previous

Next

vsx_provisioning_tool

Description

This utility adds or removes Virtual Devices, interfaces, and routes.

Run the vsx_provisioning_tool command on a Multi-Domain Server (in the context of the applicable Domain Management Server), or Security Management Server.

Syntax

vsx_provisioning_tool -h

vsx_provisioning_tool [-s <Server>] {-u <User> | -c <Certificate>} -p <Password>

-o <Commands> [-a] -L

-f <Input File> [-l <Line>] [-a] -L

Parameters

Parameter

Description

-h

Shows the built-in usage.

-s <Server>

Specifies the Management Server.

Enter IPv4 or IPv6 address, or resolvable hostname name of the Security Management Server or the applicable Domain Management Server.

This parameter is mandatory when you run the utility:

  • From a SmartConsole computer
  • On a Multi-Domain Server.

-u <User>

Specifies the Management Server administrator's user name.

-c <Certificate>

Specifies the path and the name for the Management Server administrator's certificate file.

-p <Password>

Specifies the password of the:

  • Management Server administrator
  • Certificate file

-o <Commands>

Executes the commands you enter on the command line.

-f <Input File>

Specifies the path and the name for the file with the commands to execute.

The utility treats all text begins with a hash sign (#) as a comment and ignores it.

This lets you add comments on separate lines, or in-line.

-l <Line>

Specifies the line number in <Input File>, from which to start to execute the commands.

You can use this "-l" parameter only together with the "-f" parameter.

-a

Specifies that before the utility executes the specified commands, it must make sure it can connect to all VSX Gateways.

Note - This does not guarantee that a VSX Gateway can successfully apply all the specified commands.

-L

Specifies local authentication mode.

Exit Codes

Exit Code

Description

0

The utility successfully applied all changes, on all cluster members.

1

The utility successfully applied all changes to the management database, but not to all VSX members.

2

The utility successfully applied all changes, but SIC communication failed to establish with at least one cluster member.

3

Connectivity test failed with at least one cluster member (if you used the "-a" parameter).

The utility did not apply changes to the management database, or to the VSX Gateways.

4

The utility failed to apply changes (due to internal error, syntax error, or another reason).

If commands are executed from a file with multiple transactions, the exit code refers to the last transaction processed.

Example 1

Run the utility on the Security Management Server.

Execute the commands from the text /var/log/vsx.txt file.

vsx_provisioning_tool –s localhost -u admin -p mypassword -f /var/log/vsx.txt

Example 2

Run the utility on the Security Management Server.

Create a new Virtual System object called VS1 on the cluster object called VSX1

In the new Virtual System object, on the interface eth4, add a VLAN interface with VLAN ID 100 and IPv4 address 1.1.1.1/24.

vsx_provisioning_tool –s localhost –u admin –p mypassword –o add vd name VS1 vsx VSX1, add interface name eth4.100 ip 1.1.1.1/24