org.jclouds.vcloud.domain

Interface Vm

All Superinterfaces:

Comparable<ReferenceType>, ReferenceType

All Known Implementing Classes:

VmImpl

public interface Vm
extends ReferenceType

A Vm represents a virtual machine, a member of a vApp’s Children container.

note

When the getStatus() is Status.UNRESOLVED, there will be a task present for the instantiation of the VApp.

Author:

Adrian Cole

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() optional description
GuestCustomizationSection	getGuestCustomizationSection()
NetworkConnectionSection	getNetworkConnectionSection()
VCloudOperatingSystemSection	getOperatingSystemSection()
ReferenceType	getParent() Reference to the VApp or VAppTemplate containing this vm.
Status	getStatus()
List<Task>	getTasks() read‐only container for Task elements.
String	getVAppScopedLocalId() read-only identifier created on import
VCloudVirtualHardwareSection	getVirtualHardwareSection()

Methods inherited from interface org.jclouds.vcloud.domain.ReferenceType

getHref, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getParent

ReferenceType getParent()

Reference to the VApp or VAppTemplate containing this vm.

Since:

vcloud api 1.0

getStatus

@Nullable
Status getStatus()

Returns:

creation status of the Vm or null, if a part of a VAppTemplate

Since:

vcloud api 1.0

getDescription

@Nullable
String getDescription()

optional description

Since:

vcloud api 0.8

getTasks

List<Task> getTasks()

read‐only container for Task elements. Each element in the container represents a queued, running, or failed task owned by this object.

Since:

vcloud api 1.0

getVirtualHardwareSection

@Nullable
VCloudVirtualHardwareSection getVirtualHardwareSection()

Returns:

virtual hardware that comprises this VM, or null, if part of a vApp template

Since:

vcloud api 1.0

getOperatingSystemSection

@Nullable
VCloudOperatingSystemSection getOperatingSystemSection()

Returns:

operating system on this VM, or null, if part of a vApp template

Since:

vcloud api 1.0

getNetworkConnectionSection

@Nullable
NetworkConnectionSection getNetworkConnectionSection()

Returns:

network connections for this VM, or null if it doesn't exist

Since:

vcloud api 1.0

getGuestCustomizationSection

@Nullable
GuestCustomizationSection getGuestCustomizationSection()

Returns:

guest customization section for this VM, or null if it doesn't exist

Since:

vcloud api 1.0

getVAppScopedLocalId

@Nullable
String getVAppScopedLocalId()

read-only identifier created on import

Since:

vcloud api 1.0