virtual-machine

Installs, configures, and monitors the status of virtual machines
Note

Note

This command and its syntax is common to both the User Executable and Privilege Executable configuration modes.

Supported on the following platforms

Syntax

virtual-machine [assign-usb-ports|console|export|install|restart|set|start|stop|uninstall]
virtual-machine assign-usb-ports team-vowlan {on <DEVICE-NAME>}
virtual-machine export <VM-NAME> [<FILE>|<URL>] {on <DEVICE-NAME>}
virtual-machine install [<VM-NAME>|team-urc|team-rls|team-vowlan]
virtual-machine restart [<VM-NAME>|hard|team-urc|team-rls|team-vowlan]
virtual-machine set [autostart|memory|vcpus|vif-count|vif-mac|vif-to-vmif|vnc]
virtual-machine set [autostart [ignore|start]|memory <512-8192>|vcpus <1-4>|vif-count <0-2>|
vif-mac <VIF-INDEX> <MAC-INDEX>|vif-to-vmif <VIF-INDEX> <VMIF-INDEX>|vnc [disable|enable]] 
[<VM-NAME>|team-urc|team-rls|team-vowlan] {on <DEVICE-NAME>}

The following virtual-machine commands are supported only on the VX9000 platform:

virtual-machine volume-group [add-drive|replace-drive|resize-drive|resize-volume-group]
virtual-machine volume-group [add-drive|replace-drive] <BLOCK-DEVICE-LABEL>
virtual-machine volume-group replace-drive <BLOCK-DEVICE-LABLE> <NEW-BLOCK-DEVICE-LABEL>
virtual-machine volume-group resize-volume-group <BLOCK-DEVICE-LABEL>

Parameters

virtual-machine assign-usb-ports team-vowlan {on <DEVICE-NAME>}

assign-usb-ports team-vowlan

Assigns USB ports to TEAM-VoWLAN on a specified device

  • on <DEVICE-NAME> – Optional. Specify the device name.

Note: Use the no > virtual-machine > assign-usb-ports command to reassign the port to WiNG.
Note: TEAM-RLS VM cannot be installed when USB ports are assigned to TEAM-VoWLAN.
 
virtual-machine export <VM-NAME> [<FILE>|<URL>] {on <DEVICE-NAME>}

virtual-machine export

Exports an existing VM image and settings. Use this command to export the VM to another device in the same domain.

  • <VM-NAME> – Specify the VM name.

    • <FILE> – Specify the location and name of the source file (VM image). The VM image is retrieved and exported from the specified location.

    • <URL> – Specify the destination location. This is the location to which the VM image is copied. Use one of the following formats to provide the destination path:

      • tftp://<hostname|IP>[:port]/path/file

      • ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file

      • sftp://<user>:<passwd>@<hostname|IP>[:port]>/path/file

      • http://<hostname|IP>[:port]/path/file

  • on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices

    • <DEVICE-NAME> – Specify the service or virtual platform name. Use commas to seperate multiple device names.

Note: The VM should be in a stop state during the export process.
Note: If the destination is a device, the image is copied to a predefined location (VM archive).
 
virtual-machine install [<VM-NAME>|team-centro|team-rls|team-vowlan] {on <DEVICE-NAME>}

virtual-machine install

Installs the VM. The install command internally creates a VM template, consisting of the specified parameters, and starts the installation process.

  • <VM-NAME> – Specify the VM name.

  • team-centro – Installs the VM TEAM-Centro image
  • team-rls – Installs the VM TEAM-RLS image
  • team-vowlan – Installs the VM TEAM-VoWLAN image
Specify the device on which to install the VM.
  • on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
    • <DEVICE-NAME> – Specify the service or virtual platform name. Use commas to seperate multiple device names.
 
virtual-machine set [autostart [ignore|start]|memory <512-8192>|vcpus <1-4>|vif-count <0-2>|
vif-mac <VIF-INDEX> <MAC-INDEX>|vif-to-vmif <VIF-INDEX> <VMIF-INDEX>|vnc [disable|enable]] 
[<VM-NAME>|team-urc|team-rls|team-vowlan] {on <DEVICE-NAME>}

virtual-machine set

 Configures the VM settings
  • autostart – Specifies whether to autostart the VM on system reboot
    • ignore – Enables autostart on each system reboot
    • start – Disables autostart
  • memory – Defines the VM memory size
    • <512-8192> – Specify the VM memory from 512 - 8192 MB. The default is 1024 MB.
  • vcpus – Specifies the number of VCPUS for this VM
    • <1-4> – Specify the number of VCPUS from 1- 4.
  • vif-count – Configures or resets the VM's VIFs
    • <0-2> – Specify the VIF number from 0 - 2.
  • vif-mac – Configures the MAC address of the selected virtual network interface
    • <1-2> – Select the VIF
      • <1-8> – Specify the MAC index for the selected VIF
        • <MAC> – Specify the customized MAC address for the selected VIF in the AA-BB-CC-DD-EE-FF format.
