Package com.oracle.bmc.vnmonitoring.model

Class IPSecConnectionTunnel

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class IPSecConnectionTunnel
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Information about a single IPSec tunnel in an IPSec connection.

    This object does not include the tunnel’s shared secret (pre-shared key), which is found in the IPSecConnectionTunnelSharedSecret object.
    Note: Objects should always be created or deserialized using the IPSecConnectionTunnel.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the IPSecConnectionTunnel.Builder, which maintain a set of all explicitly set fields called IPSecConnectionTunnel.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the tunnel.
        Returns:
        the value

      • getId

        public String getId()
        The OCID of the tunnel.
        Returns:
        the value

      • getVpnIp

        public String getVpnIp()
        The IP address of the Oracle VPN headend for the connection.

        Example: 203.0.113.21

        Returns:
        the value

      • getCpeIp

        public String getCpeIp()
        The IP address of the CPE device’s VPN headend.

        Example: 203.0.113.22

        Returns:
        the value

      • getStatus

        public IPSecConnectionTunnel.Status getStatus()
        The status of the tunnel based on IPSec protocol characteristics.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getRouting

        public IPSecConnectionTunnel.Routing getRouting()
        The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing).
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the IPSec tunnel was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeStatusUpdated

        public Date getTimeStatusUpdated()
        When the status of the IPSec tunnel last changed, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getOracleCanInitiate

        public IPSecConnectionTunnel.OracleCanInitiate getOracleCanInitiate()
        Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests.
        Returns:
        the value

      • getNatTranslationEnabled

        public IPSecConnectionTunnel.NatTranslationEnabled getNatTranslationEnabled()
        By default (the AUTO setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.

        The ENABLED option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.

        The DISABLED option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use.

        .

        Returns:
        the value

      • getDpdMode

        public IPSecConnectionTunnel.DpdMode getDpdMode()
        Dead peer detection (DPD) mode set on the Oracle side of the connection.

        This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, or both respond to and initiate requests.

        Returns:
        the value

      • getDpdTimeoutInSec

        public Integer getDpdTimeoutInSec()
        DPD timeout in seconds.
        Returns:
        the value

      • getAssociatedVirtualCircuits

        public List<String> getAssociatedVirtualCircuits()
        The list of virtual circuit OCIDs over which your network can reach this tunnel.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel