Method Detail

• list

  @Named(value="server:list")
  com.google.common.collect.FluentIterable<Server> list()

  Get a list of all servers on this account.

  Returns:

  an account's associated server objects.

• get

  @Named(value="server:details")
  ServerDetails get(String id)

  Get detailed information about a server such as hostname, hardware configuration (cpu, memory and disk), ip addresses, cost, transfer, os and more.

  Parameters:

  id - id of the server

  Returns:

  server or null if not found

• getStatus

  @Named(value="server:status")
  ServerStatus getStatus(String id,
                             ServerStatusOptions... options)

  Get detailed information about a server status including up-time and hardware usage (cpu, disk, memory and bandwidth)

  Parameters:

  id - id of the server

  options - optional parameters

  Returns:

  the status of the server or null if not found

• getLimits

  @Named(value="server:limits")
  SortedMap<String,ServerLimit> getLimits(String id)

  Get detailed information about a server's limits (for OpenVZ only).

  Parameters:

  id - id of the server

  Returns:

  the requested information about the server or null if not found

• getConsole

  @Named(value="server:console")
  Console getConsole(String id)

  Get information about how to connect to a server via VNC

  Parameters:

  id - id of the server

  Returns:

  the requested information about the server or null if not found

• getAllowedArgumentsForCreateByPlatform

  @Named(value="server:allowedarguments")
  Map<String,AllowedArgumentsForCreateServer> getAllowedArgumentsForCreateByPlatform()

  Get information about the OS templates available

  Returns:

  the set of information about each template

• listTemplates

  @Named(value="server:templates")
  com.google.common.collect.FluentIterable<OSTemplate> listTemplates()

  Get information about valid arguments to #createServer for each platform

  Returns:

  a map of argument lists, keyed on platform

• resetLimit

  @Named(value="server:resetlimit")
  SortedMap<String,ServerLimit> resetLimit(String id,
                                               String type)

  Reset the fail count for a server limit (for OpenVZ only).

  Parameters:

  id - id of the server

  type - the type of limit to reset

• reboot

  @Named(value="server:reboot")
  ServerDetails reboot(String id)

  Reboot a server

  Parameters:

  id - id of the server

• start

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

  Start a server

  Parameters:

  id - id of the server

• stop

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

  Stop a server

  Parameters:

  id - id of the server

• hardStop

  @Named(value="server:stop:hard")
  ServerDetails hardStop(String id)

  hard stop a server

  Parameters:

  id - id of the server

• createWithHostnameAndRootPassword

  @Named(value="server:create")
  ServerDetails createWithHostnameAndRootPassword(ServerSpec serverSpec,
                                                      String hostname,
                                                      String rootPassword,
                                                      CreateServerOptions... options)

  Create a new server

  Parameters:

  hostname - the host name of the new server

  rootPassword - the root password to use

  options - optional settings ex. description

• clone

  @Named(value="server:clone")
  ServerDetails clone(String serverid,
                          String hostname,
                          CloneServerOptions... options)

  Clone a server

  Parameters:

  serverid - the serverId of the server to clone

  hostname - the new host name of the cloned server

  options - the settings to change

• update

  @Named(value="server:edit")
  ServerDetails update(String serverid,
                           UpdateServerOptions options)

  Update the configuration of a server

  Parameters:

  serverid - the serverId of the server to edit

  options - the settings to change

• destroy

  @Named(value="server:destroy")
  void destroy(String id,
                   DestroyServerOptions keepIp)

  Destroy a server

  Parameters:

  id - the id of the server

  keepIp - if DestroyServerOptions.keepIp(true) the servers ip will be retained for use in your GleSYS account

• resetPassword

  @Named(value="server:resetpassword")
  ServerDetails resetPassword(String id,
                                  String password)

  Reset the root password of a server

  Parameters:

  id - the id of the server

  password - the new password to use

• getResourceUsage

  @Named(value="server:resourceusage")
  ResourceUsage getResourceUsage(String id,
                                     String resource,
                                     String resolution)

  Return resource usage over time for server

  Parameters:

  id - the id of the server

  resource - the name of the resource to retrieve usage information for (e.g. "cpuusage")

  resolution - the time-period to extract data for (one of "minute", "hour" or "day)