Network
SoftLayer_Network_Tunnel_Module_Context

Overview

The SoftLayer_Network_Tunnel_Module_Context data type contains general information relating to a single SoftLayer network tunnel. The SoftLayer_Network_Tunnel_Module_Context is useful to gather information such as related customer subnets (remote) and internal subnets (local) associated with the network tunnel as well as other information needed to manage the network tunnel. Account and billing information related to the network tunnel can also be retrieved.

Local Properties

accountId

A network tunnel's account identifier.

Type:

integer

advancedConfigurationFlag

A flag used to specify when advanced configurations, complex configurations that require manual setup, are being applied to network devices for a network tunnel. When the flag is set to true (1), a network tunnel cannot be configured through the management portal nor the API.

Type:

integer

createDate

The date a network tunnel was created.

Type:

dateTime

customerPeerIpAddress

The remote end of a network tunnel. This end of the network tunnel resides on an outside network and will be sending and receiving the IPSec packets.

Type:

string

friendlyName

The name giving to a network tunnel by a user.

Type:

string

id

A network tunnel's unique identifier.

Type:

integer

internalPeerIpAddress

The local end of a network tunnel. This end of the network tunnel resides on the SoftLayer networks and allows access to remote end of the tunnel to subnets on SoftLayer networks.

Type:

string

modifyDate

The date a network tunnel was last modified.

NOTE: This date should NOT be used to determine when the network tunnel configurations were last applied to the network device.

Type:

dateTime

name

A network tunnel's unique name used on the network device.

Type:

string

phaseOneAuthentication

Authentication used to generate keys for protecting the negotiations for a network tunnel.

Type:

string

phaseOneDiffieHellmanGroup

Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers in the must use the Diffie-Hellman Group.

Type:

integer

phaseOneEncryption

Encryption used to generate keys for protecting the negotiations for a network tunnel.

Type:

string

phaseOneKeylife

Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds.

Type:

integer

phaseTwoAuthentication

The authentication used in phase 2 proposal negotiation process.

Type:

string

phaseTwoDiffieHellmanGroup

Determines the strength of the key used in the key exchange process. The higher the group number the stronger the key is and the more secure it is. However, processing time will increase as the strength of the key increases. Both peers must use the Diffie-Hellman Group.

Type:

integer

phaseTwoEncryption

The encryption used in phase 2 proposal negotiation process.

Type:

string

phaseTwoKeylife

Amount of time (in seconds) allowed to pass before the encryption key expires. A new key is generated without interrupting service. Valid times are from 120 to 172800 seconds.

Type:

integer

phaseTwoPerfectForwardSecrecy

Determines if the generated keys are made from previous keys. When PFS is specified, a Diffie-Hellman exchange occurs each time a new security association is negotiated.

Type:

integer

presharedKey

A key used so that peers authenticate each other. This key is hashed by using the phase one encryption and phase one authentication.

Type:

string

Relational & Count Properties

Relational Properties can be queried by object mask
account

The account that a network tunnel belongs to.

activeTransaction

The transaction that is currently applying configurations for the network tunnel.

addressTranslationCount

A count of a network tunnel's address translations.

Type:

unsignedLong

addressTranslations

A network tunnel's address translations.

allAvailableServiceSubnetCount

A count of subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.

Type:

unsignedLong

allAvailableServiceSubnets

Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.

billingItem

The current billing item for network tunnel.

customerSubnetCount

A count of remote subnets that are allowed access through a network tunnel.

Type:

unsignedLong

customerSubnets

Remote subnets that are allowed access through a network tunnel.

datacenter

The datacenter location for one end of the network tunnel that allows access to account's private subnets.

internalSubnetCount

A count of private subnets that can be accessed through the network tunnel.

Type:

unsignedLong

internalSubnets

Private subnets that can be accessed through the network tunnel.

serviceSubnetCount

A count of service subnets that can be access through the network tunnel.

Type:

unsignedLong

serviceSubnets

Service subnets that can be access through the network tunnel.

staticRouteSubnetCount

A count of subnets used for a network tunnel's address translations.

Type:

unsignedLong

staticRouteSubnets

Subnets used for a network tunnel's address translations.

transactionHistory

The transaction history for this network tunnel.

transactionHistoryCount

A count of the transaction history for this network tunnel.

Type:

unsignedLong