com.iland.core.web.rest.api

Interface EdgeGatewayResource

@Path(value="/edge-gateways")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface EdgeGatewayResource

Edge Gateway REST resource V1.

Author:

Nick Kasprzak

Method Summary

Modifier and Type	Method and Description
CertificateResponse	createCertificate(String edgeUuid, CertificateCreateRequest createRequest) Create a certificate for an edge gateway.
CRLResponse	createCRL(String edgeUuid, CRLCreateRequest crlCreateRequest) Create a certificate revocation list (CRL) for an edge gateway.
CSRResponse	createCSR(String edgeUuid, CSRCreateRequest csrCreateRequest) Create a certificate signing request (CSR) for an edge gateway.
FirewallRestorePointDetailsResponse	createFirewallRestorePoint(String edgeUuid, FirewallRestorePointCreateRequest firewallRestorePointCreateRequest) Create a firewall restore point for an edge gateway's firewall.
NATRestorePointDetailsResponse	createNATRestorePoint(String edgeUuid, NATRestorePointCreateRequest natRestorePointCreateRequest) Create a NAT restore point for an edge gateway's NAT.
CertificateResponse	createSelfSignedCertificate(String edgeUuid, String csrId, SelfSignCertificateRequest selfSignCertificateRequest) Create a self-signed certificate on an edge gateway.
CertificateResponse	createSignedCertificate(String edgeUuid, String csrId, CertificateImportRequest importRequest) Import a certificate or a certificate chain against a certificate signing request.
void	deleteCertificate(String edgeUuid, String certificateId) Delete a certificate from an edge gateway.
void	deleteCRL(String edgeUuid, String crlId) Delete a certificate revocation list (CRL) from an edge gateway.
void	deleteCSR(String edgeUuid, String csrId) Delete a certificate signing request (CSR) from an edge gateway.
void	deleteFirewallRestorePoint(String edgeUuid, long restorePointTime) Delete a firewall restore point.
void	deleteNATRestorePoint(String edgeUuid, long restorePointTime) Delete a NAT restore point.
TaskResponse	disableDistributedRouting(String edgeUuid) Disable distributed routing for an edge gateway.
TaskResponse	enableDistributedRouting(String edgeUuid) Enable distributed routing for an edge gateway.
CertificatesResponse	getCertificates(String edgeUuid) Get the list of certificates for an edge gateway.
CRLsResponse	getCRLs(String edgeUuid) Get the list of certificate revocation lists (CRLs) for an edge gateway.
CSRsResponse	getCSRs(String edgeUuid) Get the list of certificate signing requests (CSR) for an edge gateway.
EdgeGatewayDistributedRoutingResponse	getDistributedRoutingStatus(String edgeUuid) Get the status of distributed routing for an edge gateway.
EdgeGatewayDhcpResponse	getEdgeGatewayDhcp(String edgeUuid) Get the DHCP configuration for an edge gateway.
EdgeGatewayFirewallResponse	getEdgeGatewayFirewall(String edgeUuid) Get the firewall configuration for an edge gateway.
EdgeGatewayIPsecResponse	getEdgeGatewayIPsec(String edgeUuid, boolean showSensitiveData) Get the IPsec VPN for an edge gateway.
EdgeGatewayL2VPNResponse	getEdgeGatewayL2VPN(String edgeUuid, boolean showSensitiveData) Get the L2 VPN for an edge gateway.
L2VPNStatisticsResponse	getEdgeGatewayL2VPNStatistics(String edgeUuid) Get the L2 VPN statistics for an edge gateway.
EdgeGatewayLoadBalancerResponse	getEdgeGatewayLoadBalancer(String edgeUuid) Get the load balancer for an edge gateway.
EdgeGatewayNATResponse	getEdgeGatewayNAT(String edgeUuid) Get the NAT for an edge gateway.
RelayTypeOptionListResponse	getEdgeGatewayRelayOptions(String edgeUuid, String relayType, ObjectPagingParams pagingParams) Get the DHCP relay type options for a edge gateway's relay type.
RelayTypeListResponse	getEdgeGatewayRelayTypes(String edgeUuid) Get the DHCP relay types for an edge gateway.
EdgeGatewayRoutingResponse	getEdgeGatewayRouting(String edgeUuid) Get the Routing configuration for an edge gateway.
EdgeGatewaySSHSettingsResponse	getEdgeGatewaySSHSettings(String edgeUuid) Get the SSH Settings for an edge gateway.
EdgeGatewaySSLVPNResponse	getEdgeGatewaySSLVPN(String edgeUuid) Get the SSL VPN for an edge gateway.
EdgeGatewaySyslogResponse	getEdgeGatewaySyslog(String edgeUuid) Get the Syslog settings for an edge gateway.
EdgeGatewayVNICsResponse	getEdgeGatewayVnics(String edgeUuid) Get the VNICs configuration for an edge gateway.
FirewallDestinationObjectListResponse	getFirewallDestinationObjects(String edgeUuid, String type, ObjectPagingParams filters) Get the list of firewall destination objects.
FirewallDestinationTypeListResponse	getFirewallDestinationTypes(String edgeUuid) Get the list of firewall destination types.
FirewallRestorePointDetailsResponse	getFirewallRestorePoint(String edgeUuid, long restorePointTime) Get a firewall restore point for a specific edge at a given time.
FirewallRestorePointListResponse	getFirewallRestorePoints(String edgeUuid) Get the firewall restore points for an edge gateway.
FirewallRulesInformationResponse	getFirewallRulesInformation(String edgeUuid) Retrieves name/ID mappings for all source and destination objects that are assigned to current firewall rules.
FirewallSourceObjectListResponse	getFirewallSourceObjects(String edgeUuid, String type, ObjectPagingParams filters) Get the list of firewall source objects.
FirewallSourceTypeListResponse	getFirewallSourceTypes(String edgeUuid) Get the list of firewall source types.
IPsecStatisticsResponse	getIPsecStatistics(String edgeUuid) Retrieve IPSec VPN statistics.
NATRestorePointDetailsResponse	getNATRestorePoint(String edgeUuid, long restorePointTime) Get a NAT restore point for a specific edge at a given time.
NATRestorePointListResponse	getNATRestorePoints(String edgeUuid) Get the NAT restore points for an edge gateway.
EdgeGatewayFirewallResponse	restoreFirewall(String edgeUuid, RestoreFirewallRequest restoreFirewallRequest) Restore an edge gateway's firewall configuration to a specified restore point.
EdgeGatewayNATResponse	restoreNAT(String edgeUuid, RestoreNatRequest restoreNatRequest) Restore an edge gateway's NAT configuration to a specified restore point.
EdgeGatewayDhcpResponse	updateEdgeGatewayDhcp(String edgeUuid, EdgeGatewayDhcpUpdateRequest edgeGatewayDhcpUpdateRequest) Update the DHCP configuration for an edge gateway.
EdgeGatewayFirewallResponse	updateEdgeGatewayFirewall(String edgeUuid, EdgeGatewayFirewallUpdateRequest firewallUpdateRequest) Update the firewall configuration for an edge gateway.
EdgeGatewayIPsecResponse	updateEdgeGatewayIPsec(String edgeUuid, EdgeGatewayIPsecUpdateRequest edgeGatewayIpsecUpdateRequest) Update the IPsec VPN configuration for an edge gateway.
EdgeGatewayL2VPNResponse	updateEdgeGatewayL2VPN(String edgeUuid, EdgeGatewayL2VPNUpdateRequest edgeGatewayL2VPNUpdateRequest) Update the L2 VPN configuration for an edge gateway.
EdgeGatewayLoadBalancerResponse	updateEdgeGatewayLoadBalancer(String edgeUuid, EdgeGatewayLoadBalancerUpdateRequest loadBalancerUpdateRequest) Update the load balancer configuration for an edge gateway.
EdgeGatewayNATResponse	updateEdgeGatewayNAT(String edgeUuid, EdgeGatewayNATUpdateRequest natUpdateRequest) Update the nat configuration for an edge gateway.
EdgeGatewayRoutingResponse	updateEdgeGatewayRouting(String edgeUuid, EdgeGatewayRoutingUpdateRequest edgeGatewayRoutingUpdateRequest) Update the Routing configuration for an edge gateway.
RoutingBGPConfigResponse	updateEdgeGatewayRoutingBGPConfig(String edgeUuid, RoutingBGPConfigUpdateRequest edgeGatewayRoutingBGPConfigUpdateRequest) Update the Routing BGP configuration for an edge gateway.
RoutingGlobalConfigResponse	updateEdgeGatewayRoutingGlobalConfig(String edgeUuid, RoutingGlobalConfigUpdateRequest edgeGatewayRoutingGlobalConfigUpdateRequest) Update the Routing Global configuration for an edge gateway.
RoutingOSPFConfigResponse	updateEdgeGatewayRoutingOSPFConfig(String edgeUuid, RoutingOSPFConfigUpdateRequest edgeGatewayRoutingOSPFConfigUpdateRequest) Update the Routing OSPF configuration for an edge gateway.
RoutingStaticConfigResponse	updateEdgeGatewayRoutingStaticConfig(String edgeUuid, RoutingStaticConfigUpdateRequest edgeGatewayRoutingStaticConfigUpdateRequest) Update the Routing Static configuration for an edge gateway.
EdgeGatewaySSHSettingsResponse	updateEdgeGatewaySSHSettings(String edgeUuid, EdgeGatewaySSHSettingsUpdateRequest updateRequest) Update the SSH Settings for an edge gateway.
EdgeGatewaySSLVPNResponse	updateEdgeGatewaySSLVPN(String edgeUuid, EdgeGatewaySSLVPNUpdateRequest edgeGatewaySSLVPNUpdateRequest) Update the SSL VPN configuration for an edge gateway.
EdgeGatewaySyslogResponse	updateEdgeGatewaySyslog(String edgeUuid, EdgeGatewaySyslogUpdateRequest updateRequest) Update the Syslog settings for an edge gateway.

