Package com.ibm.cloud.is.vpc.v1.model

Class VPNGatewayConnection

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    Direct Known Subclasses:
    VPNGatewayConnectionPolicyMode, VPNGatewayConnectionStaticRouteMode
    public class VPNGatewayConnection
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    VPNGatewayConnection. Classes which extend this class: - VPNGatewayConnectionStaticRouteMode - 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. Only `psk` is currently supported.
        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

      • getHref

        public String getHref()
        Gets the href. The VPN connection's canonical URL.
        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.
        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

      • getPeerAddress

        public String getPeerAddress()
        Gets the peerAddress. The IP address of the peer VPN gateway.
        Returns:
        the peerAddress

      • 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): - `cannot_authenticate_connection`: Failed to authenticate a connection because of mismatched IKE ID and PSK (check IKE ID and PSK in peer VPN configuration) - `internal_error`: Internal error (contact IBM support) - `ike_policy_mismatch`: None of the proposed IKE crypto suites was acceptable (check the IKE policies on both sides of the VPN) - `ike_v1_id_local_remote_cidr_mismatch`: Invalid IKE ID or mismatched local CIDRs and remote CIDRs in IKE V1 (check the IKE ID or the local CIDRs and remote CIDRs in IKE V1 configuration) - `ike_v2_local_remote_cidr_mismatch`: Mismatched local CIDRs and remote CIDRs in IKE V2 (check the local CIDRs and remote CIDRs in IKE V2 configuration) - `ipsec_policy_mismatch`: None of the proposed IPsec crypto suites was acceptable (check the IPsec policies on both sides of the VPN) - `peer_not_responding`: No response from peer (check network ACL configuration, peer availability, and on-premise firewall configuration) The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
        Returns:
        the statusReasons

      • getRoutingProtocol

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

      • getLocalCidrs

        public List<String> getLocalCidrs()
        Gets the localCidrs. The local CIDRs for this resource.
        Returns:
        the localCidrs

      • getPeerCidrs

        public List<String> getPeerCidrs()
        Gets the peerCidrs. The peer CIDRs for this resource.
        Returns:
        the peerCidrs