Network Edge APIs | Equinix Product Documentation

Update Device Draft

Request

This API is for updating a virtual device draft
and does not support device update as of now.

Security

BearerAuth

Path

uuidstringrequired

Unique Id of a Virtual Device

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8

Query

draftbooleanrequired

draft

Example:draft=true

Bodyapplication/jsonrequired

Update virtual device details

accountNumberstring

Account number. Either an account number or accountReferenceId is required.

Example:"10478397"

accountReferenceIdstring

AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required.

Example:"209809"

projectIdstring

Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.

Example:"XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX"

versionstringrequired

Version.

Example:"16.09.03"

deviceTypeCodestring(DeviceTypeCode)required

Device type code (e.g., C8000V)

Enum:"C8000V""C8000V-SDWAN""PA-VM""ASAV""CGUARD""FG-VM""MERAKI-VMX""PRISMA-SDWAN""INFOBLOX""AVIATRIX_EDGE"

Example:"C8000V"

hostNamePrefixstring

Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters.

Example:"mySR"

agreeOrderTermsbooleanrequired

To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.

Example:true

licenseModestringrequired

License type. One of SUB (Subscription) or BYOL (Bring Your Own License)

Enum:"SUB""BYOL"

Example:"SUB"

licenseCategorystring

This field will be deprecated in the future.

Example:"flex"

licenseFileIdstring

For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device).

Example:"d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc"

licenseTokenstring

In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters.

Example:"V74191621"

day0TextFileIdstring

Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details.

Example:"4cfb5675-5c3f-4275-adba-0c9e3c26c96b"

termlengthstring

Term length in months.

Example:"12"

metroCodestringrequired

Metro code

Example:"SV"

packageCodestring

Software package code

Example:"IPBASE"

sshUsersArray of objects(SshUsers)

An array of sshUsernames and passwords

throughputinteger, (int32)

Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options.

Example:1

throughputUnitstring

Throughput unit.

Example:"Gbps"

tierinteger

Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2

Example:1

virtualDeviceNamestringrequired

Virtual device name for identification. This should be minimum 3 and maximum 50 characters long.

Example:"Router1-c8000v"

orderingContactstring

Username of the ordering contact.

Example:"subuser01"

notificationsArray of stringsrequired

Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses.

Example:

[
  "test1@equinix.com",
  "test2@equinix.com"
]

aclDetailsArray of objects(ACLDetails)

An array of ACLs

additionalBandwidthinteger, (int32)

Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.

Example:100

deviceManagementTypestringrequired

Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED

Enum:"SELF-CONFIGURED""EQUINIX-CONFIGURED"

Example:"EQUINIX-CONFIGURED"

coreinteger, (int32)required

The desired number of cores.

Example:4

interfaceCountinteger, (int32)

The desired number of interfaces.

Example:10

siteIdstring

Site ID.

Example:"12345"

systemIpAddressstring

System IP address.

Example:"192.168.2.5"

vendorConfigobject(VendorConfig)

Vendor-specific configuration

userPublicKeyobject(UserPublicKeyRequest)

An object with public key details.

ipTypestring

This field is deprecated. The ipType value always defaults to STATIC.

Value:"STATIC"

Example:"STATIC"

sshInterfaceIdstring

You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.

Example:"4"

smartLicenseUrlstring

License URL. This field is only relevant for Ciso ASAv devices.

Example:"https://wwww.equinix.com"

diverseFromDeviceUuidstring

Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices.

Example:"ac8a8497-1b6e-42d1-9075-acf23a62ed50"

clusterDetailsobject(ClusterConfig)

Cluster configuration details

primaryDeviceUuidstring

This field is mandatory if you are using this API to add a secondary device to an existing primary device.

Example:"ac8a8497-1b6e-42d1-9075-acf23a62ed50"

connectivitystring

Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth.

Enum:"INTERNET-ACCESS""PRIVATE""INTERNET-ACCESS-WITH-PRVT-MGMT"

Example:"INTERNET-ACCESS"

channelPartnerstring

The name of the channel partner.

Example:"SDCI"

cloudInitFileIdstring

The Id of a previously uploaded license or cloud_init file.

Example:"2d732d49-7a00-4839-aeca-8a2ff89da691"

purchaseOrderNumberstring