Each VM has a maximum of two network interfaces (indexed 1 and 2, referred to as VIF). By default, each VIF is automatically assigned a MAC from the range allocated for that device. However, you can use the ‘set‘ keyword to specify the MAC from within the allocated range. Each of these VIFs are mapped to a layer 2 port in the dataplane (referred to as VMIF). These VMIFs are standard l2 ports on the DP bridge, supporting all VLAN and ACL commands. The WiNG software supports up to a maximum of 8 VMIFs. By default, a VM‘s interface is always mapped to VMIF1. You can map a VIF to any of the 8 VMIFs. Use the vif-to-vmif command to map a VIF to a VMIF on the DP bridge.
  • vif-to-vmif – Maps the virtual interface (1 or 2) to the selected VMIF interface. Specify the VMIF interface index from 1 - 8.

WiNG provides a dataplane bridge for external network connectivity for VMs. VM Interfaces define which IP address is associated with each VLAN ID the service or virtual platform is connected to and enables remote service or virtual platform administration. Each custom VM can have up to a maximum of two VM interfaces. Each VM interface can be mapped to one of the twelve ports for NX9500 on the dataplane bridge. This mapping determines the destination for service platform routing.

By default, VM interfaces are internally connected to the dataplane bridge via VMIF1. VMIF1, by default, is an untagged port providing access to VLAN 1 to support the capability to connect the VM interfaces to any of the VMIF ports. This provides the flexibility to move a VM interface onto different VLANs as well as configure specific firewall and QoS rules.
  • vnc – Disables/enables VNC port option for an existing VM. When enabled, provides remote access to VGA through the noVNC client.
    • disable – Disables VNC port
    • enable – Enables VNC port

      After configuring the VM settings, identify the VM to apply the settings.

  • <VM-NAME> – Applies these settings to the VM identified by the <VM-NAME> keyword. Specify the VM name.
  • team-urc – Applies these settings to the VM TEAM-URC
  • team-rls – Applies these settings to the VM TEAM-RLS
  • team-vowlan – Applies these settings to the VM TEAM-VoWLAN
 
virtual-machine start [<VM-NAME>|team-urc|team-rls|team-vowlan] {on <DEVICE-NAME>}
virtual-machine start Starts the VM, based on the parameters passed. Select one of the following options:
  • <VM-NAME> – Starts the VM identified by the <VM-NAME> keyword. Specify the VM name.
  • team-urc – Starts the VM TEAM-URC
  • team-rls – Starts the VM TEAM-RLS
  • team-vowlan – Starts the VM TEAM-VoWLAN

The following keywords are common to all of the above parameters:

  • on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
    • <DEVICE-NAME> – Specify the service or virtual platform name. Use commas to seperate multiple device names.
 
virtual-machine stop [<VM-NAME>|team-urc|team-rls|team-vowlan] {on <DEVICE-NAME>}

virtual-machine stop hard

 Stops the VM, based on the parameters passed. Select one of the following options:
  • <VM-NAME> – Stops the VM identified by the <VM-NAME> keyword. Specify the VM name.
  • team-urc – Stops the VM TEAM-URC
  • team-rls – Stops the VM TEAM-RLS team-vowlan – Stops the VM TEAM-VoWLAN

    The following keywords are common to all of the above parameters:

    • on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
      • <DEVICE-NAME> – Specify the service or virtual platform name. Use commas to seperate multiple device names.
Note: The option ‘hard‘ forces the selected VM to shutdown.
 
virtual-machine uninstall [<VM-NAME>|team-urc|team-rls|team-vowlan] {on <DEVICE-NAME>}

virtual-machine uninstall

 Uninstalls the specified VM
  • <VM-NAME> – Uninstalls the VM identified by the <VM-NAME> keyword. Specify the VM name.
  • team-urc – Uninstalls the VM TEAM-URC
  • team-rls – Uninstalls the VM TEAM-RLS team-vowlan – Stops the VM TEAM-VoWLAN

    The following keywords are common to all of the above parameters:

    • on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
      • <DEVICE-NAME> – Specify the service or virtual platform name. Use commas to seperate multiple device names.
Note: This command releases the VM‘s resources, such as memory, VCPUS, VNC port, disk space, and removes the RF Domain reference from the system.
 