Method Detail

getEdgeGatewayVnics

@GET
 @Path(value="/{edgeUuid}/vnics")
EdgeGatewayVNICsResponse getEdgeGatewayVnics(@PathParam(value="edgeUuid")
                                                                                    String edgeUuid)

Get the VNICs configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway VNICs

getEdgeGatewayFirewall

@GET
 @Path(value="/{edgeUuid}/firewall")
EdgeGatewayFirewallResponse getEdgeGatewayFirewall(@PathParam(value="edgeUuid")
                                                                                             String edgeUuid)

Get the firewall configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway firewall

getFirewallSourceTypes

@GET
 @Path(value="/{edgeUuid}/firewall/sources")
FirewallSourceTypeListResponse getFirewallSourceTypes(@PathParam(value="edgeUuid")
                                                                                                        String edgeUuid)

Get the list of firewall source types.

Parameters:

edgeUuid - edge uuid

Returns:

the list of firewall source types

getFirewallSourceObjects

@GET
 @Path(value="/{edgeUuid}/firewall/sources/{type}")
FirewallSourceObjectListResponse getFirewallSourceObjects(@PathParam(value="edgeUuid")
                                                                                                                   String edgeUuid,
                                                                                                                   @PathParam(value="type")
                                                                                                                   String type,
                                                                                                                   @BeanParam
                                                                                                                   ObjectPagingParams filters)

