Link edge host to another edge host
POST/v1/edge-mgmt/edgehosts/current/link
Link edge host to another edge host
Request
- application/json
Body
required
The refresh interval for the link token in seconds
The remaining time for the current link token to be valid in seconds
The link token to link the edge host in base64 encoded format
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
Array [
]
]
The error message in case of failure
peers
object[]
The list of peers linked to the edge host
config
object
EdgeHostInfo is the information about the edge host.
metadata
object
MetaData defines the metadata for the resource.
CreationTimestamp is the timestamp when the resource was created.
ID is the unique identifier of the resource.
labels
object
LastModifiedTimestamp is the timestamp when the resource was last modified.
Name is the name of the resource.
tags
object
Tags is the list of tags associated with the resource.
spec
object
EdgeHostSpec is the specification of the edge host.
Possible values: [Connected
, Airgap
]
hardwareSpec
object
HardwareSpec is the specification of the hardware of the edge host.
Possible values: [arm64
, amd64
]
Default value: amd64
Architecture type of the edge host
cpu
object
Cpu cores defines the number of cpu cores on the edge host.
disks
object[]
partitions
object[]
Size in GB
gpus
object[]
addresses
object
Addresses is a map of PCI device entry name to its addresses. Example entry would be "11:00.0 VGA compatible controller [0300]: NVIDIA Corporation Device [10de:1eb1] (rev a1)"- > 0000_11_00_0" The address is BDF (Bus Device Function) identifier format seperated by underscores. The first 4 bits are almost always 0000. In the above example 11 is Bus, 00 is Device,0 is function. The values of these addreses are expected in hexadecimal format
Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]
Vendor is the GPU vendor, for eg., NVIDIA or AMD
memory
object
Memory size in bytes
os
object
networkInfo
object[]
Possible values: [init
, controlplane
, worker
, unknown
]
status
object
EdgeHostStatus is the status of the edge host.
Possible values: [Pending
, Inprogress
, Configured
]
Configuration status of the edge host.
dns
object
ntp
object
content sync status for the edge host
health
object
Health provides details about the resource health.
Possible values: [Healthy
, Unhealthy
]
edge host id
edge host ip
edge host local UI port
Possible values: [init
, controlplane
, worker
, unknown
]
edge host role
edge host status
Possible values: [Pending
, InProgress
, Completed
, Failed
]
The status of the link operation
{
"errorMessage": "string",
"peers": [
{
"config": {
"metadata": {
"creationTimestamp": "2024-07-29T15:51:28.071Z",
"id": "string",
"labels": {},
"lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
"name": "string",
"tags": {}
},
"spec": {
"connectionMode": "Connected",
"hardwareSpec": {
"archType": "amd64",
"cpu": {
"cores": 0
},
"disks": [
{
"controller": "string",
"partitions": [
{
"fileSystemType": "string",
"freeSpace": 0,
"mountPoint": "string",
"totalSpace": 0,
"usedSpace": 0
}
],
"size": 0,
"vendor": "string"
}
],
"gpus": [
{
"addresses": {},
"model": "string",
"vendor": "string"
}
],
"memory": {
"sizeInMB": 0
},
"os": {
"family": "string",
"version": "string"
}
},
"networkInfo": [
{
"dns": [
"string"
],
"gateway": "string",
"ip": "string",
"isDefault": true,
"macAddr": "string",
"nicName": "string",
"subnet": "string"
}
],
"nodeRole": "init",
"paletteEndpointURL": "string"
},
"status": {
"agentVersion": "string",
"configurationStatus": "Pending",
"dns": {
"nameservers": [
"string"
],
"options": [
"string"
],
"searchDomains": [
"string"
]
},
"hostName": "string",
"ntp": {
"connectionRetrySec": "string",
"fallbackNtpServers": [
"string"
],
"ntpServers": [
"string"
],
"pollIntervalMaxSec": "string",
"pollIntervalMinSec": "string",
"rootDistanceMaxSec": "string",
"saveIntervalSec": "string"
}
}
},
"contentSyncStatus": "string",
"health": {
"reason": "string",
"status": "Healthy"
},
"id": "string",
"ip": "string",
"localUIPort": "string",
"nodeRole": "init",
"role": "string",
"status": "string"
}
],
"status": "Pending"
}
Bad request, invalid input
- application/json
- Schema
- Example (from schema)
Schema
{
"code": "string",
"details": {},
"message": "string",
"ref": "string"
}
Internal server error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": "string",
"details": {},
"message": "string",
"ref": "string"
}