All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Subnet
```
@ApiService("SoftLayer_Network_Subnet")
public static interface Subnet.Service
extends Service
```
Every SoftLayer ip address is associated with a subnet which is defined in the SoftLayer_Network_Subnet service. SoftLayer subnets define a group of ip addresses and are assigned to a SoftLayer_Network_Vlan. The SoftLayer_Network_Subnet service gives you information about your subnet such as your network address, broadcast address, the subnet gateway address, and the total number of IP addresses within the subnet. Use the data returned by these methods with other API services to get more detailed information about your services.

Along with VLANs, subnets are an integral part of the SoftLayer network. Each server ordered by SoftLayer comes with at least one public and one private subnet, with more available for order in the customer portal. Subnets exist in the SoftLayer network as either interfaces on a VLAN or as route destination from an IP address or VLAN.

SoftLayer customers can order and manage subnets through the customer portal. If you need to cancel a subnet please open a sales ticket in our customer portal and our account management staff will assist you.

See Also:

SoftLayer_Network_Subnet

Method Summary

Modifier and Type	Method	Description
`Boolean`	`allowAccessToNetworkStorage(Storage networkStorageTemplateObject)`	This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
`Boolean`	`allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
`Subnet.ServiceAsync`	`asAsync()`	Get an async version of this service
`Reverse`	`createReverseDomainRecords()`	Create the default PTR records for this subnet
`Boolean`	`createSubnetRouteUpdateTransaction(String newEndPointIpAddress)`	This function is used to create a new transaction to modify a subnet route.
`Boolean`	`createSwipTransaction()`	This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN.
`Boolean`	`editNote(String note)`	Edit the note for this subnet.
`List<Subnet>`	`findAllSubnetsAndActiveSwipTransactionStatus()`	Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses.
`Account`	`getAccount()`
`Registration`	`getActiveRegistration()`	If present, the active registration for this subnet.
`Transaction`	`getActiveSwipTransaction()`	All the swip transactions associated with a subnet that are still active.
`Transaction`	`getActiveTransaction()`	The billing item for a subnet.
`String`	`getAddressSpace()`	Identifier which distinguishes what classification of addresses the subnet represents.
`Host`	`getAllowedHost()`	The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.
`List<Storage>`	`getAllowedNetworkStorage()`	The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
`List<Storage>`	`getAllowedNetworkStorageReplicas()`	The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
`List<Storage>`	`getAttachedNetworkStorages(String nasType)`	This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet.
`List<Storage>`	`getAvailableNetworkStorages(String nasType)`	This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet.
`Item`	`getBillingItem()`	The billing item for a subnet.
`List<Subnet>`	`getBoundDescendants()`
`Boolean`	`getBoundRouterFlag()`	Whether or not this subnet is associated with a router.
`List<Hardware>`	`getBoundRouters()`
`List<Subnet>`	`getChildren()`
`Datacenter`	`getDatacenter()`	The data center this subnet may be routed within.
`List<Subnet>`	`getDescendants()`
`String`	`getDisplayLabel()`
`IpAddress`	`getEndPointIpAddress()`	A static routed ip address
`Global`	`getGlobalIpRecord()`
`List<Hardware>`	`getHardware()`	The hardware using IP addresses on this subnet.
`List<IpAddress>`	`getIpAddresses()`	All the ip addresses associated with a subnet.
`Firewall`	`getNetworkComponentFirewall()`	The upstream network component firewall.
`List<Address>`	`getNetworkProtectionAddresses()`
`List<Context>`	`getNetworkTunnelContexts()`	IPSec network tunnels that have access to a private subnet.
`Vlan`	`getNetworkVlan()`	The VLAN object that a subnet is associated with.
`Subnet`	`getObject()`	getObject retrieves the SoftLayer_Network_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet service.
`String`	`getPodName()`	The pod in which this subnet resides.
`List<IpAddress>`	`getProtectedIpAddresses()`
`Registry`	`getRegionalInternetRegistry()`
`List<Registration>`	`getRegistrations()`	All registrations that have been created for this subnet.
`Domain`	`getReverseDomain()`	The reverse DNS domain associated with this subnet.
`List<Domain>`	`getReverseDomainRecords()`	Retrieve all reverse DNS records associated with a subnet.
`String`	`getRoleKeyName()`	An identifier of the role the subnet is within.
`String`	`getRoleName()`	The name of the role the subnet is within.
`List<IpAddress>`	`getRoutableEndpointIpAddresses()`	getRoutableEndpointAddresses retrieves valid routable endpoint addresses for a subnet.
`String`	`getRoutingTypeKeyName()`	The identifier for the type of route then subnet is currently configured for.
`String`	`getRoutingTypeName()`	The name for the type of route then subnet is currently configured for.
`Subnet`	`getSubnetForIpAddress(String ipAddress)`	Retrieve the subnet associated with an IP address.
`List<Transaction>`	`getSwipTransaction()`	All the swip transactions associated with a subnet.
`List<Subnet>`	`getUnboundDescendants()`
`Long`	`getUtilizedIpAddressCount()`	Provides the total number of utilized IP addresses on this subnet.
`List<Guest>`	`getVirtualGuests()`	The Virtual Servers using IP addresses on this subnet.
`Boolean`	`removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to remove access to multiple SoftLayer_Network_Storage volumes
`void`	`setMask(Subnet.Mask mask)`
`Subnet.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Subnet.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 Detail
  - asAsync
```
Subnet.ServiceAsync asAsync()
```
    Description copied from interface: Service
    
    Get an async version of this service
    
    Specified by:
    
    asAsync in interface Service
  - withNewMask
```
Subnet.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
```
Subnet.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(Subnet.Mask mask)
```
  - allowAccessToNetworkStorage
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject)
```
    This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    
    See Also:
    
    SoftLayer_Network_Subnet::allowAccessToNetworkStorage
  - allowAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    
    See Also:
    
    SoftLayer_Network_Subnet::allowAccessToNetworkStorageList
  - createReverseDomainRecords
```
@ApiMethod(instanceRequired=true)
Reverse createReverseDomainRecords()
```
    Create the default PTR records for this subnet
    
    See Also:
    
    SoftLayer_Network_Subnet::createReverseDomainRecords
  - createSubnetRouteUpdateTransaction
```
@ApiMethod(instanceRequired=true)
Boolean createSubnetRouteUpdateTransaction(String newEndPointIpAddress)
```
    This function is used to create a new transaction to modify a subnet route. Routes are updated in one to two minutes depending on the number of transactions that are pending for a router.
    
    Usage of this function is restricted and may only be called from authorized accounts. It is not available for general API users without justification and consent from a SoftLayer representative.
    
    See Also:
    
    SoftLayer_Network_Subnet::createSubnetRouteUpdateTransaction
  - createSwipTransaction
```
@ApiMethod(instanceRequired=true)
Boolean createSwipTransaction()
```
    This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses.
    
    See Also:
    
    SoftLayer_Network_Subnet::createSwipTransaction
  - editNote
```
@ApiMethod(instanceRequired=true)
Boolean editNote(String note)
```
    Edit the note for this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::editNote
  - findAllSubnetsAndActiveSwipTransactionStatus
```
@ApiMethod
List<Subnet> findAllSubnetsAndActiveSwipTransactionStatus()
```
    Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets' associated SWIP transactions as well.
    
    This is a special function built for SoftLayer's use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data.
    
    See Also:
    
    SoftLayer_Network_Subnet::findAllSubnetsAndActiveSwipTransactionStatus
  - getAttachedNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAttachedNetworkStorages(String nasType)
```
    This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAttachedNetworkStorages
  - getAvailableNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAvailableNetworkStorages(String nasType)
