Interface SecurityGroup.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- SecurityGroup
@ApiService("SoftLayer_Network_SecurityGroup") public static interface SecurityGroup.Service extends Service
The Security Group service provides a common interface to interact with an account's security groups, their rules, and virtual guest instances associated with the groups. A security group contains a set of IP filter rules that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance. The rules that you add to a security group are known as [[SoftLayer_Network_SecurityGroup_Rule (type)|security group rules]]. Security groups can be assigned to one or more virtual servers by attaching virtual guest network components through [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)|bindings]].
Additional information can be found in IBM Cloud Docs and SoftLayer API Examples https://console.bluemix.net/docs/infrastructure/security-groups/sg_index.html https://softlayer.github.io/classes/softlayer_network_securitygroup/- See Also:
- SoftLayer_Network_SecurityGroup
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequestRules
addRules(List<Rule> ruleTemplates)
Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created.SecurityGroup.ServiceAsync
asAsync()
Get an async version of this serviceRequest
attachNetworkComponents(List<Long> networkComponentIds)
Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects.SecurityGroup
createObject(SecurityGroup templateObject)
Create a new security group.List<SecurityGroup>
createObjects(List<SecurityGroup> templateObjects)
Create new security groups.Boolean
deleteObject()
Delete a security group for an account.Boolean
deleteObjects(List<SecurityGroup> templateObjects)
Delete security groups for an account.Request
detachNetworkComponents(List<Long> networkComponentIds)
Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]].Boolean
editObject(SecurityGroup templateObject)
Edit a security group.Boolean
editObjects(List<SecurityGroup> templateObjects)
Edit security groups.RequestRules
editRules(List<Rule> ruleTemplates)
Edit rules that belong to the security group.Account
getAccount()
The account this security group belongs to.List<SecurityGroup>
getAllObjects()
List<Limit>
getLimits()
List the current security group limitsList<NetworkComponentBinding>
getNetworkComponentBindings()
The network component bindings for this security group.SecurityGroup
getObject()
List<OrderBinding>
getOrderBindings()
The order bindings for this security groupList<Rule>
getRules()
The rules for this security group.List<Location>
getSupportedDataCenters()
List the data centers that currently support the use of security groups.RequestRules
removeRules(List<Long> ruleIds)
Remove rules from a security group.void
setMask(SecurityGroup.Mask mask)
SecurityGroup.Mask
withMask()
Use the existing mask on this service or create it if not presentSecurityGroup.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
SecurityGroup.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
SecurityGroup.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
SecurityGroup.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(SecurityGroup.Mask mask)
-
addRules
@ApiMethod(instanceRequired=true) RequestRules addRules(List<Rule> ruleTemplates)
Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created.
-
attachNetworkComponents
@ApiMethod(instanceRequired=true) Request attachNetworkComponents(List<Long> networkComponentIds)
Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects.
-
createObject
@ApiMethod SecurityGroup createObject(SecurityGroup templateObject)
Create a new security group.
-
createObjects
@ApiMethod List<SecurityGroup> createObjects(List<SecurityGroup> templateObjects)
Create new security groups.
-
deleteObject
@ApiMethod(instanceRequired=true) Boolean deleteObject()
Delete a security group for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].
-
deleteObjects
@ApiMethod Boolean deleteObjects(List<SecurityGroup> templateObjects)
Delete security groups for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].
-
detachNetworkComponents
@ApiMethod(instanceRequired=true) Request detachNetworkComponents(List<Long> networkComponentIds)
Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]].
-
editObject
@ApiMethod(instanceRequired=true) Boolean editObject(SecurityGroup templateObject)
Edit a security group.
-
editObjects
@ApiMethod Boolean editObjects(List<SecurityGroup> templateObjects)
Edit security groups.
-
editRules
@ApiMethod(instanceRequired=true) RequestRules editRules(List<Rule> ruleTemplates)
Edit rules that belong to the security group. An array of skeleton [[SoftLayer_Network_SecurityGroup_Rule]] objects must be sent in with only the properties defined that you want to change. To edit a property to null, send in -1 for integer properties and "" for string properties. Unchanged properties are left alone.
-
getAllObjects
@ApiMethod List<SecurityGroup> getAllObjects()
-
getLimits
@ApiMethod List<Limit> getLimits()
List the current security group limits
-
getObject
@ApiMethod(instanceRequired=true) SecurityGroup getObject()
-
getSupportedDataCenters
@ApiMethod List<Location> getSupportedDataCenters()
List the data centers that currently support the use of security groups.
-
removeRules
@ApiMethod(instanceRequired=true) RequestRules removeRules(List<Long> ruleIds)
Remove rules from a security group.
-
getAccount
@ApiMethod(instanceRequired=true) Account getAccount()
The account this security group belongs to.
-
getNetworkComponentBindings
@ApiMethod(instanceRequired=true) List<NetworkComponentBinding> getNetworkComponentBindings()
The network component bindings for this security group.
-
getOrderBindings
@ApiMethod(instanceRequired=true) List<OrderBinding> getOrderBindings()
The order bindings for this security group
-
getRules
@ApiMethod(instanceRequired=true) List<Rule> getRules()
The rules for this security group.
-
-