org.jclouds.openstack.nova

Interface NovaClient

Deprecated.

Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi in openstack-nova.

public interface NovaClient

Provides access to OpenStack Nova via their REST API.

All commands return a Future of the result from OpenStack Nova. Any exceptions incurred during processing will be backend in an ExecutionException as documented in Future.get().

Author:

Adrian Cole

See Also:

NovaAsyncClient,

Method Summary

Methods

Modifier and Type	Method and Description
void	addFloatingIP(int serverId, String ip) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.addToServer(String, String) in openstack-nova.
void	changeAdminPass(int id, String adminPass) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.changeAdminPass(String, String) in openstack-nova.
void	confirmResizeServer(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.confirmResize(String) in openstack-nova.
Image	createImageFromServer(String imageName, int serverId) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.createImageFromServer(String, String) in openstack-nova.
Server	createServer(String name, String imageRef, String flavorRef, CreateServerOptions... options) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See org.jclouds.openstack.nova.v2_0.features.ServerApi#create(String, String, String, CreateServerOptions) in openstack-nova.
boolean	deleteImage(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.delete(String) in openstack-nova.
boolean	deleteImage(String id) Deprecated.
boolean	deleteServer(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.delete(String) in openstack-nova.
boolean	deleteServer(String id) Deprecated.
Addresses	getAddresses(int serverId) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.
Flavor	getFlavor(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FlavorApi.get(String) in openstack-nova.
Flavor	getFlavor(String uuid) Deprecated.
FloatingIP	getFloatingIP(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.get(String) in openstack-nova.
Image	getImage(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.get(String) in openstack-nova.
Image	getImage(String id) Deprecated.
SecurityGroup	getSecurityGroup(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See SecurityGroupApi.get(String) in openstack-nova.
Server	getServer(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.
Server	getServer(String uuid) Deprecated.
Set<Flavor>	listFlavors(ListOptions... options) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FlavorApi.list() in openstack-nova.
Set<FloatingIP>	listFloatingIPs() Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.list() in openstack-nova.
Set<Image>	listImages(ListOptions... options) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.list() in openstack-nova.
Set<String>	listPrivateAddresses(int serverId) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.
Set<String>	listPublicAddresses(int serverId) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.
Set<SecurityGroup>	listSecurityGroups() Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See SecurityGroupApi.list() in openstack-nova.
Set<Server>	listServers(ListOptions... options) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.list() in openstack-nova.
void	rebootServer(int id, RebootType rebootType) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.reboot(String, RebootType) in openstack-nova.
void	rebuildServer(int id, RebuildServerOptions... options) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See org.jclouds.openstack.nova.v2_0.features.ServerApi#rebuild(String, RebuildServerOptions) in openstack-nova.
void	renameServer(int id, String newName) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.rename(String, String) in openstack-nova.
void	resizeServer(int id, int flavorId) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.resize(String, String) in openstack-nova.
void	revertResizeServer(int id) Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.revertResize(String) in openstack-nova.

Method Detail

listServers

Set<Server> listServers(ListOptions... options)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.list() in openstack-nova.

List all servers (IDs and names only) This operation provides a list of servers associated with your identity. Servers that have been deleted are not included in this list.

in order to retrieve all details, pass the option withDetails()

getServer

Server getServer(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.

This operation returns details of the specified server.

Returns:

null, if the server is not found

See Also:

Server

getServer

Server getServer(String uuid)

Deprecated.

deleteServer

boolean deleteServer(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.delete(String) in openstack-nova.

This operation deletes a cloud server instance from the system.

Note: When a server is deleted, all images created from that server are also removed.

Returns:

false if the server is not found

See Also:

Server

deleteServer

boolean deleteServer(String id)

Deprecated.

rebootServer

void rebootServer(int id,
                RebootType rebootType)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.reboot(String, RebootType) in openstack-nova.

The reboot function allows for either a soft or hard reboot of a server.

Status Transition:

ACTIVE - REBOOT - ACTIVE (soft reboot)

ACTIVE - HARD_REBOOT - ACTIVE (hard reboot)

Parameters:

rebootType - With a soft reboot, the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot is the equivalent of power cycling the server.

resizeServer

void resizeServer(int id,
                int flavorId)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.resize(String, String) in openstack-nova.

The resize function converts an existing server to a different flavor, in essence, scaling the server up or down. The original server is saved for a period of time to allow rollback if there is a problem. All resizes should be tested and explicitly confirmed, at which time the original server is removed. All resizes are automatically confirmed after 24 hours if they are not confirmed or reverted.

Status Transition:

ACTIVE - QUEUE_RESIZE - PREP_RESIZE - VERIFY_RESIZE

ACTIVE - QUEUE_RESIZE - ACTIVE (on error)

confirmResizeServer

void confirmResizeServer(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.confirmResize(String) in openstack-nova.

The resize function converts an existing server to a different flavor, in essence, scaling the server up or down. The original server is saved for a period of time to allow rollback if there is a problem. All resizes should be tested and explicitly confirmed, at which time the original server is removed. All resizes are automatically confirmed after 24 hours if they are not confirmed or reverted.

Status Transition:

VERIFY_RESIZE - ACTIVE

revertResizeServer

void revertResizeServer(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.revertResize(String) in openstack-nova.

The resize function converts an existing server to a different flavor, in essence, scaling the server up or down. The original server is saved for a period of time to allow rollback if there is a problem. All resizes should be tested and explicitly reverted, at which time the original server is removed. All resizes are automatically reverted after 24 hours if they are not reverted or reverted.

Status Transition:

VERIFY_RESIZE - ACTIVE

createServer

Server createServer(String name,
                  String imageRef,
                  String flavorRef,
                  CreateServerOptions... options)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See org.jclouds.openstack.nova.v2_0.features.ServerApi#create(String, String, String, CreateServerOptions) in openstack-nova.

This operation asynchronously provisions a new server. The progress of this operation depends on several factors including location of the requested image, network i/o, host load, and the selected flavor. The progress of the request can be checked by performing a GET on /server/id, which will return a progress attribute (0-100% completion). A password will be randomly generated for you and returned in the response object. For security reasons, it will not be returned in subsequent GET calls against a given server ID.

Parameters:

options - - used to specify extra files, metadata, or ip parameters during server creation.

rebuildServer

void rebuildServer(int id,
                 RebuildServerOptions... options)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See org.jclouds.openstack.nova.v2_0.features.ServerApi#rebuild(String, RebuildServerOptions) in openstack-nova.

The rebuild function removes all data on the server and replaces it with the specified image. Server ID and IP addresses remain the same.

Status Transition:

ACTIVE - REBUILD - ACTIVE

ACTIVE - REBUILD - ERROR (on error)

Parameters:

options - - imageId is an optional argument. If it is not specified, the server is rebuilt with the original imageId.

changeAdminPass

void changeAdminPass(int id,
                   String adminPass)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.changeAdminPass(String, String) in openstack-nova.

This operation allows you to change the administrative password.

Status Transition: ACTIVE - PASSWORD - ACTIVE

renameServer

void renameServer(int id,
                String newName)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.rename(String, String) in openstack-nova.

This operation allows you to update the name of the server. This operation changes the name of the server in the OpenStack Nova system and does not change the server host name itself.

Status Transition: ACTIVE - PASSWORD - ACTIVE

listFlavors

Set<Flavor> listFlavors(ListOptions... options)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FlavorApi.list() in openstack-nova.

List available flavors (IDs and names only) in order to retrieve all details, pass the option withDetails()

getFlavor

Flavor getFlavor(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FlavorApi.get(String) in openstack-nova.

This operation returns details of the specified flavor.

Returns:

null, if the flavor is not found

See Also:

Flavor

getFlavor

Flavor getFlavor(String uuid)

Deprecated.

listImages

Set<Image> listImages(ListOptions... options)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.list() in openstack-nova.

List available images (IDs and names only) in order to retrieve all details, pass the option withDetails()

getImage

Image getImage(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.get(String) in openstack-nova.

This operation returns details of the specified image.

Returns:

null, if the image is not found

See Also:

Image

getImage

Image getImage(String id)

Deprecated.

deleteImage

boolean deleteImage(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ImageApi.delete(String) in openstack-nova.

This operation deletes an image from the system.

Note: Images are immediately removed. Currently, there are no state transitions to track the delete operation.

Returns:

false if the image is not found

See Also:

Image

deleteImage

boolean deleteImage(String id)

Deprecated.

createImageFromServer

Image createImageFromServer(String imageName,
                          int serverId)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.createImageFromServer(String, String) in openstack-nova.

This operation creates a new image for the given server ID. Once complete, a new image will be available that can be used to rebuild or create servers. Specifying the same image name as an existing custom image replaces the image. The image creation status can be queried by performing a GET on /images/id and examining the status and progress attributes. Status Transition:

QUEUED - PREPARING - SAVING - ACTIVE

QUEUED - PREPARING - SAVING - FAILED (on error)

Note: At present, image creation is an asynchronous operation, so coordinating the creation with data quiescence, etc. is currently not possible.

Throws:

ResourceNotFoundException - if the server is not found

See Also:

Image

getAddresses

Addresses getAddresses(int serverId)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.

List all server addresses returns empty set if the server doesn't exist

listPublicAddresses

Set<String> listPublicAddresses(int serverId)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.

List all public server addresses returns empty set if the server doesn't exist

listPrivateAddresses

Set<String> listPrivateAddresses(int serverId)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See ServerApi.get(String) in openstack-nova.

List all private server addresses returns empty set if the server doesn't exist

addFloatingIP

void addFloatingIP(int serverId,
                 String ip)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.addToServer(String, String) in openstack-nova.

Add a floating IP to the given server. The floating IP can just be added if the server has a fixed IP. It means that it is not possible to directly add the floating IP just after creating the server but have to poll if the server has an IP.

Parameters:

serverId -

ip -

Since:

2011.3 "Diablo" release, OpenStack API 1.1

See Also:

http://wiki.openstack.org/os_api_floating_ip

listFloatingIPs

Set<FloatingIP> listFloatingIPs()

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.list() in openstack-nova.

Get all the defined floating IPs in nova

Returns:

all the available floating IP for the current tenant

Since:

2011.3 "Diablo" release, OpenStack API 1.1

See Also:

http://wiki.openstack.org/os_api_floating_ip

getFloatingIP

FloatingIP getFloatingIP(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See FloatingIPApi.get(String) in openstack-nova.

Get floating IP details from its ID

Parameters:

id - the floating IP id

Returns:

the floating IP or null if not found

Since:

2011.3 "Diablo" release, OpenStack API 1.1

See Also:

http://wiki.openstack.org/os_api_floating_ip

listSecurityGroups

Set<SecurityGroup> listSecurityGroups()

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See SecurityGroupApi.list() in openstack-nova.

Get all the security groups

Returns:

all the security groups for the current tenant

Since:

OpenStack API v1.1

See Also:

http://wiki.openstack.org/os-security-groups

getSecurityGroup

SecurityGroup getSecurityGroup(int id)

Deprecated. Deprecated in jclouds 1.5.5, to be removed in jclouds 1.6. See SecurityGroupApi.get(String) in openstack-nova.

Get a security group from its ID

Parameters:

id - the ID of the security group to get details from

Returns:

the security group or null if not found

Since:

OpenStack API v1.1

See Also:

http://wiki.openstack.org/os-security-groups