org.ovirt.engine.sdk4.internal.services

Class VmServiceImpl

java.lang.Object

org.ovirt.engine.sdk4.internal.services.ServiceImpl

org.ovirt.engine.sdk4.internal.services.VmServiceImpl

All Implemented Interfaces:

Service, VmService

public class VmServiceImpl
extends ServiceImpl
implements VmService

Nested Class Summary

Nested classes/interfaces inherited from interface org.ovirt.engine.sdk4.services.VmService

VmService.CancelMigrationRequest, VmService.CancelMigrationResponse, VmService.CloneRequest, VmService.CloneResponse, VmService.CommitSnapshotRequest, VmService.CommitSnapshotResponse, VmService.DetachRequest, VmService.DetachResponse, VmService.ExportRequest, VmService.ExportResponse, VmService.FreezeFilesystemsRequest, VmService.FreezeFilesystemsResponse, VmService.GetRequest, VmService.GetResponse, VmService.LogonRequest, VmService.LogonResponse, VmService.MaintenanceRequest, VmService.MaintenanceResponse, VmService.MigrateRequest, VmService.MigrateResponse, VmService.PreviewSnapshotRequest, VmService.PreviewSnapshotResponse, VmService.RebootRequest, VmService.RebootResponse, VmService.RemoveRequest, VmService.RemoveResponse, VmService.ReorderMacAddressesRequest, VmService.ReorderMacAddressesResponse, VmService.ShutdownRequest, VmService.ShutdownResponse, VmService.StartRequest, VmService.StartResponse, VmService.StopRequest, VmService.StopResponse, VmService.SuspendRequest, VmService.SuspendResponse, VmService.ThawFilesystemsRequest, VmService.ThawFilesystemsResponse, VmService.TicketRequest, VmService.TicketResponse, VmService.UndoSnapshotRequest, VmService.UndoSnapshotResponse, VmService.UpdateRequest, VmService.UpdateResponse

Constructor Summary

Constructors

Constructor and Description
VmServiceImpl(HttpConnection connection, String path)

Method Summary

Modifier and Type	Method and Description
AssignedAffinityLabelsService	affinityLabelsService() List of scheduling labels assigned to this VM.
VmApplicationsService	applicationsService()
VmService.CancelMigrationRequest	cancelMigration()
VmCdromsService	cdromsService()
VmService.CloneRequest	clone_()
VmService.CommitSnapshotRequest	commitSnapshot()
VmService.DetachRequest	detach()
DiskAttachmentsService	diskAttachmentsService() List of disks attached to this virtual machine.
VmService.ExportRequest	export()
VmService.FreezeFilesystemsRequest	freezeFilesystems()
VmService.GetRequest	get() Retrieves the description of the virtual machine.
GraphicsConsolesService	graphicsConsolesService()
VmHostDevicesService	hostDevicesService()
KatelloErrataService	katelloErrataService()
VmService.LogonRequest	logon()
VmService.MaintenanceRequest	maintenance()
VmService.MigrateRequest	migrate()
VmNicsService	nicsService()
VmNumaNodesService	numaNodesService()
AssignedPermissionsService	permissionsService()
VmService.PreviewSnapshotRequest	previewSnapshot()
VmService.RebootRequest	reboot()
VmService.RemoveRequest	remove()
VmService.ReorderMacAddressesRequest	reorderMacAddresses()
VmReportedDevicesService	reportedDevicesService()
Service	service(String path) Service locator method, returns individual service on which the URI is dispatched.
VmSessionsService	sessionsService()
VmService.ShutdownRequest	shutdown()
SnapshotsService	snapshotsService()
VmService.StartRequest	start()
StatisticsService	statisticsService()
VmService.StopRequest	stop()
VmService.SuspendRequest	suspend()
AssignedTagsService	tagsService()
VmService.ThawFilesystemsRequest	thawFilesystems()
VmService.TicketRequest	ticket()
String	toString()
VmService.UndoSnapshotRequest	undoSnapshot()
VmService.UpdateRequest	update()
VmWatchdogsService	watchdogsService()

Methods inherited from class org.ovirt.engine.sdk4.internal.services.ServiceImpl

checkAction, checkFault, getConnection, getPath, throwError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VmServiceImpl

public VmServiceImpl(HttpConnection connection,
                     String path)

Method Detail

cancelMigration

public VmService.CancelMigrationRequest cancelMigration()

Specified by:

cancelMigration in interface VmService

clone_

public VmService.CloneRequest clone_()

Specified by:

clone_ in interface VmService

commitSnapshot

public VmService.CommitSnapshotRequest commitSnapshot()

Specified by:

