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:

  1. A Tailscale API key with read access to your tailnet
  2. Your tailnet name (e.g. example.com)

You can create an API key in the Tailscale Admin Console.

To see all available options, run:

ctrlc sync tailscale --help

Here is a basic example of how to sync in all Tailscale devices:

ctrlc sync tailscale \
    --tailscale-key <TAILSCALE_KEY> \
    --tailnet <TAILSCALE_NET> \
    --interval 5m

Resource Schemas

Device

When syncing devices from Tailscale, each device will have the following schema:

version
string
default:
"tailscale/v1"

The version of the schema

kind
string
default:
"Device"

The unique identifier of the device

version
string

Name of the device, defaults to the hostname.

identifer
string
default:
""

The unique identifier of the device.

config
Tailscale resource config
metadata
Tailscale resource metadata