Managing vMX

 
Note

Only English locale is supported for using the vmx.sh script.

After you install and deploy vMX, you can use the vmx.sh script with different options to perform these tasks:

Controlling vMX

When you are controlling vMX with the vmx.sh script, you can perform these tasks:

Deploying vMX

Note

You must be logged in as root to use the control options.

To deploy vMX, use these options with the vmx.sh script:

--cfg fileUse the specified vMX startup configuration file. The default file is config/vmx.conf.
--installStart vMX by setting up the environment, driver dependencies, and memory requirements and deploying the vMX. If you do not specify a startup configuration file with the --cfg option, the default file is used.
Note

If you cannot deploy vMX after upgrading libvirt, bring down the virbr0 bridge with the ifconfig virbr0 down command and delete the bridge with the brctl delbr virbr0 command.

This example deploys a new vMX instance specified by the my-vmx.cfg configuration file and provides verbose-level logging to a file:

Managing vMX Deployments

Note

You must be logged in as root to use the control options.

Use these options with the vmx.sh script to stop, start, restart, verify, and clean up an existing vMX:

--cfg fileUse the specified vMX startup configuration file. The default file is config/vmx.conf.
--cleanupStop vMX and clean up relevant information about the vMX instance. It also tears down the Linux bridges and other dependencies. If you do not specify a startup configuration file with the --cfg option, the default file is used.
--restartStop and start a running vMX. This option is useful for redeploying a vMX that has parameter changes in the startup configuration file. If you do not specify a startup configuration file with the --cfg option, the default file is used.
--startStart the vMX that was running and stopped. If you do not specify a startup configuration file with the --cfg option, the default file is used.
--statusVerify the status of a deployed vMX. If you do not specify a startup configuration file with the --cfg option, the default file is used.
--stopStop vMX without cleaning up build files so that the vMX can be started quickly without setup performed by the --install option.

This example tears down an existing vMX instance specified by the my-vmx.cfg configuration file:

Specifying the Temporary File Directory

Note

You must be logged in as root to use the control options.

To specify the directory used for temporary files, run the ./vmx.sh build directory script. The default directory is build/vmx-id, where vmx-id is the vMX identifier specified in the startup configuration file.

By default, copies of the VCP and VFP images are copied to this directory. We recommend that you do not change the make-local-copy-of-images and make-local-copy-of-vmxhdd parameters when specifying startup configuration file parameters for the host.

Specifying the Environment File

Note

You must be logged in as root to use the control options.

To specify the environment file (.env), run the ./vmx.sh env file script. The default file is env/ubuntu_sriov.env.

Configuring Logging Options for vMX

You can enable logging options. It is especially useful when used with the control options, such as --install.

Use these options to configure logging:

-lEnable logging to a file in the specified build directory. The default directory is build/vmx-id/logs, where vmx-id is the vMX identifier specified in the startup configuration file. By default, logging is disabled.
-lvEnable logging with verbose details.
-lvfEnable logging with verbose details to the foreground (standard output).

This example deploys a new vMX instance specified by the my-vmx.cfg configuration file and provides verbose-level logging to a file:

Connecting to Console Port for the VMs

Use these options with the vmx.sh script to connect to the console of the VCP or VFP of the specified vMX:

--console vcp [vmx-id]Connect to the console of the VCP for the specified vMX. The vMX identifier is specified in the startup configuration file.
--console vfp [vmx-id]Connect to the console of the VFP for the specified vMX. The vMX identifier is specified in the startup configuration file.

This example connects to the console of the VCP for the vMX instance specified by the vmx1 identifier:

Getting Help for the Script Options

To obtain on-line help for the vmx.sh script options, run the ./vmx.sh --help script.

Related Documentation