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

unifi.Account

Explore with Pulumi AI

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

    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

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

    Constructor syntax

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

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            password: Optional[str] = None,
            name: Optional[str] = None,
            network_id: Optional[str] = None,
            site: Optional[str] = None,
            tunnel_medium_type: Optional[int] = None,
            tunnel_type: Optional[int] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var accountResource = new Unifi.Account("accountResource", new()
{
    Password = "string",
    Name = "string",
    NetworkId = "string",
    Site = "string",
    TunnelMediumType = 0,
    TunnelType = 0,
});

    example, err := unifi.NewAccount(ctx, "accountResource", &unifi.AccountArgs{
	Password:         pulumi.String("string"),
	Name:             pulumi.String("string"),
	NetworkId:        pulumi.String("string"),
	Site:             pulumi.String("string"),
	TunnelMediumType: pulumi.Int(0),
	TunnelType:       pulumi.Int(0),
})

    var accountResource = new Account("accountResource", AccountArgs.builder()
    .password("string")
    .name("string")
    .networkId("string")
    .site("string")
    .tunnelMediumType(0)
    .tunnelType(0)
    .build());

    account_resource = unifi.Account("accountResource",
    password="string",
    name="string",
    network_id="string",
    site="string",
    tunnel_medium_type=0,
    tunnel_type=0)

    const accountResource = new unifi.Account("accountResource", {
    password: "string",
    name: "string",
    networkId: "string",
    site: "string",
    tunnelMediumType: 0,
    tunnelType: 0,
});

    type: unifi:Account
properties:
    name: string
    networkId: string
    password: string
    site: string
    tunnelMediumType: 0
    tunnelType: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    unifi logo
    Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse
    pulumiverse/pulumi-unifi