CLI Device Provider
The Tailscale scanner syncs devices from your Tailscale network into Ctrlplane,
allowing you to deploy, upgrade and manage devices in your Tailscale network.
Usage
To sync in all Tailscale devices, you’ll need:
A Tailscale API key with read access to your tailnet
Your tailnet name (e.g. example.com
)
You can create an API key in the Tailscale Admin
Console .
To see all available options, run:
Here is a basic example of how to sync in all Tailscale devices:
Resource Schemas
Device
When syncing devices from Tailscale, each device will have the following schema:
The version of the schema
The unique identifier of the device
Name of the device, defaults to the hostname.
The unique identifier of the device.
config
Tailscale resource config
The unique identifier of the device
The operating system of the device
The full DNS name of the device
The node key used to authenticate the device
The hostname of the device
The IPv4 and IPv6 addresses assigned to the device
Whether the device is external to the tailnet
The machine key used to identify the device
The version of the Tailscale client running on the device
metadata
Tailscale resource metadata
The unique identifier of the device (e.g. 6469981265034464
)
The operating system of the device (e.g. linux
)
The full DNS name of the device (e.g. db.tail1dc437.ts.net
)
The hostname of the device (e.g. db
)
The IPv4 and IPv6 addresses assigned to the device (e.g. ["100.127.168.84", "fd7a:115c:a1e0::7c01:a854"]
)
Whether the device is external to the tailnet (e.g. false)
The version of the Tailscale client running on the device (e.g. 1.78.1-t8903926f7-gc4163954e
)
The user associated with the device (e.g. example@github
)
The connection status of the device (e.g. connected
)
tailscale/blocks-incoming-connections
Whether the device blocks incoming connections
tailscale/update-available
Whether an update is available for the device (e.g. false
)