Tailscale

Pulumi Official
Package maintained by Pulumi
v0.7.1 published on Monday, Apr 25, 2022 by Pulumi

getDevices

The devices data source describes a list of devices in a tailnet.

Example Usage

using Pulumi;
using Tailscale = Pulumi.Tailscale;

class MyStack : Stack
{
    public MyStack()
    {
        var sampleDevices = Output.Create(Tailscale.GetDevices.InvokeAsync(new Tailscale.GetDevicesArgs
        {
            NamePrefix = "example-",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-tailscale/sdk/go/tailscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tailscale.GetDevices(ctx, &GetDevicesArgs{
			NamePrefix: pulumi.StringRef("example-"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_tailscale as tailscale

sample_devices = tailscale.get_devices(name_prefix="example-")
import * as pulumi from "@pulumi/pulumi";
import * as tailscale from "@pulumi/tailscale";

const sampleDevices = pulumi.output(tailscale.getDevices({
    namePrefix: "example-",
}));

Coming soon!

Using getDevices

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDevices(args: GetDevicesArgs, opts?: InvokeOptions): Promise<GetDevicesResult>
function getDevicesOutput(args: GetDevicesOutputArgs, opts?: InvokeOptions): Output<GetDevicesResult>
def get_devices(name_prefix: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDevicesResult
def get_devices_output(name_prefix: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDevicesResult]
func GetDevices(ctx *Context, args *GetDevicesArgs, opts ...InvokeOption) (*GetDevicesResult, error)
func GetDevicesOutput(ctx *Context, args *GetDevicesOutputArgs, opts ...InvokeOption) GetDevicesResultOutput

> Note: This function is named GetDevices in the Go SDK.

public static class GetDevices 
{
    public static Task<GetDevicesResult> InvokeAsync(GetDevicesArgs args, InvokeOptions? opts = null)
    public static Output<GetDevicesResult> Invoke(GetDevicesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDevicesResult> getDevices(GetDevicesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: tailscale:index/getDevices:getDevices
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NamePrefix string

Filters the returned list of devices to those whose name have this prefix.

NamePrefix string

Filters the returned list of devices to those whose name have this prefix.

namePrefix String

Filters the returned list of devices to those whose name have this prefix.

namePrefix string

Filters the returned list of devices to those whose name have this prefix.

name_prefix str

Filters the returned list of devices to those whose name have this prefix.

namePrefix String

Filters the returned list of devices to those whose name have this prefix.

getDevices Result

The following output properties are available:

Devices List<GetDevicesDevice>

The list of devices returned from the Tailscale API. Each element contains the following:

Id string

The provider-assigned unique ID for this managed resource.

NamePrefix string
Devices []GetDevicesDevice

The list of devices returned from the Tailscale API. Each element contains the following:

Id string

The provider-assigned unique ID for this managed resource.

NamePrefix string
devices ListDevicesDevice>

The list of devices returned from the Tailscale API. Each element contains the following:

id String

The provider-assigned unique ID for this managed resource.

namePrefix String
devices GetDevicesDevice[]

The list of devices returned from the Tailscale API. Each element contains the following:

id string

The provider-assigned unique ID for this managed resource.

namePrefix string
devices Sequence[GetDevicesDevice]

The list of devices returned from the Tailscale API. Each element contains the following:

id str

The provider-assigned unique ID for this managed resource.

name_prefix str
devices List

The list of devices returned from the Tailscale API. Each element contains the following:

id String

The provider-assigned unique ID for this managed resource.

namePrefix String

Supporting Types

GetDevicesDevice

Addresses List<string>

Tailscale IPs for the device

Id string

The unique identifier of the device

Name string

The name of the device

Tags List<string>

Tags applied to the device

User string

The user associated with the device

Addresses []string

Tailscale IPs for the device

Id string

The unique identifier of the device

Name string

The name of the device

Tags []string

Tags applied to the device

User string

The user associated with the device

addresses List

Tailscale IPs for the device

id String

The unique identifier of the device

name String

The name of the device

tags List

Tags applied to the device

user String

The user associated with the device

addresses string[]

Tailscale IPs for the device

id string

The unique identifier of the device

name string

The name of the device

tags string[]

Tags applied to the device

user string

The user associated with the device

addresses Sequence[str]

Tailscale IPs for the device

id str

The unique identifier of the device

name str

The name of the device

tags Sequence[str]

Tags applied to the device

user str

The user associated with the device

addresses List

Tailscale IPs for the device

id String

The unique identifier of the device

name String

The name of the device

tags List

Tags applied to the device

user String

The user associated with the device

Package Details

Repository
https://github.com/pulumi/pulumi-tailscale
License
Apache-2.0
Notes

This Pulumi package is based on the tailscale Terraform Provider.