Call Home Hosts

Invoke the clear operation

Remove all hosts in the unclaimed or duplicate list. As soon as an unclaimed or duplicate host calls home again, it will be added back to the appropriate list.

SecurityaccessToken

Request

Request Body schema:
application/yaml

One of:

unclaimed-hosts

boolean

Must have the value true.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/system/call-home/clear

Request samples

Payload

duplicate-hosts: true

Retrieve all duplicates

Hosts that have called home with a host id that is already used by an existing host in an existing site are called "duplicate".

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/call-home/duplicate-hosts

Response samples

- host-id: a5103d37-411b-4aa3-8bdc-a320bb0b3766
  last-call-home: 2023-03-20T15:23:20.432Z
  peer-ip: 192.168.100.1
  forwarded-for: []
  configured-in-site: sto
  supd-version: dev-9b9ba181
  platform:
    hostname: host-abc-123
    architecture: x86_64
    total-memory: 2042392 KiB
    vcpus: 1
    operating-system: Alpine Linux v3.13
    kernel-version: 5.10.61-0-virt
    docker:
      version: 20.10.3
      api-version: "1.41"
      os: linux
      arch: amd64
      git-commit: 46229ca1d815cfd4b50eb377ac75ad8300e13a85
      components:
        - name: Engine
          version: 20.10.3
        - name: containerd
          version: v1.4.8
        - name: runc
          version: 1.0.0-rc95
        - name: docker-init
          version: 0.19.0
  smbios:
    board-asset-tag: i-0a421a882ef138679
    board-name: Acme Board
    board-serial: ASD2332424
    board-vendor: Acme
    board-version: "1"
    chassis-asset-tag: Acme 23243
    chassis-serial: S9898987978
    chassis-type: Acme Super Chassis
    chassis-vendor: Acme
    chassis-version: pc-i440fx-focal
    product-family: Standard PC
    product-name: Standard PC (i440FX + PIIX, 1996)
    product-serial: a5103d37-411b-4aa3-8bdc-a320bb0b3766
    product-uuid: a5103d37-411b-4aa3-8bdc-a320bb0b3766
    product-version: pc-i440fx-focal
    extra: {}

Retrieve a duplicate

Hosts that have called home with a host id that is already used by an existing host in an existing site are called "duplicate".

SecurityaccessToken

Request

path Parameters

duplicate-host-id

required

string <host-id> ^[^\s](.*[^\s])?$

host-id of duplicate

query Parameters

fields

string

Retrieve only requested fields from the resource

See section fields

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/call-home/duplicate-hosts/{duplicate-host-id}

Response samples

host-id: a5103d37-411b-4aa3-8bdc-a320bb0b3766
last-call-home: 2023-03-20T15:23:20.432Z
peer-ip: 192.168.100.1
forwarded-for: []
configured-in-site: sto
supd-version: dev-9b9ba181
platform:
  hostname: host-abc-123
  architecture: x86_64
  total-memory: 2042392 KiB
  vcpus: 1
  operating-system: Alpine Linux v3.13
  kernel-version: 5.10.61-0-virt
  docker:
    version: 20.10.3
    api-version: "1.41"
    os: linux
    arch: amd64
    git-commit: 46229ca1d815cfd4b50eb377ac75ad8300e13a85
    components:
      - name: Engine
        version: 20.10.3
      - name: containerd
        version: v1.4.8
      - name: runc
        version: 1.0.0-rc95
      - name: docker-init
        version: 0.19.0
smbios:
  board-asset-tag: i-0a421a882ef138679
  board-name: Acme Board
  board-serial: ASD2332424
  board-vendor: Acme
  board-version: "1"
  chassis-asset-tag: Acme 23243
  chassis-serial: S9898987978
  chassis-type: Acme Super Chassis
  chassis-vendor: Acme
  chassis-version: pc-i440fx-focal
  product-family: Standard PC
  product-name: Standard PC (i440FX + PIIX, 1996)
  product-serial: a5103d37-411b-4aa3-8bdc-a320bb0b3766
  product-uuid: a5103d37-411b-4aa3-8bdc-a320bb0b3766
  product-version: pc-i440fx-focal
  extra: {}

Invoke the clear operation

Remove the duplicate host-id from the list. If the same host calls home again, it will re-appear.

SecurityaccessToken

Request

path Parameters

duplicate-host-id

required

string <host-id> ^[^\s](.*[^\s])?$

host-id of duplicate

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/system/call-home/duplicate-hosts/{duplicate-host-id}/clear

Retrieve all unclaimeds

Hosts that have called home to this Control Tower, but that have not been assigned to a site are called "unclaimed".

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/call-home/unclaimed-hosts

Response samples