Get the list of firewall source objects.

Parameters:

edgeUuid - edge uuid

type - firewall source object type

filters - firewall object paging params

Returns:

the list of firewall source objects

getFirewallDestinationTypes

@GET
 @Path(value="/{edgeUuid}/firewall/destinations")
FirewallDestinationTypeListResponse getFirewallDestinationTypes(@PathParam(value="edgeUuid")
                                                                                                                       String edgeUuid)

Get the list of firewall destination types.

Parameters:

edgeUuid - edge uuid

Returns:

the list of firewall destination types

getFirewallDestinationObjects

@GET
 @Path(value="/{edgeUuid}/firewall/destinations/{type}")
FirewallDestinationObjectListResponse getFirewallDestinationObjects(@PathParam(value="edgeUuid")
                                                                                                                                  String edgeUuid,
                                                                                                                                  @PathParam(value="type")
                                                                                                                                  String type,
                                                                                                                                  @BeanParam
                                                                                                                                  ObjectPagingParams filters)

Get the list of firewall destination objects.

Parameters:

edgeUuid - edge uuid

type - firewall destination object type

filters - firewall object paging params

Returns:

the list of firewall destination objects

getFirewallRulesInformation

@GET
 @Path(value="/{edgeUuid}/firewall/rule-info")
FirewallRulesInformationResponse getFirewallRulesInformation(@PathParam(value="edgeUuid")
                                                                                                                 String edgeUuid)

Retrieves name/ID mappings for all source and destination objects that are assigned to current firewall rules.

Parameters:

edgeUuid - edge uuid

updateEdgeGatewayFirewall

@PUT
 @Path(value="/{edgeUuid}/firewall")
EdgeGatewayFirewallResponse updateEdgeGatewayFirewall(@PathParam(value="edgeUuid")
                                                                                                String edgeUuid,
                                                                                                EdgeGatewayFirewallUpdateRequest firewallUpdateRequest)

Update the firewall configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

firewallUpdateRequest - firewall update request

Returns:

updated edge gateway firewall

updateEdgeGatewayNAT

@PUT
 @Path(value="/{edgeUuid}/nat")
