Package com.ibm.cloud.is.vpc.v1.model
Class CreateVpnServerOptions
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.is.vpc.v1.model.CreateVpnServerOptions
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class CreateVpnServerOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The createVpnServer options.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CreateVpnServerOptions.Builder
Builder.static interface
CreateVpnServerOptions.Protocol
The transport protocol to use for this VPN server.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CertificateInstanceIdentity
certificate()
Gets the certificate.List<VPNServerAuthenticationPrototype>
clientAuthentication()
Gets the clientAuthentication.List<IP>
clientDnsServerIps()
Gets the clientDnsServerIps.Long
clientIdleTimeout()
Gets the clientIdleTimeout.String
clientIpPool()
Gets the clientIpPool.Boolean
enableSplitTunneling()
Gets the enableSplitTunneling.String
name()
Gets the name.CreateVpnServerOptions.Builder
newBuilder()
New builder.Long
port()
Gets the port.String
protocol()
Gets the protocol.ResourceGroupIdentity
resourceGroup()
Gets the resourceGroup.List<SecurityGroupIdentity>
securityGroups()
Gets the securityGroups.List<SubnetIdentity>
subnets()
Gets the subnets.
-
-
-
Method Detail
-
newBuilder
public CreateVpnServerOptions.Builder newBuilder()
New builder.- Returns:
- a CreateVpnServerOptions builder
-
certificate
public CertificateInstanceIdentity certificate()
Gets the certificate. The certificate instance for this VPN server.- Returns:
- the certificate
-
clientAuthentication
public List<VPNServerAuthenticationPrototype> clientAuthentication()
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
-
clientIpPool
public String clientIpPool()
Gets the clientIpPool. The VPN client IPv4 address pool, expressed in CIDR format. The request must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges: - `127.0.0.0/8` (IPv4 loopback addresses) - `161.26.0.0/16` (IBM services) - `166.8.0.0/14` (Cloud Service Endpoints) - `169.254.0.0/16` (IPv4 link-local addresses) - `224.0.0.0/4` (IPv4 multicast addresses) The prefix length of the client IP address pool's CIDR must be between `/9` (8,388,608 addresses) and `/22` (1024 addresses). A CIDR block that contains twice the number of IP addresses that are required to enable the maximum number of concurrent connections is recommended.- Returns:
- the clientIpPool
-
subnets
public List<SubnetIdentity> subnets()
Gets the subnets. The subnets to provision this VPN server in. Use subnets in different zones for high availability.- Returns:
- the subnets
-
clientDnsServerIps
public List<IP> clientDnsServerIps()
Gets the clientDnsServerIps. The DNS server addresses that will be provided to VPN clients connected to this VPN server.- Returns:
- the clientDnsServerIps
-
clientIdleTimeout
public Long clientIdleTimeout()
Gets the clientIdleTimeout. The seconds a VPN client can be idle before this VPN server will disconnect it. Specify `0` to prevent the server from disconnecting idle clients.- Returns:
- the clientIdleTimeout
-
enableSplitTunneling
public Boolean enableSplitTunneling()
Gets the enableSplitTunneling. Indicates whether the split tunneling is enabled on this VPN server.- Returns:
- the enableSplitTunneling
-
name
public String name()
Gets the name. The name for this VPN server. The name must not be used by another VPN server in the VPC. If unspecified, the name will be a hyphenated list of randomly-selected words.- Returns:
- the name
-
port
public Long port()
Gets the port. The port number to use for this VPN server.- Returns:
- the port
-
protocol
public String protocol()
Gets the protocol. The transport protocol to use for this VPN server.- Returns:
- the protocol
-
resourceGroup
public ResourceGroupIdentity resourceGroup()
Gets the resourceGroup. The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.- Returns:
- the resourceGroup
-
securityGroups
public List<SecurityGroupIdentity> securityGroups()
Gets the securityGroups. The security groups to use for this VPN server. If unspecified, the VPC's default security group is used.- Returns:
- the securityGroups
-
-