- host-id: f05cfc24-79fa-4039-b399-31dc59dd7571
  last-call-home: 2023-03-20T16:04:49.125Z
  peer-ip: 192.168.100.102
  forwarded-for: []
  supd-version: dev-9b9ba181
  platform:
    hostname: host-abc-123
    architecture: x86_64
    total-memory: 2038192 KiB
    vcpus: 1
    operating-system: Alpine Linux v3.15
    kernel-version: 5.15.94-0-virt
    docker:
      version: 20.10.16
      api-version: "1.41"
      os: linux
      arch: amd64
      git-commit: f756502055d2e36a84f2068e6620bea5ecf09058
      components:
        - name: Engine
          version: 20.10.16
        - name: containerd
          version: v1.5.11
        - name: runc
          version: 1.1.2
        - name: docker-init
          version: 0.19.0
  smbios:
    board-asset-tag: i-0a421a882ef138679
    board-name: Acme Board
    board-serial: ASD2332424
    board-vendor: Acme
    board-version: "1"
    chassis-asset-tag: Acme 23243
    chassis-serial: S9898987978
    chassis-type: Acme Super Chassis
    chassis-vendor: Acme
    chassis-version: pc-i440fx-focal
    product-family: Standard PC
    product-name: Standard PC (i440FX + PIIX, 1996)
    product-serial: f05cfc24-79fa-4039-b399-31dc59dd7571
    product-uuid: f05cfc24-79fa-4039-b399-31dc59dd7571
    product-version: pc-i440fx-jammy
    extra: {}

Retrieve an unclaimed

Hosts that have called home to this Control Tower, but that have not been assigned to a site are called "unclaimed".

SecurityaccessToken

Request

path Parameters

unclaimed-host-id

required

string <host-id> ^[^\s](.*[^\s])?$

host-id of unclaimed

query Parameters

fields

string

Retrieve only requested fields from the resource

See section fields

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/call-home/unclaimed-hosts/{unclaimed-host-id}

Response samples

host-id: f05cfc24-79fa-4039-b399-31dc59dd7571
last-call-home: 2023-03-20T16:04:49.125Z
peer-ip: 192.168.100.102
forwarded-for: []
supd-version: dev-9b9ba181
platform:
  hostname: host-abc-123
  architecture: x86_64
  total-memory: 2038192 KiB
  vcpus: 1
  operating-system: Alpine Linux v3.15
  kernel-version: 5.15.94-0-virt
  docker:
    version: 20.10.16
    api-version: "1.41"
    os: linux
    arch: amd64
    git-commit: f756502055d2e36a84f2068e6620bea5ecf09058
    components:
      - name: Engine
        version: 20.10.16
      - name: containerd
        version: v1.5.11
      - name: runc
        version: 1.1.2
      - name: docker-init
        version: 0.19.0
smbios:
  board-asset-tag: i-0a421a882ef138679
  board-name: Acme Board
  board-serial: ASD2332424
  board-vendor: Acme
  board-version: "1"
  chassis-asset-tag: Acme 23243
  chassis-serial: S9898987978
  chassis-type: Acme Super Chassis
  chassis-vendor: Acme
  chassis-version: pc-i440fx-focal
  product-family: Standard PC
  product-name: Standard PC (i440FX + PIIX, 1996)
  product-serial: f05cfc24-79fa-4039-b399-31dc59dd7571
  product-uuid: f05cfc24-79fa-4039-b399-31dc59dd7571
  product-version: pc-i440fx-jammy
  extra: {}

Invoke the assign-site operation

Add this host to a site. The site must already exist.

SecurityaccessToken

Request

path Parameters

unclaimed-host-id

required

string <host-id> ^[^\s](.*[^\s])?$

host-id of unclaimed

Request Body schema:
application/yaml

site-name

required

string

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/system/call-home/unclaimed-hosts/{unclaimed-host-id}/assign-site

Request samples

Payload

site-name: metrograph

Invoke the clear operation

Remove the unclaimed host-id from the list. If the same host calls home again, it will re-appear.

SecurityaccessToken

Request

path Parameters

unclaimed-host-id

required

string <host-id> ^[^\s](.*[^\s])?$

host-id of unclaimed

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/system/call-home/unclaimed-hosts/{unclaimed-host-id}/clear

➔ Next to Call Home Settings

Call Home Hosts

Invoke the clear operation

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve all duplicates

query Parameters

Retrieve a duplicate

path Parameters

query Parameters

Invoke the clear operation

path Parameters

Retrieve all unclaimeds

query Parameters

Retrieve an unclaimed

path Parameters

query Parameters

Invoke the assign-site operation

path Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Invoke the clear operation

path Parameters

Request Body schema:
application/yaml

Request Body schema:
application/yaml