```
    This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAvailableNetworkStorages
  - getObject
```
@ApiMethod(instanceRequired=true)
Subnet getObject()
```
    getObject retrieves the SoftLayer_Network_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet service. You can only retrieve the subnet whose vlan is associated with the account that you portal user is assigned to.
    
    See Also:
    
    SoftLayer_Network_Subnet::getObject
  - getReverseDomainRecords
```
@ApiMethod(instanceRequired=true)
List<Domain> getReverseDomainRecords()
```
    Retrieve all reverse DNS records associated with a subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getReverseDomainRecords
  - getRoutableEndpointIpAddresses
```
@ApiMethod(instanceRequired=true)
List<IpAddress> getRoutableEndpointIpAddresses()
```
    getRoutableEndpointAddresses retrieves valid routable endpoint addresses for a subnet. You may use any IP address in a portable subnet, but may not use the network identifier, gateway, or broadcast address for primary and secondary on VLAN subnets.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRoutableEndpointIpAddresses
  - getSubnetForIpAddress
```
@ApiMethod
Subnet getSubnetForIpAddress(String ipAddress)
```
    Retrieve the subnet associated with an IP address. You may only retrieve subnets assigned to your SoftLayer customer account.
    
    See Also:
    
    SoftLayer_Network_Subnet::getSubnetForIpAddress
  - removeAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to remove access to multiple SoftLayer_Network_Storage volumes
    
    See Also:
    
    SoftLayer_Network_Subnet::removeAccessToNetworkStorageList
  - getAccount
```
@ApiMethod(instanceRequired=true)
Account getAccount()
```
    See Also:
    
    SoftLayer_Network_Subnet::getAccount
  - getActiveRegistration
```
@ApiMethod(instanceRequired=true)
Registration getActiveRegistration()
```
    If present, the active registration for this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getActiveRegistration
  - getActiveSwipTransaction
```
@ApiMethod(instanceRequired=true)
Transaction getActiveSwipTransaction()
```
    All the swip transactions associated with a subnet that are still active.
    
    See Also:
    
    SoftLayer_Network_Subnet::getActiveSwipTransaction
  - getActiveTransaction
```
@ApiMethod(instanceRequired=true)
Transaction getActiveTransaction()
```
    The billing item for a subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getActiveTransaction
  - getAddressSpace
```
@ApiMethod(instanceRequired=true)
String getAddressSpace()
```
    Identifier which distinguishes what classification of addresses the subnet represents.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAddressSpace
  - getAllowedHost
```
@ApiMethod(instanceRequired=true)
Host getAllowedHost()
```
    The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAllowedHost
  - getAllowedNetworkStorage
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorage()
```
    The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAllowedNetworkStorage
  - getAllowedNetworkStorageReplicas
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorageReplicas()
```
    The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Network_Subnet::getAllowedNetworkStorageReplicas
  - getBillingItem
```
@ApiMethod(instanceRequired=true)
Item getBillingItem()
```
    The billing item for a subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getBillingItem
  - getBoundDescendants
```
@ApiMethod(instanceRequired=true)
List<Subnet> getBoundDescendants()
```
    See Also:
    
    SoftLayer_Network_Subnet::getBoundDescendants
  - getBoundRouterFlag
```
@ApiMethod(instanceRequired=true)
Boolean getBoundRouterFlag()
```
    Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed.
    
    See Also:
    
    SoftLayer_Network_Subnet::getBoundRouterFlag
  - getBoundRouters
```
@ApiMethod(instanceRequired=true)
List<Hardware> getBoundRouters()
```
    See Also:
    
    SoftLayer_Network_Subnet::getBoundRouters
  - getChildren
```
@ApiMethod(instanceRequired=true)
List<Subnet> getChildren()
```
    See Also:
    
    SoftLayer_Network_Subnet::getChildren
  - getDatacenter
```
@ApiMethod(instanceRequired=true)
Datacenter getDatacenter()
```
    The data center this subnet may be routed within.
    
    See Also:
    
    SoftLayer_Network_Subnet::getDatacenter
  - getDescendants
```
@ApiMethod(instanceRequired=true)
List<Subnet> getDescendants()
```
    See Also:
    
    SoftLayer_Network_Subnet::getDescendants
  - getDisplayLabel
```
@ApiMethod(instanceRequired=true)
String getDisplayLabel()
```
    See Also:
    
    SoftLayer_Network_Subnet::getDisplayLabel
  - getEndPointIpAddress
```
@ApiMethod(instanceRequired=true)
IpAddress getEndPointIpAddress()
```
    A static routed ip address
    
    See Also:
    
    SoftLayer_Network_Subnet::getEndPointIpAddress
  - getGlobalIpRecord
```
@ApiMethod(instanceRequired=true)
Global getGlobalIpRecord()
```
    See Also:
    
    SoftLayer_Network_Subnet::getGlobalIpRecord
  - getHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getHardware()
```
    The hardware using IP addresses on this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getHardware
  - getIpAddresses
