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

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 service
`Request`	`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 limits
`List<NetworkComponentBinding>`	`getNetworkComponentBindings()`	The network component bindings for this security group.
`SecurityGroup`	`getObject()`
`List<OrderBinding>`	`getOrderBindings()`	The order bindings for this security group
`List<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 present
`SecurityGroup.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  SecurityGroup.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface 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 interface Maskable
- withMask
  
  SecurityGroup.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- 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.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::addRules
- 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.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::attachNetworkComponents
- createObject
  
  @ApiMethod SecurityGroup createObject(SecurityGroup templateObject)
  
  Create a new security group.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::createObject
- createObjects
  
  @ApiMethod List<SecurityGroup> createObjects(List<SecurityGroup> templateObjects)
  
  Create new security groups.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::createObjects
- 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]].
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::deleteObject
- 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]].
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::deleteObjects
- 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)]].
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::detachNetworkComponents
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(SecurityGroup templateObject)
  
  Edit a security group.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::editObject
- editObjects
  
  @ApiMethod Boolean editObjects(List<SecurityGroup> templateObjects)
  
  Edit security groups.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::editObjects
- 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.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::editRules
- getAllObjects
  
  @ApiMethod List<SecurityGroup> getAllObjects()
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getAllObjects
- getLimits
  
  @ApiMethod List<Limit> getLimits()
  
  List the current security group limits
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getLimits
- getObject
  
  @ApiMethod(instanceRequired=true) SecurityGroup getObject()
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getObject
- getSupportedDataCenters
  
  @ApiMethod List<Location> getSupportedDataCenters()
  
  List the data centers that currently support the use of security groups.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getSupportedDataCenters
- removeRules
  
  @ApiMethod(instanceRequired=true) RequestRules removeRules(List<Long> ruleIds)
  
  Remove rules from a security group.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::removeRules
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The account this security group belongs to.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getAccount
- getNetworkComponentBindings
  
  @ApiMethod(instanceRequired=true) List<NetworkComponentBinding> getNetworkComponentBindings()
  
  The network component bindings for this security group.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getNetworkComponentBindings
- getOrderBindings
  
  @ApiMethod(instanceRequired=true) List<OrderBinding> getOrderBindings()
  
  The order bindings for this security group
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getOrderBindings
- getRules
  
  @ApiMethod(instanceRequired=true) List<Rule> getRules()
  
  The rules for this security group.
  
  See Also:
  
  SoftLayer_Network_SecurityGroup::getRules

Interface SecurityGroup.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details