Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. Mgmt
Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.setting.Mgmt

Explore with Pulumi AI

unifi logo
Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse
pulumiverse/pulumi-unifi

    unifi.setting.Mgmt manages settings for a unifi site.

    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,
});

    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)

    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),
		})
		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,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.Site;
import com.pulumi.unifi.SiteArgs;
import com.pulumi.unifi.setting.Mgmt;
import com.pulumi.unifi.setting.MgmtArgs;
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)
            .build());

    }
}

    resources:
  example:
    type: unifi:Site
    properties:
      description: example
  exampleMgmt:
    type: unifi:setting:Mgmt
    name: example
    properties:
      site: ${example.name}
      autoUpgrade: true

    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,
         auto_upgrade: Optional[bool] = None,
         site: Optional[str] = None,
         ssh_enabled: Optional[bool] = None,
         ssh_keys: Optional[Sequence[MgmtSshKeyArgs]] = None)
    func NewMgmt(ctx *Context, name string, args *MgmtArgs, opts ...ResourceOption) (*Mgmt, error)
    public Mgmt(string name, MgmtArgs? args = null, CustomResourceOptions? opts = null)
    public Mgmt(String name, MgmtArgs args)
public Mgmt(String name, MgmtArgs args, CustomResourceOptions options)

    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()
{
    AutoUpgrade = false,
    Site = "string",
    SshEnabled = false,
    SshKeys = new[]
    {
        new Unifi.Setting.Inputs.MgmtSshKeyArgs
        {
            Name = "string",
            Type = "string",
            Comment = "string",
            Key = "string",
        },
    },
});

    example, err := setting.NewMgmt(ctx, "mgmtResource", &setting.MgmtArgs{
	AutoUpgrade: pulumi.Bool(false),
	Site:        pulumi.String("string"),
	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"),
		},
	},
})

    var mgmtResource = new Mgmt("mgmtResource", MgmtArgs.builder()
    .autoUpgrade(false)
    .site("string")
    .sshEnabled(false)
    .sshKeys(MgmtSshKeyArgs.builder()
        .name("string")
        .type("string")
        .comment("string")
        .key("string")
        .build())
    .build());

    mgmt_resource = unifi.setting.Mgmt("mgmtResource",
    auto_upgrade=False,
    site="string",
    ssh_enabled=False,
    ssh_keys=[{
        "name": "string",
        "type": "string",
        "comment": "string",
        "key": "string",
    }])

    const mgmtResource = new unifi.setting.Mgmt("mgmtResource", {
    autoUpgrade: false,
    site: "string",
    sshEnabled: false,
    sshKeys: [{
        name: "string",
        type: "string",
        comment: "string",
        key: "string",
    }],
});

    type: unifi:setting:Mgmt
properties:
    autoUpgrade: false
    site: string
    sshEnabled: false
    sshKeys:
        - comment: string
          key: string
          name: string
          type: string

    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:

    AutoUpgrade bool
    Automatically upgrade device firmware.
    Site string
    The name of the site to associate the settings with.
    SshEnabled bool
    Enable SSH authentication.
    SshKeys List<Pulumiverse.Unifi.Setting.Inputs.MgmtSshKey>
    SSH key.
    AutoUpgrade bool
    Automatically upgrade device firmware.
    Site string
    The name of the site to associate the settings with.
    SshEnabled bool
    Enable SSH authentication.
    SshKeys []MgmtSshKeyArgs
    SSH key.
    autoUpgrade Boolean
    Automatically upgrade device firmware.
    site String
    The name of the site to associate the settings with.
    sshEnabled Boolean
    Enable SSH authentication.
    sshKeys List<MgmtSshKey>
    SSH key.
    autoUpgrade boolean
    Automatically upgrade device firmware.
    site string
    The name of the site to associate the settings with.
    sshEnabled boolean
    Enable SSH authentication.
    sshKeys MgmtSshKey[]
    SSH key.
    auto_upgrade bool
    Automatically upgrade device firmware.
    site str
    The name of the site to associate the settings with.
    ssh_enabled bool
    Enable SSH authentication.
    ssh_keys Sequence[MgmtSshKeyArgs]
    SSH key.
    autoUpgrade Boolean
    Automatically upgrade device firmware.
    site String
    The name of the site to associate the settings with.
    sshEnabled Boolean
    Enable SSH authentication.
    sshKeys List<Property Map>
    SSH key.

    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,
        auto_upgrade: Optional[bool] = None,
        site: Optional[str] = None,
        ssh_enabled: Optional[bool] = None,
        ssh_keys: Optional[Sequence[MgmtSshKeyArgs]] = None) -> Mgmt
    func 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)
    Resource lookup is not supported in YAML
    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:
    AutoUpgrade bool
    Automatically upgrade device firmware.
    Site string
    The name of the site to associate the settings with.
    SshEnabled bool
    Enable SSH authentication.
    SshKeys List<Pulumiverse.Unifi.Setting.Inputs.MgmtSshKey>
    SSH key.
    AutoUpgrade bool
    Automatically upgrade device firmware.
    Site string
    The name of the site to associate the settings with.
    SshEnabled bool
    Enable SSH authentication.
    SshKeys []MgmtSshKeyArgs
    SSH key.
    autoUpgrade Boolean
    Automatically upgrade device firmware.
    site String
    The name of the site to associate the settings with.
    sshEnabled Boolean
    Enable SSH authentication.
    sshKeys List<MgmtSshKey>
    SSH key.
    autoUpgrade boolean
    Automatically upgrade device firmware.
    site string
    The name of the site to associate the settings with.
    sshEnabled boolean
    Enable SSH authentication.
    sshKeys MgmtSshKey[]
    SSH key.
    auto_upgrade bool
    Automatically upgrade device firmware.
    site str
    The name of the site to associate the settings with.
    ssh_enabled bool
    Enable SSH authentication.
    ssh_keys Sequence[MgmtSshKeyArgs]
    SSH key.
    autoUpgrade Boolean
    Automatically upgrade device firmware.
    site String
    The name of the site to associate the settings with.
    sshEnabled Boolean
    Enable SSH authentication.
    sshKeys List<Property Map>
    SSH key.

    Supporting Types

    MgmtSshKey, MgmtSshKeyArgs

    Name string
    Name of SSH key.
    Type string
    Type of SSH key, e.g. ssh-rsa.
    Comment string
    Comment.
    Key string
    Public SSH key.
    Name string
    Name of SSH key.
    Type string
    Type of SSH key, e.g. ssh-rsa.
    Comment string
    Comment.
    Key string
    Public SSH key.
    name String
    Name of SSH key.
    type String
    Type of SSH key, e.g. ssh-rsa.
    comment String
    Comment.
    key String
    Public SSH key.
    name string
    Name of SSH key.
    type string
    Type of SSH key, e.g. ssh-rsa.
    comment string
    Comment.
    key string
    Public SSH key.
    name str
    Name of SSH key.
    type str
    Type of SSH key, e.g. ssh-rsa.
    comment str
    Comment.
    key str
    Public SSH key.
    name String
    Name of SSH key.
    type String
    Type of SSH key, e.g. ssh-rsa.
    comment String
    Comment.
    key String
    Public SSH key.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse
    pulumiverse/pulumi-unifi