```
@ApiMethod(instanceRequired=true)
List<IpAddress> getIpAddresses()
```
    All the ip addresses associated with a subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getIpAddresses
  - getNetworkComponentFirewall
```
@ApiMethod(instanceRequired=true)
Firewall getNetworkComponentFirewall()
```
    The upstream network component firewall.
    
    See Also:
    
    SoftLayer_Network_Subnet::getNetworkComponentFirewall
  - getNetworkProtectionAddresses
```
@ApiMethod(instanceRequired=true)
List<Address> getNetworkProtectionAddresses()
```
    See Also:
    
    SoftLayer_Network_Subnet::getNetworkProtectionAddresses
  - getNetworkTunnelContexts
```
@ApiMethod(instanceRequired=true)
List<Context> getNetworkTunnelContexts()
```
    IPSec network tunnels that have access to a private subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getNetworkTunnelContexts
  - getNetworkVlan
```
@ApiMethod(instanceRequired=true)
Vlan getNetworkVlan()
```
    The VLAN object that a subnet is associated with.
    
    See Also:
    
    SoftLayer_Network_Subnet::getNetworkVlan
  - getPodName
```
@ApiMethod(instanceRequired=true)
String getPodName()
```
    The pod in which this subnet resides.
    
    See Also:
    
    SoftLayer_Network_Subnet::getPodName
  - getProtectedIpAddresses