EdgeGatewayNATResponse updateEdgeGatewayNAT(@PathParam(value="edgeUuid")
                                                                                 String edgeUuid,
                                                                                 EdgeGatewayNATUpdateRequest natUpdateRequest)

Update the nat configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

natUpdateRequest - nat update request

Returns:

updated edge gateway nat

getEdgeGatewayNAT

@GET
 @Path(value="/{edgeUuid}/nat")
EdgeGatewayNATResponse getEdgeGatewayNAT(@PathParam(value="edgeUuid")
                                                                              String edgeUuid)

Get the NAT for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway nat

getEdgeGatewayDhcp

@GET
 @Path(value="/{edgeUuid}/dhcp")
EdgeGatewayDhcpResponse getEdgeGatewayDhcp(@PathParam(value="edgeUuid")
                                                                                 String edgeUuid)

Get the DHCP configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway dhcp

updateEdgeGatewayDhcp

@PUT
 @Path(value="/{edgeUuid}/dhcp")
EdgeGatewayDhcpResponse updateEdgeGatewayDhcp(@PathParam(value="edgeUuid")
                                                                                    String edgeUuid,
                                                                                    EdgeGatewayDhcpUpdateRequest edgeGatewayDhcpUpdateRequest)

Update the DHCP configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayDhcpUpdateRequest - dhcp update request

Returns:

updated edge gateway dhcp

createFirewallRestorePoint

@POST
 @Path(value="/{edgeUuid}/firewall/restore-points")
FirewallRestorePointDetailsResponse createFirewallRestorePoint(@PathParam(value="edgeUuid")
                                                                                                                         String edgeUuid,
                                                                                                                         FirewallRestorePointCreateRequest firewallRestorePointCreateRequest)

Create a firewall restore point for an edge gateway's firewall.

Parameters:

edgeUuid - edge uuid

firewallRestorePointCreateRequest - firewall restore point create request

Returns:

firewall restore point

getFirewallRestorePoints

@GET
 @Path(value="/{edgeUuid}/firewall/restore-points")
FirewallRestorePointListResponse getFirewallRestorePoints(@PathParam(value="edgeUuid")
                                                                                                                   String edgeUuid)

Get the firewall restore points for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

firewall restore points

getFirewallRestorePoint

@GET
 @Path(value="/{edgeUuid}/firewall/restore-points/{restorePointTime}")
FirewallRestorePointDetailsResponse getFirewallRestorePoint(@PathParam(value="edgeUuid")
                                                                                                                                        String edgeUuid,
                                                                                                                                        @PathParam(value="restorePointTime")
                                                                                                                                        long restorePointTime)

Get a firewall restore point for a specific edge at a given time.

Restore point time is epoch time in milliseconds.

Parameters:

edgeUuid - edge uuid

restorePointTime - restore point time

Returns:

firewall restore point

deleteFirewallRestorePoint

@DELETE
 @Path(value="/{edgeUuid}/firewall/restore-points/{restorePointTime}")
void deleteFirewallRestorePoint(@PathParam(value="edgeUuid")
                                                                                                               String edgeUuid,
                                                                                                               @PathParam(value="restorePointTime")
                                                                                                               long restorePointTime)

Delete a firewall restore point.

Restore point time is epoch time in milliseconds.

Parameters:

edgeUuid - edge uuid

restorePointTime - restore point time

restoreFirewall

@POST
 @Path(value="/{edgeUuid}/firewall/actions/restore")
EdgeGatewayFirewallResponse restoreFirewall(@PathParam(value="edgeUuid")
                                                                                                       String edgeUuid,
                                                                                                       RestoreFirewallRequest restoreFirewallRequest)

Restore an edge gateway's firewall configuration to a specified restore point.

Parameters:

edgeUuid - edge uuid

restoreFirewallRequest - the request body, which specifies the restore point time

Returns:

firewall

getEdgeGatewayRelayTypes

@GET
 @Path(value="/{edgeUuid}/dhcp/relays")
RelayTypeListResponse getEdgeGatewayRelayTypes(@PathParam(value="edgeUuid")
                                                                                            String edgeUuid)

Get the DHCP relay types for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

dhcp relay types

getEdgeGatewayRelayOptions

@GET
 @Path(value="/{edgeUuid}/dhcp/relays/{relayType}")
RelayTypeOptionListResponse getEdgeGatewayRelayOptions(@PathParam(value="edgeUuid")
                                                                                                                String edgeUuid,
                                                                                                                @PathParam(value="relayType")
                                                                                                                String relayType,
                                                                                                                @BeanParam
                                                                                                                ObjectPagingParams pagingParams)

