NodeOps
Defined in: packages/core/src/ops.ts:9
Methods
Section titled “Methods”delete()
Section titled “delete()”delete(
id):Promise<void>
Defined in: packages/core/src/ops.ts:53
Removes the node from the control plane.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: breaking. Irreversible. The machine loses its addresses and has to register from scratch.
expire()
Section titled “expire()”expire(
id):Promise<void>
Defined in: packages/core/src/ops.ts:44
Expires the node’s key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: breaking. The machine drops off the tailnet and cannot rejoin until someone logs in on it again.
fetch()
Section titled “fetch()”Call Signature
Section titled “Call Signature”fetch():
Promise<TailnetNode[]>
Defined in: packages/core/src/ops.ts:11
Lists every node on the tailnet.
Returns
Section titled “Returns”Promise<TailnetNode[]>
Call Signature
Section titled “Call Signature”fetch(
id):Promise<TailnetNode>
Defined in: packages/core/src/ops.ts:14
Resolves one node by id.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TailnetNode>
rename()?
Section titled “rename()?”
optionalrename(id,newName):Promise<void>
Defined in: packages/core/src/ops.ts:65
Renames a node.
Optional because Tailscale has no rename endpoint: a device’s name comes from the machine itself. Check for the method before offering it.
Parameters
Section titled “Parameters”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: write. The MagicDNS name changes, so anything addressing the node by its old name stops resolving.
setRoutes()
Section titled “setRoutes()”setRoutes(
id,routes):Promise<void>
Defined in: packages/core/src/ops.ts:35
Replaces the set of approved subnet routes.
A route only carries traffic once the node advertises it and an administrator enables it here.
Parameters
Section titled “Parameters”string
routes
Section titled “routes”string[]
Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: write. Enabling a route sends every tailnet member’s traffic for that subnet through this node.
setTags()
Section titled “setTags()”setTags(
id,tags):Promise<void>
Defined in: packages/core/src/ops.ts:23
Replaces the node’s tags. Pass the full set; an empty array clears them.
Parameters
Section titled “Parameters”string
string[]
Returns
Section titled “Returns”Promise<void>
Remarks
Section titled “Remarks”Risk: write. Tags drive ACL matching, so this grants or revokes access across the tailnet.