1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. Dpi
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
unifi logo
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse

    Manages Deep Packet Inspection (DPI) settings for a UniFi site. DPI is a feature that allows the UniFi controller to analyze network traffic and identify applications and services being used on the network.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as unifi from "@pulumiverse/unifi";
    
    const example = new unifi.setting.Dpi("example", {
        enabled: true,
        fingerprintingEnabled: true,
    });
    
    import pulumi
    import pulumiverse_unifi as unifi
    
    example = unifi.setting.Dpi("example",
        enabled=True,
        fingerprinting_enabled=True)
    
    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.NewDpi(ctx, "example", &setting.DpiArgs{
    			Enabled:               pulumi.Bool(true),
    			FingerprintingEnabled: pulumi.Bool(true),
    		})
    		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.Dpi("example", new()
        {
            Enabled = true,
            FingerprintingEnabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.unifi.setting.Dpi;
    import com.pulumiverse.unifi.setting.DpiArgs;
    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 Dpi("example", DpiArgs.builder()
                .enabled(true)
                .fingerprintingEnabled(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: unifi:setting:Dpi
        properties:
          enabled: true # Enable DPI fingerprinting for more accurate application identification
          fingerprintingEnabled: true # Specify the site (optional, defaults to site configured in provider, otherwise "default")
          #   # site = "default"
    

    Create Dpi Resource

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

    Constructor syntax

    new Dpi(name: string, args: DpiArgs, opts?: CustomResourceOptions);
    @overload
    def Dpi(resource_name: str,
            args: DpiArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dpi(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            fingerprinting_enabled: Optional[bool] = None,
            site: Optional[str] = None)
    func NewDpi(ctx *Context, name string, args DpiArgs, opts ...ResourceOption) (*Dpi, error)
    public Dpi(string name, DpiArgs args, CustomResourceOptions? opts = null)
    public Dpi(String name, DpiArgs args)
    public Dpi(String name, DpiArgs args, CustomResourceOptions options)
    
    type: unifi:setting:Dpi
    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 DpiArgs
    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 DpiArgs
    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 DpiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DpiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DpiArgs
    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 dpiResource = new Unifi.Setting.Dpi("dpiResource", new()
    {
        Enabled = false,
        FingerprintingEnabled = false,
        Site = "string",
    });
    
    example, err := setting.NewDpi(ctx, "dpiResource", &setting.DpiArgs{
    	Enabled:               pulumi.Bool(false),
    	FingerprintingEnabled: pulumi.Bool(false),
    	Site:                  pulumi.String("string"),
    })
    
    var dpiResource = new Dpi("dpiResource", DpiArgs.builder()
        .enabled(false)
        .fingerprintingEnabled(false)
        .site("string")
        .build());
    
    dpi_resource = unifi.setting.Dpi("dpiResource",
        enabled=False,
        fingerprinting_enabled=False,
        site="string")
    
    const dpiResource = new unifi.setting.Dpi("dpiResource", {
        enabled: false,
        fingerprintingEnabled: false,
        site: "string",
    });
    
    type: unifi:setting:Dpi
    properties:
        enabled: false
        fingerprintingEnabled: false
        site: string
    

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

    Enabled bool
    Whether Deep Packet Inspection is enabled.
    FingerprintingEnabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    FingerprintingEnabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled Boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprinting_enabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled Boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Dpi 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 Dpi Resource

    Get an existing Dpi 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?: DpiState, opts?: CustomResourceOptions): Dpi
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            fingerprinting_enabled: Optional[bool] = None,
            site: Optional[str] = None) -> Dpi
    func GetDpi(ctx *Context, name string, id IDInput, state *DpiState, opts ...ResourceOption) (*Dpi, error)
    public static Dpi Get(string name, Input<string> id, DpiState? state, CustomResourceOptions? opts = null)
    public static Dpi get(String name, Output<String> id, DpiState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:Dpi    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 Deep Packet Inspection is enabled.
    FingerprintingEnabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    FingerprintingEnabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled Boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprinting_enabled bool
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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 Deep Packet Inspection is enabled.
    fingerprintingEnabled Boolean
    Whether DPI fingerprinting is enabled. Fingerprinting allows the controller to identify applications and services based on traffic patterns.
    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.2.0
    published on Tuesday, Feb 17, 2026 by Pulumiverse
      Try Pulumi Cloud free. Your team will thank you.