ServerApi (Apache jclouds 2.1.0 API)

@Consumes(value="application/json")
@Path(value="/servers")
public interface ServerApi

Provides access to the OpenStack Compute (Nova) Server API.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`changeAdminPass(String id, String adminPass)` Change the administrative password to a server.
`void`	`confirmResize(String id)` Confirm a resize operation.
`ServerCreated`	`create(String name, String imageRef, String flavorRef, CreateServerOptions... options)` Create a new server
`String`	`createImageFromServer(String name, String id)` Create an image from a server.
`boolean`	`delete(String id)` Terminate and delete a server.
`void`	`deleteMetadata(String id, String key)` Delete a metadata item from a server.
`Server`	`get(String id)` List details of the specified server
`com.google.common.base.Optional<Map<String,String>>`	`getDiagnostics(String id)` Get usage information about the server such as CPU usage, Memory and IO.
`Map<String,String>`	`getMetadata(String id)` List all metadata for a server.
`String`	`getMetadata(String id, String key)` Update the metadata for a server.
`PagedIterable<Resource>`	`list()` List all servers (IDs, names, links)
`PaginatedCollection<Resource>`	`list(PaginationOptions options)`
`PagedIterable<Server>`	`listInDetail()` List all servers (all details)
`PaginatedCollection<Server>`	`listInDetail(PaginationOptions options)`
`Set<PortInterface>`	`listPortInterfaces(String id)` Lists port interfaces that are attached to a server.
`Set<SecurityGroup>`	`listSecurityGroupForServer(String id)` Lists Security Groups for a server.
`void`	`reboot(String id, RebootType rebootType)` Reboot a server.
`void`	`rebuild(String id, RebuildServerOptions... options)` Rebuild a server.
`void`	`rename(String id, String newName)` Rename a server.
`void`	`resize(String id, String flavorId)` Resize a server to a new flavor size.
`void`	`revertResize(String id)` Revert a resize operation.
`Map<String,String>`	`setMetadata(String id, Map<String,String> metadata)` Set the metadata for a server.
`void`	`start(String id)` Start a server
`void`	`stop(String id)` Stop a server
`Map<String,String>`	`updateMetadata(String id, Map<String,String> metadata)` Update the metadata for a server.
`String`	`updateMetadata(String id, String key, String value)` Set a metadata item for a server.

Method Detail

list
```
@Named(value="server:list")
@GET
PagedIterable<Resource> list()
```
List all servers (IDs, names, links)

Returns:
all servers (IDs, names, links)

list

@Named(value="server:list")
@GET
PaginatedCollection<Resource> list(PaginationOptions options)

listInDetail

@Named(value="server:list")
@GET
@Path(value="/detail")
PagedIterable<Server> listInDetail()

List all servers (all details)

Returns:: all servers (all details)

listInDetail

@Named(value="server:list")
@GET
@Path(value="/detail")
PaginatedCollection<Server> listInDetail(PaginationOptions options)

get

@Named(value="server:get")
@GET
@Path(value="/{id}")
@Nullable
Server get(@PathParam(value="id")
                                 String id)

List details of the specified server

Parameters:: id - id of the server
Returns:: server or null if not found

create

@Named(value="server:create")
@POST
ServerCreated create(String name,
                              String imageRef,
                              String flavorRef,
                              CreateServerOptions... options)

Create a new server

Parameters:: name - name of the server to create; imageRef - reference to the image for the server to use; flavorRef - reference to the flavor to use when creating the server; options - optional parameters to be passed into the server creation request
Returns:: the newly created server

delete

@Named(value="server:delete")
@DELETE
@Path(value="/{id}")
boolean delete(@PathParam(value="id")
                               String id)

Terminate and delete a server.

Parameters:: id - id of the server
Returns:: True if successful, False otherwise

start

@Named(value="server:start")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void start(@PathParam(value="id")
                                  String id)

Start a server

Parameters:: id - id of the server

stop

@Named(value="server:stop")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void stop(@PathParam(value="id")
                                 String id)

Stop a server

Parameters:: id - id of the server

reboot

@Named(value="server:reboot")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void reboot(@PathParam(value="id")
                                   String id,
                                   RebootType rebootType)

Reboot a server.

Parameters:: id - id of the server; rebootType - The type of reboot to perform (Hard/Soft)

resize

@Named(value="server:resize")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void resize(@PathParam(value="id")
                                   String id,
                                   String flavorId)

Resize a server to a new flavor size.

Parameters:: id - id of the server; flavorId - id of the new flavor to use

confirmResize

@Named(value="server:confirmResize")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void confirmResize(@PathParam(value="id")
                                          String id)

Confirm a resize operation.

Parameters:: id - id of the server

revertResize

@Named(value="server:revertResize")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void revertResize(@PathParam(value="id")
                                         String id)

Revert a resize operation.

Parameters:: id - id of the server

rebuild

@Named(value="server:rebuild")
@POST
@Path(value="/{id}/action")
void rebuild(@PathParam(value="id")
                           String id,
                           RebuildServerOptions... options)

