Unifi v0.0.3, Dec 5 22

unifi.Account

Explore with Pulumi AI

unifi.Account manages a RADIUS user account

To authenticate devices based on MAC address, use the MAC address as the username and password under client creation. Convert lowercase letters to uppercase, and also remove colons or periods from the MAC address.

ATTENTION: If the user profile does not include a VLAN, the client will fall back to the untagged VLAN.

NOTE: MAC-based authentication accounts can only be used for wireless and wired clients. L2TP remote access does not apply.

Create Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            password: Optional[str] = None,
            site: Optional[str] = None,
            tunnel_medium_type: Optional[int] = None,
            tunnel_type: Optional[int] = None)
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)

func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)

public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)

public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

type: unifi:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountArgs: 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 AccountArgs: 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 AccountArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccountArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AccountArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Account Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Account resource accepts the following input properties:

Password string: The password of the account.
Name string: The name of the account.
NetworkId string: ID of the network for this account
Site string: The name of the site to associate the account with.
TunnelMediumType int: See RFC 2868 section 3.2 Defaults to 6.
TunnelType int: See RFC 2868 section 3.1 Defaults to 13.

Password string: The password of the account.
Name string: The name of the account.
NetworkId string: ID of the network for this account
Site string: The name of the site to associate the account with.
TunnelMediumType int: See RFC 2868 section 3.2 Defaults to 6.
TunnelType int: See RFC 2868 section 3.1 Defaults to 13.

password String: The password of the account.
name String: The name of the account.
networkId String: ID of the network for this account
site String: The name of the site to associate the account with.
tunnelMediumType Integer: See RFC 2868 section 3.2 Defaults to 6.
tunnelType Integer: See RFC 2868 section 3.1 Defaults to 13.

password string: The password of the account.
name string: The name of the account.
networkId string: ID of the network for this account
site string: The name of the site to associate the account with.
tunnelMediumType number: See RFC 2868 section 3.2 Defaults to 6.
tunnelType number: See RFC 2868 section 3.1 Defaults to 13.

password str: The password of the account.
name str: The name of the account.
network_id str: ID of the network for this account
site str: The name of the site to associate the account with.
tunnel_medium_type int: See RFC 2868 section 3.2 Defaults to 6.
tunnel_type int: See RFC 2868 section 3.1 Defaults to 13.

password String: The password of the account.
name String: The name of the account.
networkId String: ID of the network for this account
site String: The name of the site to associate the account with.
tunnelMediumType Number: See RFC 2868 section 3.2 Defaults to 6.
tunnelType Number: See RFC 2868 section 3.1 Defaults to 13.

Outputs

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

Get an existing Account 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?: AccountState, opts?: CustomResourceOptions): Account

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        password: Optional[str] = None,
        site: Optional[str] = None,
        tunnel_medium_type: Optional[int] = None,
        tunnel_type: Optional[int] = None) -> Account

func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)

public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)

public static Account get(String name, Output<String> id, AccountState 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:

Name string: The name of the account.
NetworkId string: ID of the network for this account
Password string: The password of the account.
Site string: The name of the site to associate the account with.
TunnelMediumType int: See RFC 2868 section 3.2 Defaults to 6.
TunnelType int: See RFC 2868 section 3.1 Defaults to 13.

Name string: The name of the account.
NetworkId string: ID of the network for this account
Password string: The password of the account.
Site string: The name of the site to associate the account with.
TunnelMediumType int: See RFC 2868 section 3.2 Defaults to 6.
TunnelType int: See RFC 2868 section 3.1 Defaults to 13.

name String: The name of the account.
networkId String: ID of the network for this account
password String: The password of the account.
site String: The name of the site to associate the account with.
tunnelMediumType Integer: See RFC 2868 section 3.2 Defaults to 6.
tunnelType Integer: See RFC 2868 section 3.1 Defaults to 13.

name string: The name of the account.
networkId string: ID of the network for this account
password string: The password of the account.
site string: The name of the site to associate the account with.
tunnelMediumType number: See RFC 2868 section 3.2 Defaults to 6.
tunnelType number: See RFC 2868 section 3.1 Defaults to 13.

name str: The name of the account.
network_id str: ID of the network for this account
password str: The password of the account.
site str: The name of the site to associate the account with.
tunnel_medium_type int: See RFC 2868 section 3.2 Defaults to 6.
tunnel_type int: See RFC 2868 section 3.1 Defaults to 13.

name String: The name of the account.
networkId String: ID of the network for this account
password String: The password of the account.
site String: The name of the site to associate the account with.
tunnelMediumType Number: See RFC 2868 section 3.2 Defaults to 6.
tunnelType Number: See RFC 2868 section 3.1 Defaults to 13.

Package Details

Repository: unifi pulumiverse/pulumi-unifi
License: Apache-2.0
Notes: This Pulumi package is based on the unifi Terraform Provider.