org.jclouds.cloudstack.features
Interface NATClient

public interface NATClient

Provides synchronous access to CloudStack IPForwardingRule features.

Author:

Adrian Cole

See Also:

IPForwardingRuleAsyncClient,

Method Summary

AsyncCreateResponse	createIPForwardingRule(long IPAddressId, String protocol, int startPort, CreateIPForwardingRuleOptions... options) Creates an ip forwarding rule
Long	deleteIPForwardingRule(long id) Deletes an ip forwarding rule
Long	disableStaticNATOnPublicIP(long IPAddressId) Disables static rule for given ip address
void	enableStaticNATForVirtualMachine(long virtualMachineId, long IPAddressId)
IPForwardingRule	getIPForwardingRule(long id) get a specific IPForwardingRule by id
Set<IPForwardingRule>	getIPForwardingRulesForIPAddress(long id) get a set of IPForwardingRules by ipaddress id
Set<IPForwardingRule>	getIPForwardingRulesForVirtualMachine(long id) get a set of IPForwardingRules by virtual machine id
Set<IPForwardingRule>	listIPForwardingRules(ListIPForwardingRulesOptions... options) List the ip forwarding rules

Method Detail

listIPForwardingRules

Set<IPForwardingRule> listIPForwardingRules(ListIPForwardingRulesOptions... options)

List the ip forwarding rules

Parameters:

options - if present, how to constrain the list.

Returns:

IPForwardingRules matching query, or empty set, if no IPForwardingRules are found

getIPForwardingRule

IPForwardingRule getIPForwardingRule(long id)

get a specific IPForwardingRule by id

Parameters:

id - IPForwardingRule to get

Returns:

IPForwardingRule or null if not found

getIPForwardingRulesForIPAddress

Set<IPForwardingRule> getIPForwardingRulesForIPAddress(long id)

get a set of IPForwardingRules by ipaddress id

Parameters:

id - IPAddress of rule to get

Returns:

IPForwardingRule matching query or empty if not found

getIPForwardingRulesForVirtualMachine

Set<IPForwardingRule> getIPForwardingRulesForVirtualMachine(long id)

get a set of IPForwardingRules by virtual machine id

Parameters:

id - virtual machine of rule to get

Returns:

IPForwardingRule matching query or empty set if not found

createIPForwardingRule

AsyncCreateResponse createIPForwardingRule(long IPAddressId,
                                           String protocol,
                                           int startPort,
                                           CreateIPForwardingRuleOptions... options)

Creates an ip forwarding rule

Parameters:

IPAddressId - the public IP address id of the forwarding rule, already associated via associateIp

protocol - the protocol for the rule. Valid values are TCP or UDP.

startPort - the start port for the rule

Returns:

response used to track creation

deleteIPForwardingRule

Long deleteIPForwardingRule(long id)

Deletes an ip forwarding rule

Parameters:

id - the id of the forwarding rule

enableStaticNATForVirtualMachine

void enableStaticNATForVirtualMachine(long virtualMachineId,
                                      long IPAddressId)

disableStaticNATOnPublicIP

Long disableStaticNATOnPublicIP(long IPAddressId)

Disables static rule for given ip address

Parameters:

IPAddressId - the public IP address id for which static nat feature is being disabled