Class VPNGatewayConnection

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    Direct Known Subclasses:
    VPNGatewayConnectionPolicyMode, VPNGatewayConnectionRouteMode

    public class VPNGatewayConnection
    extends com.ibm.cloud.sdk.core.service.model.GenericModel
    VPNGatewayConnection. Classes which extend this class: - VPNGatewayConnectionRouteMode - VPNGatewayConnectionPolicyMode
    • Method Detail

      • isAdminStateUp

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

        public String getAuthenticationMode()
        Gets the authenticationMode. The authentication mode. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
        Returns:
        the authenticationMode
      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date and time that this VPN gateway connection was created.
        Returns:
        the createdAt
      • getDeadPeerDetection

        public VPNGatewayConnectionDPD getDeadPeerDetection()
        Gets the deadPeerDetection. The Dead Peer Detection settings.
        Returns:
        the deadPeerDetection
      • getEstablishMode

        public String getEstablishMode()
        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
      • getHref

        public String getHref()
        Gets the href. The URL for this VPN gateway connection.
        Returns:
        the href
      • getId

        public String getId()
        Gets the id. The unique identifier for this VPN gateway connection.
        Returns:
        the id
      • getIkePolicy

        public IKEPolicyReference getIkePolicy()
        Gets the ikePolicy. The IKE policy. If absent, [auto-negotiation is used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1).
        Returns:
        the ikePolicy
      • getIpsecPolicy

        public IPsecPolicyReference getIpsecPolicy()
        Gets the ipsecPolicy. The IPsec policy. If absent, [auto-negotiation is used](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2).
        Returns:
        the ipsecPolicy
      • getMode

        public String getMode()
        Gets the mode. The mode of the VPN gateway. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
        Returns:
        the mode
      • getName

        public String getName()
        Gets the name. The name for this VPN gateway connection. The name is unique across all connections for the VPN gateway.
        Returns:
        the name
      • getPsk

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

        public String getResourceType()
        Gets the resourceType. The resource type.
        Returns:
        the resourceType
      • getStatus

        public String getStatus()
        Gets the status. The status of a VPN gateway connection.
        Returns:
        the status
      • getStatusReasons

        public List<VPNGatewayConnectionStatusReason> getStatusReasons()
        Gets the statusReasons. The reasons for the current VPN gateway connection status (if any).
        Returns:
        the statusReasons
      • isDistributeTraffic

        public Boolean isDistributeTraffic()
        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.
        Returns:
        the distributeTraffic
      • getRoutingProtocol

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