```
@ApiMethod(instanceRequired=true)
List<IpAddress> getProtectedIpAddresses()
```
    See Also:
    
    SoftLayer_Network_Subnet::getProtectedIpAddresses
  - getRegionalInternetRegistry
```
@ApiMethod(instanceRequired=true)
Registry getRegionalInternetRegistry()
```
    See Also:
    
    SoftLayer_Network_Subnet::getRegionalInternetRegistry
  - getRegistrations
```
@ApiMethod(instanceRequired=true)
List<Registration> getRegistrations()
```
    All registrations that have been created for this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRegistrations
  - getReverseDomain
```
@ApiMethod(instanceRequired=true)
Domain getReverseDomain()
```
    The reverse DNS domain associated with this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getReverseDomain
  - getRoleKeyName
```
@ApiMethod(instanceRequired=true)
String getRoleKeyName()
```
    An identifier of the role the subnet is within. Roles dictate how a subnet may be used.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRoleKeyName
  - getRoleName
```
@ApiMethod(instanceRequired=true)
String getRoleName()
```
    The name of the role the subnet is within. Roles dictate how a subnet may be used.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRoleName
  - getRoutingTypeKeyName
```
@ApiMethod(instanceRequired=true)
String getRoutingTypeKeyName()
```
    The identifier for the type of route then subnet is currently configured for.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRoutingTypeKeyName
  - getRoutingTypeName
```
@ApiMethod(instanceRequired=true)
String getRoutingTypeName()
```
    The name for the type of route then subnet is currently configured for.
    
    See Also:
    
    SoftLayer_Network_Subnet::getRoutingTypeName
  - getSwipTransaction
```
@ApiMethod(instanceRequired=true)
List<Transaction> getSwipTransaction()
```
    All the swip transactions associated with a subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getSwipTransaction
  - getUnboundDescendants
```
@ApiMethod(instanceRequired=true)
List<Subnet> getUnboundDescendants()
```
    See Also:
    
    SoftLayer_Network_Subnet::getUnboundDescendants
  - getUtilizedIpAddressCount
```
@ApiMethod(instanceRequired=true)
Long getUtilizedIpAddressCount()
```
    Provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types.
    
    See Also:
    
    SoftLayer_Network_Subnet::getUtilizedIpAddressCount
  - getVirtualGuests
```
@ApiMethod(instanceRequired=true)
List<Guest> getVirtualGuests()
```
    The Virtual Servers using IP addresses on this subnet.
    
    See Also:
    
    SoftLayer_Network_Subnet::getVirtualGuests

Interface Subnet.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Detail

asAsync

withNewMask

withMask

setMask

allowAccessToNetworkStorage

allowAccessToNetworkStorageList

createReverseDomainRecords

createSubnetRouteUpdateTransaction

createSwipTransaction

editNote

findAllSubnetsAndActiveSwipTransactionStatus

getAttachedNetworkStorages

getAvailableNetworkStorages

getObject

getReverseDomainRecords

getRoutableEndpointIpAddresses

getSubnetForIpAddress

removeAccessToNetworkStorageList

getAccount

getActiveRegistration

getActiveSwipTransaction

getActiveTransaction

getAddressSpace

getAllowedHost

getAllowedNetworkStorage

getAllowedNetworkStorageReplicas

getBillingItem

getBoundDescendants

getBoundRouterFlag

getBoundRouters

getChildren

getDatacenter

getDescendants

getDisplayLabel

getEndPointIpAddress

getGlobalIpRecord

getHardware

getIpAddresses

getNetworkComponentFirewall

getNetworkProtectionAddresses

getNetworkTunnelContexts

getNetworkVlan

getPodName

getProtectedIpAddresses

getRegionalInternetRegistry

getRegistrations

getReverseDomain

getRoleKeyName

getRoleName

getRoutingTypeKeyName

getRoutingTypeName

getSwipTransaction

getUnboundDescendants

getUtilizedIpAddressCount

getVirtualGuests