Virtualization Query Language Guide

• Examples
• Syntax
• Operators
• Keywords
• Types
• Object Reference
• API Usage

Syntax

• Filter specifications can use parenthetical grouping for the boolean logic
• Strings that do not contains spaces are not required to have quotes around them
• Strings can be quoted either with matching ' or " characters
• Specification of object, properties, operators, and keywords are case insensitive

Operators

Keywords

Types

Examples

type=host

vm.mem > 1024

vm.mem > 1024 AND vm.cpu = 2

vm.mem > 1024 AND vm.cpu = 2 project cluster

vm.mem > 1024 AND vm.cpu = 2 project cluster at 7 days ago

portgroup.vlan = 42 project vm

cluster.dpm_enabled = false

cluster.das_enabled = false project vm

vcdrom.is_connected project vm

datastore.percent_used > 80 project vdisk | vdisk.capacity_mb > 200000 project vm

software.name contains 'SQL Server' project vm

vms.name = 'vCenter Name' project host

pg.vlan = 42 project vnic | vnic.ips = '192.168.1.10' project vm

vm.tags contains quarantined

vm.name = 'Foo' AND vm.tags contains quarantine at 7 days ago

host.name = 'Foo' project vmknic

vm.name = 'Foo' project vnic

API Usage

1. Enable the Reflex VMC API
2. Java Example
   1. Create client side SOAP Proxy code
   2. Issue VQL Query in Java
3. Python Example
   1. Issue VQL Query in Python

Enable the Reflex VMC API

1. Log on to the VMC and go to the Administration tab
2. Open the 'Edit server configuration' dialog
3. Set 'core.api.enabled' to 'true' to expose the API externally
4. Set 'core.api.require.auth' to 'false' to turn off authentication for the API. This can be set to require authentication later
5. Set 'core.api.use.ssl' to 'false' to turn off SSL for the API. This can be set to encrypt network traffic later

Create client side Java SOAP Proxy code

VQL is a dynamic language in that some properties are dynamically added during the runtime of the system. VQL queries are issued through a SOAP method serviced by the Reflex VMC. Strongly typed VQL objects are provided via dynamically created XSD files embedded within the WSDL. The URL addresses for the WSDL as well as the actual SOAP service are:

• WSDL Address: http://<Reflex-VMC-DNS-or-IP>:8443/1.0/sdk?wsdl
• Service Address: http://<Reflex-VMC-DNS-or-IP>:8443/1.0/sdk

wsimport -keep "http://<VMC_server>:8443/1.0/sdk?wsdl"

Issue VQL Query in Java

import java.util.List;
import javax.xml.ws.BindingProvider;
import com.reflexsecurity.otoro.soap.ReflexPortType;
import com.reflexsecurity.otoro.soap.ReflexPortTypeService;
import com.reflexsecurity.otoro.soap.Vm;
import com.reflexsecurity.otoro.soap.VqlObject;

public class QueryExample {
    public static void main(String[] args) throws Exception {
        ReflexPortTypeService reflexService = new ReflexPortTypeService();
        ReflexPortType reflexPort = reflexService.getReflexPortTypePort();

        BindingProvider bp = (BindingProvider) reflexPort;
        bp.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://<VMC server>:8443/1.0/sdk?");

        List<VqlObject> objects = reflexPort.runVQLQuery("vnic.ips = '172.16.9.40' project vm");

        for (VqlObject object : objects) {
	        Vm vm = (Vm)object;
	        System.out.println("vm.getName() = " + vm.getName());
        }
    }
}
    

Issue VQL Query in Python

import suds

client = suds.client.Client('http://<VMC_Server>:8443/1.0/sdk?wsdl')
vm_list = client.service.runVQLQuery('vnic.ips = '172.16.9.40' project vm')

for vm in vm_list:
   print vm.name