Method Detail

• list

  @Named(value="server:list")
  PagedIterable<Resource> list()

  List all servers (IDs, names, links)

  Returns:

  all servers (IDs, names, links)

• list

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

• listInDetail

  @Named(value="server:list")
  PagedIterable<Server> listInDetail()

  List all servers (all details)

  Returns:

  all servers (all details)

• listInDetail

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

• get

  @Named(value="server:get")
  @Nullable
  Server get(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")
  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")
  boolean delete(String id)

  Terminate and delete a server.

  Parameters:

  id - id of the server

  Returns:

  True if successful, False otherwise

• start

  @Named(value="server:start")
  void start(String id)

  Start a server

  Parameters:

  id - id of the server

• stop

  @Named(value="server:stop")
  void stop(String id)

  Stop a server

  Parameters:

  id - id of the server

• reboot

  @Named(value="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

  @Named(value="server: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

  @Named(value="server:confirmResize")
  void confirmResize(String id)

  Confirm a resize operation.

  Parameters:

  id - id of the server

• revertResize

  @Named(value="server:revertResize")
  void revertResize(String id)

  Revert a resize operation.

  Parameters:

  id - id of the server

• rebuild

  @Named(value="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

  @Named(value="server: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

  @Named(value="server:rename")
  void rename(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")
  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

  @Named(value="server: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

  @Named(value="server: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

  @Named(value="server: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

  @Named(value="server: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

  @Named(value="server: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

  @Named(value="server: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

  @Named(value="server: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.