Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Specifying vMX Configuration File Parameters

 

The parameters required to configure vMX are defined in the startup configuration file. The configuration file is in YAML format. The default file is config/vmx.conf. You can save your configuration file to a different name for different instances.

Note

You must set up these three interfaces to launch the VFP.

  • Management access

  • Bridge for internal communication between the VCP and VFP

  • WAN interface (minimum of one)

Starting in Junos OS Release 18.1, to configure the vMX instance, download and modify the startup configuration file (vmx.conf).

  1. Download the vMX software package as root and uncompress the package.

    tar xzvf package-name

  2. Change directory to the location of the uncompressed vMX package.

    cd package-location

  3. Edit the config/vmx.conf text file with a text editor to configure a single vMX instance and save the file.

To customize the configuration, perform these tasks:

Configuring the Host

To configure the host environment, you must change the identifier for each vMX instance and you must provide the correct path for the images.

To configure the host, navigate to Host and specify the following parameters:

Parameter

Description

identifier

Name of the vMX instance, maximum of four alphanumeric characters.

host-management-interface

Name of the physical NIC on the host device that is used for management access (eth0).

Note: The interfaces for HOST:host-management-interface, CONTROL_PLANE, and FORWARDING_PLANE must be on the same subnet.

routing-engine-image

Absolute path to the junos-vmx-x86-64-*.qcow2 file for launching VCP.

routing-engine-hdd

Absolute path to the vmxhdd.img file for VCP storage.

forwarding-engine-image

Absolute path to the vFPC-*.img file for launching VFP.

make-local-copy-of-images

(Optional) Makes a local copy of the VCP and VFP images and uses the local copy to launch vMX. Default value is yes.

Note: Copy the image file from its default location to ensure that the scripts do not try to use the same image file concurrently.

make-local-copy-of-vmxhdd

(Optional) Makes a local copy of the VCP storage image and uses the local copy to launch vMX. Default value is yes.

Note: Copy the image file from its default location to ensure that the scripts do not try to use the same image file concurrently.

Configuring the VCP VM

To configure the VCP VM, you must change the IP address and you must make sure the console port is not being used by another vMX instance or another server.

To configure the VCP VM, navigate to CONTROL_PLANE and specify the following parameters:

Note

Starting in Junos OS Release 18.1 If you are deploying across multiple servers (for example, one server as the RE and one server as the PFE), and you would like to disable VCP for the Control Plane on the server, you have the option to specify none.

Parameter

Description

vcpus

Number of vCPUs for the VCP, default is 1. Starting in Junos OS Release 18.1, If you are deploying dual VCP instances, you must double the number of vCPUs.

memory-mb

Amount of memory for the VCP, default is 2 GB.

In Junos OS Release 15.1F6, amount of memory for the VCP; minimum is 4 GB (performance mode) and 1 GB (lite mode).

console_port

KVM TCP-based console port. It must be a unique number.

deploy

(Optional) VCP instance to deploy on this host. Specify the number of the instance; first instance is 0, second instance is 1, and multiple instances are separated by a comma. If you do not specify this parameter, both instances (0,1) are deployed on this host. If none is set, no VCP instance will be deployed on this host.

Note: When deploying on separate hosts, you must set up a connection between the hosts for the VCPs to communicate.

console_listen

(Optional) IP address for the interface from which the console can be accessed; default is 127.0.0.1, which only allows access from within the host. To allow access from any interfaces, specify 0.0.0.0.

instance (starting in Junos OS Release 18.1)

VCP instance. Navigate to interfaces > type (static) and include this parameter below it.

(Optional) Create the second instance below the first instance and include the console_port parameter for the second instance. The parameters for specifying both VCP instances might resemble the following:

    interfaces  :
      - type      : static
        instance  : 0
        ipaddr    : 10.102.144.94 
        macaddr   : "0A:00:DD:C0:DE:0E"

      - type        : static
        instance    : 1
        console_port: 8612
        ipaddr      : 10.102.144.95 
        macaddr     : "0A:00:DD:C0:DE:0F"

ipaddr

Management IP address for the VCP VM (fxp0). Navigate to interfaces > type (static) > ipaddr to modify this parameter.

Note: The interfaces for HOST:host-management-interface, CONTROL_PLANE, and FORWARDING_PLANE must be on the same subnet.

Configuring the VFP VM

Before you configure the VFP VM, consider the following:

  • You must make sure the console port is not being used by another vMX instance or another server.

  • To disable network access to the VFP console, do not configure an IP address.

  • Based on your requirements, you might want to change the memory, number of vCPUs, and the device type. See Sample Configurations for Use Cases for some sample configuration requirements.

Note

Starting in Junos OS Release 18.1 if you are deploying across multiple servers (for example, one server as the RE and one server as the PFE), and you need to disable VFP for the Forwarding Plane on the server, you have the option to specify none.