Get the DHCP relay type options for a edge gateway's relay type.

Parameters:

edgeUuid - edge uuid

relayType - the type of dhcp relay

pagingParams - filters

Returns:

dhcp relay type options

createNATRestorePoint

@POST
 @Path(value="/{edgeUuid}/nat/restore-points")
 @Consumes(value="application/json")
NATRestorePointDetailsResponse createNATRestorePoint(@PathParam(value="edgeUuid")
                                                                                                                                               String edgeUuid,
                                                                                                                                               NATRestorePointCreateRequest natRestorePointCreateRequest)

Create a NAT restore point for an edge gateway's NAT.

Parameters:

edgeUuid - edge uuid

natRestorePointCreateRequest - nat restore point create request

Returns:

NAT restore point

getNATRestorePoints

@GET
 @Path(value="/{edgeUuid}/nat/restore-points")
NATRestorePointListResponse getNATRestorePoints(@PathParam(value="edgeUuid")
                                                                                                    String edgeUuid)

Get the NAT restore points for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

nat restore points

getNATRestorePoint

@GET
 @Path(value="/{edgeUuid}/nat/restore-points/{restorePointTime}")
NATRestorePointDetailsResponse getNATRestorePoint(@PathParam(value="edgeUuid")
                                                                                                                         String edgeUuid,
                                                                                                                         @PathParam(value="restorePointTime")
                                                                                                                         long restorePointTime)

Get a NAT restore point for a specific edge at a given time.

Restore point time is epoch time in milliseconds.

Parameters:

edgeUuid - edge uuid

restorePointTime - restore point time

Returns:

NAT restore point

deleteNATRestorePoint

@DELETE
 @Path(value="/{edgeUuid}/nat/restore-points/{restorePointTime}")
void deleteNATRestorePoint(@PathParam(value="edgeUuid")
                                                                                                     String edgeUuid,
                                                                                                     @PathParam(value="restorePointTime")
                                                                                                     long restorePointTime)

Delete a NAT restore point.

Restore point time is epoch time in milliseconds.

Parameters:

edgeUuid - edge uuid

restorePointTime - restore point time

restoreNAT

@POST
 @Path(value="/{edgeUuid}/nat/actions/restore")
EdgeGatewayNATResponse restoreNAT(@PathParam(value="edgeUuid")
                                                                                        String edgeUuid,
                                                                                        RestoreNatRequest restoreNatRequest)

Restore an edge gateway's NAT configuration to a specified restore point.

Parameters:

edgeUuid - edge uuid

restoreNatRequest - the request body, which specifies the restore point time

Returns:

nat

getEdgeGatewayLoadBalancer

@GET
 @Path(value="/{edgeUuid}/load-balancer")
EdgeGatewayLoadBalancerResponse getEdgeGatewayLoadBalancer(@PathParam(value="edgeUuid")
                                                                                                          String edgeUuid)

Get the load balancer for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway load balancer

updateEdgeGatewayLoadBalancer

@PUT
 @Path(value="/{edgeUuid}/load-balancer")
EdgeGatewayLoadBalancerResponse updateEdgeGatewayLoadBalancer(@PathParam(value="edgeUuid")
                                                                                                             String edgeUuid,
                                                                                                             EdgeGatewayLoadBalancerUpdateRequest loadBalancerUpdateRequest)

Update the load balancer configuration for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

loadBalancerUpdateRequest - load balancer update request

Returns:

updated edge gateway load balancer

getEdgeGatewayRouting

@GET
 @Path(value="/{edgeUuid}/routing")
EdgeGatewayRoutingResponse getEdgeGatewayRouting(@PathParam(value="edgeUuid")
                                                                                          String edgeUuid)

Get the Routing configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway Routing

updateEdgeGatewayRouting

@PUT
 @Path(value="/{edgeUuid}/routing")
EdgeGatewayRoutingResponse updateEdgeGatewayRouting(@PathParam(value="edgeUuid")
                                                                                             String edgeUuid,
                                                                                             EdgeGatewayRoutingUpdateRequest edgeGatewayRoutingUpdateRequest)

Update the Routing configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayRoutingUpdateRequest - Routing update request

Returns:

updated edge gateway Routing

updateEdgeGatewayRoutingGlobalConfig

@PUT
 @Path(value="/{edgeUuid}/routing/global-config")
RoutingGlobalConfigResponse updateEdgeGatewayRoutingGlobalConfig(@PathParam(value="edgeUuid")
                                                                                                                        String edgeUuid,
                                                                                                                        RoutingGlobalConfigUpdateRequest edgeGatewayRoutingGlobalConfigUpdateRequest)

