org.jclouds.cloudstack.features
Interface LoadBalancerApi

public interface LoadBalancerApi

Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

String	assignVirtualMachinesToLoadBalancerRule(String id, Iterable<String> virtualMachineIds) Assigns virtual machine or a list of virtual machines to a load balancer rule.
String	assignVirtualMachinesToLoadBalancerRule(String id, String... virtualMachineIds) Assigns virtual machine or a list of virtual machines to a load balancer rule.
String	createLoadBalancerRuleForPublicIP(String publicIPId, LoadBalancerRule.Algorithm algorithm, String name, int privatePort, int publicPort, CreateLoadBalancerRuleOptions... options) Creates a load balancer rule.
String	deleteLoadBalancerRule(String id) deletes a loadbalancer rule
LoadBalancerRule	getLoadBalancerRule(String id) get a specific LoadBalancerRule by id
Set<LoadBalancerRule>	listLoadBalancerRules(ListLoadBalancerRulesOptions... options) List the load balancer rules
Set<VirtualMachine>	listVirtualMachinesAssignedToLoadBalancerRule(String id) List all virtual machine instances that are assigned to a load balancer rule.
String	removeVirtualMachinesFromLoadBalancerRule(String id, Iterable<String> virtualMachineIds) Removes a virtual machine or a list of virtual machines from a load balancer rule.
String	removeVirtualMachinesFromLoadBalancerRule(String id, String... virtualMachineIds) Removes a virtual machine or a list of virtual machines from a load balancer rule.
LoadBalancerRule	updateLoadBalancerRule(String id, UpdateLoadBalancerRuleOptions... options) Update a load balancer rule.

Method Detail

listLoadBalancerRules

@Named(value="listLoadBalancerRules")
Set<LoadBalancerRule> listLoadBalancerRules(ListLoadBalancerRulesOptions... options)

List the load balancer rules

Parameters:

options - if present, how to constrain the list.

Returns:

load balancer rules matching query, or empty set, if no load balancer rules are found

getLoadBalancerRule

@Named(value="listLoadBalancerRules")
LoadBalancerRule getLoadBalancerRule(String id)

get a specific LoadBalancerRule by id

Parameters:

id - LoadBalancerRule to get

Returns:

LoadBalancerRule or null if not found

createLoadBalancerRuleForPublicIP

@Named(value="createLoadBalancerRule")
String createLoadBalancerRuleForPublicIP(String publicIPId,
                                               LoadBalancerRule.Algorithm algorithm,
                                               String name,
                                               int privatePort,
                                               int publicPort,
                                               CreateLoadBalancerRuleOptions... options)

Creates a load balancer rule.

Parameters:

publicIPId - the public port from where the network traffic will be load balanced from

algorithm - load balancer algorithm (source, roundrobin, leastconn)

name - name of the load balancer rule

privatePort - the private port of the private ip address/virtual machine where the network traffic will be load balanced to

publicPort - public ip address id from where the network traffic will be load balanced from

options - optional call arguments

Returns:

newly created rule

updateLoadBalancerRule

@Named(value="updateLoadBalancerRule")
LoadBalancerRule updateLoadBalancerRule(String id,
                                              UpdateLoadBalancerRuleOptions... options)

Update a load balancer rule.

Parameters:

id - rule id

options - optional arguments

Returns:

updated rule

deleteLoadBalancerRule

@Named(value="deleteLoadBalancerRule")
String deleteLoadBalancerRule(String id)

deletes a loadbalancer rule

Parameters:

id - id of the rule to delete

Returns:

async job id of the job completing or null, if the load balancer rule was not found.

assignVirtualMachinesToLoadBalancerRule

@Named(value="assignToLoadBalancerRule")
String assignVirtualMachinesToLoadBalancerRule(String id,
                                                     Iterable<String> virtualMachineIds)

Assigns virtual machine or a list of virtual machines to a load balancer rule.

Parameters:

id - the ID of the load balancer rule

virtualMachineIds - the list of IDs of the virtual machine that are being assigned to the load balancer rule

Returns:

job id related to the operation

assignVirtualMachinesToLoadBalancerRule

@Named(value="assignToLoadBalancerRule")
String assignVirtualMachinesToLoadBalancerRule(String id,
                                                     String... virtualMachineIds)

Assigns virtual machine or a list of virtual machines to a load balancer rule.

Parameters:

id - the ID of the load balancer rule

virtualMachineIds - the list of IDs of the virtual machine that are being assigned to the load balancer rule

Returns:

job id related to the operation

removeVirtualMachinesFromLoadBalancerRule

@Named(value="removeFromLoadBalancerRule")
String removeVirtualMachinesFromLoadBalancerRule(String id,
                                                       Iterable<String> virtualMachineIds)

Removes a virtual machine or a list of virtual machines from a load balancer rule.

Parameters:

id - the ID of the load balancer rule

virtualMachineIds - the list of IDs of the virtual machine that are being removed from the load balancer rule

Returns:

job id related to the operation

removeVirtualMachinesFromLoadBalancerRule

@Named(value="removeFromLoadBalancerRule")
String removeVirtualMachinesFromLoadBalancerRule(String id,
                                                       String... virtualMachineIds)

Removes a virtual machine or a list of virtual machines from a load balancer rule.

Parameters:

id - the ID of the load balancer rule

virtualMachineIds - the list of IDs of the virtual machine that are being removed from the load balancer rule

Returns:

job id related to the operation

listVirtualMachinesAssignedToLoadBalancerRule

@Named(value="listLoadBalancerRuleInstances")
Set<VirtualMachine> listVirtualMachinesAssignedToLoadBalancerRule(String id)

List all virtual machine instances that are assigned to a load balancer rule.

Parameters:

id - id of the rule

Returns:

VirtualMachines matching query, or empty set, if no VirtualMachines are assigned