To configure the VFP VM, navigate to FORWARDING_PLANE and specify the following parameters:

Parameter

Description

memory-mb

Amount of memory for the VFP, default is 6 GB.

vcpus

Number of vCPUs for the VFP, default is 3.

console_port

KVM TCP-based console port. It must be a unique number.

deploy

(Optional) VFP instance to deploy on this host. Specify the number of the instance; first instance is 0, second instance is 1, and multiple instances are separated by a comma. If you do not specify this parameter, both instances (0,1) are deployed on this host. If none is set, no VFP instance will be deployed on this host.

Note: When deploying on separate hosts, you must set up a connection between the hosts for the VFPs to communicate.

console_listen

(Optional) IP address for the interface from which the console can be accessed; default is 127.0.0.1, which only allows access from within the host. To allow access from any interfaces, specify 0.0.0.0.

device-type

NIC interface type, either sriov or virtio. If you are configuring both virtio and SR-IOV interfaces, specify mixed.

ipaddr

Management IP address for the VFP VM (eth0). Navigate to interfaces > type (static) > ipaddr to modify this parameter.

Note: The interfaces for HOST:host-management-interface, CONTROL_PLANE, and FORWARDING_PLANE must be on the same subnet.

use_native_drivers

Set to true to allow using the host’s driver.

Note: As in Junos OS Release 18.4R1 (Ubuntu host) and Junos OS Release 19.1R1 (Redhat host), you can set the use_native_drivers value to true to use the latest unmodified drivers for your network interface cards for vMX installations.

To configure the VFP VM, navigate to FORWARDING_PLANE and specify the following parameters (supported in Junos OS Release 15.1F6):

Parameter

Description

memory-mb

Amount of memory for the VFP; minimum is 12 GB (performance mode) and 4 GB (lite mode).

vcpus

Number of vCPUs for the VFP; minimum is 7 (performance mode) and 3 (lite mode).

console_port

KVM TCP-based console port. It must be a unique number.

console_listen

(Optional) IP address for the interface from which the console can be accessed; default is 127.0.0.1, which only allows access from within the host. To allow access from any interfaces, specify 0.0.0.0.

device-type

NIC interface type, either sriov or virtio.

ipaddr

Management IP address for the VFP VM (eth0). Navigate to interfaces > type (static) > ipaddr to modify this parameter.

Note: The interfaces for HOST:host-management-interface, CONTROL_PLANE, and FORWARDING_PLANE must be on the same subnet.

Configuring Interfaces

The JUNOS_DEVICES interface names correspond to the Linux physical NIC names on the host. Bring up the Linux physical NIC ports that are defined in this section before proceeding. For example, use the ifconfig eth9 up command to bring up the NIC ports on the eth9 interface.

To configure interfaces for virtio device types, you must specify the interface and the MAC address. You can bind virtio devices to connect virtio NICs in the vMX to physical NICs or virtio NICs in another vMX (see Binding virtio Devices).

To configure interfaces for SR-IOV device types, you must specify the interface, the NIC, and the MAC address.

To configure the routed interfaces, navigate to JUNOS_DEVICES and specify the following parameters:

Parameter

Description

interface

Name of the interface on the vMX.

Note: The interface names that are defined in the vmx.conf file must be contiguous starting from ge-0/0/0. The total number of interfaces supported is 23 for configurations running in performance mode. If you are running virtio interfaces in lite mode, you can use up to 96 interfaces.

type (supported in Junos OS Release 17.2 onwards)

NIC interface type, either sriov or virtio.

Note: If you are configuring both interface types, you must specify the virtio interfaces before the SR-IOV interfaces.

port-speed-mbps

(SR-IOV only) Port speed for the physical NIC, default is 10000 Mbps.

nic

(SR-IOV only) Name of the physical NIC.

Note: Depending on the version of udev, you can rename the classic Linux standard ethXX names. See Predictable Network Interface Names for more information.

mtu

(SR-IOV only) MTU value, default is 2000 and maximum is 9500.

To change the MTU configuration for virtio device types, modify the mtu parameter in the device binding file (vmx-junosdev.conf).

virtual-function

(SR-IOV only) Child unit of the physical NIC, default is 0.

(SR-IOV only) Virtual function number of the physical NIC; default is 0 (supported in Junos OS Release 15.1F5 and earlier releases).

mac-address

Unicast MAC address for the physical NIC.

description

Description of the mapping.

Release History Table
Release
Description
Starting in Junos OS Release 18.1 If you are deploying across multiple servers (for example, one server as the RE and one server as the PFE), and you would like to disable VCP for the Control Plane on the server, you have the option to specify none.
Starting in Junos OS Release 18.1 if you are deploying across multiple servers (for example, one server as the RE and one server as the PFE), and you need to disable VFP for the Forwarding Plane on the server, you have the option to specify none.