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

unifi.setting.AutoSpeedtest

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

    The unifi.setting.AutoSpeedtest resource manages the automatic speedtest settings in the UniFi controller.Automatic speedtests can be scheduled to run at regular intervals to monitor the network performance.

    NOTE: Automatic speedtests where not verified and tested on all UniFi controller versions due to limitations of controller used in acceptance testing.

    Example Usage

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

const example = new unifi.setting.AutoSpeedtest("example", {
    enabled: true,
    cron: "0 0 * * *",
});

    import pulumi
import pulumiverse_unifi as unifi

example = unifi.setting.AutoSpeedtest("example",
    enabled=True,
    cron="0 0 * * *")

    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.NewAutoSpeedtest(ctx, "example", &setting.AutoSpeedtestArgs{
			Enabled: pulumi.Bool(true),
			Cron:    pulumi.String("0 0 * * *"),
		})
		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.AutoSpeedtest("example", new()
    {
        Enabled = true,
        Cron = "0 0 * * *",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.setting.AutoSpeedtest;
import com.pulumiverse.unifi.setting.AutoSpeedtestArgs;
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 AutoSpeedtest("example", AutoSpeedtestArgs.builder()
            .enabled(true)
            .cron("0 0 * * *")
            .build());

    }
}

    resources:
  example:
    type: unifi:setting:AutoSpeedtest
    properties:
      enabled: true # Schedule for running speedtests using cron syntax
      #   # This example runs at midnight every day
      cron: 0 0 * * *

    Create AutoSpeedtest Resource

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

    Constructor syntax

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

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

    type: unifi:setting:AutoSpeedtest
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 AutoSpeedtestArgs
    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 AutoSpeedtestArgs
    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 AutoSpeedtestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AutoSpeedtestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AutoSpeedtestArgs
    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 autoSpeedtestResource = new Unifi.Setting.AutoSpeedtest("autoSpeedtestResource", new()
{
    Enabled = false,
    Cron = "string",
    Site = "string",
});

    example, err := setting.NewAutoSpeedtest(ctx, "autoSpeedtestResource", &setting.AutoSpeedtestArgs{
	Enabled: pulumi.Bool(false),
	Cron:    pulumi.String("string"),
	Site:    pulumi.String("string"),
})

    var autoSpeedtestResource = new AutoSpeedtest("autoSpeedtestResource", AutoSpeedtestArgs.builder()
    .enabled(false)
    .cron("string")
    .site("string")
    .build());

    auto_speedtest_resource = unifi.setting.AutoSpeedtest("autoSpeedtestResource",
    enabled=False,
    cron="string",
    site="string")

    const autoSpeedtestResource = new unifi.setting.AutoSpeedtest("autoSpeedtestResource", {
    enabled: false,
    cron: "string",
    site: "string",
});

    type: unifi:setting:AutoSpeedtest
properties:
    cron: string
    enabled: false
    site: string

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

    Enabled bool
    Whether the automatic speedtest is enabled.
    Cron string
    Cron expression defining the schedule for automatic speedtests.
    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 the automatic speedtest is enabled.
    Cron string
    Cron expression defining the schedule for automatic speedtests.
    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 the automatic speedtest is enabled.
    cron String
    Cron expression defining the schedule for automatic speedtests.
    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 the automatic speedtest is enabled.
    cron string
    Cron expression defining the schedule for automatic speedtests.
    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 the automatic speedtest is enabled.
    cron str
    Cron expression defining the schedule for automatic speedtests.
    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 the automatic speedtest is enabled.
    cron String
    Cron expression defining the schedule for automatic speedtests.
    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 AutoSpeedtest 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 AutoSpeedtest Resource

    Get an existing AutoSpeedtest 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?: AutoSpeedtestState, opts?: CustomResourceOptions): AutoSpeedtest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cron: Optional[str] = None,
        enabled: Optional[bool] = None,
        site: Optional[str] = None) -> AutoSpeedtest
    func GetAutoSpeedtest(ctx *Context, name string, id IDInput, state *AutoSpeedtestState, opts ...ResourceOption) (*AutoSpeedtest, error)
    public static AutoSpeedtest Get(string name, Input<string> id, AutoSpeedtestState? state, CustomResourceOptions? opts = null)
    public static AutoSpeedtest get(String name, Output<String> id, AutoSpeedtestState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:AutoSpeedtest    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:
    Cron string
    Cron expression defining the schedule for automatic speedtests.
    Enabled bool
    Whether the automatic speedtest 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.
    Cron string
    Cron expression defining the schedule for automatic speedtests.
    Enabled bool
    Whether the automatic speedtest 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.
    cron String
    Cron expression defining the schedule for automatic speedtests.
    enabled Boolean
    Whether the automatic speedtest 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.
    cron string
    Cron expression defining the schedule for automatic speedtests.
    enabled boolean
    Whether the automatic speedtest 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.
    cron str
    Cron expression defining the schedule for automatic speedtests.
    enabled bool
    Whether the automatic speedtest 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.
    cron String
    Cron expression defining the schedule for automatic speedtests.
    enabled Boolean
    Whether the automatic speedtest 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.

    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.