Rebuild a server.

Parameters:: id - id of the server; options - Optional parameters to the rebuilding operation.

changeAdminPass

@Named(value="server:changeAdminPass")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
void changeAdminPass(@PathParam(value="id")
                                            String id,
                                            String adminPass)

Change the administrative password to a server.

Parameters:: id - id of the server; adminPass - The new administrative password to use

rename

@Named(value="server:rename")
@PUT
@Path(value="/{id}")
@Produces(value="application/json")
void rename(@PathParam(value="id")
                                  String id,
                                  String newName)

Rename a server.

Parameters:: id - id of the server; newName - The new name for the server

createImageFromServer

@Named(value="server:createImageFromServer")
@POST
@Path(value="/{id}/action")
@Produces(value="application/json")
String createImageFromServer(String name,
                                                    @PathParam(value="id")
                                                    String id)

Create an image from a server.

Parameters:: name - The name of the new image; id - id of the server
Returns:: ID of the new / updated image

getMetadata

@Named(value="server:getMetadata")
@GET
@Path(value="/{id}/metadata")
Map<String,String> getMetadata(@PathParam(value="id")
                                            String id)

List all metadata for a server.

Parameters:: id - id of the server
Returns:: the metadata as a Map

setMetadata

@Named(value="server:setMetadata")
@PUT
@Path(value="/{id}/metadata")
@Produces(value="application/json")
Map<String,String> setMetadata(@PathParam(value="id")
                                                     String id,
                                                     Map<String,String> metadata)

Set the metadata for a server.

Parameters:: id - id of the server; metadata - a Map containing the metadata
Returns:: the metadata as a Map

updateMetadata

@Named(value="server:updateMetadata")
@POST
@Path(value="/{id}/metadata")
@Produces(value="application/json")
Map<String,String> updateMetadata(@PathParam(value="id")
                                                         String id,
                                                         Map<String,String> metadata)

Update the metadata for a server.

Parameters:: id - id of the server; metadata - a Map containing the metadata
Returns:: the metadata as a Map

getMetadata

@Named(value="server:getMetadata")
@GET
@Path(value="/{id}/metadata/{key}")
@Nullable
String getMetadata(@PathParam(value="id")
                                         String id,
                                         @PathParam(value="key")
                                         String key)

Update the metadata for a server.

Parameters:: id - id of the image; key - a key containing the metadata
Returns:: the value or null if not present

updateMetadata

@Named(value="server:updateMetadata")
@PUT
@Path(value="/{id}/metadata/{key}")
@Produces(value="application/json")
String updateMetadata(@PathParam(value="id")
                                            String id,
                                            @PathParam(value="key")
                                            String key,
                                            @PathParam(value="value")
                                            String value)

Set a metadata item for a server.

Parameters:: id - id of the image; key - the name of the metadata item; value - the value of the metadata item
Returns:: the value you updated

deleteMetadata

@Named(value="server:deleteMetadata")
@DELETE
@Path(value="/{id}/metadata/{key}")
void deleteMetadata(@PathParam(value="id")
                                    String id,
                                    @PathParam(value="key")
                                    String key)

Delete a metadata item from a server.

Parameters:: id - id of the image; key - the name of the metadata item

getDiagnostics
```
@Named(value="server:getDiagnostics")
@GET
@Path(value="/{id}/diagnostics")
com.google.common.base.Optional<Map<String,String>> getDiagnostics(@PathParam(value="id")
                                                                                String id)
```
Get usage information about the server such as CPU usage, Memory and IO. The information returned by this method is dependent on the hypervisor in use by the OpenStack installation and whether that hypervisor supports this method. More information can be found in the OpenStack API reference.
At the moment the returned response is a generic map. In future versions of OpenStack this might be subject to change.

Parameters:
id - id of the server

Returns:
A Map containing the collected values organized by key - value.

listSecurityGroupForServer

@Named(value="server:getSecurityGroups")
@GET
@Path(value="/{id}/os-security-groups")
Set<SecurityGroup> listSecurityGroupForServer(@PathParam(value="id")
                                                           String id)

Lists Security Groups for a server.

Parameters:: id - id of the server
Returns:: a list of security groups attached to the server

listPortInterfaces

@Named(value="server:getPortInterfaces")
@GET
@Path(value="/{id}/os-interface")
Set<PortInterface> listPortInterfaces(@PathParam(value="id")
                                                   String id)

Lists port interfaces that are attached to a server.

Parameters:: id - id of the server
Returns:: a list of ports attached to the server

Interface ServerApi

Method Summary

Method Detail

list

list

listInDetail

listInDetail

get

create

delete

start

stop

reboot

resize

confirmResize

revertResize

rebuild

changeAdminPass

rename

createImageFromServer

getMetadata

setMetadata

updateMetadata

getMetadata

updateMetadata

deleteMetadata

getDiagnostics

listSecurityGroupForServer

listPortInterfaces