Skip to main content
Loading...

API docs by

Get Virtual Device By Uuid

Request

Returns the virtual device details of an existing device on the Network Edge platform. You must provide the unique ID of the existing device as a path parameter.

Security
BearerAuth
Path
uuidstringrequired

uuid

Example:3da0a663-20d9-4b8f-8c5d-d5cf706840c8
Payload
// No request payload

Responses

Success

Bodyapplication/json
accountNamestring

Account name

Example:"ABC INC"
accountNumberstring

Account number

Example:"133911"
createdBystring

Created by user

Example:"cust0001"
createdDateTimestring, (date-time)

Date and time of creation

Example:"2018-01-30T10:30:31Z"
deletedBystring

Deleted by user

Example:"cust0001"
deletedDateTimestring, (date-time)

Date and time of deletion

Example:"2018-01-30T10:30:31Z"
deviceSerialNostring

Device serial number

Example:"53791666484"
deviceTypeCategorystring

Device type category (e.g., ROUTER, FIREWALL)

Enum:"ROUTER""FIREWALL""SDWAN"
Example:"ROUTER"
diverseFromDeviceNamestring

The name of a device that is in a location different from this device.

Example:"My-Other-Device"
diverseFromDeviceUuidstring

The unique ID of a device that is in a location different from this device.

Example:"4cfb5675-5c3f-4275-adba-0c9e3c26c96b"
deviceTypeCodestring(DeviceTypeCode)

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"
deviceTypeNamestring(DeviceTypeCode)

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"
expirystring

Expiry time

Example:"2019-02-07 00:00:00"
regionstring

Region

Example:"AMER"
deviceTypeVendorstring

Device type vendor

Enum:"CISCO""PALO_ALTO_NETWORKS""JUNIPER""FORTINET""ARISTA""ARUBA""F5""BLUECAT""ZSCALER""CHECK_POINT"
Example:"CISCO"
hostNamestring

Host name

Example:"VR-SV-C8000V-cust0001-1"
uuidstring

Device UUID

Example:"877a3aa2-c49a-4af1-98a6-007424e737ae"
lastUpdatedBystring

Last updated by user

Example:"cust0002"
lastUpdatedDateTimestring, (date-time)

Date and time of last update

Example:"2018-01-30T10:30:31Z"
licenseFileIdstring

License file ID

Example:"877a3aa2-c49a-4af1-98a6-007424e737ae"
licenseNamestring

License name

Example:"Bring your own license"
licenseStatusstring

License status

Enum:"REGISTERED""UNREGISTERED""PENDING""EXPIRED"
Example:"REGISTERED"
licenseTypestring

License type (e.g., BYOL, SUB)

Enum:"BYOL""SUB"
Example:"BYOL"
metroCodestring

Metro code

Example:"SV"
metroNamestring

Metro name

Example:"Silicon Valley"
namestring

Device name

Example:"AWS-Azure-Router-c8000v"
notificationsArray of strings

List of notifications

Example:
[
  "test@equinix.com"
]
packageCodestring

Package code

Example:"SEC"
packageNamestring

Package name

Example:"Security"
versionstring

Device version

Example:"16.09.02"
purchaseOrderNumberstring

Purchase order number

Example:"PO1223"
redundancyTypestring

Redundancy type

Enum:"PRIMARY""SECONDARY"
Example:"PRIMARY"
redundantUuidstring

Redundant device UUID

Example:"xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx"
connectivitystring

Connectivity type

Example:"INTERNET-ACCESS"
sshIpAddressstring

SSH IP address

Example:"10.195.11.23"
sshIpFqdnstring

SSH IP FQDN

Example:"test-device-168-201-97-149.eis.lab.equinix.com"
sshIpFqdnStatusstring

SSH IP FQDN status

Enum:"ASSIGNED""UNASSIGNED"
Example:"ASSIGNED"
statusstring

Device status

Enum:"PROVISIONED""PROVISIONING""DEPROVISIONED""DEPROVISIONING""FAILED"
Example:"PROVISIONED"
throughputinteger, (int32)

Throughput

Example:500
throughputUnitstring

Throughput unit

Example:"Mbps"
coreobject(CoresDisplayConfig)

Core configuration details

pricingDetailsobject(PricingSiebelConfig)

An object that has the pricing and other details of a Siebel order.

interfaceCountinteger
Example:10
deviceManagementTypestring

Device management type (e.g., SELF-CONFIGURED, EQUINIX-CONFIGURED)

