tsutil

Documentation

Index

• type Client
  • func (c *Client) AdvertiseExitNode(ctx context.Context, enable bool) error
  • func (c *Client) AdvertiseRoutes(ctx context.Context, routes []netip.Prefix) error
  • func (c *Client) AllowLANAccess(ctx context.Context, allow bool) error
  • func (c *Client) ExitNode(ctx context.Context, peer *ipnstate.PeerStatus) error
  • func (c *Client) NetCheck(ctx context.Context, full bool) (*netcheck.Report, *tailcfg.DERPMap, error)
  • func (c *Client) Prefs(ctx context.Context) (*ipn.Prefs, error)
  • func (c *Client) Start(ctx context.Context) error
  • func (c *Client) Status(ctx context.Context) (*ipnstate.Status, error)
  • func (c *Client) Stop(ctx context.Context) error

Types

type Client

type Client struct {
	// Command is the command to call for the Tailscale CLI binary. It
	// defaults to "tailscale".
	Command string
}

Client is a client for Tailscale's services. Some functionality is handled via the Go API, and some is handled via execution of the Tailscale CLI binary.

func (*Client) AdvertiseExitNode

func (c *Client) AdvertiseExitNode(ctx context.Context, enable bool) error

AdvertiseExitNode enables and disables exit node advertisement for the current node.

func (*Client) AdvertiseRoutes

func (c *Client) AdvertiseRoutes(ctx context.Context, routes []netip.Prefix) error

func (*Client) AllowLANAccess

func (c *Client) AllowLANAccess(ctx context.Context, allow bool) error

AllowLANAccess enabled and disables the ability for the current node to get access to the regular LAN that it is connected to while an exit node is in use.

func (*Client) ExitNode

func (c *Client) ExitNode(ctx context.Context, peer *ipnstate.PeerStatus) error

ExitNode uses the specified peer as an exit node, or unsets an existing exit node if peer is nil.

func (*Client) NetCheck

func (c *Client) NetCheck(ctx context.Context, full bool) (*netcheck.Report, *tailcfg.DERPMap, error)

func (*Client) Prefs

func (c *Client) Prefs(ctx context.Context) (*ipn.Prefs, error)

Prefs returns the options of the local node.

func (*Client) Start

func (c *Client) Start(ctx context.Context) error

Start connects the local peer to the Tailscale network.

func (*Client) Status

func (c *Client) Status(ctx context.Context) (*ipnstate.Status, error)

Status returns the status of the connection to the Tailscale network. If the network is not currently connected, it returns nil, nil.

func (*Client) Stop

func (c *Client) Stop(ctx context.Context) error

Stop disconnects the local peer from the Tailscale network.