Update the Routing Global configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayRoutingGlobalConfigUpdateRequest - Routing global config update request

Returns:

updated edge gateway Routing Global config

updateEdgeGatewayRoutingStaticConfig

@PUT
 @Path(value="/{edgeUuid}/routing/static-config")
RoutingStaticConfigResponse updateEdgeGatewayRoutingStaticConfig(@PathParam(value="edgeUuid")
                                                                                                                        String edgeUuid,
                                                                                                                        RoutingStaticConfigUpdateRequest edgeGatewayRoutingStaticConfigUpdateRequest)

Update the Routing Static configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayRoutingStaticConfigUpdateRequest - Routing static config update request

Returns:

updated edge gateway Routing Static config

updateEdgeGatewayRoutingOSPFConfig

@PUT
 @Path(value="/{edgeUuid}/routing/ospf-config")
RoutingOSPFConfigResponse updateEdgeGatewayRoutingOSPFConfig(@PathParam(value="edgeUuid")
                                                                                                                  String edgeUuid,
                                                                                                                  RoutingOSPFConfigUpdateRequest edgeGatewayRoutingOSPFConfigUpdateRequest)

Update the Routing OSPF configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayRoutingOSPFConfigUpdateRequest - Routing OSPF config update request

Returns:

updated edge gateway Routing OSPF config

updateEdgeGatewayRoutingBGPConfig

@PUT
 @Path(value="/{edgeUuid}/routing/bgp-config")
RoutingBGPConfigResponse updateEdgeGatewayRoutingBGPConfig(@PathParam(value="edgeUuid")
                                                                                                               String edgeUuid,
                                                                                                               RoutingBGPConfigUpdateRequest edgeGatewayRoutingBGPConfigUpdateRequest)

Update the Routing BGP configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayRoutingBGPConfigUpdateRequest - Routing BGP config update request

Returns:

updated edge gateway Routing BGP config

getEdgeGatewayIPsec

@GET
 @Path(value="/{edgeUuid}/ipsec")
EdgeGatewayIPsecResponse getEdgeGatewayIPsec(@PathParam(value="edgeUuid")
                                                                                    String edgeUuid,
                                                                                    @QueryParam(value="showSensitiveData")
                                                                                    boolean showSensitiveData)

Get the IPsec VPN for an edge gateway.

Parameters:

edgeUuid - edge uuid

showSensitiveData - show sensitive data

Returns:

edge gateway IPsec VPN

updateEdgeGatewayIPsec

@PUT
 @Path(value="/{edgeUuid}/ipsec")
EdgeGatewayIPsecResponse updateEdgeGatewayIPsec(@PathParam(value="edgeUuid")
                                                                                       String edgeUuid,
                                                                                       EdgeGatewayIPsecUpdateRequest edgeGatewayIpsecUpdateRequest)

Update the IPsec VPN configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayIpsecUpdateRequest - IPsec VPN update request

Returns:

updated edge gateway IPsec VPN

getIPsecStatistics

@GET
 @Path(value="/{edgeUuid}/ipsec-statistics")
IPsecStatisticsResponse getIPsecStatistics(@PathParam(value="edgeUuid")
                                                                                             String edgeUuid)

Retrieve IPSec VPN statistics.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway ipsec statistics

getEdgeGatewayL2VPN

@GET
 @Path(value="/{edgeUuid}/l2vpn")
EdgeGatewayL2VPNResponse getEdgeGatewayL2VPN(@PathParam(value="edgeUuid")
                                                                                    String edgeUuid,
                                                                                    @QueryParam(value="showSensitiveData")
                                                                                    boolean showSensitiveData)

Get the L2 VPN for an edge gateway.

Parameters:

edgeUuid - edge uuid

showSensitiveData - show sensitive data

Returns:

edge gateway l2 vpn

updateEdgeGatewayL2VPN

@PUT
 @Path(value="/{edgeUuid}/l2vpn")
EdgeGatewayL2VPNResponse updateEdgeGatewayL2VPN(@PathParam(value="edgeUuid")
                                                                                       String edgeUuid,
                                                                                       EdgeGatewayL2VPNUpdateRequest edgeGatewayL2VPNUpdateRequest)

Update the L2 VPN configuration for an edge gateway.

Parameters:

edgeUuid - edge uuid

edgeGatewayL2VPNUpdateRequest - L2 VPN update request

Returns:

edge gateway L2 VPN

getEdgeGatewayL2VPNStatistics