Enum:"SELF-CONFIGURED""EQUINIX-CONFIGURED"
Example:"EQUINIX-CONFIGURED"
planestring
Example:"PRIMARY"
userPublicKeyobject(UserPublicKeyConfig)

An object with public key details.

managementIpstring
Example:"10.195.237.228/26"
managementGatewayIpstring
Example:"10.195.237.254"
publicIpstring
Example:"149.97.198.95/31"
publicGatewayIpstring
Example:"149.97.198.94"
primaryDnsNamestring

Primary DNS name

Example:"4.0.0.53"
secondaryDnsNamestring

Secondary DNS name

Example:"129.250.35.250"
termLengthstring

Term length in months.

Example:"12"
newTermLengthstring

The term length effective upon the expiration of the current term.

Example:"24"
additionalBandwidthstring

Additional bandwidth

Example:"200"
siteIdstring

Site ID

Example:"12345"
systemIpAddressstring

System IP address

Example:"192.168.2.5"
vendorConfigobject(VendorConfig)

Vendor-specific configuration

interfacesArray of objects(InterfaceBasicInfoResponse)
asnnumber

The ASN number.

Example:1029
channelPartnerstring

The name of the channel partner.

Example:"SDCI"
Response
{
  "accountName": "ABC INC",
  "accountNumber": "133911",
  "createdBy": "cust0001",
  "createdDateTime": "2018-01-30T10:30:31Z",
  "deletedBy": "cust0001",
  "deletedDateTime": "2018-01-30T10:30:31Z",
  "deviceSerialNo": "53791666484",
  "deviceTypeCategory": "ROUTER",
  "diverseFromDeviceName": "My-Other-Device",
  "diverseFromDeviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
  "deviceTypeCode": "C8000V",
  "deviceTypeName": "C8000V",
  "expiry": "2019-02-07 00:00:00",
  "region": "AMER",
  "deviceTypeVendor": "CISCO",
  "hostName": "VR-SV-C8000V-cust0001-1",
  "uuid": "877a3aa2-c49a-4af1-98a6-007424e737ae",
  "lastUpdatedBy": "cust0002",
  "lastUpdatedDateTime": "2018-01-30T10:30:31Z",
  "licenseFileId": "877a3aa2-c49a-4af1-98a6-007424e737ae",
  "licenseName": "Bring your own license",
  "licenseStatus": "REGISTERED",
  "licenseType": "BYOL",
  "metroCode": "SV",
  "metroName": "Silicon Valley",
  "name": "AWS-Azure-Router-c8000v",
  "notifications": [
    "test@equinix.com"
  ],
  "packageCode": "SEC",
  "packageName": "Security",
  "version": "16.09.02",
  "purchaseOrderNumber": "PO1223",
  "redundancyType": "PRIMARY",
  "redundantUuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx",
  "connectivity": "INTERNET-ACCESS",
  "sshIpAddress": "10.195.11.23",
  "sshIpFqdn": "test-device-168-201-97-149.eis.lab.equinix.com",
  "sshIpFqdnStatus": "ASSIGNED",
  "status": "PROVISIONED",
  "throughput": 500,
  "throughputUnit": "Mbps",
  "core": {
    "core": 4,
    "memory": 4,
    "unit": "GB",
    "tier": 2
  },
  "pricingDetails": {
    "termLength": "36",
    "orderNumber": "1-198735018693",
    "core": 4,
    "throughput": "1",
    "throughputUnit": "Gbps",
    "packageCode": "AX",
    "additionalBandwidth": "100",
    "primary": { … },
    "secondary": { … }
  },
  "interfaceCount": 10,
  "deviceManagementType": "EQUINIX-CONFIGURED",
  "plane": "PRIMARY",
  "userPublicKey": {
    "username": "test-user-1",
    "publicKeyName": "test-pk-2",
    "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88Xypsamplesample"
  },
  "managementIp": "10.195.237.228/26",
  "managementGatewayIp": "10.195.237.254",
  "publicIp": "149.97.198.95/31",
  "publicGatewayIp": "149.97.198.94",
  "primaryDnsName": "4.0.0.53",
  "secondaryDnsName": "129.250.35.250",
  "termLength": "12",
  "newTermLength": "24",
  "additionalBandwidth": "200",
  "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"
  },
  "interfaces": [
    { … }
  ],
  "asn": 1029,
  "channelPartner": "SDCI"
}
Was this page helpful?