Purchase Order information will be included in your order confirmation email.

Example:"789065"

orderReferencestring

Enter a short name/number to identify this order on the invoice.

Example:"345678A"

secondaryobject(VirtualDevicHARequest)

Request to create a secondary HA device

Payload

{
  "accountNumber": "10478397",
  "accountReferenceId": "209809",
  "projectId": "XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX",
  "version": "16.09.03",
  "deviceTypeCode": "C8000V",
  "hostNamePrefix": "mySR",
  "agreeOrderTerms": true,
  "licenseMode": "SUB",
  "licenseCategory": "flex",
  "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
  "licenseToken": "V74191621",
  "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
  "termlength": "12",
  "metroCode": "SV",
  "packageCode": "IPBASE",
  "sshUsers": [
    { … }
  ],
  "throughput": 1,
  "throughputUnit": "Gbps",
  "tier": 1,
  "virtualDeviceName": "Router1-c8000v",
  "orderingContact": "subuser01",
  "notifications": [
    "test1@equinix.com",
    "test2@equinix.com"
  ],
  "aclDetails": [
    { … }
  ],
  "additionalBandwidth": 100,
  "deviceManagementType": "EQUINIX-CONFIGURED",
  "core": 4,
  "interfaceCount": 10,
  "siteId": "12345",
  "systemIpAddress": "192.168.2.5",
  "vendorConfig": {
    "siteId": "567",
    "systemIpAddress": "192.164.0.0",
    "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7",
    "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0",
    "localId": "branch1@example.com",
    "remoteId": "companyController1@example.com",
    "managementType": "FMC",
    "controller1": "54.219.248.29",
    "controller2": "54.177.220.115",
    "serialNumber": "4545454",
    "adminPassword": "ZQeIDI7sUd",
    "activationKey": "GJUK-JM2X-59BJ-2TDJ",
    "controllerFqdn": "demo.velocloud.net",
    "rootPassword": "myPassw0rd!",
    "accountName": "accountName",
    "hostname": "myHostname",
    "accountKey": "Primary Account Key1",
    "applianceTag": "applianceTag",
    "userName": "user123",
    "connectToCloudVision": true,
    "cvpType": "As-a-Service",
    "cvpFqdn": "www.NetworkSolutions.com",
    "cvpIpAddress": "192.168.0.10",
    "cvaasPort": "443",
    "cvpPort": "443",
    "cvpToken": "123",
    "provisioningKey": "samppleKey",
    "privateAddress": "192.168.20.32",
    "privateCidrMask": "24",
    "privateGateway": "192.168.20.1",
    "licenseId": "21913599",
    "panoramaIpAddress": "1.1.1.1",
    "panoramaAuthKey": "123456"
  },
  "userPublicKey": {
    "username": "test-user-1",
    "keyName": "test-pk-2"
  },
  "ipType": "STATIC",
  "sshInterfaceId": "4",
  "smartLicenseUrl": "https://wwww.equinix.com",
  "diverseFromDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
  "clusterDetails": {
    "clusterName": "My Cluster",
    "clusterNodeDetails": { … }
  },
  "primaryDeviceUuid": "ac8a8497-1b6e-42d1-9075-acf23a62ed50",
  "connectivity": "INTERNET-ACCESS",
  "channelPartner": "SDCI",
  "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691",
  "purchaseOrderNumber": "789065",
  "orderReference": "345678A",
  "secondary": {
    "accountNumber": "10478398",
    "accountReferenceId": "209805",
    "version": "16.09.03",
    "additionalBandwidth": 100,
    "licenseFileId": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc",
    "licenseToken": "V74191621",
    "day0TextFileId": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
    "metroCode": "SV",
    "notifications": [ … ],
    "aclDetails": [ … ],
    "sshUsers": [ … ],
    "virtualDeviceName": "Router1-c8000v",
    "hostNamePrefix": "mySR",
    "siteId": "12345",
    "systemIpAddress": "192.168.2.5",
    "vendorConfig": { … },
    "sshInterfaceId": "4",
    "smartLicenseUrl": "https://wwww.equinix.com",
    "cloudInitFileId": "2d732d49-7a00-4839-aeca-8a2ff89da691"
  }
}

Responses

No Content

Response

No content