DoubleCloud.org

In my last article, I announced the Guest Operating System Management API for vSphere. As promised, I will write samples to show how to use the APIs. This post explains the GuestProgramDirector type with an example.

Let’s take a quick look at the following sample:

/*=============================================================================
Copyright (c) 2012 Steve Jin, All Rights Reserved.

http://www.doublecloud.org

=============================================================================*/

package org.doublecloud.vi.vmware.guest.samples;

import java.net.URL;
import java.util.Calendar;

import org.doublecloud.vi.vmware.guest.GuestProcessDirector;

import com.vmware.vim25.GuestProcessInfo;
import com.vmware.vim25.mo.Folder;
import com.vmware.vim25.mo.InventoryNavigator;
import com.vmware.vim25.mo.ManagedEntity;
import com.vmware.vim25.mo.ServiceInstance;
import com.vmware.vim25.mo.VirtualMachine;

public class NewGuestRunProgram
{
  public static void main(String[] args) throws Exception
  {
    ServiceInstance si = new ServiceInstance(new URL("https://8.8.8.8/sdk"), "Administrator", "doublecloud.org", true);
    Folder rootFolder = si.getRootFolder();

    ManagedEntity[] mes = new InventoryNavigator(rootFolder).searchManagedEntities("VirtualMachine");
    if (mes == null || mes.length == 0)
    {
      return;
    }

    VirtualMachine vm = (VirtualMachine) mes[0];

    System.out.println("guest tool status:" + vm.getGuest().toolsRunningStatus);
    if (!"guestToolsRunning".equals(vm.getGuest().toolsRunningStatus))
    {
      System.out.println("The VMware Tools is not running in the Guest OS on VM: " + vm.getName());
      System.out.println("Exiting...");
      return;
    }

    GuestProcessDirector progDir = new GuestProcessDirector(vm, "Administrator", "vijava");

    long pid = progDir.run("C:\\Windows\\notepad.exe");
    System.out.println("pid: " + pid);

    progDir.killProcess(pid);

    GuestProcessInfo[] procInfos = progDir.listProcesses();
    for (GuestProcessInfo info : procInfos)
    {
      System.out.println("===================================");
      System.out.println("cmdLine:" + info.cmdLine);
      System.out.println("startTime:" + info.startTime.getTime());
      Calendar endTime = info.endTime;
      if (endTime != null)
        System.out.println("endTime:" + endTime.getTime());

      System.out.println("name:" + info.name);
      System.out.println("owner:" + info.owner);
      System.out.println("pid:" + info.pid);
    }
    si.getServerConnection().logout();
  }
}

To run this program, you will need to first download the new Guest Operating System Management API here , then change the related vCenter server URL/credential and guest operating system username and password. It implicitly assumes the first virtual machine is a Windows system, which is in general not a good practice but make the code easier. If it’s not true, you can either search for a Windows, or simply change the command to run.

Compared with the sample I wrote days ago (), this sample has a bit more features. Not only can it run a new program, but also kill an existing program, and list all the programs currently running in the guest operating system.

The GuestProgramDirector can actually do more the sample shows, like read the environment variables as you specify, or all of the environment variables.  There are two overloaded methods for reading environment variables as shown below: (somehow the web page just show one methd due to horizontal scroll bar. To view two, just click inside. Please let me if you know of a trick to fix this.)

public String[] readEnvironmentVariables(String[] names) throws GuestOperationsFault, InvalidState, TaskInProgress, RuntimeFault, RemoteException
public String[] readEnvironmentVariables() throws GuestOperationsFault, InvalidState, TaskInProgress, RuntimeFault, RemoteException

The first one reads only the environment variables specified with the parameter names which is an array; the second one reads all of the existing environment variables from the guest operating system. Both of them return an array of Strings. Each string in the array has format of “name=value.” The sub string before the “=” is name and after is its value.

•