Package com.iland.core.web.rest.api

Interface ConnectivityResource

All Superinterfaces:
com.iland.connectivity.api.instance.BgpApi, com.iland.connectivity.api.instance.CatoNetworkInterfaceApi, com.iland.connectivity.api.instance.CatoTunnelsApi, com.iland.connectivity.api.device.DeviceApi, com.iland.connectivity.api.instance.IpsecVpnTunnelApi, com.iland.connectivity.api.instance.NetworkInterfaceApi, com.iland.connectivity.api.metric.PerformanceApi, com.iland.connectivity.api.ticket.TicketApi
@Path("/connectivity") @Consumes("application/json") @Produces("application/vnd.ilandcloud.api.v1.0+json") public interface ConnectivityResource extends com.iland.connectivity.api.device.DeviceApi, com.iland.connectivity.api.instance.BgpApi, com.iland.connectivity.api.metric.PerformanceApi, com.iland.connectivity.api.instance.NetworkInterfaceApi, com.iland.connectivity.api.ticket.TicketApi, com.iland.connectivity.api.instance.IpsecVpnTunnelApi, com.iland.connectivity.api.instance.CatoNetworkInterfaceApi, com.iland.connectivity.api.instance.CatoTunnelsApi
Connectivity Resource.
Author:
Nick Kasprzak

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.iland.connectivity.core.web.rest.response.AlertResponse>
    getAlertsForDevice(String deviceUuid, Integer offset, Integer limit, String filter)
    Retrieves a set of alerts associated with a specific device identified by its UUID.
    List<com.iland.connectivity.core.web.rest.response.BgpResponse>
    getBgpForDevice(String deviceUuid)
    Retrieves the Border Gateway Protocol (BGP) information for a specific device identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse>
    getBgpPerformanceCounters(String deviceUuid, String bgpUuid)
    Retrieves the performance counters for a specific Border Gateway Protocol (BGP) identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.CatoNetworkInterfaceResponse>
    getCatoNetworkInterfacesForDevice(String deviceUuid)
    Retrieves the Cato Interfaces information for a specific device identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.CatoTunnelsResponse>
    getCatoTunnelsForDevice(String deviceUuid)
    Retrieves the Cato Tunnels information for a specific device identified by its UUID.
    com.iland.connectivity.core.web.rest.response.DeviceResponse
    getDevice(String deviceId)
    Get the specified device given its id.
    Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse>
    getDevicePerformanceCounters(String deviceUuid)
    Retrieves the performance counters for a specific device identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.DeviceResponse>
    getDevicesForCompany(String companyId)
    Get the connectivity devices for the given company.
    Set<com.iland.connectivity.core.web.rest.response.IpsecVpnTunnelResponse>
    getIpsecVpnTunnelForDevice(String deviceUuid)
    Retrieves the IPSec VPN Tunnels information for a specific device identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.NetworkInterfaceResponse>
    getNetworkInterfacesForDevice(String deviceUuid)
    Retrieves a set of network interfaces associated with a specific device identified by its UUID.
    Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse>
    getPerformanceCountersForIpsecVpnTunnel(String deviceUuid, String ipsecVpnTunnelUuid)
    Retrieves a set of performance counters for IPSec VPN Tunnels associated with the specified UUID.
    Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse>
    getPerformanceCountersForNetworkInterfaces(String deviceUuid, String netUuid)
    Retrieves a set of performance counters for network interfaces associated with the specified network UUID.
    Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse>
    getPerformanceCountersForVlanNetworkInterfaces(String deviceUuid, String vlanUuid)
    Retrieves a set of performance counters for network interfaces associated with the specified VLAN UUID.
    List<com.iland.connectivity.core.web.rest.response.PerfSampleResponse>
    getPerformanceSamples(String companyId, String uuid, com.iland.connectivity.api.model.PerfDatasource perfDatasource, com.iland.connectivity.api.model.PerfMetric perfMetric, Long start, Long end)
    Retrieves the performance samples for a specific entity identified by its UUID, data source, and metric within a given time range.
    List<com.iland.connectivity.core.web.rest.response.SupportTicketResponse>
    getTicketsForCompany(String companyId, Integer offset, Integer limit, String filter, com.iland.connectivity.api.model.TicketSortField sort)
    Retrieves a list of ServiceNow tickets, each one associated with a specific alert from a company.
    List<com.iland.connectivity.core.web.rest.response.SupportTicketResponse>
    getTicketsForDevice(String deviceUuid, Integer offset, Integer limit, String filter, com.iland.connectivity.api.model.TicketSortField sort)
    Retrieves a list of ServiceNow tickets associated with a specific alert from a company's device.
    Set<com.iland.connectivity.core.web.rest.response.VlanNetworkInterfaceResponse>
    getVlanNetworkInterfacesForDevice(String deviceUuid)
    Retrieves a set of VLAN network interfaces associated with a specific device identified by its UUID.

    Methods inherited from interface com.iland.connectivity.api.instance.BgpApi

    getBgpPerformanceCounters

    Methods inherited from interface com.iland.connectivity.api.device.DeviceApi

    getAlertsForDeviceInstance

    Methods inherited from interface com.iland.connectivity.api.instance.IpsecVpnTunnelApi

    getPerformanceCountersForIpsecVpnTunnel

    Methods inherited from interface com.iland.connectivity.api.instance.NetworkInterfaceApi

    getPerformanceCountersForNetworkInterfaces, getPerformanceCountersForVlanNetworkInterfaces

  • Method Details

    • getDevicesForCompany

      @GET @Path("/{companyId}/devices") Set<com.iland.connectivity.core.web.rest.response.DeviceResponse> getDevicesForCompany(@PathParam("companyId") String companyId)
      Get the connectivity devices for the given company.
      Specified by:
      getDevicesForCompany in interface com.iland.connectivity.api.device.DeviceApi
      Parameters:
      companyId - company id

    • getDevice

      @GET @Path("/devices/{deviceUuid}") com.iland.connectivity.core.web.rest.response.DeviceResponse getDevice(@PathParam("deviceUuid") String deviceId)
      Get the specified device given its id.
      Specified by:
      getDevice in interface com.iland.connectivity.api.device.DeviceApi
      Parameters:
      deviceId - device id

    • getDevicePerformanceCounters

      @GET @Path("/devices/{deviceUuid}/performance-counters") Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse> getDevicePerformanceCounters(@PathParam("deviceUuid") String deviceUuid)
      Retrieves the performance counters for a specific device identified by its UUID.
      Specified by:
      getDevicePerformanceCounters in interface com.iland.connectivity.api.device.DeviceApi
      Parameters:
      deviceUuid - The UUID of the device for which performance counters are to be retrieved.
      Returns:
      A set of PerfCounterResponse objects representing the performance counters for the device.

    • getBgpPerformanceCounters

      @GET @Path("/bgp/{deviceUuid}/{bgpUuid}/performance-counters") Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse> getBgpPerformanceCounters(@PathParam("deviceUuid") String deviceUuid, @PathParam("bgpUuid") String bgpUuid)
      Retrieves the performance counters for a specific Border Gateway Protocol (BGP) identified by its UUID.
      Parameters:
      bgpUuid - The UUID of the BGP for which performance counters are to be retrieved.
      Returns:
      A set of PerfCounterResponse objects representing the performance counters for the BGP.

    • getPerformanceSamples

      @GET @Path("/{companyId}/performance/{uuid}/{dataSource}::{metric}") List<com.iland.connectivity.core.web.rest.response.PerfSampleResponse> getPerformanceSamples(@PathParam("companyId") String companyId, @PathParam("uuid") String uuid, @PathParam("dataSource") com.iland.connectivity.api.model.PerfDatasource perfDatasource, @PathParam("metric") com.iland.connectivity.api.model.PerfMetric perfMetric, @QueryParam("start") Long start, @QueryParam("end") Long end)
      Retrieves the performance samples for a specific entity identified by its UUID, data source, and metric within a given time range.
      Specified by:
      getPerformanceSamples in interface com.iland.connectivity.api.metric.PerformanceApi
      Parameters:
      companyId - The company id for which the entity belongs to.
      uuid - The UUID of the entity for which performance samples are to be retrieved.
      perfDatasource - The data source of the performance samples.
      perfMetric - The metric of the performance samples.
      start - The start time of the time range for which performance samples are to be retrieved.
      end - The end time of the time range for which performance samples are to be retrieved.
      Returns:
      A set of PerfSampleResponse objects representing the performance samples for the specified entity.

    • getBgpForDevice

      @GET @Path("/devices/{deviceUuid}/bgp") List<com.iland.connectivity.core.web.rest.response.BgpResponse> getBgpForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves the Border Gateway Protocol (BGP) information for a specific device identified by its UUID.
      Specified by:
      getBgpForDevice in interface com.iland.connectivity.api.instance.BgpApi
      Parameters:
      deviceUuid - The UUID of the device for which BGP information is to be retrieved.
      Returns:
      A list of BgpResponse objects representing the BGP information for the device.

    • getCatoTunnelsForDevice

      @GET @Path("/devices/{deviceUuid}/cato-sdwan-tunnels") Set<com.iland.connectivity.core.web.rest.response.CatoTunnelsResponse> getCatoTunnelsForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves the Cato Tunnels information for a specific device identified by its UUID.
      Specified by:
      getCatoTunnelsForDevice in interface com.iland.connectivity.api.instance.CatoTunnelsApi
      Parameters:
      deviceUuid - The UUID of the device.
      Returns:
      A list of cato tunnels for the device.

    • getCatoNetworkInterfacesForDevice

      @GET @Path("/devices/{deviceUuid}/cato-sdwan-interfaces") Set<com.iland.connectivity.core.web.rest.response.CatoNetworkInterfaceResponse> getCatoNetworkInterfacesForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves the Cato Interfaces information for a specific device identified by its UUID.
      Specified by:
      getCatoNetworkInterfacesForDevice in interface com.iland.connectivity.api.instance.CatoNetworkInterfaceApi
      Parameters:
      deviceUuid - The UUID of the device.
      Returns:
      A list of cato interfaces for the device

    • getIpsecVpnTunnelForDevice

      @GET @Path("/devices/{deviceUuid}/ipsec-vpn-tunnels") Set<com.iland.connectivity.core.web.rest.response.IpsecVpnTunnelResponse> getIpsecVpnTunnelForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves the IPSec VPN Tunnels information for a specific device identified by its UUID.
      Specified by:
      getIpsecVpnTunnelForDevice in interface com.iland.connectivity.api.instance.IpsecVpnTunnelApi
      Parameters:
      deviceUuid - The UUID of the device.
      Returns:
      A list of IpsecVpnTunnelResponse objects representing the tunnels for the device.

    • getPerformanceCountersForIpsecVpnTunnel

      @GET @Path("/ipsec-vpn-tunnel/{deviceUuid}/{ipsecVpnTunnelUuid}/performance-counters") Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse> getPerformanceCountersForIpsecVpnTunnel(@PathParam("deviceUuid") String deviceUuid, @PathParam("ipsecVpnTunnelUuid") String ipsecVpnTunnelUuid)
      Retrieves a set of performance counters for IPSec VPN Tunnels associated with the specified UUID.
      Parameters:
      deviceUuid - the UUID of the device the IPSec VPN Tunnel belongs to.
      ipsecVpnTunnelUuid - the UUID of the tunnel for which to retrieve performance counters
      Returns:
      a set of PerfCounterResponse objects representing the performance counters for the specified vpn tunnel

    • getAlertsForDevice

      @GET @Path("/devices/{deviceUuid}/alerts") List<com.iland.connectivity.core.web.rest.response.AlertResponse> getAlertsForDevice(@PathParam("deviceUuid") String deviceUuid, @QueryParam("offset") Integer offset, @QueryParam("limit") Integer limit, @QueryParam("filter") String filter)
      Retrieves a set of alerts associated with a specific device identified by its UUID.
      Specified by:
      getAlertsForDevice in interface com.iland.connectivity.api.device.DeviceApi
      Parameters:
      deviceUuid - The unique identifier (UUID) of the device for which alerts are being requested.
      offset - The starting point for the pagination of results. Defaults to 0.
      limit - The maximum number of alerts to return. Defaults to 25.
      filter - A string used to filter the alerts based on specific criteria.
      Returns:
      A set of the alerts associated with the specified device.

    • getTicketsForCompany

      @GET @Path("/support-tickets/{companyId}") List<com.iland.connectivity.core.web.rest.response.SupportTicketResponse> getTicketsForCompany(@PathParam("companyId") String companyId, @QueryParam("offset") Integer offset, @QueryParam("limit") Integer limit, @QueryParam("filter") String filter, @QueryParam("sort") com.iland.connectivity.api.model.TicketSortField sort)
      Retrieves a list of ServiceNow tickets, each one associated with a specific alert from a company.
      Specified by:
      getTicketsForCompany in interface com.iland.connectivity.api.ticket.TicketApi
      Parameters:
      companyId - The unique identifier (UUID) of the company for which tickets are being requested.
      offset - The starting point for the pagination of results. Defaults to 0.
      limit - The maximum number of tickets to return. Defaults to 25.
      filter - A string used to filter the tickets: "priority" and "closed".
      sort - A TicketSortField which designates the sorting order for the tickets
      Returns:
      A list of the tickets associated with the specified device.

    • getTicketsForDevice

      @GET @Path("/support-tickets/devices/{deviceUuid}") List<com.iland.connectivity.core.web.rest.response.SupportTicketResponse> getTicketsForDevice(@PathParam("deviceUuid") String deviceUuid, @QueryParam("offset") Integer offset, @QueryParam("limit") Integer limit, @QueryParam("filter") String filter, @QueryParam("sort") com.iland.connectivity.api.model.TicketSortField sort)
      Retrieves a list of ServiceNow tickets associated with a specific alert from a company's device.
      Specified by:
      getTicketsForDevice in interface com.iland.connectivity.api.ticket.TicketApi
      Parameters:
      deviceUuid - The company id, along with the device vendor id for which tickets are being requested.
      offset - The starting point for the pagination of results. Defaults to 0.
      limit - The maximum number of tickets to return. Defaults to 25.
      filter - A string used to filter the tickets: "priority" and "closed".
      sort - A TicketSortField which designates the sorting order for the tickets
      Returns:
      A list of the tickets associated with the specified device.

    • getNetworkInterfacesForDevice

      @GET @Path("/devices/{deviceUuid}/network-interfaces") Set<com.iland.connectivity.core.web.rest.response.NetworkInterfaceResponse> getNetworkInterfacesForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves a set of network interfaces associated with a specific device identified by its UUID.
      Specified by:
      getNetworkInterfacesForDevice in interface com.iland.connectivity.api.instance.NetworkInterfaceApi
      Parameters:
      deviceUuid - The unique identifier (UUID) of the device for which network interfaces are being requested.
      Returns:
      A set of network interfaces associated with the specified device. If no network interfaces are found, an empty set is returned.

    • getVlanNetworkInterfacesForDevice

      @GET @Path("/devices/{deviceUuid}/vlan-network-interfaces") Set<com.iland.connectivity.core.web.rest.response.VlanNetworkInterfaceResponse> getVlanNetworkInterfacesForDevice(@PathParam("deviceUuid") String deviceUuid)
      Retrieves a set of VLAN network interfaces associated with a specific device identified by its UUID.
      Specified by:
      getVlanNetworkInterfacesForDevice in interface com.iland.connectivity.api.instance.NetworkInterfaceApi
      Parameters:
      deviceUuid - The unique identifier (UUID) of the device for which VLAN network interfaces are being requested. This value is used to identify the device.
      Returns:
      A set of VLAN network interfaces associated with the specified device. If no VLAN network interfaces are found, an empty set is returned.

    • getPerformanceCountersForNetworkInterfaces

      @GET @Path("/network/{deviceUuid}/{netUuid}/performance-counters") Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse> getPerformanceCountersForNetworkInterfaces(@PathParam("deviceUuid") String deviceUuid, @PathParam("netUuid") String netUuid)
      Retrieves a set of performance counters for network interfaces associated with the specified network UUID.
      Parameters:
      deviceUuid - the uuid of the device the network belongs to.
      netUuid - the UUID of the network for which to retrieve performance counters
      Returns:
      a set of PerfCounterResponse objects representing the performance counters for the specified network interfaces

    • getPerformanceCountersForVlanNetworkInterfaces

      @GET @Path("/network/{deviceUuid}/{vlanUuid}/performance-counters") Set<com.iland.connectivity.core.web.rest.response.PerfCounterResponse> getPerformanceCountersForVlanNetworkInterfaces(@PathParam("deviceUuid") String deviceUuid, @PathParam("vlanUuid") String vlanUuid)
      Retrieves a set of performance counters for network interfaces associated with the specified VLAN UUID.
      Parameters:
      deviceUuid - the uuid of the device the vlan belongs to.
      vlanUuid - the UUID of the VLAN for which to retrieve performance counters
      Returns:
      a set of PerfCounterResponse objects representing the performance counters for the specified VLAN network interfaces