commitSnapshot in interface VmService

detach

public VmService.DetachRequest detach()

Specified by:

detach in interface VmService

export

public VmService.ExportRequest export()

Specified by:

export in interface VmService

freezeFilesystems

public VmService.FreezeFilesystemsRequest freezeFilesystems()

Specified by:

freezeFilesystems in interface VmService

get

public VmService.GetRequest get()

Description copied from interface: VmService

Retrieves the description of the virtual machine.

Note that some elements of the description of the virtual machine won’t be returned unless the All-Content header is present in the request and has the value true. The elements that aren’t currently returned are the following:

• console

• initialization.configuration.data - The OVF document describing the virtual machine.

• rng_source

• soundcard

• virtio_scsi

With the Python SDK the All-Content header can be set using the all_content parameter of the get method:

api.vms.get(name="myvm", all_content=True)

Note that the reason for not including these elements is performance: they are seldom used and they require additional queries in the server. So try to use the All-Content header only when it is really needed.

Specified by:

get in interface VmService

logon

public VmService.LogonRequest logon()

Specified by:

logon in interface VmService

maintenance

public VmService.MaintenanceRequest maintenance()

Specified by:

maintenance in interface VmService

migrate

public VmService.MigrateRequest migrate()

Specified by:

migrate in interface VmService

previewSnapshot

public VmService.PreviewSnapshotRequest previewSnapshot()

Specified by:

previewSnapshot in interface VmService

reboot

public VmService.RebootRequest reboot()

Specified by:

reboot in interface VmService

remove

public VmService.RemoveRequest remove()

Specified by:

remove in interface VmService

reorderMacAddresses

public VmService.ReorderMacAddressesRequest reorderMacAddresses()

Specified by:

reorderMacAddresses in interface VmService

shutdown

public VmService.ShutdownRequest shutdown()

Specified by:

shutdown in interface VmService

start

public VmService.StartRequest start()

Specified by:

start in interface VmService

stop

public VmService.StopRequest stop()

Specified by:

stop in interface VmService

suspend

public VmService.SuspendRequest suspend()

Specified by:

suspend in interface VmService

thawFilesystems

public VmService.ThawFilesystemsRequest thawFilesystems()

Specified by:

thawFilesystems in interface VmService

ticket

public VmService.TicketRequest ticket()

Specified by:

ticket in interface VmService

undoSnapshot

public VmService.UndoSnapshotRequest undoSnapshot()

Specified by:

undoSnapshot in interface VmService

update

public VmService.UpdateRequest update()

Specified by:

update in interface VmService

affinityLabelsService

public AssignedAffinityLabelsService affinityLabelsService()

Description copied from interface: VmService

List of scheduling labels assigned to this VM.

Specified by:

affinityLabelsService in interface VmService

applicationsService

public VmApplicationsService applicationsService()

Specified by:

applicationsService in interface VmService

cdromsService

public VmCdromsService cdromsService()

Specified by:

cdromsService in interface VmService

diskAttachmentsService

public DiskAttachmentsService diskAttachmentsService()

Description copied from interface: VmService

List of disks attached to this virtual machine.

Specified by:

diskAttachmentsService in interface VmService

graphicsConsolesService

public GraphicsConsolesService graphicsConsolesService()

Specified by:

graphicsConsolesService in interface VmService

hostDevicesService

public VmHostDevicesService hostDevicesService()

Specified by:

hostDevicesService in interface VmService

katelloErrataService

public KatelloErrataService katelloErrataService()

Specified by:

katelloErrataService in interface VmService

nicsService

public VmNicsService nicsService()

Specified by:

nicsService in interface VmService

numaNodesService

public VmNumaNodesService numaNodesService()

Specified by:

numaNodesService in interface VmService

permissionsService

public AssignedPermissionsService permissionsService()

Specified by:

permissionsService in interface VmService

reportedDevicesService

public VmReportedDevicesService reportedDevicesService()

Specified by:

reportedDevicesService in interface VmService

sessionsService

public VmSessionsService sessionsService()

Specified by:

sessionsService in interface VmService

snapshotsService

public SnapshotsService snapshotsService()

Specified by:

snapshotsService in interface VmService

statisticsService

public StatisticsService statisticsService()

tagsService

public AssignedTagsService tagsService()

Specified by:

tagsService in interface VmService

watchdogsService

public VmWatchdogsService watchdogsService()

Specified by:

watchdogsService in interface VmService

service

public Service service(String path)

Description copied from interface: VmService

Service locator method, returns individual service on which the URI is dispatched.

Specified by:

service in interface VmService

toString

public String toString()

Overrides:

toString in class Object