How to Use VMware OVF Tool for vApp

Document created by Qualys Documentation Employee on Aug 5, 2019Last modified by Qualys Documentation Employee on Aug 5, 2019
Version 3Show Document
  • View in full screen mode

For customers using Qualys Virtual Scanner Appliance in VMware vSphere (vCenter), this document describes how to use the VMware OVF Tool to deploy, save and query virtual machines and OVF packages. The OVF Tool is available from the VMware website. We suggest you check ovftool --help examples.

 

We also recommend: Deploying Qualys Virtual Scanner Appliance in VMware vSphere (vCenter)

 

 

Accessing vCenter or ESXi

~]# ovftool --X:logFile=ovftool-log.txt --X:logLevel=verbose vi://[user[:pass]@]vCenter FQDN|IP/location/folder/

Error: Found wrong kind of object (Datacenter). Possible completions are:

  vm/

  host/

 

This error indicates that it can connect to the vCenter but it needs more information on ‘datacenter’. It suggests what you could use to complete the command. In this case, the suggestion is to add vm/ or host/ at the end of the vcenter path.

 

List all ESXi hosts on a vCenter

# ovftool --X:logFile=ovftool-log.txt --X:logLevel=verbose vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/

Error: Found wrong kind of object (Folder). Possible completions are:

  ESXi1.qualys.com/

  ESXi2.qualys.com/

  ESXi3.qualys.com/

 

If you didn’t provide an ESXi hostname then you’ll see suggestions listed.

 

List all VMs on a particular ESXi host

~]# ovftool --X:logFile=ovftool-log.txt --X:logLevel=verbose vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com/Resources/

Error: Found wrong kind of object (ResourcePool). Possible completions are:

  VM-instance1

  VM-instance2

  VM-instance3

 

Check VM details

Note – The virtual machine needs to be switched off to pull this data.  

# ovftool --X:logFile=ovftool-log.txt --X:logLevel=verbose vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com/Resources/VM-instance1

OVF version:   1.0

VirtualApp:    false

Name:          Qualys Virtual Scanner Appliance

Version:       1.2.3-4

Full Version:  qVSA-1.2.3-4

Vendor:        Qualys, Inc.

Product URL:   http://www.qualys.com

Vendor URL:    http://www.qualys.com

 

Annotation:  Qualys Virtual Scanner Appliance - VMware vSphere vApp,

             build:qVSA-1.2.3-4

 

Download Size:  Unknown

 

Deployment Sizes:

  Flat disks:   56.00 GB

  Sparse disks: Unknown

 

Networks:

  Name:        My-Network

  Description: The WAN-Network network

 

Virtual Machines:

  Name:               VM-instance1

  Operating System:   rhel6guest

  Virtual Hardware:

    Families:         vmx-08

    Number of CPUs:   1

    Cores per socket: 1

    Memory:           2.00 GB

 

    Disks:

      Index:          0

      Instance ID:    8

      Capacity:       56.00 GB

      Disk Types:     SCSI-lsilogic

 

    NICs:

      Adapter Type:   E1000

      Connection:     My-Network

 

      Adapter Type:   E1000

      Connection:     My-Network

 

IP Allocation Policy:

  Schemes:     ovfenv dhcp

  Protocols:   IPv4

 

Checking vApp package deployment properties

# ovftool qVSA-1.2.3-4.vApp.ova

OVF version:   1.0

VirtualApp:    false

Name:          Qualys Virtual Scanner Appliance

Version:       1.2.3-4.vApp

Full Version:  qVSA-1.2.3-4.vApp

Vendor:        Qualys, Inc.

Product URL:   http://www.qualys.com

Vendor URL:    http://www.qualys.com

 

Annotation:  Qualys Virtual Scanner Appliance - VMware vSphere vApp,

             build:qVSA-1.2.3-4.vApp

 

Download Size:  958.63 MB

 

Deployment Sizes:

  Flat disks:   56.00 GB

  Sparse disks: 969.25 MB

 

Networks:

  Name:        LAN

  Description: The LAN interface services all network traffic unless the "Enable WAN Interface" property is selected. If WAN is enabled, only scanning traffic is routed through this interface.

 

  Name:        WAN

  Description: The WAN interface is used to service management traffic (software updates and health checks) if the "Enable WAN Interface" property is selected.

 

Virtual Machines:

  Name:               Qualys Virtual Scanner Appliance

  Operating System:   rhel5guest

  Virtual Hardware:

    Families:         vmx-07 vmx-08

    Number of CPUs:   1

    Cores per socket: 1

    Memory:           2.00 GB

 

    Disks:

      Index:          0

      Instance ID:    9

      Capacity:       56.00 GB

      Disk Types:     SCSI-lsilogic

 

    NICs:

      Adapter Type:   E1000

      Connection:     LAN

 

      Adapter Type:   E1000

      Connection:     WAN

 

