NATApi (Apache jclouds 2.1.0 API)

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

```
public interface NATApi
```
Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

AsyncCreateResponse createIPForwardingRule(String IPAddressId, String protocol, int startPort, CreateIPForwardingRuleOptions... options)
Creates an ip forwarding rule

String deleteIPForwardingRule(String id)
Deletes an ip forwarding rule

String disableStaticNATOnPublicIP(String IPAddressId)
Disables static rule for given ip address

void enableStaticNATForVirtualMachine(String virtualMachineId, String IPAddressId)

IPForwardingRule getIPForwardingRule(String id)
get a specific IPForwardingRule by id

Set<IPForwardingRule> getIPForwardingRulesForIPAddress(String id)
get a set of IPForwardingRules by ipaddress id

Set<IPForwardingRule> getIPForwardingRulesForVirtualMachine(String id)
get a set of IPForwardingRules by virtual machine id

Set<IPForwardingRule> listIPForwardingRules(ListIPForwardingRulesOptions... options)
List the ip forwarding rules

Method Detail

listIPForwardingRules
```
@Named(value="listIpForwardingRules")
@GET
@Consumes(value="application/json")
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

@Named(value="listIpForwardingRules")
@GET
@Consumes(value="application/json")
IPForwardingRule getIPForwardingRule(@QueryParam(value="id")
                                                      String id)

get a specific IPForwardingRule by id

Parameters:: id - IPForwardingRule to get
Returns:: IPForwardingRule or null if not found

getIPForwardingRulesForIPAddress

@Named(value="listIpForwardingRules")
@GET
@Consumes(value="application/json")
Set<IPForwardingRule> getIPForwardingRulesForIPAddress(@QueryParam(value="ipaddressid")
                                                                        String 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

@Named(value="listIpForwardingRules")
@GET
@Consumes(value="application/json")
Set<IPForwardingRule> getIPForwardingRulesForVirtualMachine(@QueryParam(value="virtualmachineid")
                                                                             String 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

@Named(value="createIpForwardingRule")
@GET
@Consumes(value="application/json")
AsyncCreateResponse createIPForwardingRule(@QueryParam(value="ipaddressid")
                                                            String IPAddressId,
                                                            @QueryParam(value="protocol")
                                                            String protocol,
                                                            @QueryParam(value="startport")
                                                            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

enableStaticNATForVirtualMachine

@Named(value="enableStaticNat")
@GET
@Consumes(value="application/json")
void enableStaticNATForVirtualMachine(@QueryParam(value="virtualmachineid")
                                                       String virtualMachineId,
                                                       @QueryParam(value="ipaddressid")
                                                       String IPAddressId)

deleteIPForwardingRule

@Named(value="deleteIpForwardingRule")
@GET
@Consumes(value="application/json")
String deleteIPForwardingRule(@QueryParam(value="id")
                                               String id)

Deletes an ip forwarding rule

Parameters:: id - the id of the forwarding rule

disableStaticNATOnPublicIP

@Named(value="disableStaticNat")
@GET
@Consumes(value="application/json")
String disableStaticNATOnPublicIP(@QueryParam(value="ipaddressid")
                                                   String IPAddressId)

Disables static rule for given ip address

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

Interface NATApi

Method Summary