EdgeResource (iland cloud Java SDK 1.0.16 API)

@Path(value="/edges")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface EdgeResource

Edge Gateway REST resource V1.

Author:: Cory Snyder

Method Summary

All Methods Instance Methods Abstract Methods
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.

Method Detail

getEdge

@GET
 @Path(value="/{edgeUuid}")
EdgeResponse getEdge(@PathParam(value="edgeUuid")
                                                      String edgeUuid)

Gets information for a VCD edge gateway.

Parameters:: edgeUuid - edge UUID
Returns:: edge

getPerformance

@GET
 @Path(value="/{edgeUuid}/performance/{group}::{name}::{type}")
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)

Gets performance statistics data for a VCD edge gateway.

Parameters:: edgeUuid - UUID of the edge; group - group; name - name; type - type; start - start date; end - end date
Returns:: network performance samples

getFirewallTrafficLogs

@GET
 @Path(value="/{edgeUuid}/firewall-logs")
EdgeFirewallTrafficLogListResponse getFirewallTrafficLogs(@PathParam(value="edgeUuid")
                                                                                                         String edgeUuid,
                                                                                                         @QueryParam(value="type")
                                                                                                         EdgeFirewallTrafficAnalysisType analysisType,
                                                                                                         @QueryParam(value="start")
                                                                                                         Long start,
                                                                                                         @QueryParam(value="end")
                                                                                                         Long end)

Gets firewall traffic log analysis in different formats that summarize the count of actions that have occured against a particular edge firewall.

Parameters:: edgeUuid - unique UUID of edge gateway
Returns:: firewall traffic log analysis

getSslVpnConfig

@GET
 @Path(value="/{edgeUuid}/sslvpn")
EdgeSslVpnServiceResponse getSslVpnConfig(@PathParam(value="edgeUuid")
                                                                                  String edgeUuid)

Gets SSL VPN configuration details for an edge gateway..

Parameters:: edgeUuid - unique uuid of the edge gateway
Returns:: SSL VPN config for the edge

deleteSslVpnConfig

@DELETE
 @Path(value="/{edgeUuid}/sslvpn")
void deleteSslVpnConfig(@PathParam(value="edgeUuid")
                                                                   String edgeUuid)

Deletes SSL VPN configuration details for an edge gateway..

Parameters:: edgeUuid - unique uuid of the edge gateway

updateSslVpnServerConfig

@PUT
 @Path(value="/{edgeUuid}/sslvpn-config")
 @Consumes(value="application/json")
void updateSslVpnServerConfig(@PathParam(value="edgeUuid")
                                                                                                                  String edgeUuid,
                                                                                                                  EdgeSslVpnServerConfigUpdateRequest request)

Updates SSL VPN configuration for an edge gateway.

Parameters:: edgeUuid - unique UUID of the edge gateway; request - edge ssl vpn server config

updateSslVpnServerSettings

@PUT
 @Path(value="/{edgeUuid}/sslvpn-server-settings")
 @Consumes(value="application/json")
EdgeSslVpnServiceResponse updateSslVpnServerSettings(@PathParam(value="edgeUuid")
                                                                                                                                                  String edgeUuid,
                                                                                                                                                  EdgeSslVpnServiceUpdateRequest serverSettings)

Updates SSL VPN server settings for an edge gateway..

Parameters:: edgeUuid - unique UUID of the edge gateway; serverSettings - edge ssl vpn service settings
Returns:: asynchronous task details.

updateSslVpnPrivateNetworks

@PUT
 @Path(value="/{edgeUuid}/sslvpn-private-networks")
 @Consumes(value="application/json")
EdgeSslVpnPrivateNetworkListResponse updateSslVpnPrivateNetworks(@PathParam(value="edgeUuid")
                                                                                                                                                               String edgeUuid,
                                                                                                                                                               List<EdgeSslVpnPrivateNetworkUpdateRequest> requests)

Updates list of private networks that are reachable through an SSL VPN for an edge gateway.

Parameters:: edgeUuid - unique UUID of the edge gateway; requests - list of edge ssl vpn private networks
Returns:: asynchronous task details.

updateSslVpnIpPools

@PUT
 @Path(value="/{edgeUuid}/sslvpn-ip-pools")
 @Consumes(value="application/json")
EdgeSslVpnIpPoolListResponse updateSslVpnIpPools(@PathParam(value="edgeUuid")
                                                                                                                                       String edgeUuid,
                                                                                                                                       List<EdgeSslVpnIpPoolUpdateRequest> requests)

