Pantavisor Metadata
This page contains reference information about Pantavisor metadata.
Device metadata
This is the device metadata created by Pantavisor that will give you useful information about your device:
| Key | Value | Description |
|---|---|---|
interfaces | json | network interfaces of the device, keyed by <iface>.<family> where family is ipv4, ipv6 or mac (see below) |
pantahub.address | IP:port | Pantacor Hub address the client is communicating with |
pantahub.claimed | 0 or 1 | 1 if claimed in Pantacor Hub |
pantahub.online | 0 or 1 | 1 if connection to Pantacor Hub was established |
pantahub.state | string | see Pantacor Hub states (init, register, claim, sync, login, wait hub, report, idle, prep download or download) |
pantavisor.arch | string | CPU architecture |
pantavisor.claimed | 0 or 1 | 1 if device has ever been claimed (local or remote) |
pantavisor.cpumodel | string | CPU model name |
pantavisor.dtmodel | string | Device Tree model name |
pantavisor.mode | local or remote | see operation modes |
pantavisor.revision | string | revision number |
pantavisor.status | string | revision status |
pantavisor.uname | json | uname output |
pantavisor.version | string | Pantavisor build version |
storage | json | disk usage of the device |
sysinfo | json | sysinfo |
time | json | time information |
interfaces format
The interfaces device metadata is a JSON object keyed by <iface>.<family>. Each value is an array, since an interface can hold multiple addresses of the same family. The mac family carries the interface hardware (MAC) address; interfaces without a hardware address (e.g. lo) have no mac entry.
{
"eth0.mac": ["b8:27:eb:00:11:22"],
"eth0.ipv4": ["192.168.1.10"],
"eth0.ipv6": ["fe80::ba27:ebff:fe00:1122"],
"lo.ipv4": ["127.0.0.1"],
"lo.ipv6": ["::1"]
}
User metadata
This is the user metadata that can be set by the user which is parsed and have some actions on Pantavisor:
| Key | Value | Description |
|---|---|---|
pvr-sdk.authorized_keys | SSH pub key | set public key to get SSH access |
pvr-auto-follow.url | URL | device will automatically pull every change in the device associated to that clone URL |
pantahub.log.push | 0 or 1 | disable/enable log pushing to Pantacor Hub. Overrides PV_LOG_PUSH |
<config-key> | config-value | override any configuration keys that allow RUN level |
<container>/<key> | value | send user metadata that can be consumed by one of the containers |