1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. Teleport
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.setting.Teleport

unifi logo
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    Manages Teleport settings for a UniFi site. Teleport is a secure remote access technology that allows authorized users to connect to UniFi devices from anywhere.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

const example = new unifi.setting.Teleport("example", {
    enabled: true,
    subnet: "192.168.100.0/24",
});

    import pulumi
import pulumiverse_unifi as unifi

example = unifi.setting.Teleport("example",
    enabled=True,
    subnet="192.168.100.0/24")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/setting"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := setting.NewTeleport(ctx, "example", &setting.TeleportArgs{
			Enabled: pulumi.Bool(true),
			Subnet:  pulumi.String("192.168.100.0/24"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var example = new Unifi.Setting.Teleport("example", new()
    {
        Enabled = true,
        Subnet = "192.168.100.0/24",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.setting.Teleport;
import com.pulumiverse.unifi.setting.TeleportArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Teleport("example", TeleportArgs.builder()
            .enabled(true)
            .subnet("192.168.100.0/24")
            .build());

    }
}

    resources:
  example:
    type: unifi:setting:Teleport
    properties:
      enabled: true # Optional subnet configuration for Teleport
      #   # Specify a CIDR notation subnet for Teleport to use
      subnet: 192.168.100.0/24

    Create Teleport Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Teleport(name: string, args: TeleportArgs, opts?: CustomResourceOptions);
    @overload
def Teleport(resource_name: str,
             args: TeleportArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Teleport(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             enabled: Optional[bool] = None,
             site: Optional[str] = None,
             subnet: Optional[str] = None)
    func NewTeleport(ctx *Context, name string, args TeleportArgs, opts ...ResourceOption) (*Teleport, error)
    public Teleport(string name, TeleportArgs args, CustomResourceOptions? opts = null)
    public Teleport(String name, TeleportArgs args)
public Teleport(String name, TeleportArgs args, CustomResourceOptions options)

    type: unifi:setting:Teleport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TeleportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TeleportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TeleportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeleportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeleportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var teleportResource = new Unifi.Setting.Teleport("teleportResource", new()
{
    Enabled = false,
    Site = "string",
    Subnet = "string",
});

    example, err := setting.NewTeleport(ctx, "teleportResource", &setting.TeleportArgs{
	Enabled: pulumi.Bool(false),
	Site:    pulumi.String("string"),
	Subnet:  pulumi.String("string"),
})

    var teleportResource = new Teleport("teleportResource", TeleportArgs.builder()
    .enabled(false)
    .site("string")
    .subnet("string")
    .build());

    teleport_resource = unifi.setting.Teleport("teleportResource",
    enabled=False,
    site="string",
    subnet="string")

    const teleportResource = new unifi.setting.Teleport("teleportResource", {
    enabled: false,
    site: "string",
    subnet: "string",
});

    type: unifi:setting:Teleport
properties:
    enabled: false
    site: string
    subnet: string

    Teleport Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Teleport resource accepts the following input properties:

    Enabled bool
    Whether Teleport is enabled.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    Enabled bool
    Whether Teleport is enabled.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled Boolean
    Whether Teleport is enabled.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet String
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled boolean
    Whether Teleport is enabled.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled bool
    Whether Teleport is enabled.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet str
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled Boolean
    Whether Teleport is enabled.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet String
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Teleport resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Teleport Resource

    Get an existing Teleport resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TeleportState, opts?: CustomResourceOptions): Teleport
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        site: Optional[str] = None,
        subnet: Optional[str] = None) -> Teleport
    func GetTeleport(ctx *Context, name string, id IDInput, state *TeleportState, opts ...ResourceOption) (*Teleport, error)
    public static Teleport Get(string name, Input<string> id, TeleportState? state, CustomResourceOptions? opts = null)
    public static Teleport get(String name, Output<String> id, TeleportState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:Teleport    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Enabled bool
    Whether Teleport is enabled.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    Enabled bool
    Whether Teleport is enabled.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled Boolean
    Whether Teleport is enabled.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet String
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled boolean
    Whether Teleport is enabled.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet string
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled bool
    Whether Teleport is enabled.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet str
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.
    enabled Boolean
    Whether Teleport is enabled.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    subnet String
    The subnet CIDR for Teleport (e.g., 192.168.1.0/24). Can be empty but must be set explicitly.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Viewing docs for Unifi v0.2.0
    published on Tuesday, Feb 17, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi
      Try Pulumi Cloud free. Your team will thank you.