Hardware (worker) data operations.


Hardware operations:

  all         Get all known hardware for facility
  id          Get hardware by id
  ingest      Trigger tinkerbell to ingest
  ip          Get hardware by any associated ip
  mac         Get hardware by any associated mac
  push        Push new hardware to tinkerbell
  watch       Register to watch an id for any changes


  -h, --help   help for hardware


Consider the following hardware data (saved as data.json) for a worker machine to be part of a workflow:

  "id": "ce2e62ed-826f-4485-a39f-a82bb74338e2",
  "arch": "x86_64",
  "allow_pxe": true,
  "allow_workflow": true,
  "facility_code": "onprem",
  "ip_addresses": [
      "address": "",
      "address_family": 4,
      "enabled": true,
      "gateway": "",
      "management": true,
      "netmask": "",
      "public": false
  "network_ports": [
      "data": {
        "mac": "ec:0d:9a:bf:ff:dc"
      "name": "eth0",
      "type": "data"
  • push the data with either of the following:
$ tink hardware push --file data.json
$ cat data.json | tink hardware push
  • get hardware data using ID:
$ tink hardware id ce2e62ed-826f-4485-a39f-a82bb74338e2
  • get hardware data using MAC address:
$ tink hardware mac ec:0d:9a:bf:ff:dc
  • get hardware data using IP address:
$ tink hardware ip