@GET
 @Path(value="/{edgeUuid}/l2vpn-statistics")
L2VPNStatisticsResponse getEdgeGatewayL2VPNStatistics(@PathParam(value="edgeUuid")
                                                                                                        String edgeUuid)

Get the L2 VPN statistics for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway L2 VPN statistics

getEdgeGatewaySSLVPN

@GET
 @Path(value="/{edgeUuid}/sslvpn")
EdgeGatewaySSLVPNResponse getEdgeGatewaySSLVPN(@PathParam(value="edgeUuid")
                                                                                       String edgeUuid)

Get the SSL VPN for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway ssl vpn

updateEdgeGatewaySSLVPN

@PUT
 @Path(value="/{edgeUuid}/sslvpn")
EdgeGatewaySSLVPNResponse updateEdgeGatewaySSLVPN(@PathParam(value="edgeUuid")
                                                                                          String edgeUuid,
                                                                                          EdgeGatewaySSLVPNUpdateRequest edgeGatewaySSLVPNUpdateRequest)

Update the SSL VPN configuration for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

edgeGatewaySSLVPNUpdateRequest - SSL VPN update request

Returns:

edge gateway SSL VPN

getEdgeGatewaySyslog

@GET
 @Path(value="/{edgeUuid}/syslog")
EdgeGatewaySyslogResponse getEdgeGatewaySyslog(@PathParam(value="edgeUuid")
                                                                                       String edgeUuid)

Get the Syslog settings for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway syslog

getEdgeGatewaySSHSettings

@GET
 @Path(value="/{edgeUuid}/ssh-settings")
EdgeGatewaySSHSettingsResponse getEdgeGatewaySSHSettings(@PathParam(value="edgeUuid")
                                                                                                       String edgeUuid)

Get the SSH Settings for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

edge gateway SSH Settings

updateEdgeGatewaySyslog

@PUT
 @Path(value="/{edgeUuid}/syslog")
EdgeGatewaySyslogResponse updateEdgeGatewaySyslog(@PathParam(value="edgeUuid")
                                                                                          String edgeUuid,
                                                                                          EdgeGatewaySyslogUpdateRequest updateRequest)

Update the Syslog settings for an edge gateway.

Parameters:

edgeUuid - edge uuid

updateRequest - syslog update request

Returns:

edge gateway syslog

updateEdgeGatewaySSHSettings

@PUT
 @Path(value="/{edgeUuid}/ssh-settings")
EdgeGatewaySSHSettingsResponse updateEdgeGatewaySSHSettings(@PathParam(value="edgeUuid")
                                                                                                          String edgeUuid,
                                                                                                          EdgeGatewaySSHSettingsUpdateRequest updateRequest)

Update the SSH Settings for an edge gateway.

Parameters:

edgeUuid - edge uuid

updateRequest - SSH Settings update request

Returns:

edge gateway SSH Settings

getCertificates

@GET
 @Path(value="/{edgeUuid}/certificates")
CertificatesResponse getCertificates(@PathParam(value="edgeUuid")
                                                                                   String edgeUuid)

Get the list of certificates for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

list of certificates

createCertificate

@POST
 @Path(value="/{edgeUuid}/certificates")
 @Consumes(value="application/json")
CertificateResponse createCertificate(@PathParam(value="edgeUuid")
                                                                                                                          String edgeUuid,
                                                                                                                          CertificateCreateRequest createRequest)

Create a certificate for an edge gateway.

Parameters:

edgeUuid - edge uuid

createRequest - create request

Returns:

the certificates created

createSignedCertificate

@POST
 @Path(value="/{edgeUuid}/certificate-signing-requests/{csrId}/actions/import-signed-certificate")
CertificateResponse createSignedCertificate(@PathParam(value="edgeUuid")
                                                                                                                                                     String edgeUuid,
                                                                                                                                                     @PathParam(value="csrId")
                                                                                                                                                     String csrId,
                                                                                                                                                     CertificateImportRequest importRequest)

Import a certificate or a certificate chain against a certificate signing request.

Parameters:

edgeUuid - edge uuid

csrId - csr id (e.g. csr-1)

importRequest - certificate import request

Returns:

the certificate

deleteCertificate

@DELETE
 @Path(value="/{edgeUuid}/certificates/{certificateId}")
void deleteCertificate(@PathParam(value="edgeUuid")
                                                                                        String edgeUuid,
                                                                                        @PathParam(value="certificateId")
                                                                                        String certificateId)

Delete a certificate from an edge gateway.

Parameters:

edgeUuid - edge uuid