Updates the SSL VPN IP pools for an edge gateway..

Parameters:: edgeUuid - unique UUID of the edge gateway; requests - list of edge ssl vpn ip pools
Returns:: asynchronous task details.

updateSslVpnAuthentication

@PUT
 @Path(value="/{edgeUuid}/sslvpn-authentication-servers")
 @Consumes(value="application/json")
EdgeSslVpnAuthenticationResponse updateSslVpnAuthentication(@PathParam(value="edgeUuid")
                                                                                                                                                                String edgeUuid,
                                                                                                                                                                EdgeSslVpnAuthenticationUpdateRequest request)

Updates authentication configuration of SSL VPN for an edge gateway.

Parameters:: edgeUuid - unique UUID of the edge gateway; request - edge ssl vpn authentication config
Returns:: asynchronous task details.

uploadSslVpnRsaConfigFile

@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)

Uploads an RSA configuration file for use with RSA authentication server. The configuration file must be uploaded before attempting to add an RSA authentication server.

Parameters:: edgeUuid - unique UUID of the edge gateway; config - RSA config file

updateSslVpnClientInstallPackages

@PUT
 @Path(value="/{edgeUuid}/sslvpn-client-install-packages")
 @Consumes(value="application/json")
EdgeSslVpnClientInstallPackageListResponse updateSslVpnClientInstallPackages(@PathParam(value="edgeUuid")
                                                                                                                                                                                  String edgeUuid,
                                                                                                                                                                                  List<EdgeSslVpnClientInstallPackageUpdateRequest> requests)

Updates client install package configuration of SSL VPN for an edge gateway..

Parameters:: edgeUuid - unique UUID of the edge gateway; requests - list of edge ssl vpn client install packages
Returns:: asynchronous task details.

createSslVpnUser

@POST
 @Path(value="/{edgeUuid}/sslvpn-user")
 @Consumes(value="application/json")
EdgeSslVpnUserResponse createSslVpnUser(@PathParam(value="edgeUuid")
                                                                                                                           String edgeUuid,
                                                                                                                           EdgeSslVpnUserCreateRequest request)

Creates a new edge SSL VPN user.

Parameters:: edgeUuid - UUID of the edge gateway; request - new vpn user
Returns:: new vpn user details

updateSslVpnUser

@PUT
 @Path(value="/{edgeUuid}/sslvpn-user/{userId}")
 @Consumes(value="application/json")
EdgeSslVpnUserResponse updateSslVpnUser(@PathParam(value="edgeUuid")
                                                                                                                                   String edgeUuid,
                                                                                                                                   @PathParam(value="userId")
                                                                                                                                   String userId,
                                                                                                                                   EdgeSslVpnUserUpdateRequest request)

Updates an edge SSL VPN user. The userId field in the URL is the user's object_id.

Parameters:: edgeUuid - UUID of the edge gateway; userId - id of the user; request - new vpn user
Returns:: new vpn user details

deleteSslVpnUser

@DELETE
 @Path(value="/{edgeUuid}/sslvpn-user/{userId}")
void deleteSslVpnUser(@PathParam(value="edgeUuid")
                                                                               String edgeUuid,
                                                                               @PathParam(value="userId")
                                                                               String userId)

Deletes a user from an edge SSL VPN service. The userId field in the URL is the user's object_id.

Parameters:: edgeUuid - UUID of the edge gateway; userId - id of the user

getFirewallConfiguration

@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)

Export an Edge Firewall configuration file that can be imported/applied to other edges.

Parameters:: edgeUuid - edge uuid; filename - filename for downloaded file
Returns:: file with edge configuration

importFirewallConfiguration

@POST
 @Path(value="/{edgeUuid}/actions/import-firewall-configuration")
 @Consumes(value="application/octet-stream")
TaskResponse importFirewallConfiguration(@PathParam(value="edgeUuid")
                                                                                                                                                              String edgeUuid,
                                                                                                                                                              byte[] firewall)

Import an Edge Firewall configuration file to the specified edge and upates the edges firewall accordingly.

Parameters:: edgeUuid - edge uuid; firewall - firewall configuration file
Returns:: asynchronous task details

getNATConfiguration

@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)

Export an Edge NAT configuration file that can be imported/applied to other edges.

Parameters:: edgeUuid - edge uuid; filename - filename for download file
Returns:: file with edge configuration

importNATConfiguration

@POST
 @Path(value="/{edgeUuid}/actions/import-nat-configuration")
 @Consumes(value="application/octet-stream")
