org.jclouds.openstack.nova.v2_0.extensions
Interface ServerAdminApi

@Beta
public interface ServerAdminApi

Provide access to the OpenStack Compute (Nova) Admin Server Actions Extension API. Provide additional actions for servers: 'suspend', 'resume', 'migrate', 'lock', 'unlock', 'resetNetwork', 'createBackup', 'pause', 'migrateLive', 'injectNetworkInfo', 'unpause'

Method Summary

String	createBackup(String id, String imageName, BackupType backupType, int rotation, CreateBackupOfServerOptions... options) Create backup of a server.
Boolean	injectNetworkInfo(String id) Inject network info into a server.
Boolean	liveMigrate(String id, String host, boolean blockMigration, boolean diskOverCommit) Live migrate a server.
Boolean	lock(String id) Lock a server.
Boolean	migrate(String id) Migrate a server.
Boolean	pause(String id) Pause a server.
Boolean	resetNetwork(String id) Reset network of a server.
Boolean	resume(String id) Resume a server.
Boolean	suspend(String id) Suspend a server.
Boolean	unlock(String id) Unlock a server.
Boolean	unpause(String id) Unpause a server.

Method Detail

suspend

@Named(value="serverAdmin:suspend")
Boolean suspend(String id)

Suspend a server.

Parameters:

id - id of the server

resume

@Named(value="serverAdmin:resume")
Boolean resume(String id)

Resume a server.

Parameters:

id - id of the server

migrate

@Named(value="serverAdmin:migrate")
Boolean migrate(String id)

Migrate a server.

Parameters:

id - id of the server

lock

@Named(value="serverAdmin:lock")
Boolean lock(String id)

Lock a server.

Parameters:

id - id of the server

unlock

@Named(value="serverAdmin:unlock")
Boolean unlock(String id)

Unlock a server.

Parameters:

id - id of the server

resetNetwork

@Named(value="serverAdmin:resetNetwork")
Boolean resetNetwork(String id)

Reset network of a server.

Parameters:

id - id of the server

createBackup

@Named(value="serverAdmin:createBackup")
String createBackup(String id,
                          String imageName,
                          BackupType backupType,
                          int rotation,
                          CreateBackupOfServerOptions... options)

Create backup of a server.

Parameters:

id - id of the server

imageName - the name of the image to create

backupType - the type of backup

rotation - the number of images to retain (0 to simply overwrite)

options - optional rotation and/or metadata parameters

Returns:

the id of the newly created image

pause

@Named(value="serverAdmin:pause")
Boolean pause(String id)

Pause a server.

Parameters:

id - id of the server

unpause

@Named(value="serverAdmin:unpause")
Boolean unpause(String id)

Unpause a server.

Parameters:

id - id of the server

liveMigrate

@Named(value="serverAdmin:liveMigrate")
Boolean liveMigrate(String id,
                          String host,
                          boolean blockMigration,
                          boolean diskOverCommit)

Live migrate a server.

Parameters:

id - id of the server

injectNetworkInfo

@Named(value="serverAdmin:injectNetwork")
Boolean injectNetworkInfo(String id)

Inject network info into a server.

Parameters:

id - id of the server