All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Context

@ApiService("SoftLayer_Network_Tunnel_Module_Context")
public static interface Context.Service
extends Service

A SoftLayer network tunnel allows customer to authenticate and encrypt all IP traffic between two locations.

Manage the entire network tunnel using this service. The SoftLayer_Network_Tunnel_Module_Context allows customers to manage subnets on both ends of the network tunnel. Address translations can also be managed. SoftLayer also provides the ability to apply the network tunnel configurations on the SoftLayer network devices.

See Also:: SoftLayer_Network_Tunnel_Module_Context

Method Summary

Modifier and Type	Method	Description
`Boolean`	`addCustomerSubnetToNetworkTunnel(Long subnetId)`	Associates a remote subnet to the network tunnel.
`Boolean`	`addPrivateSubnetToNetworkTunnel(Long subnetId)`	Associates a private subnet to the network tunnel.
`Boolean`	`addServiceSubnetToNetworkTunnel(Long subnetId)`	Associates a service subnet to the network tunnel.
`Boolean`	`applyConfigurationsToDevice()`	An asynchronous task will be created to apply the IPSec network tunnel's configuration to network devices.
`Context.ServiceAsync`	`asAsync()`	Get an async version of this service
`Translation`	`createAddressTranslation(Translation translation)`	Create an address translation for a network tunnel.
`List<Translation>`	`createAddressTranslations(List<Translation> translations)`	This has the same functionality as the SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation.
`Boolean`	`deleteAddressTranslation(Long translationId)`	Remove an existing address translation from a network tunnel.
`Entity`	`downloadAddressTranslationConfigurations()`	Provides all of the address translation configurations for an IPSec VPN tunnel in a text file
`Entity`	`downloadParameterConfigurations()`	Provides all of the configurations for an IPSec VPN network tunnel in a text file
`Translation`	`editAddressTranslation(Translation translation)`	Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for an existing address translation for a network tunnel.
`List<Translation>`	`editAddressTranslations(List<Translation> translations)`	Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for existing address translations for a network tunnel.
`Boolean`	`editObject(Context templateObject)`	Negotiation parameters for both phases one and two are editable.
`Account`	`getAccount()`	The account that a network tunnel belongs to.
`Transaction`	`getActiveTransaction()`	The transaction that is currently applying configurations for the network tunnel.
`String`	`getAddressTranslationConfigurations()`	The address translations will be returned.
`List<Translation>`	`getAddressTranslations()`	A network tunnel's address translations.
`List<Subnet>`	`getAllAvailableServiceSubnets()`	Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.
`String`	`getAuthenticationDefault()`	The default authentication type used for both phases of the negotiation process.
`List<String>`	`getAuthenticationOptions()`	Authentication options available for both phases of the negotiation process.
`Item`	`getBillingItem()`	The current billing item for network tunnel.
`List<Subnet>`	`getCustomerSubnets()`	Remote subnets that are allowed access through a network tunnel.
`Location`	`getDatacenter()`	The datacenter location for one end of the network tunnel that allows access to account's private subnets.
`Long`	`getDiffieHellmanGroupDefault()`	The default Diffie-Hellman group used for both phases of the negotiation process.
`List<Long>`	`getDiffieHellmanGroupOptions()`	The Diffie-Hellman group options used for both phases of the negotiation process.
`String`	`getEncryptionDefault()`	The default encryption type used for both phases of the negotiation process.
`List<String>`	`getEncryptionOptions()`	Encryption options available for both phases of the negotiation process.
`List<Subnet>`	`getInternalSubnets()`	Private subnets that can be accessed through the network tunnel.
`List<Long>`	`getKeylifeLimits()`	The keylife limits.
`Context`	`getObject()`	getObject retrieves the SoftLayer_Network_Tunnel_Module_Context object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Tunnel_Module_Context service.
`String`	`getParameterConfigurationsForCustomerView()`	All of the IPSec VPN tunnel's configurations will be returned.
`String`	`getPhaseOneKeylifeDefault()`	The default phase 1 keylife used if a value is not provided.
`String`	`getPhaseTwoKeylifeDefault()`	The default phase 2 keylife used if a value is not provided.
`List<Subnet>`	`getServiceSubnets()`	Service subnets that can be access through the network tunnel.
`List<Subnet>`	`getStaticRouteSubnets()`	Subnets used for a network tunnel's address translations.
`List<Transaction>`	`getTransactionHistory()`	The transaction history for this network tunnel.
`Boolean`	`removeCustomerSubnetFromNetworkTunnel(Long subnetId)`	Disassociate a customer subnet (remote) from a network tunnel.
`Boolean`	`removePrivateSubnetFromNetworkTunnel(Long subnetId)`	Disassociate a private subnet from a network tunnel.
`Boolean`	`removeServiceSubnetFromNetworkTunnel(Long subnetId)`	Disassociate a service subnet from a network tunnel.
`void`	`setMask(Context.Mask mask)`
`Context.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Context.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
  
  Context.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Context.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
  
  Context.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(Context.Mask mask)
- addCustomerSubnetToNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean addCustomerSubnetToNetworkTunnel(Long subnetId)
  
  Associates a remote subnet to the network tunnel. When a remote subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::addCustomerSubnetToNetworkTunnel
- addPrivateSubnetToNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean addPrivateSubnetToNetworkTunnel(Long subnetId)
  
  Associates a private subnet to the network tunnel. When a private subnet is associated, the network tunnel will allow the customer (remote) network to access the private subnet.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::addPrivateSubnetToNetworkTunnel
- addServiceSubnetToNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean addServiceSubnetToNetworkTunnel(Long subnetId)
  
  Associates a service subnet to the network tunnel. When a service subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel. Service subnets provide access to SoftLayer services such as the customer management portal and the SoftLayer API.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::addServiceSubnetToNetworkTunnel
- applyConfigurationsToDevice
  
  @ApiMethod(instanceRequired=true) Boolean applyConfigurationsToDevice()
  
  An asynchronous task will be created to apply the IPSec network tunnel's configuration to network devices. During this time, an IPSec network tunnel cannot be modified in anyway. Only one network tunnel configuration task can be created at a time. If a task has already been created and has not completed, a new task cannot be created.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::applyConfigurationsToDevice
- createAddressTranslation
  
  @ApiMethod(instanceRequired=true) Translation createAddressTranslation(Translation translation)
  
  Create an address translation for a network tunnel.
  
  To create an address translation, ip addresses from an assigned /30 static route subnet are used. Address translations deliver packets to a destination ip address that is on a customer (remote) subnet.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation
- createAddressTranslations
  
  @ApiMethod(instanceRequired=true) List<Translation> createAddressTranslations(List<Translation> translations)
  
  This has the same functionality as the SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation. However, it allows multiple translations to be passed in for creation.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the address translations to be created.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::createAddressTranslations
- deleteAddressTranslation
  
  @ApiMethod(instanceRequired=true) Boolean deleteAddressTranslation(Long translationId)
  
  Remove an existing address translation from a network tunnel.
  
  Address translations deliver packets to a destination ip address that is on a customer subnet (remote).
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be deleted.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::deleteAddressTranslation
- downloadAddressTranslationConfigurations
  
  @ApiMethod(instanceRequired=true) Entity downloadAddressTranslationConfigurations()
  
  Provides all of the address translation configurations for an IPSec VPN tunnel in a text file
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::downloadAddressTranslationConfigurations
- downloadParameterConfigurations
  
  @ApiMethod(instanceRequired=true) Entity downloadParameterConfigurations()
  
  Provides all of the configurations for an IPSec VPN network tunnel in a text file
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::downloadParameterConfigurations
- editAddressTranslation
  
  @ApiMethod(instanceRequired=true) Translation editAddressTranslation(Translation translation)
  
  Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for an existing address translation for a network tunnel.
  
  Address translations deliver packets to a destination ip address that is on a customer (remote) subnet.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::editAddressTranslation
- editAddressTranslations
  
  @ApiMethod(instanceRequired=true) List<Translation> editAddressTranslations(List<Translation> translations)
  
  Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for existing address translations for a network tunnel.
  
  Address translations deliver packets to a destination ip address that is on a customer (remote) subnet.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be modified.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::editAddressTranslations
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Context templateObject)
  
  Negotiation parameters for both phases one and two are editable. Here are the phase one and two parameters that can modified:
  
  *Phase One
  **Authentication
  ***Default value is set to MD5.
  ***Valid Options are: MD5, SHA1, SHA256.
  **Encryption
  ***Default value is set to 3DES.
  ***Valid Options are: DES, 3DES, AES128, AES192, AES256.
  **Diffie-Hellman Group
  ***Default value is set to 2.
  ***Valid Options are: 0 (None), 1, 2, 5.
  **Keylife
  ***Default value is set to 3600.
  ***Limits are: MIN = 120, MAX = 172800
  **Preshared Key
  *Phase Two
  **Authentication
  ***Default value is set to MD5.
  ***Valid Options are: MD5, SHA1, SHA256.
  **Encryption
  ***Default value is set to 3DES.
  ***Valid Options are: DES, 3DES, AES128, AES192, AES256.
  **Diffie-Hellman Group
  ***Default value is set to 2.
  ***Valid Options are: 0 (None), 1, 2, 5.
  **Keylife
  ***Default value is set to 28800.
  ***Limits are: MIN = 120, MAX = 172800
  **Perfect Forward Secrecy
  ***Valid Options are: Off = 0, On = 1.
  ***NOTE: If perfect forward secrecy is turned On (set to 1), then a phase 2 diffie-hellman group is required.
  
  The remote peer address for the network tunnel may also be modified if needed. Invalid options will not be accepted and will cause an exception to be thrown. There are properties that provide valid options and limits for each negotiation parameter. Those properties are as follows:
  * encryptionDefault
  * encryptionOptions
  * authenticationDefault
  * authenticationOptions
  * diffieHellmanGroupDefault
  * diffieHellmanGroupOptions
  * phaseOneKeylifeDefault
  * phaseTwoKeylifeDefault
  * keylifeLimits
  
  Configurations cannot be modified if a network tunnel's requires complex manual setups/configuration modifications by the SoftLayer Network department. If the former is required, the configurations for the network tunnel will be locked until the manual configurations are complete. A network tunnel's configurations are applied via a transaction. If a network tunnel configuration change transaction is currently running, the network tunnel's setting cannot be modified until the running transaction completes.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the modifications made to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::editObject
- getAddressTranslationConfigurations
  
  @ApiMethod(instanceRequired=true) String getAddressTranslationConfigurations()
  
  The address translations will be returned. All the translations will be formatted so that the configurations can be copied into a host file.
  
  Format:
  
  {address translation SoftLayer IP Address} {address translation name}
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAddressTranslationConfigurations
- getAuthenticationDefault
  
  @ApiMethod String getAuthenticationDefault()
  
  The default authentication type used for both phases of the negotiation process. The default value is set to MD5.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAuthenticationDefault
- getAuthenticationOptions
  
  @ApiMethod List<String> getAuthenticationOptions()
  
  Authentication options available for both phases of the negotiation process.
  
  The authentication options are as follows:
  * MD5
  * SHA1
  * SHA256
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAuthenticationOptions
- getDiffieHellmanGroupDefault
  
  @ApiMethod Long getDiffieHellmanGroupDefault()
  
  The default Diffie-Hellman group used for both phases of the negotiation process. The default value is set to 2.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getDiffieHellmanGroupDefault
- getDiffieHellmanGroupOptions
  
  @ApiMethod List<Long> getDiffieHellmanGroupOptions()
  
  The Diffie-Hellman group options used for both phases of the negotiation process.
  
  The diffie-hellman group options are as follows:
  * 0 (None)
  * 1
  * 2
  * 5
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getDiffieHellmanGroupOptions
- getEncryptionDefault
  
  @ApiMethod String getEncryptionDefault()
  
  The default encryption type used for both phases of the negotiation process. The default value is set to 3DES.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getEncryptionDefault
- getEncryptionOptions
  
  @ApiMethod List<String> getEncryptionOptions()
  
  Encryption options available for both phases of the negotiation process.
  
  The valid encryption options are as follows:
  * DES
  * 3DES
  * AES128
  * AES192
  * AES256
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getEncryptionOptions
- getKeylifeLimits
  
  @ApiMethod List<Long> getKeylifeLimits()
  
  The keylife limits. Keylife max limit is set to 120. Keylife min limit is set to 172800.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getKeylifeLimits
- getObject
  
  @ApiMethod(instanceRequired=true) Context getObject()
  
  getObject retrieves the SoftLayer_Network_Tunnel_Module_Context object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Tunnel_Module_Context service. The IPSec network tunnel will be returned if it is associated with the account and the user has proper permission to manage network tunnels.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getObject
- getParameterConfigurationsForCustomerView
  
  @ApiMethod(instanceRequired=true) String getParameterConfigurationsForCustomerView()
  
  All of the IPSec VPN tunnel's configurations will be returned. It will list all of phase one and two negotiation parameters. Both remote and local subnets will be provided as well. This is useful when the configurations need to be passed on to another team and/or company for internal network configuration.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getParameterConfigurationsForCustomerView
- getPhaseOneKeylifeDefault
  
  @ApiMethod String getPhaseOneKeylifeDefault()
  
  The default phase 1 keylife used if a value is not provided. The default value is set to 3600.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getPhaseOneKeylifeDefault
- getPhaseTwoKeylifeDefault
  
  @ApiMethod String getPhaseTwoKeylifeDefault()
  
  The default phase 2 keylife used if a value is not provided. The default value is set to 28800.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getPhaseTwoKeylifeDefault
- removeCustomerSubnetFromNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean removeCustomerSubnetFromNetworkTunnel(Long subnetId)
  
  Disassociate a customer subnet (remote) from a network tunnel. When a remote subnet is disassociated, that subnet will not able to communicate with private and service subnets on the SoftLayer network.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::removeCustomerSubnetFromNetworkTunnel
- removePrivateSubnetFromNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean removePrivateSubnetFromNetworkTunnel(Long subnetId)
  
  Disassociate a private subnet from a network tunnel. When a private subnet is disassociated, the customer (remote) subnet on the other end of the tunnel will not able to communicate with the private subnet that was just disassociated.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::removePrivateSubnetFromNetworkTunnel
- removeServiceSubnetFromNetworkTunnel
  
  @ApiMethod(instanceRequired=true) Boolean removeServiceSubnetFromNetworkTunnel(Long subnetId)
  
  Disassociate a service subnet from a network tunnel. When a service subnet is disassociated, that customer (remote) subnet on the other end of the network tunnel will not able to communicate with that service subnet on the SoftLayer network.
  
  NOTE: A network tunnel's configurations must be applied to the network device in order for the disassociation described above to take effect.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::removeServiceSubnetFromNetworkTunnel
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The account that a network tunnel belongs to.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAccount
- getActiveTransaction
  
  @ApiMethod(instanceRequired=true) Transaction getActiveTransaction()
  
  The transaction that is currently applying configurations for the network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getActiveTransaction
- getAddressTranslations
  
  @ApiMethod(instanceRequired=true) List<Translation> getAddressTranslations()
  
  A network tunnel's address translations.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAddressTranslations
- getAllAvailableServiceSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getAllAvailableServiceSubnets()
  
  Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getAllAvailableServiceSubnets
- getBillingItem
  
  @ApiMethod(instanceRequired=true) Item getBillingItem()
  
  The current billing item for network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getBillingItem
- getCustomerSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getCustomerSubnets()
  
  Remote subnets that are allowed access through a network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getCustomerSubnets
- getDatacenter
  
  @ApiMethod(instanceRequired=true) Location getDatacenter()
  
  The datacenter location for one end of the network tunnel that allows access to account's private subnets.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getDatacenter
- getInternalSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getInternalSubnets()
  
  Private subnets that can be accessed through the network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getInternalSubnets
- getServiceSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getServiceSubnets()
  
  Service subnets that can be access through the network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getServiceSubnets
- getStaticRouteSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getStaticRouteSubnets()
  
  Subnets used for a network tunnel's address translations.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getStaticRouteSubnets
- getTransactionHistory
  
  @ApiMethod(instanceRequired=true) List<Transaction> getTransactionHistory()
  
  The transaction history for this network tunnel.
  
  See Also:
  
  SoftLayer_Network_Tunnel_Module_Context::getTransactionHistory

Interface Context.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details

asAsync

withNewMask

withMask

setMask

addCustomerSubnetToNetworkTunnel

addPrivateSubnetToNetworkTunnel

addServiceSubnetToNetworkTunnel

applyConfigurationsToDevice

createAddressTranslation

createAddressTranslations

deleteAddressTranslation

downloadAddressTranslationConfigurations

downloadParameterConfigurations

editAddressTranslation

editAddressTranslations

editObject

getAddressTranslationConfigurations

getAuthenticationDefault

getAuthenticationOptions

getDiffieHellmanGroupDefault

getDiffieHellmanGroupOptions

getEncryptionDefault

getEncryptionOptions

getKeylifeLimits

getObject

getParameterConfigurationsForCustomerView

getPhaseOneKeylifeDefault

getPhaseTwoKeylifeDefault

removeCustomerSubnetFromNetworkTunnel

removePrivateSubnetFromNetworkTunnel

removeServiceSubnetFromNetworkTunnel

getAccount

getActiveTransaction

getAddressTranslations

getAllAvailableServiceSubnets

getBillingItem

getCustomerSubnets

getDatacenter

getInternalSubnets

getServiceSubnets

getStaticRouteSubnets

getTransactionHistory