Class DeviceRMARequest

java.lang.Object
com.eqixiac.equinix.networkedge.model.json.creators.DeviceRMARequest
public class DeviceRMARequest extends Object

Request body for triggering an RMA (Return Merchandise Authorization) of a virtual device. The version is required; the remaining fields are vendor-dependent. The vendorConfig map carries vendor-specific values (e.g. siteId, systemIpAddress, licenseKey, adminPassword) whose required subset varies by device type — refer to the API reference for the exact payload per vendor.

DeviceRMARequest request = new DeviceRMARequest("17.09.01a")
    .withLicenseFileId("329a0bcd-0b2f-4bc5-b875-b506aa4b9730")
    .withVendorConfigValue("siteId", "567");
Author:
ianjones

  • Constructor Details

    • DeviceRMARequest

      public DeviceRMARequest(String version)
      Parameters:
      version - any version you want to associate with the RMA (required).

  • Method Details

    • withCloudInitFileId

      public DeviceRMARequest withCloudInitFileId(String cloudInitFileId)

      For a C8KV device, the Id of an uploaded bootstrap file (see Setup.uploadFile(MetroCode, String, FileProcessType, DeviceManagementType, LicenseType, String)).

      Parameters:
      cloudInitFileId - the uploaded bootstrap file id.
      Returns:
      this DeviceRMARequest for chaining.

    • withLicenseFileId

      public DeviceRMARequest withLicenseFileId(String licenseFileId)

      The Id of an uploaded license file (see Devices#postLicenseFile).

      Parameters:
      licenseFileId - the uploaded license file id.
      Returns:
      this DeviceRMARequest for chaining.

    • withToken

      public DeviceRMARequest withToken(String token)

      A license token. For a cluster, provide tokens for both node0 and node1.

      Parameters:
      token - the license token.
      Returns:
      this DeviceRMARequest for chaining.

    • withVendorConfigValue

      public DeviceRMARequest withVendorConfigValue(String key, String value)

      Sets a single vendor-specific configuration value (e.g. siteId, systemIpAddress, licenseKey, adminPassword).

      Parameters:
      key - the vendor configuration field name.
      value - the vendor configuration value.
      Returns:
      this DeviceRMARequest for chaining.

    • withVendorConfig

      public DeviceRMARequest withVendorConfig(Map<String,String> vendorConfig)

      Replaces the full vendor-specific configuration map.

      Parameters:
      vendorConfig - the vendor configuration values.
      Returns:
      this DeviceRMARequest for chaining.

    • withUserPublicKey

      public DeviceRMARequest withUserPublicKey(String username, String keyName)

      Sets the user public key details for the RMA. The keyName must reference an existing public key (see PublicKeys#define).

      Parameters:
      username - the username.
      keyName - the name of an existing public key.
      Returns:
      this DeviceRMARequest for chaining.