certificateId - certificate id (e.g. certificate-1)

getCSRs

@GET
 @Path(value="/{edgeUuid}/certificate-signing-requests")
CSRsResponse getCSRs(@PathParam(value="edgeUuid")
                                                                                   String edgeUuid)

Get the list of certificate signing requests (CSR) for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

list of CSRs

createCSR

@POST
 @Path(value="/{edgeUuid}/certificate-signing-requests")
 @Consumes(value="application/json")
CSRResponse createCSR(@PathParam(value="edgeUuid")
                                                                                                                          String edgeUuid,
                                                                                                                          CSRCreateRequest csrCreateRequest)

Create a certificate signing request (CSR) for an edge gateway.

Parameters:

edgeUuid - edge uuid

csrCreateRequest - csr create request

Returns:

the csr created

createSelfSignedCertificate

@POST
 @Path(value="/{edgeUuid}/certificate-signing-requests/{csrId}/actions/generate-self-signed-certificate")
 @Consumes(value="application/json")
CertificateResponse createSelfSignedCertificate(@PathParam(value="edgeUuid")
                                                                                                                                                                                                     String edgeUuid,
                                                                                                                                                                                                     @PathParam(value="csrId")
                                                                                                                                                                                                     String csrId,
                                                                                                                                                                                                     SelfSignCertificateRequest selfSignCertificateRequest)

Create a self-signed certificate on an edge gateway.

Parameters:

edgeUuid - edge uuid

csrId - csr id (e.g. csr-1)

selfSignCertificateRequest - self sign certificate request

Returns:

the self-signed certificate

deleteCSR

@DELETE
 @Path(value="/{edgeUuid}/certificate-signing-requests/{csrId}")
void deleteCSR(@PathParam(value="edgeUuid")
                                                                                        String edgeUuid,
                                                                                        @PathParam(value="csrId")
                                                                                        String csrId)

Delete a certificate signing request (CSR) from an edge gateway.

Parameters:

edgeUuid - edge uuid

csrId - csr id (e.g. csr-1)

getCRLs

@GET
 @Path(value="/{edgeUuid}/certificate-revocation-lists")
CRLsResponse getCRLs(@PathParam(value="edgeUuid")
                                                                                   String edgeUuid)

Get the list of certificate revocation lists (CRLs) for an edge gateway.

Parameters:

edgeUuid - edge uuid

Returns:

list of CRLs

createCRL

@POST
 @Path(value="/{edgeUuid}/certificate-revocation-lists")
 @Consumes(value="application/json")
CRLResponse createCRL(@PathParam(value="edgeUuid")
                                                                                                                          String edgeUuid,
                                                                                                                          CRLCreateRequest crlCreateRequest)

Create a certificate revocation list (CRL) for an edge gateway.

Parameters:

edgeUuid - edge uuid

crlCreateRequest - crl create request

Returns:

the crl created

deleteCRL

@DELETE
 @Path(value="/{edgeUuid}/certificate-revocation-lists/{crlId}")
void deleteCRL(@PathParam(value="edgeUuid")
                                                                                        String edgeUuid,
                                                                                        @PathParam(value="crlId")
                                                                                        String crlId)

Delete a certificate revocation list (CRL) from an edge gateway.

Parameters:

edgeUuid - edge uuid

crlId - crl id (e.g. crl-1)

enableDistributedRouting

@POST
 @Consumes(value="application/json")
 @Path(value="/{edgeUuid}/actions/enable-distributed-routing")
TaskResponse enableDistributedRouting(@PathParam(value="edgeUuid")
                                                                                                                                                String edgeUuid)

Enable distributed routing for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

TaskResponse a task response

disableDistributedRouting

@POST
 @Consumes(value="application/json")
 @Path(value="/{edgeUuid}/actions/disable-distributed-routing")
TaskResponse disableDistributedRouting(@PathParam(value="edgeUuid")
                                                                                                                                                  String edgeUuid)

Disable distributed routing for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

TaskResponse a task response

getDistributedRoutingStatus

@GET
 @Path(value="/{edgeUuid}/distributed-routing-status")
EdgeGatewayDistributedRoutingResponse getDistributedRoutingStatus(@PathParam(value="edgeUuid")
                                                                                                                              String edgeUuid)

Get the status of distributed routing for an edge gateway.

THIS ENDPOINT IS UNDER DEVELOPMENT AND IS SUBJECT TO CHANGE IN THE FUTURE

Parameters:

edgeUuid - edge uuid

Returns:

EdgeGatewayDistributedRoutingResponse a distributed routing response