Class VPNGatewayConnectionPrototype

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.VPNGatewayConnectionPrototype
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
Direct Known Subclasses:
VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype, VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype
public class VPNGatewayConnectionPrototype extends com.ibm.cloud.sdk.core.service.model.GenericModel
VPNGatewayConnectionPrototype. Classes which extend this class: - VPNGatewayConnectionPrototypeVPNGatewayConnectionStaticRouteModePrototype - VPNGatewayConnectionPrototypeVPNGatewayConnectionPolicyModePrototype

  • Method Details

    • adminStateUp

      public Boolean adminStateUp()
      Gets the adminStateUp. If set to false, the VPN gateway connection is shut down.
      Returns:
      the adminStateUp

    • deadPeerDetection

      public VPNGatewayConnectionDPDPrototype deadPeerDetection()
      Gets the deadPeerDetection. The Dead Peer Detection settings.
      Returns:
      the deadPeerDetection

    • establishMode

      public String establishMode()
      Gets the establishMode. The establish mode of the VPN gateway connection: - `bidirectional`: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes. - `peer_only`: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
      Returns:
      the establishMode

    • ikePolicy

      public VPNGatewayConnectionIKEPolicyPrototype ikePolicy()
      Gets the ikePolicy. The IKE policy to use. If unspecified, [auto-negotiation will be used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1).
      Returns:
      the ikePolicy

    • ipsecPolicy

      public VPNGatewayConnectionIPsecPolicyPrototype ipsecPolicy()
      Gets the ipsecPolicy. The IPsec policy to use. If unspecified, [auto-negotiation will be used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2).
      Returns:
      the ipsecPolicy

    • name

      public String name()
      Gets the name. The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway. If unspecified, the name will be a hyphenated list of randomly-selected words.
      Returns:
      the name

    • psk

      public String psk()
      Gets the psk. The pre-shared key.
      Returns:
      the psk

    • distributeTraffic

      public Boolean distributeTraffic()
      Gets the distributeTraffic. Indicates whether the traffic is distributed between the `up` tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If `false`, the traffic is only routed through the `up` tunnel with the lower `public_ip` address. Before enabling it on VPN connections to on-prem private networks, review [distributing traffic restrictions](https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-limitations#distributing-traffic-restrictions).
      Returns:
      the distributeTraffic

    • local

      public VPNGatewayConnectionLocalPrototype local()
      Gets the local.
      Returns:
      the local

    • peer

      public VPNGatewayConnectionPeerPrototype peer()
      Gets the peer.
      Returns:
      the peer

    • routingProtocol

      public String routingProtocol()
      Gets the routingProtocol. Routing protocols are disabled for this VPN gateway connection.
      Returns:
      the routingProtocol