Interface Devices

All Known Implementing Classes:
DevicesImpl
public interface Devices
Client interface for managing Network Edge virtual devices. Provides operations to list, retrieve, and create devices, as well as manage device types, network interfaces, and license files.
Author:
ianjones

  • Method Details

    • list

      PaginatedList<Device> list()
      Lists available Network Edge devices.
      Returns:
      PaginatedList

    • list

      PaginatedList<Device> list(RequestBuilder.Device requestBuilder)
      Lists Network Edge devices based on the parameters provided.
      Parameters:
      requestBuilder - the desired query parameters.
      Returns:
      PaginatedList

    • getByUuid

      Device getByUuid(String uuid)
      Gets the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      Device

    • listDeviceTypes

      PaginatedList<DeviceType> listDeviceTypes()
      Lists the available device types.
      Returns:
      PaginatedList

    • listInterfaces

      List<NetworkInterface> listInterfaces(String uuid)
      Lists the interfaces for the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      List

    • listAllowedInterfaces

      AllowedInterfaceResponse listAllowedInterfaces(RequestBuilder.AllowedInterfaces requestBuilder)
      Returns the interface layout allowed for a device type with a chosen configuration. Use this to size a device before creation.
      Parameters:
      requestBuilder - the device type and configuration parameters.
      Returns:
      AllowedInterfaceResponse

    • listReloadHistory

      List<DeviceReboot> listReloadHistory(String uuid)
      Returns the reload/soft-reboot history of the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      List

    • listUpgradeHistory

      List<DeviceUpgrade> listUpgradeHistory(String uuid)
      Returns the resource-upgrade history of the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      List

    • getInterfaceStatistics

      InterfaceStats getInterfaceStatistics(String uuid, String interfaceId, Instant startDateTime, Instant endDateTime)
      Returns interface throughput statistics for an interface of the specified device.

      Maps to GET /ne/v1/devices/{uuid}/interfaces/{interfaceId}/stats. The bounds are sent as YYYY-MM-DDThh:mm:ssZ in UTC, truncated to whole seconds. Live (2026-11-11) the service rejects fractional seconds (...:28.282Z) and the spec's example form (2023-11-10 19:06:06 UTC) with HTTP 400 EQ-4000702 "Start date is not valid", and rejects a request without the bounds, although the spec marks them optional.

      Parameters:
      uuid - the unique identifier of the device.
      interfaceId - the interface id.
      startDateTime - the start of the stats window; required
      endDateTime - the end of the stats window; required
      Returns:
      InterfaceStats
      Throws:
      IllegalArgumentException - if a bound is null or the window is reversed

    • listDownloadableImages

      List<DownloadableImage> listDownloadableImages(String deviceType)
      Lists the images available to download for the specified device type.
      Parameters:
      deviceType - the device type code.
      Returns:
      List

    • requestImageDownload

      ImageDownload requestImageDownload(String deviceType, String version)
      Requests a download link for a specific image version of the specified device type.
      Parameters:
      deviceType - the device type code.
      version - the device version.
      Returns:
      ImageDownload

    • define

      DeviceOperator.DeviceBuilder define(String deviceName)
      Returns an instance of DeviceBuilder for defining a new device.
      Returns:
      DeviceOperator.DeviceBuilder

    • defineSecondary

      DeviceOperator.DeviceBuilderSecondary defineSecondary(String secondaryDeviceName, String primaryDeviceUuid)
      Returns an instance of DeviceBuilderSecondary for defining a secondary device.
      Returns:
      DeviceOperator.DeviceBuilderSecondary

    • postLicenseFile

      String postLicenseFile(MetroCode metroCode, String deviceTypeCode, LicenseType licenseType, String fileContents)
      Posts a new license file.
      Parameters:
      metroCode - the MetroCode to associate the license file with.
      deviceTypeCode - the device type code to associate the license file with.
      licenseType - the LicenseType to associate the license file with.
      fileContents - the contents of the license file.
      Returns:
      String the fileId of the uploaded license file.

    • softReboot

      Boolean softReboot(String uuid)
      Triggers a soft reboot of the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      Boolean true if the reboot request was accepted.

    • createRMA

      Boolean createRMA(String uuid, DeviceRMARequest deviceRMARequest)
      Triggers an RMA (Return Merchandise Authorization) of the specified device. The required payload fields vary by vendor; refer to the API reference for the exact payload per device type.
      Parameters:
      uuid - the unique identifier of the device.
      deviceRMARequest - the DeviceRMARequest describing the RMA.
      Returns:
      Boolean true if the RMA request was accepted.

    • getDeviceAcl

      DeviceACL getDeviceAcl(String uuid)
      Returns the ACL templates currently associated with the specified device, including each template's provisioning status on the device.
      Parameters:
      uuid - the unique identifier of the device.
      Returns:
      DeviceACL

    • addDeviceAcl

      DeviceACL addDeviceAcl(String uuid, DeviceACLRequest deviceACLRequest)
      Associates ACL templates with the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      deviceACLRequest - the DeviceACLRequest describing the ACLs to apply.
      Returns:
      DeviceACL the updated device ACL state.

    • addDeviceAcl

      DeviceACL addDeviceAcl(String uuid, DeviceACLRequest deviceACLRequest, String accountUcmId)
      Associates ACL templates with the specified device on behalf of a customer account (reseller flow).
      Parameters:
      uuid - the unique identifier of the device.
      deviceACLRequest - the DeviceACLRequest describing the ACLs to apply.
      accountUcmId - the customer account UCM id.
      Returns:
      DeviceACL the updated device ACL state.

    • updateDeviceAcl

      DeviceACL updateDeviceAcl(String uuid, DeviceACLRequest deviceACLRequest)
      Updates or removes the ACL templates associated with the specified device.
      Parameters:
      uuid - the unique identifier of the device.
      deviceACLRequest - the DeviceACLRequest describing the desired ACLs.
      Returns:
      DeviceACL the updated device ACL state.

    • updateDeviceAcl

      DeviceACL updateDeviceAcl(String uuid, DeviceACLRequest deviceACLRequest, String accountUcmId)
      Updates or removes the ACL templates associated with the specified device on behalf of a customer account (reseller flow).
      Parameters:
      uuid - the unique identifier of the device.
      deviceACLRequest - the DeviceACLRequest describing the desired ACLs.
      accountUcmId - the customer account UCM id.
      Returns:
      DeviceACL the updated device ACL state.