Class VPNServer

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.VPNServer
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class VPNServer extends com.ibm.cloud.sdk.core.service.model.GenericModel
VPNServer.

  • Method Details

    • getCertificate

      public CertificateInstanceReference getCertificate()
      Gets the certificate. The certificate instance for this VPN server.
      Returns:
      the certificate

    • getClientAuthentication

      public List<VPNServerAuthentication> getClientAuthentication()
      Gets the clientAuthentication. The methods used to authenticate VPN clients to this VPN server. VPN clients must authenticate against all specified methods.
      Returns:
      the clientAuthentication

    • isClientAutoDelete

      public Boolean isClientAutoDelete()
      Gets the clientAutoDelete. Indicates whether disconnected VPN clients will be automatically deleted after `client_auto_delete_timeout` hours have passed. At present, this is always `true`, but may be modifiable in the future.
      Returns:
      the clientAutoDelete

    • getClientAutoDeleteTimeout

      public Long getClientAutoDeleteTimeout()
      Gets the clientAutoDeleteTimeout. If `client_auto_delete` is `true`, the hours after which disconnected VPN clients will be automatically deleted. If the value is `0`, disconnected VPN clients will be deleted immediately. This value may be modifiable in the future.
      Returns:
      the clientAutoDeleteTimeout

    • getClientDnsServerIps

      public List<IP> getClientDnsServerIps()
      Gets the clientDnsServerIps. The DNS server addresses that will be provided to VPN clients that are connected to this VPN server.
      Returns:
      the clientDnsServerIps

    • getClientIdleTimeout

      public Long getClientIdleTimeout()
      Gets the clientIdleTimeout. The seconds a VPN client can be idle before this VPN server will disconnect it. If `0`, the server will not disconnect idle clients.
      Returns:
      the clientIdleTimeout

    • getClientIpPool

      public String getClientIpPool()
      Gets the clientIpPool. The VPN client IPv4 address pool, expressed in CIDR format.
      Returns:
      the clientIpPool

    • getCreatedAt

      public Date getCreatedAt()
      Gets the createdAt. The date and time that the VPN server was created.
      Returns:
      the createdAt

    • getCrn

      public String getCrn()
      Gets the crn. The CRN for this VPN server.
      Returns:
      the crn

    • isEnableSplitTunneling

      public Boolean isEnableSplitTunneling()
      Gets the enableSplitTunneling. Indicates whether the split tunneling is enabled on this VPN server.
      Returns:
      the enableSplitTunneling

    • getHealthReasons

      public List<VPNServerHealthReason> getHealthReasons()
      Gets the healthReasons. The reasons for the current `health_state` (if any).
      Returns:
      the healthReasons

    • getHealthState

      public String getHealthState()
      Gets the healthState. The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.
      Returns:
      the healthState

    • getHostname

      public String getHostname()
      Gets the hostname. Fully qualified domain name assigned to this VPN server.
      Returns:
      the hostname

    • getHref

      public String getHref()
      Gets the href. The URL for this VPN server.
      Returns:
      the href

    • getId

      public String getId()
      Gets the id. The unique identifier for this VPN server.
      Returns:
      the id

    • getLifecycleReasons

      public List<VPNServerLifecycleReason> getLifecycleReasons()
      Gets the lifecycleReasons. The reasons for the current `lifecycle_state` (if any).
      Returns:
      the lifecycleReasons

    • getLifecycleState

      public String getLifecycleState()
      Gets the lifecycleState. The lifecycle state of the VPN server.
      Returns:
      the lifecycleState

    • getName

      public String getName()
      Gets the name. The name for this VPN server. The name is unique across all VPN servers in the VPC.
      Returns:
      the name

    • getPort

      public Long getPort()
      Gets the port. The port number used by this VPN server.
      Returns:
      the port

    • getPrivateIps

      public List<ReservedIPReference> getPrivateIps()
      Gets the privateIps. The reserved IPs bound to this VPN server.
      Returns:
      the privateIps

    • getProtocol

      public String getProtocol()
      Gets the protocol. The transport protocol to use for this VPN server. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the protocol

    • getResourceGroup

      public ResourceGroupReference getResourceGroup()
      Gets the resourceGroup. The resource group for this VPN server.
      Returns:
      the resourceGroup

    • getResourceType

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

    • getSecurityGroups

      public List<SecurityGroupReference> getSecurityGroups()
      Gets the securityGroups. The security groups targeting this VPN server.
      Returns:
      the securityGroups

    • getSubnets

      public List<SubnetReference> getSubnets()
      Gets the subnets. The subnets this VPN server is provisioned in.
      Returns:
      the subnets

    • getVpc

      public VPCReference getVpc()
      Gets the vpc. The VPC this VPN server resides in.
      Returns:
      the vpc