@Path(value="/edges") @Consumes(value="application/json") @Produces(value="application/vnd.ilandcloud.api.v1.0+json") public interface EdgeResource extends Serializable
| Modifier and Type | Method and Description |
|---|---|
EdgeSslVpnUserResponse |
createSslVpnUser(String edgeUuid,
EdgeSslVpnUserCreateRequest request)
Creates a new edge SSL VPN user.
|
void |
deleteSslVpnConfig(String edgeUuid)
Deletes SSL VPN configuration details for an edge gateway..
|
void |
deleteSslVpnUser(String edgeUuid,
String userId)
Deletes a user from an edge SSL VPN service.
|
EdgeResponse |
getEdge(String edgeUuid)
Gets information for a VCD edge gateway.
|
EdgeFirewallCheckpointResponse |
getFirewallCheckpoint(String edgeUuid,
String checkpointUuid)
Get an edge firewall checkpoint by edge uuid and checkpoint.
|
EdgeFirewallCheckpointListResponse |
getFirewallCheckpoints(String edgeUuid)
Get a list of edge firewall checkpoints that are snapshots of an edge
firewall in time.
|
InputStream |
getFirewallConfiguration(String edgeUuid,
String filename)
Export an Edge Firewall configuration file that can be imported/applied to
other edges.
|
EdgeFirewallTrafficLogListResponse |
getFirewallTrafficLogs(String edgeUuid,
EdgeFirewallTrafficAnalysisType analysisType,
Long start,
Long end)
Gets firewall traffic log analysis in different formats that summarize the
count of actions that have occured against a particular edge firewall.
|
EdgeIpSecVpnServiceResponse |
getIpSecVpn(String edgeUuid)
Gets IpSec VPN Service details for an edge.
|
EdgeNATCheckpointResponse |
getNATCheckpoint(String edgeUuid,
String checkpointUuid)
Get a NAT checkpoint by edge uuid and checkpoint.
|
EdgeNATCheckpointListResponse |
getNATCheckpoints(String edgeUuid)
Get a list of edge NAT checkpoints that are snapshots of an edge NAT
service in time.
|
InputStream |
getNATConfiguration(String edgeUuid,
String filename)
Export an Edge NAT configuration file that can be imported/applied to other
edges.
|
NetworkPerfSampleSerieResponse |
getPerformance(String edgeUuid,
String group,
String name,
String type,
Long start,
Long end)
Gets performance statistics data for a VCD edge gateway.
|
EdgeSslVpnServiceResponse |
getSslVpnConfig(String edgeUuid)
Gets SSL VPN configuration details for an edge gateway..
|
TaskResponse |
importFirewallConfiguration(String edgeUuid,
byte[] firewall)
Import an Edge Firewall configuration file to the specified edge and upates
the edges firewall accordingly.
|
TaskResponse |
importNATConfiguration(String edgeUuid,
byte[] nat)
Import an Edge NAT configuration file to the specified edge and upates the
edges NAT service accordingly.
|
TaskResponse |
restoreFirewallFromCheckpoint(String edgeUuid,
String checkpointUuid)
Restore an edge firewall to a previous state (edge firewall checkpoint).
|
TaskResponse |
restoreNATFromCheckpoint(String edgeUuid,
String checkpointUuid)
Restore an edge NAT service to a previous state (edge NAT checkpoint).
|
EdgeIpSecVpnServiceResponse |
updateIpSecVpn(String edgeUuid,
EdgeIpSecVpnServiceUpdateRequest ipSecVpnService)
Updates IpSec VPN Service details for a vCD Edge.
|
EdgeSslVpnAuthenticationResponse |
updateSslVpnAuthentication(String edgeUuid,
EdgeSslVpnAuthenticationUpdateRequest request)
Updates authentication configuration of SSL VPN for an edge gateway.
|
EdgeSslVpnClientInstallPackageListResponse |
updateSslVpnClientInstallPackages(String edgeUuid,
List<EdgeSslVpnClientInstallPackageUpdateRequest> requests)
Updates client install package configuration of SSL VPN for an edge
gateway..
|
EdgeSslVpnIpPoolListResponse |
updateSslVpnIpPools(String edgeUuid,
List<EdgeSslVpnIpPoolUpdateRequest> requests)
Updates the SSL VPN IP pools for an edge gateway..
|
EdgeSslVpnPrivateNetworkListResponse |
updateSslVpnPrivateNetworks(String edgeUuid,
List<EdgeSslVpnPrivateNetworkUpdateRequest> requests)
Updates list of private networks that are reachable through an SSL VPN for
an edge gateway.
|
void |
updateSslVpnServerConfig(String edgeUuid,
EdgeSslVpnServerConfigUpdateRequest request)
Updates SSL VPN configuration for an edge gateway.
|
EdgeSslVpnServiceResponse |
updateSslVpnServerSettings(String edgeUuid,
EdgeSslVpnServiceUpdateRequest serverSettings)
Updates SSL VPN server settings for an edge gateway..
|
EdgeSslVpnUserResponse |
updateSslVpnUser(String edgeUuid,
String userId,
EdgeSslVpnUserUpdateRequest request)
Updates an edge SSL VPN user.
|
void |
uploadSslVpnRsaConfigFile(String edgeUuid,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput config)
Uploads an RSA configuration file for use with RSA authentication server.
|
@GET
@Path(value="/{edgeUuid}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeResponse getEdge(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - edge UUID@GET
@Path(value="/{edgeUuid}/performance/{group}::{name}::{type}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
NetworkPerfSampleSerieResponse getPerformance(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="group")
String group,
@PathParam(value="name")
String name,
@PathParam(value="type")
String type,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
edgeUuid - UUID of the edgegroup - groupname - nametype - typestart - start dateend - end date@GET
@Path(value="/{edgeUuid}/firewall-logs")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeFirewallTrafficLogListResponse getFirewallTrafficLogs(@PathParam(value="edgeUuid")
String edgeUuid,
@QueryParam(value="type")
EdgeFirewallTrafficAnalysisType analysisType,
@QueryParam(value="start")
Long start,
@QueryParam(value="end")
Long end)
edgeUuid - unique UUID of edge gateway@GET
@Path(value="/{edgeUuid}/sslvpn")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnServiceResponse getSslVpnConfig(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - unique uuid of the edge gateway@DELETE
@Path(value="/{edgeUuid}/sslvpn")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void deleteSslVpnConfig(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - unique uuid of the edge gateway@PUT
@Path(value="/{edgeUuid}/sslvpn-config")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void updateSslVpnServerConfig(@PathParam(value="edgeUuid")
String edgeUuid,
EdgeSslVpnServerConfigUpdateRequest request)
edgeUuid - unique UUID of the edge gatewayrequest - edge ssl vpn server config@PUT
@Path(value="/{edgeUuid}/sslvpn-server-settings")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnServiceResponse updateSslVpnServerSettings(@PathParam(value="edgeUuid")
String edgeUuid,
EdgeSslVpnServiceUpdateRequest serverSettings)
edgeUuid - unique UUID of the edge gatewayserverSettings - edge ssl vpn service settings@PUT
@Path(value="/{edgeUuid}/sslvpn-private-networks")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnPrivateNetworkListResponse updateSslVpnPrivateNetworks(@PathParam(value="edgeUuid")
String edgeUuid,
List<EdgeSslVpnPrivateNetworkUpdateRequest> requests)
edgeUuid - unique UUID of the edge gatewayrequests - list of edge ssl vpn private networks@PUT
@Path(value="/{edgeUuid}/sslvpn-ip-pools")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnIpPoolListResponse updateSslVpnIpPools(@PathParam(value="edgeUuid")
String edgeUuid,
List<EdgeSslVpnIpPoolUpdateRequest> requests)
edgeUuid - unique UUID of the edge gatewayrequests - list of edge ssl vpn ip pools@PUT
@Path(value="/{edgeUuid}/sslvpn-authentication-servers")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnAuthenticationResponse updateSslVpnAuthentication(@PathParam(value="edgeUuid")
String edgeUuid,
EdgeSslVpnAuthenticationUpdateRequest request)
There are five types of authentication servers that may be configured: LOCAL, AD, LDAP, RADIUS, and RSA. Only four authentication servers may be configured simultaneously (including the secondary server). Both the LOCAL and RSA servers may only have one instance configured.
{
"authentication_servers":
[
{
"enabled": true,
"pwd_min_length": 1,
"pwd_max_length": 63,
"pwd_min_alphabets": 0,
"pwd_min_digits": 0,
"pwd_min_special_characters": 0,
"pwd_allow_user_id_within_pwd": true,
"pwd_lifetime": 30,
"pwd_expiry_notification": 25,
"retry_count": 3,
"retry_duration": 1,
"lockout_duration": 1,
"type": "LOCAL"
},
{
"enabled": true,
"ip": "12.12.12.12",
"port": 389,
"timeout": 10,
"enable_ssl": false,
"search_base": "dev-vcd",
"bind_domain_name": "ilanddev",
"bind_password": "",
"login_attribute_name": "sAMAccountName",
"search_filter": "objectClass=*",
"terminate_session_on_auth_fails": false,
"type": "AD"
},
{
"ip": "13.13.13.13",
"port": 1812,
"timeout": 10,
"secret": "secret",
"nas_ip": "",
"retry_count": 3,
"type": "RADIUS"
}
],
"secondary_authentication_server":
{
"enabled": true,
"search_filter": "objectClass=*",
"login_attribute_name": "uid",
"bind_password": "",
"bind_domain_name": "slkjdfa",
"search_base": "sdifj",
"enable_ssl": false,
"timeout": 10,
"port": 389,
"ip": "2.2.2.2",
"type": "LDAP"
}
}
edgeUuid - unique UUID of the edge gatewayrequest - edge ssl vpn authentication config@POST
@Path(value="/{edgeUuid}/sslvpn/actions/upload-rsa-config-file")
@Consumes(value="multipart/form-data")
void uploadSslVpnRsaConfigFile(@PathParam(value="edgeUuid")
String edgeUuid,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput config)
edgeUuid - unique UUID of the edge gatewayconfig - RSA config file@PUT
@Path(value="/{edgeUuid}/sslvpn-client-install-packages")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnClientInstallPackageListResponse updateSslVpnClientInstallPackages(@PathParam(value="edgeUuid")
String edgeUuid,
List<EdgeSslVpnClientInstallPackageUpdateRequest> requests)
edgeUuid - unique UUID of the edge gatewayrequests - list of edge ssl vpn client install packages@POST
@Path(value="/{edgeUuid}/sslvpn-user")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnUserResponse createSslVpnUser(@PathParam(value="edgeUuid")
String edgeUuid,
EdgeSslVpnUserCreateRequest request)
edgeUuid - UUID of the edge gatewayrequest - new vpn user@PUT
@Path(value="/{edgeUuid}/sslvpn-user/{userId}")
@Consumes(value="application/json")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeSslVpnUserResponse updateSslVpnUser(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="userId")
String userId,
EdgeSslVpnUserUpdateRequest request)
edgeUuid - UUID of the edge gatewayrequest - id of the userrequest - new vpn user@DELETE
@Path(value="/{edgeUuid}/sslvpn-user/{userId}")
void deleteSslVpnUser(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="userId")
String userId)
edgeUuid - UUID of the edge gatewayuserId - id of the user@GET
@Path(value="/{edgeUuid}/firewall-configuration")
@Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream getFirewallConfiguration(@PathParam(value="edgeUuid")
String edgeUuid,
@QueryParam(value="filename")
String filename)
edgeUuid - edge uuidfilename - filename for downloaded file@POST
@Path(value="/{edgeUuid}/actions/import-firewall-configuration")
@Consumes(value="application/octet-stream")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse importFirewallConfiguration(@PathParam(value="edgeUuid")
String edgeUuid,
byte[] firewall)
edgeUuid - edge uuidfirewall - firewall configuration file@GET
@Path(value="/{edgeUuid}/nat-configuration")
@Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream getNATConfiguration(@PathParam(value="edgeUuid")
String edgeUuid,
@QueryParam(value="filename")
String filename)
edgeUuid - edge uuidfilename - filename for download file@POST
@Path(value="/{edgeUuid}/actions/import-nat-configuration")
@Consumes(value="application/octet-stream")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse importNATConfiguration(@PathParam(value="edgeUuid")
String edgeUuid,
byte[] nat)
edgeUuid - edge uuidnat - nat configuration file@GET
@Path(value="/{edgeUuid}/firewall-checkpoints")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeFirewallCheckpointListResponse getFirewallCheckpoints(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - edge uuid@GET
@Path(value="/{edgeUuid}/firewall-checkpoints/{checkpointUuid}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeFirewallCheckpointResponse getFirewallCheckpoint(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="checkpointUuid")
String checkpointUuid)
edgeUuid - edge uuidcheckpointUuid - firewall checkpoint uuid@GET
@Path(value="/{edgeUuid}/nat-checkpoints")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeNATCheckpointListResponse getNATCheckpoints(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - edge uuid@GET
@Path(value="/{edgeUuid}/nat-checkpoints/{checkpointUuid}")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeNATCheckpointResponse getNATCheckpoint(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="checkpointUuid")
String checkpointUuid)
edgeUuid - edge uuidcheckpointUuid - NAT checkpoint uuid@POST
@Path(value="/{edgeUuid}/firewall-checkpoints/{checkpointUuid}/actions/restore")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse restoreFirewallFromCheckpoint(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="checkpointUuid")
String checkpointUuid)
edgeUuid - edge uuidcheckpointUuid - firewall checkpoint uuid@POST
@Path(value="/{edgeUuid}/nat-checkpoints/{checkpointUuid}/actions/restore")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse restoreNATFromCheckpoint(@PathParam(value="edgeUuid")
String edgeUuid,
@PathParam(value="checkpointUuid")
String checkpointUuid)
edgeUuid - edge uuidcheckpointUuid - firewall checkpoint uuid@GET
@Path(value="/{edgeUuid}/ipsec-vpn")
@Produces(value="application/vnd.ilandcloud.api.v1.0+json")
EdgeIpSecVpnServiceResponse getIpSecVpn(@PathParam(value="edgeUuid")
String edgeUuid)
edgeUuid - unique uuid of edge gateway@PUT
@Path(value="/{edgeUuid}/ipsec-vpn")
@Consumes(value="application/json")
EdgeIpSecVpnServiceResponse updateIpSecVpn(@PathParam(value="edgeUuid")
String edgeUuid,
EdgeIpSecVpnServiceUpdateRequest ipSecVpnService)
edgeUuid - unique uuid of edge gatewayipSecVpnService - new ipsec vpn service details in json formatCopyright © 2019 iland Internet Solutions, Corp. All rights reserved.