Skip to main content

Get the status of the edge host link

GET 
/v1/edge-mgmt/edgehosts/current/link/status

Get the status of the edge host link

Responses​

(empty)

Schema

    errorMessagestring

    The error message in case of failure

    peers

    object[]

    The list of peers linked to the edge host

  • Array [

    • config

    object

    EdgeHostInfo is the information about the edge host.

    metadata

    object

    MetaData defines the metadata for the resource.

    creationTimestampdate-time

    CreationTimestamp is the timestamp when the resource was created.

    idstring

    ID is the unique identifier of the resource.

    labels

    object

    property name*string
    lastModifiedTimestampdate-time

    LastModifiedTimestamp is the timestamp when the resource was last modified.

    namestring

    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.

    connectionModestring

    Possible values: [Connected, Airgap]

    hardwareSpec

    object

    HardwareSpec is the specification of the hardware of the edge host.

    archTypestring

    Possible values: [arm64, amd64]

    Default value: amd64

    Architecture type of the edge host

    cpu

    object

    coresint32

    Cpu cores defines the number of cpu cores on the edge host.

    disks

    object[]

  • Array [

    • controllerstring

    partitions

    object[]

  • Array [

    • fileSystemTypestring
    freeSpaceint32
    mountPointstring
    totalSpaceint32
    usedSpaceint32

  • ]

    • sizeint32

    Size in GB

    vendorstring

  • ]

    • gpus

    object[]

  • Array [

    • 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

    property name*string
    modelstring

    Model is the model of GPU, for a given vendor, for eg., TU104GL [Tesla T4]

    vendorstring

    Vendor is the GPU vendor, for eg., NVIDIA or AMD

  • ]

    • memory

    object

    sizeInMBint64

    Memory size in bytes

    os

    object

    familystring
    versionstring

    networkInfo

    object[]

  • Array [

    • dnsstring[]
    gatewaystring
    ipstring
    isDefaultboolean
    macAddrstring
    nicNamestring
    subnetstring

  • ]

    • nodeRolestring

    Possible values: [init, controlplane, worker, unknown]

    paletteEndpointURLstring

    status

    object

    EdgeHostStatus is the status of the edge host.

    agentVersionstring
    configurationStatusstring

    Possible values: [Pending, Inprogress, Configured]

    Configuration status of the edge host.

    dns

    object

    nameserversstring[]
    optionsstring[]
    searchDomainsstring[]
    hostNamestring

    ntp

    object

    connectionRetrySecstring
    fallbackNtpServersstring[]
    ntpServersstring[]
    pollIntervalMaxSecstring
    pollIntervalMinSecstring
    rootDistanceMaxSecstring
    saveIntervalSecstring
    contentSyncStatusstring

    content sync status for the edge host

    health

    object

    Health provides details about the resource health.

    reasonstring
    statusstring

    Possible values: [Healthy, Unhealthy]

    idstring

    edge host id

    ipstring

    edge host ip

    localUIPortstring

    edge host local UI port

    nodeRolestring

    Possible values: [init, controlplane, worker, unknown]

    rolestring

    edge host role

    statusstring

    edge host status

  • ]

    • statusstring

    Possible values: [Pending, InProgress, Completed, Failed]

    The status of the link operation

Loading...