org.jclouds.glesys.features

Interface IpApi

public interface IpApi

Provides synchronous access to IP Addresses.

Author:

Adrian Cole, Mattias Holmqvist, Adam Lowe

See Also:

IpAsyncApi,

Method Summary

Methods

Modifier and Type	Method and Description
IpDetails	addIpToServer(String ipAddress, String serverId) Add an IP address to an server.
IpDetails	getIp(String ipAddress) Get details about the given IP address such as gateway and netmask.
Set<String>	listFree(int ipVersion, String datacenter, String platform) Get a set of all IP addresses that are available and not used on any account or server.
Set<IpDetails>	listIps(ListIpOptions... options) Get IP addresses associated with your account (reserved, assigned to servers, etc)
IpDetails	release(String ipAddress) Return an unused IP address to the pool of free ips.
IpDetails	removeIpFromServer(String ipAddress, String serverId) Remove an IP address from a server.
IpDetails	removeIpFromServerAndRelease(String ipAddress, String serverId) Remove an IP address from a server and release it back to GleSYS pool of free ips.
IpDetails	resetPtr(String ipAddress) Resets PTR data for an IP back to the default value
IpDetails	setPtr(String ipAddress, String ptr) Sets PTR data for an IP.
IpDetails	take(String ipAddress) Take a free IP address and add it to this account.

Method Detail

listFree

Set<String> listFree(int ipVersion,
                   String datacenter,
                   String platform)

Get a set of all IP addresses that are available and not used on any account or server.

Parameters:

ipVersion - 4 or 6, for IPV4 or IPV6, respectively

datacenter - the datacenter

platform - the platform

Returns:

a set of free IP addresses

take

IpDetails take(String ipAddress)

Take a free IP address and add it to this account. You can list free IP addresses with the function listFree(). Once your free IP on this account you can add it to a server with the add() function.

Parameters:

ipAddress - the IP address to be add to this account (reserve)

release

IpDetails release(String ipAddress)

Return an unused IP address to the pool of free ips. If the IP address is allocated to a server, it must first be removed by calling remove(ipAddress) before it can be released.

Parameters:

ipAddress - the IP address to be released

listIps

Set<IpDetails> listIps(ListIpOptions... options)

Get IP addresses associated with your account (reserved, assigned to servers, etc)

Parameters:

options - options to filter the results (by IPV4/6, serverId, etc)

Returns:

the set of IP addresses

getIp

IpDetails getIp(String ipAddress)

Get details about the given IP address such as gateway and netmask. Different details are available on different platforms.

Parameters:

ipAddress - the ip address

Returns:

details about the given IP address

addIpToServer

IpDetails addIpToServer(String ipAddress,
                      String serverId)

Add an IP address to an server. The IP has to be free, but reserved to this account. You are able to list such addresses with listOwn() and reserve an address for this account by using take(). To find free ips you can use ip/listfree ip to an Xen-server you have to configure the server yourself, unless the ip was added during the c server (server/create). You can get detailed information such as gateway and netmask using the ip

Parameters:

ipAddress - the IP address to remove

serverId - the server to add the IP address to

removeIpFromServer

IpDetails removeIpFromServer(String ipAddress,
                           String serverId)

Remove an IP address from a server. This does not release it back to GleSYS pool of free ips. The address will be kept on the account so that you can use it for other servers or the same server at a later time. To completely remove the IP address from this account, use removeIpFromServerAndRelease to do so

Parameters:

ipAddress - the IP address to remove

serverId - the server to remove the IP address from

See Also:

removeIpFromServerAndRelease(java.lang.String, java.lang.String)

removeIpFromServerAndRelease

IpDetails removeIpFromServerAndRelease(String ipAddress,
                                     String serverId)

Remove an IP address from a server and release it back to GleSYS pool of free ips.

Parameters:

ipAddress - the IP address to remove

serverId - the server to remove the IP address from

See Also:

removeIpFromServer(java.lang.String, java.lang.String)

setPtr

IpDetails setPtr(String ipAddress,
               String ptr)

Sets PTR data for an IP. Use ip/listown or ip/details to get current PTR data

resetPtr

IpDetails resetPtr(String ipAddress)

Resets PTR data for an IP back to the default value