org.jclouds.cloudstack.features
Interface SecurityGroupApi

public interface SecurityGroupApi

Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

String	authorizeIngressICMPToCIDRs(String securityGroupId, int ICMPCode, int ICMPType, Iterable<String> cidrList, AccountInDomainOptions... options) Authorizes a particular ICMP ingress rule for this security group
String	authorizeIngressICMPToSecurityGroups(String securityGroupId, int ICMPCode, int ICMPType, com.google.common.collect.Multimap<String,String> accountToGroup, AccountInDomainOptions... options) Authorizes a particular ICMP ingress rule for this security group
String	authorizeIngressPortsToCIDRs(String securityGroupId, String protocol, int startPort, int endPort, Iterable<String> cidrList, AccountInDomainOptions... options) Authorizes a particular TCP or UDP ingress rule for this security group
String	authorizeIngressPortsToSecurityGroups(String securityGroupId, String protocol, int startPort, int endPort, com.google.common.collect.Multimap<String,String> accountToGroup, AccountInDomainOptions... options) Authorizes a particular TCP or UDP ingress rule for this security group
SecurityGroup	createSecurityGroup(String name) Creates a security group
void	deleteSecurityGroup(String id) delete a specific security group by id
SecurityGroup	getSecurityGroup(String id) get a specific security group by id
SecurityGroup	getSecurityGroupByName(String securityGroupName) get a specific security group by name
Set<SecurityGroup>	listSecurityGroups(ListSecurityGroupsOptions... options) Lists security groups
String	revokeIngressRule(String id, AccountInDomainOptions... options) Deletes a particular ingress rule from this security group

Method Detail

listSecurityGroups

@Named(value="listSecurityGroups")
Set<SecurityGroup> listSecurityGroups(ListSecurityGroupsOptions... options)

Lists security groups

Parameters:

options - if present, how to constrain the list.

Returns:

security groups matching query, or empty set, if no security groups are found

getSecurityGroup

@Named(value="listSecurityGroups")
SecurityGroup getSecurityGroup(String id)

get a specific security group by id

Parameters:

id - group to get

Returns:

security group or null if not found

getSecurityGroupByName

@Named(value="listSecurityGroups")
SecurityGroup getSecurityGroupByName(String securityGroupName)

get a specific security group by name

Parameters:

securityGroupName - group to get

Returns:

security group or null if not found

createSecurityGroup

@Named(value="createSecurityGroup")
SecurityGroup createSecurityGroup(String name)

Creates a security group

Parameters:

name - name of the security group

Returns:

security group

authorizeIngressPortsToCIDRs

@Named(value="authorizeSecurityGroupIngress")
String authorizeIngressPortsToCIDRs(String securityGroupId,
                                          String protocol,
                                          int startPort,
                                          int endPort,
                                          Iterable<String> cidrList,
                                          AccountInDomainOptions... options)

Authorizes a particular TCP or UDP ingress rule for this security group

Parameters:

securityGroupId - The ID of the security group

protocol - tcp or udp

startPort - start port for this ingress rule

endPort - end port for this ingress rule

cidrList - the cidr list associated

Returns:

response relating to the creation of this ingress rule

authorizeIngressPortsToSecurityGroups

@Named(value="authorizeSecurityGroupIngress")
String authorizeIngressPortsToSecurityGroups(String securityGroupId,
                                                   String protocol,
                                                   int startPort,
                                                   int endPort,
                                                   com.google.common.collect.Multimap<String,String> accountToGroup,
                                                   AccountInDomainOptions... options)

Authorizes a particular TCP or UDP ingress rule for this security group

Parameters:

securityGroupId - The ID of the security group

protocol - tcp or udp

startPort - start port for this ingress rule

endPort - end port for this ingress rule

accountToGroup - mapping of account names to security groups you wish to authorize

Returns:

response relating to the creation of this ingress rule

authorizeIngressICMPToCIDRs

@Named(value="authorizeSecurityGroupIngress")
String authorizeIngressICMPToCIDRs(String securityGroupId,
                                         int ICMPCode,
                                         int ICMPType,
                                         Iterable<String> cidrList,
                                         AccountInDomainOptions... options)

Authorizes a particular ICMP ingress rule for this security group

Parameters:

securityGroupId - The ID of the security group

ICMPCode - type of the icmp message being sent

ICMPType - error code for this icmp message

cidrList - the cidr list associated

Returns:

response relating to the creation of this ingress rule

authorizeIngressICMPToSecurityGroups

@Named(value="authorizeSecurityGroupIngress")
String authorizeIngressICMPToSecurityGroups(String securityGroupId,
                                                  int ICMPCode,
                                                  int ICMPType,
                                                  com.google.common.collect.Multimap<String,String> accountToGroup,
                                                  AccountInDomainOptions... options)

Authorizes a particular ICMP ingress rule for this security group

Parameters:

securityGroupId - The ID of the security group

ICMPCode - type of the icmp message being sent

ICMPType - error code for this icmp message

accountToGroup - mapping of account names to security groups you wish to authorize

Returns:

response relating to the creation of this ingress rule

revokeIngressRule

@Named(value="revokeSecurityGroupIngress")
String revokeIngressRule(String id,
                               AccountInDomainOptions... options)

Deletes a particular ingress rule from this security group

Parameters:

id - The ID of the ingress rule

options - scope of the rule.

deleteSecurityGroup

@Named(value="deleteSecurityGroup")
void deleteSecurityGroup(String id)

delete a specific security group by id

Parameters:

id - group to delete