The unifi.setting.Mgmt resource manages site-wide management settings in the UniFi controller.
This resource allows you to configure important management features including:
- Automatic firmware upgrades for UniFi devices
- SSH access for advanced configuration and troubleshooting
- SSH key management for secure remote access
These settings affect how the UniFi controller manages devices at the site level. They are particularly important for:
- Maintaining device security through automatic updates
- Enabling secure remote administration
- Implementing SSH key-based authentication
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";
const example = new unifi.Site("example", {description: "example"});
const exampleMgmt = new unifi.setting.Mgmt("example", {
site: example.name,
autoUpgrade: true,
autoUpgradeHour: 3,
advancedFeatureEnabled: true,
alertEnabled: true,
bootSound: false,
debugToolsEnabled: true,
directConnectEnabled: false,
ledEnabled: true,
outdoorModeEnabled: false,
unifiIdpEnabled: false,
wifimanEnabled: true,
sshEnabled: true,
sshAuthPasswordEnabled: true,
sshBindWildcard: false,
sshUsername: "admin",
sshKeys: [{
name: "Admin Key",
type: "ssh-rsa",
key: "AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx...",
comment: "admin@example.com",
}],
});
import pulumi
import pulumiverse_unifi as unifi
example = unifi.Site("example", description="example")
example_mgmt = unifi.setting.Mgmt("example",
site=example.name,
auto_upgrade=True,
auto_upgrade_hour=3,
advanced_feature_enabled=True,
alert_enabled=True,
boot_sound=False,
debug_tools_enabled=True,
direct_connect_enabled=False,
led_enabled=True,
outdoor_mode_enabled=False,
unifi_idp_enabled=False,
wifiman_enabled=True,
ssh_enabled=True,
ssh_auth_password_enabled=True,
ssh_bind_wildcard=False,
ssh_username="admin",
ssh_keys=[{
"name": "Admin Key",
"type": "ssh-rsa",
"key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx...",
"comment": "admin@example.com",
}])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi"
"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/setting"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := unifi.NewSite(ctx, "example", &unifi.SiteArgs{
Description: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = setting.NewMgmt(ctx, "example", &setting.MgmtArgs{
Site: example.Name,
AutoUpgrade: pulumi.Bool(true),
AutoUpgradeHour: pulumi.Int(3),
AdvancedFeatureEnabled: pulumi.Bool(true),
AlertEnabled: pulumi.Bool(true),
BootSound: pulumi.Bool(false),
DebugToolsEnabled: pulumi.Bool(true),
DirectConnectEnabled: pulumi.Bool(false),
LedEnabled: pulumi.Bool(true),
OutdoorModeEnabled: pulumi.Bool(false),
UnifiIdpEnabled: pulumi.Bool(false),
WifimanEnabled: pulumi.Bool(true),
SshEnabled: pulumi.Bool(true),
SshAuthPasswordEnabled: pulumi.Bool(true),
SshBindWildcard: pulumi.Bool(false),
SshUsername: pulumi.String("admin"),
SshKeys: setting.MgmtSshKeyArray{
&setting.MgmtSshKeyArgs{
Name: pulumi.String("Admin Key"),
Type: pulumi.String("ssh-rsa"),
Key: pulumi.String("AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx..."),
Comment: pulumi.String("admin@example.com"),
},
},
})
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.Site("example", new()
{
Description = "example",
});
var exampleMgmt = new Unifi.Setting.Mgmt("example", new()
{
Site = example.Name,
AutoUpgrade = true,
AutoUpgradeHour = 3,
AdvancedFeatureEnabled = true,
AlertEnabled = true,
BootSound = false,
DebugToolsEnabled = true,
DirectConnectEnabled = false,
LedEnabled = true,
OutdoorModeEnabled = false,
UnifiIdpEnabled = false,
WifimanEnabled = true,
SshEnabled = true,
SshAuthPasswordEnabled = true,
SshBindWildcard = false,
SshUsername = "admin",
SshKeys = new[]
{
new Unifi.Setting.Inputs.MgmtSshKeyArgs
{
Name = "Admin Key",
Type = "ssh-rsa",
Key = "AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx...",
Comment = "admin@example.com",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.Site;
import com.pulumiverse.unifi.SiteArgs;
import com.pulumiverse.unifi.setting.Mgmt;
import com.pulumiverse.unifi.setting.MgmtArgs;
import com.pulumi.unifi.setting.inputs.MgmtSshKeyArgs;
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 Site("example", SiteArgs.builder()
.description("example")
.build());
var exampleMgmt = new Mgmt("exampleMgmt", MgmtArgs.builder()
.site(example.name())
.autoUpgrade(true)
.autoUpgradeHour(3)
.advancedFeatureEnabled(true)
.alertEnabled(true)
.bootSound(false)
.debugToolsEnabled(true)
.directConnectEnabled(false)
.ledEnabled(true)
.outdoorModeEnabled(false)
.unifiIdpEnabled(false)
.wifimanEnabled(true)
.sshEnabled(true)
.sshAuthPasswordEnabled(true)
.sshBindWildcard(false)
.sshUsername("admin")
.sshKeys(MgmtSshKeyArgs.builder()
.name("Admin Key")
.type("ssh-rsa")
.key("AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx...")
.comment("admin@example.com")
.build())
.build());
}
}
resources:
example:
type: unifi:Site
properties:
description: example
exampleMgmt:
type: unifi:setting:Mgmt
name: example
properties:
site: ${example.name}
autoUpgrade: true
autoUpgradeHour: 3 # Device management settings
advancedFeatureEnabled: true
alertEnabled: true
bootSound: false
debugToolsEnabled: true
directConnectEnabled: false
ledEnabled: true
outdoorModeEnabled: false
unifiIdpEnabled: false
wifimanEnabled: true # SSH access configuration
sshEnabled: true
sshAuthPasswordEnabled: true
sshBindWildcard: false
sshUsername: admin
sshKeys:
- name: Admin Key
type: ssh-rsa
key: AAAAB3NzaC1yc2EAAAADAQABAAABAQCxxx...
comment: admin@example.com
Create Mgmt Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Mgmt(name: string, args?: MgmtArgs, opts?: CustomResourceOptions);@overload
def Mgmt(resource_name: str,
args: Optional[MgmtArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Mgmt(resource_name: str,
opts: Optional[ResourceOptions] = None,
advanced_feature_enabled: Optional[bool] = None,
alert_enabled: Optional[bool] = None,
auto_upgrade: Optional[bool] = None,
auto_upgrade_hour: Optional[int] = None,
boot_sound: Optional[bool] = None,
debug_tools_enabled: Optional[bool] = None,
direct_connect_enabled: Optional[bool] = None,
led_enabled: Optional[bool] = None,
outdoor_mode_enabled: Optional[bool] = None,
site: Optional[str] = None,
ssh_auth_password_enabled: Optional[bool] = None,
ssh_bind_wildcard: Optional[bool] = None,
ssh_enabled: Optional[bool] = None,
ssh_keys: Optional[Sequence[MgmtSshKeyArgs]] = None,
ssh_password: Optional[str] = None,
ssh_username: Optional[str] = None,
unifi_idp_enabled: Optional[bool] = None,
wifiman_enabled: Optional[bool] = None)func NewMgmt(ctx *Context, name string, args *MgmtArgs, opts ...ResourceOption) (*Mgmt, error)public Mgmt(string name, MgmtArgs? args = null, CustomResourceOptions? opts = null)type: unifi:setting:Mgmt
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 MgmtArgs
- 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 MgmtArgs
- 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 MgmtArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MgmtArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MgmtArgs
- 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 mgmtResource = new Unifi.Setting.Mgmt("mgmtResource", new()
{
AdvancedFeatureEnabled = false,
AlertEnabled = false,
AutoUpgrade = false,
AutoUpgradeHour = 0,
BootSound = false,
DebugToolsEnabled = false,
DirectConnectEnabled = false,
LedEnabled = false,
OutdoorModeEnabled = false,
Site = "string",
SshAuthPasswordEnabled = false,
SshBindWildcard = false,
SshEnabled = false,
SshKeys = new[]
{
new Unifi.Setting.Inputs.MgmtSshKeyArgs
{
Name = "string",
Type = "string",
Comment = "string",
Key = "string",
},
},
SshPassword = "string",
SshUsername = "string",
UnifiIdpEnabled = false,
WifimanEnabled = false,
});
example, err := setting.NewMgmt(ctx, "mgmtResource", &setting.MgmtArgs{
AdvancedFeatureEnabled: pulumi.Bool(false),
AlertEnabled: pulumi.Bool(false),
AutoUpgrade: pulumi.Bool(false),
AutoUpgradeHour: pulumi.Int(0),
BootSound: pulumi.Bool(false),
DebugToolsEnabled: pulumi.Bool(false),
DirectConnectEnabled: pulumi.Bool(false),
LedEnabled: pulumi.Bool(false),
OutdoorModeEnabled: pulumi.Bool(false),
Site: pulumi.String("string"),
SshAuthPasswordEnabled: pulumi.Bool(false),
SshBindWildcard: pulumi.Bool(false),
SshEnabled: pulumi.Bool(false),
SshKeys: setting.MgmtSshKeyArray{
&setting.MgmtSshKeyArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Comment: pulumi.String("string"),
Key: pulumi.String("string"),
},
},
SshPassword: pulumi.String("string"),
SshUsername: pulumi.String("string"),
UnifiIdpEnabled: pulumi.Bool(false),
WifimanEnabled: pulumi.Bool(false),
})
var mgmtResource = new Mgmt("mgmtResource", MgmtArgs.builder()
.advancedFeatureEnabled(false)
.alertEnabled(false)
.autoUpgrade(false)
.autoUpgradeHour(0)
.bootSound(false)
.debugToolsEnabled(false)
.directConnectEnabled(false)
.ledEnabled(false)
.outdoorModeEnabled(false)
.site("string")
.sshAuthPasswordEnabled(false)
.sshBindWildcard(false)
.sshEnabled(false)
.sshKeys(MgmtSshKeyArgs.builder()
.name("string")
.type("string")
.comment("string")
.key("string")
.build())
.sshPassword("string")
.sshUsername("string")
.unifiIdpEnabled(false)
.wifimanEnabled(false)
.build());
mgmt_resource = unifi.setting.Mgmt("mgmtResource",
advanced_feature_enabled=False,
alert_enabled=False,
auto_upgrade=False,
auto_upgrade_hour=0,
boot_sound=False,
debug_tools_enabled=False,
direct_connect_enabled=False,
led_enabled=False,
outdoor_mode_enabled=False,
site="string",
ssh_auth_password_enabled=False,
ssh_bind_wildcard=False,
ssh_enabled=False,
ssh_keys=[{
"name": "string",
"type": "string",
"comment": "string",
"key": "string",
}],
ssh_password="string",
ssh_username="string",
unifi_idp_enabled=False,
wifiman_enabled=False)
const mgmtResource = new unifi.setting.Mgmt("mgmtResource", {
advancedFeatureEnabled: false,
alertEnabled: false,
autoUpgrade: false,
autoUpgradeHour: 0,
bootSound: false,
debugToolsEnabled: false,
directConnectEnabled: false,
ledEnabled: false,
outdoorModeEnabled: false,
site: "string",
sshAuthPasswordEnabled: false,
sshBindWildcard: false,
sshEnabled: false,
sshKeys: [{
name: "string",
type: "string",
comment: "string",
key: "string",
}],
sshPassword: "string",
sshUsername: "string",
unifiIdpEnabled: false,
wifimanEnabled: false,
});
type: unifi:setting:Mgmt
properties:
advancedFeatureEnabled: false
alertEnabled: false
autoUpgrade: false
autoUpgradeHour: 0
bootSound: false
debugToolsEnabled: false
directConnectEnabled: false
ledEnabled: false
outdoorModeEnabled: false
site: string
sshAuthPasswordEnabled: false
sshBindWildcard: false
sshEnabled: false
sshKeys:
- comment: string
key: string
name: string
type: string
sshPassword: string
sshUsername: string
unifiIdpEnabled: false
wifimanEnabled: false
Mgmt 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 Mgmt resource accepts the following input properties:
- Advanced
Feature boolEnabled - Enable advanced features for UniFi devices at this site.
- Alert
Enabled bool - Enable alerts for UniFi devices at this site.
- Auto
Upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- Auto
Upgrade intHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- Boot
Sound bool - Enable the boot sound for UniFi devices at this site.
- Debug
Tools boolEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- Direct
Connect boolEnabled - Enable direct connect for UniFi devices at this site.
- Led
Enabled bool - Enable the LED light for UniFi devices at this site.
- Outdoor
Mode boolEnabled - Enable outdoor mode for UniFi devices at this site.
- Site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- Ssh
Auth boolPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- Ssh
Bind boolWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- Ssh
Enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- Ssh
Keys List<Pulumiverse.Unifi. Setting. Inputs. Mgmt Ssh Key> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- Ssh
Password string - The SSH password for UniFi devices at this site.
- Ssh
Username string - The SSH username for UniFi devices at this site.
- Unifi
Idp boolEnabled - Enable UniFi IDP for UniFi devices at this site.
- Wifiman
Enabled bool - Enable WiFiman for UniFi devices at this site.
- Advanced
Feature boolEnabled - Enable advanced features for UniFi devices at this site.
- Alert
Enabled bool - Enable alerts for UniFi devices at this site.
- Auto
Upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- Auto
Upgrade intHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- Boot
Sound bool - Enable the boot sound for UniFi devices at this site.
- Debug
Tools boolEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- Direct
Connect boolEnabled - Enable direct connect for UniFi devices at this site.
- Led
Enabled bool - Enable the LED light for UniFi devices at this site.
- Outdoor
Mode boolEnabled - Enable outdoor mode for UniFi devices at this site.
- Site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- Ssh
Auth boolPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- Ssh
Bind boolWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- Ssh
Enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- Ssh
Keys []MgmtSsh Key Args - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- Ssh
Password string - The SSH password for UniFi devices at this site.
- Ssh
Username string - The SSH username for UniFi devices at this site.
- Unifi
Idp boolEnabled - Enable UniFi IDP for UniFi devices at this site.
- Wifiman
Enabled bool - Enable WiFiman for UniFi devices at this site.
- advanced
Feature BooleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled Boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade Boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade IntegerHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound Boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools BooleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect BooleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled Boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode BooleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site String
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth BooleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind BooleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled Boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys List<MgmtSsh Key> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password String - The SSH password for UniFi devices at this site.
- ssh
Username String - The SSH username for UniFi devices at this site.
- unifi
Idp BooleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled Boolean - Enable WiFiman for UniFi devices at this site.
- advanced
Feature booleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade numberHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools booleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect booleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode booleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth booleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind booleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys MgmtSsh Key[] - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password string - The SSH password for UniFi devices at this site.
- ssh
Username string - The SSH username for UniFi devices at this site.
- unifi
Idp booleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled boolean - Enable WiFiman for UniFi devices at this site.
- advanced_
feature_ boolenabled - Enable advanced features for UniFi devices at this site.
- alert_
enabled bool - Enable alerts for UniFi devices at this site.
- auto_
upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto_
upgrade_ inthour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot_
sound bool - Enable the boot sound for UniFi devices at this site.
- debug_
tools_ boolenabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct_
connect_ boolenabled - Enable direct connect for UniFi devices at this site.
- led_
enabled bool - Enable the LED light for UniFi devices at this site.
- outdoor_
mode_ boolenabled - Enable outdoor mode for UniFi devices at this site.
- site str
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh_
auth_ boolpassword_ enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh_
bind_ boolwildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh_
enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh_
keys Sequence[MgmtSsh Key Args] - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh_
password str - The SSH password for UniFi devices at this site.
- ssh_
username str - The SSH username for UniFi devices at this site.
- unifi_
idp_ boolenabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman_
enabled bool - Enable WiFiman for UniFi devices at this site.
- advanced
Feature BooleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled Boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade Boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade NumberHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound Boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools BooleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect BooleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled Boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode BooleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site String
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth BooleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind BooleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled Boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys List<Property Map> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password String - The SSH password for UniFi devices at this site.
- ssh
Username String - The SSH username for UniFi devices at this site.
- unifi
Idp BooleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled Boolean - Enable WiFiman for UniFi devices at this site.
Outputs
All input properties are implicitly available as output properties. Additionally, the Mgmt 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 Mgmt Resource
Get an existing Mgmt 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?: MgmtState, opts?: CustomResourceOptions): Mgmt@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_feature_enabled: Optional[bool] = None,
alert_enabled: Optional[bool] = None,
auto_upgrade: Optional[bool] = None,
auto_upgrade_hour: Optional[int] = None,
boot_sound: Optional[bool] = None,
debug_tools_enabled: Optional[bool] = None,
direct_connect_enabled: Optional[bool] = None,
led_enabled: Optional[bool] = None,
outdoor_mode_enabled: Optional[bool] = None,
site: Optional[str] = None,
ssh_auth_password_enabled: Optional[bool] = None,
ssh_bind_wildcard: Optional[bool] = None,
ssh_enabled: Optional[bool] = None,
ssh_keys: Optional[Sequence[MgmtSshKeyArgs]] = None,
ssh_password: Optional[str] = None,
ssh_username: Optional[str] = None,
unifi_idp_enabled: Optional[bool] = None,
wifiman_enabled: Optional[bool] = None) -> Mgmtfunc GetMgmt(ctx *Context, name string, id IDInput, state *MgmtState, opts ...ResourceOption) (*Mgmt, error)public static Mgmt Get(string name, Input<string> id, MgmtState? state, CustomResourceOptions? opts = null)public static Mgmt get(String name, Output<String> id, MgmtState state, CustomResourceOptions options)resources: _: type: unifi:setting:Mgmt 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.
- Advanced
Feature boolEnabled - Enable advanced features for UniFi devices at this site.
- Alert
Enabled bool - Enable alerts for UniFi devices at this site.
- Auto
Upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- Auto
Upgrade intHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- Boot
Sound bool - Enable the boot sound for UniFi devices at this site.
- Debug
Tools boolEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- Direct
Connect boolEnabled - Enable direct connect for UniFi devices at this site.
- Led
Enabled bool - Enable the LED light for UniFi devices at this site.
- Outdoor
Mode boolEnabled - Enable outdoor mode for UniFi devices at this site.
- Site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- Ssh
Auth boolPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- Ssh
Bind boolWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- Ssh
Enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- Ssh
Keys List<Pulumiverse.Unifi. Setting. Inputs. Mgmt Ssh Key> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- Ssh
Password string - The SSH password for UniFi devices at this site.
- Ssh
Username string - The SSH username for UniFi devices at this site.
- Unifi
Idp boolEnabled - Enable UniFi IDP for UniFi devices at this site.
- Wifiman
Enabled bool - Enable WiFiman for UniFi devices at this site.
- Advanced
Feature boolEnabled - Enable advanced features for UniFi devices at this site.
- Alert
Enabled bool - Enable alerts for UniFi devices at this site.
- Auto
Upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- Auto
Upgrade intHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- Boot
Sound bool - Enable the boot sound for UniFi devices at this site.
- Debug
Tools boolEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- Direct
Connect boolEnabled - Enable direct connect for UniFi devices at this site.
- Led
Enabled bool - Enable the LED light for UniFi devices at this site.
- Outdoor
Mode boolEnabled - Enable outdoor mode for UniFi devices at this site.
- Site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- Ssh
Auth boolPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- Ssh
Bind boolWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- Ssh
Enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- Ssh
Keys []MgmtSsh Key Args - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- Ssh
Password string - The SSH password for UniFi devices at this site.
- Ssh
Username string - The SSH username for UniFi devices at this site.
- Unifi
Idp boolEnabled - Enable UniFi IDP for UniFi devices at this site.
- Wifiman
Enabled bool - Enable WiFiman for UniFi devices at this site.
- advanced
Feature BooleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled Boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade Boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade IntegerHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound Boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools BooleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect BooleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled Boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode BooleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site String
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth BooleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind BooleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled Boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys List<MgmtSsh Key> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password String - The SSH password for UniFi devices at this site.
- ssh
Username String - The SSH username for UniFi devices at this site.
- unifi
Idp BooleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled Boolean - Enable WiFiman for UniFi devices at this site.
- advanced
Feature booleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade numberHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools booleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect booleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode booleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site string
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth booleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind booleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys MgmtSsh Key[] - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password string - The SSH password for UniFi devices at this site.
- ssh
Username string - The SSH username for UniFi devices at this site.
- unifi
Idp booleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled boolean - Enable WiFiman for UniFi devices at this site.
- advanced_
feature_ boolenabled - Enable advanced features for UniFi devices at this site.
- alert_
enabled bool - Enable alerts for UniFi devices at this site.
- auto_
upgrade bool - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto_
upgrade_ inthour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot_
sound bool - Enable the boot sound for UniFi devices at this site.
- debug_
tools_ boolenabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct_
connect_ boolenabled - Enable direct connect for UniFi devices at this site.
- led_
enabled bool - Enable the LED light for UniFi devices at this site.
- outdoor_
mode_ boolenabled - Enable outdoor mode for UniFi devices at this site.
- site str
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh_
auth_ boolpassword_ enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh_
bind_ boolwildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh_
enabled bool - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh_
keys Sequence[MgmtSsh Key Args] - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh_
password str - The SSH password for UniFi devices at this site.
- ssh_
username str - The SSH username for UniFi devices at this site.
- unifi_
idp_ boolenabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman_
enabled bool - Enable WiFiman for UniFi devices at this site.
- advanced
Feature BooleanEnabled - Enable advanced features for UniFi devices at this site.
- alert
Enabled Boolean - Enable alerts for UniFi devices at this site.
- auto
Upgrade Boolean - Enable automatic firmware upgrades for all UniFi devices at this site. When enabled, devices will automatically update to the latest stable firmware version approved for your controller version.
- auto
Upgrade NumberHour - The hour of the day (0-23) when automatic firmware upgrades will occur.
- boot
Sound Boolean - Enable the boot sound for UniFi devices at this site.
- debug
Tools BooleanEnabled - Enable debug tools for UniFi devices at this site. Requires controller version 7.3 or later.
- direct
Connect BooleanEnabled - Enable direct connect for UniFi devices at this site.
- led
Enabled Boolean - Enable the LED light for UniFi devices at this site.
- outdoor
Mode BooleanEnabled - Enable outdoor mode for UniFi devices at this site.
- site String
- The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
- ssh
Auth BooleanPassword Enabled - Enable SSH password authentication for UniFi devices at this site.
- ssh
Bind BooleanWildcard - Enable SSH bind wildcard for UniFi devices at this site.
- ssh
Enabled Boolean - Enable SSH access to UniFi devices at this site. When enabled, you can connect to devices using SSH for advanced configuration and troubleshooting. It's recommended to only enable this temporarily when needed.
- ssh
Keys List<Property Map> - List of SSH public keys that are allowed to connect to UniFi devices when SSH is enabled. Using SSH keys is more secure than password authentication.
- ssh
Password String - The SSH password for UniFi devices at this site.
- ssh
Username String - The SSH username for UniFi devices at this site.
- unifi
Idp BooleanEnabled - Enable UniFi IDP for UniFi devices at this site.
- wifiman
Enabled Boolean - Enable WiFiman for UniFi devices at this site.
Supporting Types
MgmtSshKey, MgmtSshKeyArgs
- Name string
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- Type string
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- Comment string
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- Key string
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
- Name string
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- Type string
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- Comment string
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- Key string
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
- name String
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- type String
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- comment String
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- key String
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
- name string
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- type string
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- comment string
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- key string
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
- name str
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- type str
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- comment str
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- key str
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
- name String
- A friendly name for the SSH key to help identify its owner or purpose (e.g., 'admin-laptop' or 'backup-server').
- type String
- The type of SSH key. Common values include:
ssh-rsa- RSA key (most common)ssh-ed25519- Ed25519 key (more secure)ecdsa-sha2-nistp256- ECDSA key
- comment String
- An optional comment to provide additional context about the key (e.g., 'generated on 2024-01-01' or 'expires 2025-12-31').
- key String
- The public key string. This is the content that would normally go in an authorized_keys file, excluding the type and comment (e.g., 'AAAAB3NzaC1yc2EA...').
Package Details
- Repository
- unifi pulumiverse/pulumi-unifi
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
unifiTerraform Provider.