virtual-machine volume-group [add-drive|resize-drive] <BLOCK-DEVICE-LABEL>
virtual-machine volume-group [add-drive|resize-drive] <BLOCK-DEVICE-LABEL>]

Enables provisioning of logical volume-groups on the CX9000 or VX9000 platform. Logical volume-groups are created on the primary storage device, allowing the database storage to be expanded to include additional storage drives. However, volume-groups can be provisioned only on new CX9000 or VX9000 installation and cannot be added to an existing CX9000 or VX9000 installation.

  • add-drive – Adds a new block-device to the VM. Note, currently a maximum of 3 (three) block devices can be added. To add a new drive, first halt the VM, In the Hypervisor, add a new storage disk to the VM and restart the VM. Once the VM comes up, use this command to add the new drive. To identify the new drive execute the 
    show > virtual-machine > volume-group > status
    command.
  • resize-drive - Resizes a drive in the VM‘s volume group. To increase the size of a drive in the volume-group, first halt the VM. In the Hypervisor, increase the size of the existing secondary storage drive and restart the VM. Once the VM comes up, use this command to resize the drive. To identify the drive with the additional free space, execute the show > virtual-machine > volume-group > status command.

    The following keyword is common to all of the above parameters:

    • <BLOCK-DEVICE-LABEL> –Specify the block-device label to be added or resized depending on the action being performed. 
virtual-machine volume-group replace-drive <BLOCK-DEVICE-LABEL> <NEW-BLOCK-DEVICE-LABEL>
virtual-machine volume-group replace-drive <BLOCK-DEVICE-LABEL> <NEW-BLOCK-DEVICE-LABEL>]

Enables provisioning of VMs as logical volume-groups on the CX9000 or VX9000 platform. Logical volume-group VMs are created on the primary storage device, allowing the database storage to be expanded to include additional storage drives.

  • replace-drive – Replaces an existing block-device with a new block-device in a volume-group. To replace a drive in the volume-group, first halt the VM. In the Hypervisor, add the new drive and restart the VM. Once the VM comes up, use this command to replace an existing drive with the new drive. To identify the drive with the additional free space, execute the show > virtual-machine > volume-group > status command
    • <BLOCK-DEVICE-LABEL> –Specify the block-device label to be replaced.
      • <BLOCK-DEVICE-LABEL> – Specify the replacement block-device label.
 
virtual-machine volume-group resize-volume-group <BLOCK-DEVICE-LABEL>
virtual-machine volume-group resize-volume-group <BLOCK-DEVICE-LABEL>

Enables provisioning of VMs as logical volume-groups on the CX9000 or VX9000 platform. Logical volume-group VMs are created on the primary storage device, allowing the database storage to be expanded to include additional storage drives.

  • resize-volume-group – Adds drive space to an existing block-device in the volume-group
    • <BLOCK-DEVICE-LABEL> –Specify the block-device label to which additional drive space is to be provided

Examples

The following examples show the VM installation process:

Insatllation media: USB

<DEVICE>#virtual-machine install <VM-NAME> type iso disk-size 8 install-media usb1://vms/win7.iso autostart start memory 512 vcpus 3 vif-count 2 vnc enable

Installation media: pre-installed disk image

<DEVICE>#virtual-machine install <VM-NAME> type disk install-media flash:/vms/win7_disk.img autostart start memory 512 vcpus 3 vif-count 2 vnc-enable  on <DEVICE-NAME>
In the preceding example, the command is executed on the device identified by the <DEVICE-NAME> keyword. In such a scenario, the disk-size is ignored if specified. The VM has the install media as first boot device.

Installation media: VM archive

<DEVICE>#virtual-machine install type vm-archive install-media flash:/vms/<VM-NAME> vcpus 3
In the preceding example, the default configuration attached with the VM archive overrides any parameters specified.

Exporting an installed VM: 

<DEVICE>#virtual-machine export <VM-NAME> <URL> on <DEVICE-NAME>
In the preceding example, the command copies the VM archive on to the URL (VM should be in stop state).
<DEVICE>>virtual-machine install team-urc
Virtual Machine install team-urc command successfully sent.
<DEVICE>>
VX-DE6F97>cirtual-machine add-drive sdb
VX-DE6F97>show virtual-machine volume-group status
-----------------------------------------
Logical Volume: lv1
-----------------------------------------
 STATUS           : available
 SIZE             : 81.89 GiB
 VOLUME GROUP     : vg0
 PHYSICAL VOLUMES :
     sda10        : 73.90 GiB
     sdc1         : 8.00 GiB
 AVAILABLE DISKS  :
     sdb          : size: 8590MB
-----------------------------------------
* indicates a drive that must be resized
-----------------------------------------
VX-DE6F97>
9037762-01 Rev AA