Interface GridIpApi


public interface GridIpApi
  • Method Details

    • getIpList

      @GET @Path("/grid/ip/list") Set<Ip> getIpList(GetIpListOptions... options)
      Returns all IPs in the system that match the options
      Parameters:
      options - options to narrow the search down
      Returns:
      IPs found by the search
    • getUnassignedIpList

      @GET @Path("/grid/ip/list") Set<Ip> getUnassignedIpList()
      Returns the list of unassigned IPs. NOTE: this returns both public and private IPs!
      Returns:
      unassigned IPs
    • getUnassignedPublicIpList

      @GET @Path("/grid/ip/list") Set<Ip> getUnassignedPublicIpList()
      Returns the list of unassigned public IPs.
      Returns:
      unassigned public IPs
    • getAssignedIpList

      @GET @Path("/grid/ip/list") Set<Ip> getAssignedIpList()
      Returns the list of assigned IPs NOTE: this returns both public and private IPs!
      Returns:
      assigned IPs
    • getDatacenters

      @GET @Path("/common/lookup/list") Set<Option> getDatacenters()
      Retrieves the list of supported Datacenters to retrieve ips from. The objects will have datacenter ID, name and description. In most cases, id or name will be used for
      invalid reference
      #addServer
      .
      Returns:
      supported datacenters