Properties:

  Key:         Enable_WAN_Interface

  Category:    Application

  Label:       Enable WAN Interface

  Type:        boolean

  Description: By default the LAN interface services all network traffic. If the WAN interface is enabled, all software updates and health checks are routed through the WAN interface and scanning traffic is routed through the LAN interface.

  Value:       False

 

  Key:         Personalization_Code

  Category:    Application

  Label:       Personalization Code

  Type:        int(0..99999999999999)

  Description: A personalization code is required to power on and activate this virtual scanner. You received this code when you provisioned the virtual scanner using the Qualys UI. One personalization code may be configured for one virtual scanner appliance.

 

  Key:         LAN_IP

  Category:    Network

  Label:       LAN IP

  Type:        ip

  Value:       0.0.0.0

 

  Key:         LAN_Netmask

  Category:    Network

  Label:       LAN Netmask

  Type:        string

  Value:       255.255.255.0

 

  Key:         LAN_Gateway

  Category:    Network

  Label:       LAN Gateway

  Type:        ip

  Value:       0.0.0.0

 

  Key:         LAN_DNS_Servers

  Category:    Network

  Label:       LAN DNS Servers

  Type:        string

 

  Key:         LAN_Domain_Name

  Category:    Network

  Label:       LAN Domain Name

  Type:        string

 

  Key:         LAN_HTTP_Proxy

  Category:    Network

  Label:       LAN HTTP Proxy

  Type:        string

 

  Key:         WAN_IP

  Category:    Network

  Label:       WAN IP

  Type:        ip

  Value:       0.0.0.0

 

  Key:         WAN_Netmask

  Category:    Network

  Label:       WAN Netmask

  Type:        string

  Value:       255.255.255.0

 

  Key:         WAN_Gateway

  Category:    Network

  Label:       WAN Gateway

  Type:        ip

  Value:       0.0.0.0

 

  Key:         WAN_DNS_Servers

  Category:    Network

  Label:       WAN DNS Servers

  Type:        string

 

  Key:         WAN_Domain_Name

  Category:    Network

  Label:       WAN Domain Name

  Type:        string

 

  Key:         WAN_HTTP_Proxy

  Category:    Network

  Label:       WAN HTTP Proxy

  Type:        string

 

  Key:         LAN_Default_VLAN

  Category:    Network

  Label:       LAN Default VLAN

  Type:        int(0..4094)

  Description: If you connected the LAN interface to a 802.1q trunked port and need this Virtual Scanner to use VLAN tags on the LAN default network, enter the VLAN number here (1-4094). The value 0 disables 802.1q tagging.

  Value:       0

 

  Key:         WINS_1

  Category:    Scanner

  Label:       WINS 1

  Type:        ip

  Description: Configure a primary WINS address. This is used only if you are running Windows Internet Naming Service and the virtual scanner needs to use it for name resolution.

  Value:       0.0.0.0

 

  Key:         WINS_2

  Category:    Scanner

  Label:       WINS 2

  Type:        ip

  Description: Configure a secondary WINS address. This is used only if you are running Windows Internet Naming Service and the virtual scanner needs to use it for name resolution.

  Value:       0.0.0.0

 

IP Allocation Policy:

  Schemes:     ovfenv dhcp

  Protocols:   IPv4

 

Creating a Standard VM

This command will create a single network scanner on network “10 15-Network” and automatically power it on. You’ll see a progress percentage before it says Completed successfully. 

# ovftool --acceptAllEulas --name=test-instance --X:logFile=ovftool-log.txt --X:logLevel=verbose --powerOn -dm=thin --datastore=datastore1 --net:"LAN=LAN-Network" --net:"WAN=WAN-Network" qVSA-1.2.3-4.ova vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

 

Creating a vApp VM

Single network vApp image

This command will create a vApp instance in single network mode with network label “WAN-Network”. It’ll use the given perscode and automatically power on. Once powered on it’ll go ahead and personalize right away. You’ll see a progress percentage before it says Completed successfully. 

# ovftool --acceptAllEulas --name=Scanner-vapp --X:logFile=ovftool-log.txt --X:logLevel=verbose --powerOn -dm=thin --datastore=datastore1 --net:"LAN=LAN-Network" --net:"WAN=WAN-Network" --prop:Personalization_Code=12345678901234 qVSA-1.2.3-4.vApp.ova vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Opening OVA source: qVSA-1.2.3-4.vApp.ova

The manifest validates

Opening VI target: vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Deploying to VI: vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Transfer Completed

Powering on VM: Scanner-vapp

Task Completed

Completed successfully

~]#

 

Split Network vApp instance

This command will create a vApp instance in split network mode. It’ll use the given perscode and automatically power on. Once powered on it’ll go ahead and personalize right away. You’ll see a progress percentage before it says Completed successfully. 

# ovftool --acceptAllEulas --name=Scanner-vApp_split --X:logFile=ovftool-log.txt --X:logLevel=verbose --powerOn -dm=thin --datastore=datastore1 --net:"LAN=LAN-Network" --net:"WAN=WAN-Network" --prop:Enable_WAN_Interface=True --prop:Personalization_Code=12345678901234 qVSA.1.2.3-4.vApp.ova vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Opening OVA source: qVSA.1.2.3-4.vApp.ova

The manifest validates

Opening VI target: vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Deploying to VI: vi://[user[:pass]@]vCenter FQDN|IP/location/folder/host/ESXi1.qualys.com

Transfer Completed

Powering on VM: Scanner-vApp_split

Task Completed

Completed successfully

1 person found this helpful

Attachments

    Outcomes