TaskResponse importNATConfiguration(@PathParam(value="edgeUuid")
                                                                                                                                                    String edgeUuid,
                                                                                                                                                    byte[] nat)

Import an Edge NAT configuration file to the specified edge and upates the edges NAT service accordingly.

Parameters:: edgeUuid - edge uuid; nat - nat configuration file
Returns:: asynchronous task details

getFirewallCheckpoints
```
@GET
 @Path(value="/{edgeUuid}/firewall-checkpoints")
EdgeFirewallCheckpointListResponse getFirewallCheckpoints(@PathParam(value="edgeUuid")
                                                                                                                String edgeUuid)
```
Get a list of edge firewall checkpoints that are snapshots of an edge firewall in time. These checkpoints can be used to restore the edge firewall to a previous state in time. The actual firewall config is not returned by this endpoint, to retrieve the actual config the edge/{edgeUuid}/firewall/checkpoint/{checkpointUuid} endpoint must be used..

Parameters:

edgeUuid - edge uuid

Returns:

list of edge firewall checkpoints

getFirewallCheckpoint

@GET
 @Path(value="/{edgeUuid}/firewall-checkpoints/{checkpointUuid}")
EdgeFirewallCheckpointResponse getFirewallCheckpoint(@PathParam(value="edgeUuid")
                                                                                                                            String edgeUuid,
                                                                                                                            @PathParam(value="checkpointUuid")
                                                                                                                            String checkpointUuid)

Get an edge firewall checkpoint by edge uuid and checkpoint. The actual firewall config of the checkpoint will be included in the return.

valid checkpoint uuids can be found using the /edge/{edgeUuid}/firewall/checkpoint endpoint

Parameters:: edgeUuid - edge uuid; checkpointUuid - firewall checkpoint uuid
Returns:: edge firewall checkpoint with details

getNATCheckpoints
```
@GET
 @Path(value="/{edgeUuid}/nat-checkpoints")
EdgeNATCheckpointListResponse getNATCheckpoints(@PathParam(value="edgeUuid")
                                                                                                 String edgeUuid)
```
Get a list of edge NAT checkpoints that are snapshots of an edge NAT service in time. These checkpoints can be used to restore the edge NAT service to a previous state in time. The actual NAT config is not returned by this endpoint, to retrieve the actual config the edge/{edgeUuid}/nat/checkpoint/{checkpointUuid} endpoint must be used.

Parameters:

edgeUuid - edge uuid

Returns:

list of edge NAT checkpoints

getNATCheckpoint

@GET
 @Path(value="/{edgeUuid}/nat-checkpoints/{checkpointUuid}")
EdgeNATCheckpointResponse getNATCheckpoint(@PathParam(value="edgeUuid")
                                                                                                             String edgeUuid,
                                                                                                             @PathParam(value="checkpointUuid")
                                                                                                             String checkpointUuid)

Get a NAT checkpoint by edge uuid and checkpoint. The actual NAT config of the checkpoint will be included in the return.

valid checkpoint uuids can be found using the /edge/{edgeUuid}/nat/checkpoint endpoint

Parameters:: edgeUuid - edge uuid; checkpointUuid - NAT checkpoint uuid
Returns:: edge NAT checkpoint with details

restoreFirewallFromCheckpoint

@POST
 @Path(value="/{edgeUuid}/firewall-checkpoints/{checkpointUuid}/actions/restore")
TaskResponse restoreFirewallFromCheckpoint(@PathParam(value="edgeUuid")
                                                                                                                                   String edgeUuid,
                                                                                                                                   @PathParam(value="checkpointUuid")
                                                                                                                                   String checkpointUuid)

Restore an edge firewall to a previous state (edge firewall checkpoint). A list of edge firewall checkpoints available to restore from can be found at /edge/{edgeUuid}/firewall/checkpoint.

Return a task assocatied with the restore of the firewall to a previous checkpoint.

Parameters:: edgeUuid - edge uuid; checkpointUuid - firewall checkpoint uuid
Returns:: aynchronous task details

restoreNATFromCheckpoint

@POST
 @Path(value="/{edgeUuid}/nat-checkpoints/{checkpointUuid}/actions/restore")
TaskResponse restoreNATFromCheckpoint(@PathParam(value="edgeUuid")
                                                                                                                         String edgeUuid,
                                                                                                                         @PathParam(value="checkpointUuid")
                                                                                                                         String checkpointUuid)

Restore an edge NAT service to a previous state (edge NAT checkpoint). A list of edge NAT checkpoints available to restore from can be found at /edge/{edgeUuid}/nat/checkpoint.