ServerApi (Apache jclouds 1.7.3 API)

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<? extends Resource>`	`list()` List all servers (IDs, names, links)
`PaginatedCollection<? extends Resource>`	`list(PaginationOptions options)`
`PagedIterable<? extends Server>`	`listInDetail()` List all servers (all details)
`PaginatedCollection<? extends Server>`	`listInDetail(PaginationOptions options)`
`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.

```
public interface ServerApi
```
Provides synchronous access to Server.

Author:

Adrian Cole

See Also:
ServerAsyncApi,

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<? extends Resource> list()
List all servers (IDs, names, links)

PaginatedCollection<? extends Resource> list(PaginationOptions options)

PagedIterable<? extends Server> listInDetail()
List all servers (all details)

PaginatedCollection<? extends Server> listInDetail(PaginationOptions options)

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
```
PagedIterable<? extends Resource> list()
```
    List all servers (IDs, names, links)
    
    Returns:
    all servers (IDs, names, links)
  - list
```
PaginatedCollection<? extends Resource> list(PaginationOptions options)
```
  - listInDetail
```
PagedIterable<? extends Server> listInDetail()
```
    List all servers (all details)
    
    Returns:
    all servers (all details)
  - listInDetail
```
PaginatedCollection<? extends Server> listInDetail(PaginationOptions options)
```
  - get
```
Server get(String id)
```
    List details of the specified server
    
    Parameters:
    id - id of the server
    
    Returns:
    server or null if not found
  - create
```
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
```
boolean delete(String id)
```
    Terminate and delete a server.
    
    Parameters:
    id - id of the server
    
    Returns:
    True if successful, False otherwise
  - start
```
void start(String id)
```
    Start a server
    
    Parameters:
    id - id of the server
  - stop
```
void stop(String id)
```
    Stop a server
    
    Parameters:
    id - id of the server
  - reboot
```
void reboot(String id,
          RebootType rebootType)
```
    Reboot a server.
    
    Parameters:
    id - id of the server
    rebootType - The type of reboot to perform (Hard/Soft)
  - resize
```
void resize(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
```
void confirmResize(String id)
```
    Confirm a resize operation.
    
    Parameters:
    id - id of the server
  - revertResize
```
void revertResize(String id)
```
    Revert a resize operation.
    
    Parameters:
    id - id of the server
  - rebuild
```
void rebuild(String id,
           RebuildServerOptions... options)
```
    Rebuild a server.
    
    Parameters:
    id - id of the server
    options - Optional parameters to the rebuilding operation.
  - changeAdminPass
```
void changeAdminPass(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
```
void rename(String id,
          String newName)
```
    Rename a server.
    
    Parameters:
    id - id of the server
    newName - The new name for the server
  - createImageFromServer
```
String createImageFromServer(String name,
                           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
```
Map<String,String> getMetadata(String id)
```
    List all metadata for a server.
    
    Parameters:
    id - id of the server
    
    Returns:
    the metadata as a Map
  - setMetadata
```
Map<String,String> setMetadata(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
```
Map<String,String> updateMetadata(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
```
@Nullable
String getMetadata(String id,
                          String key)
```
    Update the metadata for a server.
    
    Parameters:
    id - id of the image
    metadata - a Map containing the metadata
    
    Returns:
    the value or null if not present
  - updateMetadata
```
String updateMetadata(String id,
                    String key,
                    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
```
void deleteMetadata(String id,
                  String key)
```
    Delete a metadata item from a server.
    
    Parameters:
    id - id of the image
    key - the name of the metadata item
  - getDiagnostics
```
com.google.common.base.Optional<Map<String,String>> getDiagnostics(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.

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