1. Packages
  2. Packages
  3. Unifi
  4. API Docs
  5. setting
  6. Connectivity
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse
unifi logo
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse

    Manages the site Connectivity settings for a UniFi site. The enabled flag controls wireless meshing (shown as “Wireless Meshing” in the controller UI): when on, access points can uplink to the network over a hidden wireless backhaul instead of Ethernet, and each AP keeps a standby mesh radio running for failover. Disable it on a fully wired site to reclaim that radio/airtime; APs that lose their wired uplink then go offline rather than re-joining over mesh. The controller-generated mesh SSID and PSK are intentionally not managed by this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as unifi from "@pulumiverse/unifi";
    
    const example = new unifi.setting.Connectivity("example", {enabled: false});
    
    import pulumi
    import pulumiverse_unifi as unifi
    
    example = unifi.setting.Connectivity("example", enabled=False)
    
    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.NewConnectivity(ctx, "example", &setting.ConnectivityArgs{
    			Enabled: pulumi.Bool(false),
    		})
    		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.Connectivity("example", new()
        {
            Enabled = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.unifi.setting.Connectivity;
    import com.pulumiverse.unifi.setting.ConnectivityArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 Connectivity("example", ConnectivityArgs.builder()
                .enabled(false)
                .build());
    
        }
    }
    
    resources:
      example:
        type: unifi:setting:Connectivity
        properties:
          enabled: false # Specify the site (optional, defaults to site configured in provider, otherwise "default")
          #   # site = "default"
    
    pulumi {
      required_providers {
        unifi = {
          source = "pulumi/unifi"
        }
      }
    }
    
    resource "unifi_setting_connectivity" "example" {
      enabled = false
    }
    

    Create Connectivity Resource

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

    Constructor syntax

    new Connectivity(name: string, args: ConnectivityArgs, opts?: CustomResourceOptions);
    @overload
    def Connectivity(resource_name: str,
                     args: ConnectivityArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Connectivity(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     enabled: Optional[bool] = None,
                     site: Optional[str] = None)
    func NewConnectivity(ctx *Context, name string, args ConnectivityArgs, opts ...ResourceOption) (*Connectivity, error)
    public Connectivity(string name, ConnectivityArgs args, CustomResourceOptions? opts = null)
    public Connectivity(String name, ConnectivityArgs args)
    public Connectivity(String name, ConnectivityArgs args, CustomResourceOptions options)
    
    type: unifi:setting:Connectivity
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "unifi_setting_connectivity" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ConnectivityArgs
    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 ConnectivityArgs
    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 ConnectivityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectivityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectivityArgs
    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 connectivityResource = new Unifi.Setting.Connectivity("connectivityResource", new()
    {
        Enabled = false,
        Site = "string",
    });
    
    example, err := setting.NewConnectivity(ctx, "connectivityResource", &setting.ConnectivityArgs{
    	Enabled: pulumi.Bool(false),
    	Site:    pulumi.String("string"),
    })
    
    resource "unifi_setting_connectivity" "connectivityResource" {
      enabled = false
      site    = "string"
    }
    
    var connectivityResource = new Connectivity("connectivityResource", ConnectivityArgs.builder()
        .enabled(false)
        .site("string")
        .build());
    
    connectivity_resource = unifi.setting.Connectivity("connectivityResource",
        enabled=False,
        site="string")
    
    const connectivityResource = new unifi.setting.Connectivity("connectivityResource", {
        enabled: false,
        site: "string",
    });
    
    type: unifi:setting:Connectivity
    properties:
        enabled: false
        site: string
    

    Connectivity 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 Connectivity resource accepts the following input properties:

    Enabled bool
    Whether wireless meshing is enabled for the site.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Enabled bool
    Whether wireless meshing is enabled for the site.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled bool
    Whether wireless meshing is enabled for the site.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled Boolean
    Whether wireless meshing is enabled for the site.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled boolean
    Whether wireless meshing is enabled for the site.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled bool
    Whether wireless meshing is enabled for the site.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled Boolean
    Whether wireless meshing is enabled for the site.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connectivity 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 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 Connectivity Resource

    Get an existing Connectivity 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?: ConnectivityState, opts?: CustomResourceOptions): Connectivity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            site: Optional[str] = None) -> Connectivity
    func GetConnectivity(ctx *Context, name string, id IDInput, state *ConnectivityState, opts ...ResourceOption) (*Connectivity, error)
    public static Connectivity Get(string name, Input<string> id, ConnectivityState? state, CustomResourceOptions? opts = null)
    public static Connectivity get(String name, Output<String> id, ConnectivityState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:Connectivity    get:      id: ${id}
    import {
      to = unifi_setting_connectivity.example
      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 wireless meshing is enabled for the site.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Enabled bool
    Whether wireless meshing is enabled for the site.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled bool
    Whether wireless meshing is enabled for the site.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled Boolean
    Whether wireless meshing is enabled for the site.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled boolean
    Whether wireless meshing is enabled for the site.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled bool
    Whether wireless meshing is enabled for the site.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    enabled Boolean
    Whether wireless meshing is enabled for the site.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.

    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.3.0
    published on Wednesday, Jul 8, 2026 by Pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial