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

unifi.RadiusProfile

Explore with Pulumi AI

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

    unifi.RadiusProfile manages RADIUS profiles.

    Create RadiusProfile Resource

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

    Constructor syntax

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

@overload
def RadiusProfile(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  accounting_enabled: Optional[bool] = None,
                  acct_servers: Optional[Sequence[RadiusProfileAcctServerArgs]] = None,
                  auth_servers: Optional[Sequence[RadiusProfileAuthServerArgs]] = None,
                  interim_update_enabled: Optional[bool] = None,
                  interim_update_interval: Optional[int] = None,
                  name: Optional[str] = None,
                  site: Optional[str] = None,
                  use_usg_acct_server: Optional[bool] = None,
                  use_usg_auth_server: Optional[bool] = None,
                  vlan_enabled: Optional[bool] = None,
                  vlan_wlan_mode: Optional[str] = None)
    func NewRadiusProfile(ctx *Context, name string, args *RadiusProfileArgs, opts ...ResourceOption) (*RadiusProfile, error)
    public RadiusProfile(string name, RadiusProfileArgs? args = null, CustomResourceOptions? opts = null)
    public RadiusProfile(String name, RadiusProfileArgs args)
public RadiusProfile(String name, RadiusProfileArgs args, CustomResourceOptions options)

    type: unifi:RadiusProfile
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 RadiusProfileArgs
    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 RadiusProfileArgs
    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 RadiusProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RadiusProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RadiusProfileArgs
    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 radiusProfileResource = new Unifi.RadiusProfile("radiusProfileResource", new()
{
    AccountingEnabled = false,
    AcctServers = new[]
    {
        new Unifi.Inputs.RadiusProfileAcctServerArgs
        {
            Ip = "string",
            Xsecret = "string",
            Port = 0,
        },
    },
    AuthServers = new[]
    {
        new Unifi.Inputs.RadiusProfileAuthServerArgs
        {
            Ip = "string",
            Xsecret = "string",
            Port = 0,
        },
    },
    InterimUpdateEnabled = false,
    InterimUpdateInterval = 0,
    Name = "string",
    Site = "string",
    UseUsgAcctServer = false,
    UseUsgAuthServer = false,
    VlanEnabled = false,
    VlanWlanMode = "string",
});

    example, err := unifi.NewRadiusProfile(ctx, "radiusProfileResource", &unifi.RadiusProfileArgs{
	AccountingEnabled: pulumi.Bool(false),
	AcctServers: unifi.RadiusProfileAcctServerArray{
		&unifi.RadiusProfileAcctServerArgs{
			Ip:      pulumi.String("string"),
			Xsecret: pulumi.String("string"),
			Port:    pulumi.Int(0),
		},
	},
	AuthServers: unifi.RadiusProfileAuthServerArray{
		&unifi.RadiusProfileAuthServerArgs{
			Ip:      pulumi.String("string"),
			Xsecret: pulumi.String("string"),
			Port:    pulumi.Int(0),
		},
	},
	InterimUpdateEnabled:  pulumi.Bool(false),
	InterimUpdateInterval: pulumi.Int(0),
	Name:                  pulumi.String("string"),
	Site:                  pulumi.String("string"),
	UseUsgAcctServer:      pulumi.Bool(false),
	UseUsgAuthServer:      pulumi.Bool(false),
	VlanEnabled:           pulumi.Bool(false),
	VlanWlanMode:          pulumi.String("string"),
})

    var radiusProfileResource = new RadiusProfile("radiusProfileResource", RadiusProfileArgs.builder()
    .accountingEnabled(false)
    .acctServers(RadiusProfileAcctServerArgs.builder()
        .ip("string")
        .xsecret("string")
        .port(0)
        .build())
    .authServers(RadiusProfileAuthServerArgs.builder()
        .ip("string")
        .xsecret("string")
        .port(0)
        .build())
    .interimUpdateEnabled(false)
    .interimUpdateInterval(0)
    .name("string")
    .site("string")
    .useUsgAcctServer(false)
    .useUsgAuthServer(false)
    .vlanEnabled(false)
    .vlanWlanMode("string")
    .build());

    radius_profile_resource = unifi.RadiusProfile("radiusProfileResource",
    accounting_enabled=False,
    acct_servers=[{
        "ip": "string",
        "xsecret": "string",
        "port": 0,
    }],
    auth_servers=[{
        "ip": "string",
        "xsecret": "string",
        "port": 0,
    }],
    interim_update_enabled=False,
    interim_update_interval=0,
    name="string",
    site="string",
    use_usg_acct_server=False,
    use_usg_auth_server=False,
    vlan_enabled=False,
    vlan_wlan_mode="string")

    const radiusProfileResource = new unifi.RadiusProfile("radiusProfileResource", {
    accountingEnabled: false,
    acctServers: [{
        ip: "string",
        xsecret: "string",
        port: 0,
    }],
    authServers: [{
        ip: "string",
        xsecret: "string",
        port: 0,
    }],
    interimUpdateEnabled: false,
    interimUpdateInterval: 0,
    name: "string",
    site: "string",
    useUsgAcctServer: false,
    useUsgAuthServer: false,
    vlanEnabled: false,
    vlanWlanMode: "string",
});

    type: unifi:RadiusProfile
properties:
    accountingEnabled: false
    acctServers:
        - ip: string
          port: 0
          xsecret: string
    authServers:
        - ip: string
          port: 0
          xsecret: string
    interimUpdateEnabled: false
    interimUpdateInterval: 0
    name: string
    site: string
    useUsgAcctServer: false
    useUsgAuthServer: false
    vlanEnabled: false
    vlanWlanMode: string

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

    AccountingEnabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    AcctServers List<Pulumiverse.Unifi.Inputs.RadiusProfileAcctServer>
    RADIUS accounting servers.
    AuthServers List<Pulumiverse.Unifi.Inputs.RadiusProfileAuthServer>
    RADIUS authentication servers.
    InterimUpdateEnabled bool
    Specifies whether to use interim_update. Defaults to false.
    InterimUpdateInterval int
    Specifies interim_update interval. Defaults to 3600.
    Name string
    The name of the profile.
    Site string
    The name of the site to associate the settings with.
    UseUsgAcctServer bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    UseUsgAuthServer bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    VlanEnabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    VlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    AccountingEnabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    AcctServers []RadiusProfileAcctServerArgs
    RADIUS accounting servers.
    AuthServers []RadiusProfileAuthServerArgs
    RADIUS authentication servers.
    InterimUpdateEnabled bool
    Specifies whether to use interim_update. Defaults to false.
    InterimUpdateInterval int
    Specifies interim_update interval. Defaults to 3600.
    Name string
    The name of the profile.
    Site string
    The name of the site to associate the settings with.
    UseUsgAcctServer bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    UseUsgAuthServer bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    VlanEnabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    VlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled Boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers List<RadiusProfileAcctServer>
    RADIUS accounting servers.
    authServers List<RadiusProfileAuthServer>
    RADIUS authentication servers.
    interimUpdateEnabled Boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval Integer
    Specifies interim_update interval. Defaults to 3600.
    name String
    The name of the profile.
    site String
    The name of the site to associate the settings with.
    useUsgAcctServer Boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer Boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled Boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode String
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers RadiusProfileAcctServer[]
    RADIUS accounting servers.
    authServers RadiusProfileAuthServer[]
    RADIUS authentication servers.
    interimUpdateEnabled boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval number
    Specifies interim_update interval. Defaults to 3600.
    name string
    The name of the profile.
    site string
    The name of the site to associate the settings with.
    useUsgAcctServer boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accounting_enabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    acct_servers Sequence[RadiusProfileAcctServerArgs]
    RADIUS accounting servers.
    auth_servers Sequence[RadiusProfileAuthServerArgs]
    RADIUS authentication servers.
    interim_update_enabled bool
    Specifies whether to use interim_update. Defaults to false.
    interim_update_interval int
    Specifies interim_update interval. Defaults to 3600.
    name str
    The name of the profile.
    site str
    The name of the site to associate the settings with.
    use_usg_acct_server bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    use_usg_auth_server bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlan_enabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlan_wlan_mode str
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled Boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers List<Property Map>
    RADIUS accounting servers.
    authServers List<Property Map>
    RADIUS authentication servers.
    interimUpdateEnabled Boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval Number
    Specifies interim_update interval. Defaults to 3600.
    name String
    The name of the profile.
    site String
    The name of the site to associate the settings with.
    useUsgAcctServer Boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer Boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled Boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode String
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.

    Outputs

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

    Get an existing RadiusProfile 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?: RadiusProfileState, opts?: CustomResourceOptions): RadiusProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accounting_enabled: Optional[bool] = None,
        acct_servers: Optional[Sequence[RadiusProfileAcctServerArgs]] = None,
        auth_servers: Optional[Sequence[RadiusProfileAuthServerArgs]] = None,
        interim_update_enabled: Optional[bool] = None,
        interim_update_interval: Optional[int] = None,
        name: Optional[str] = None,
        site: Optional[str] = None,
        use_usg_acct_server: Optional[bool] = None,
        use_usg_auth_server: Optional[bool] = None,
        vlan_enabled: Optional[bool] = None,
        vlan_wlan_mode: Optional[str] = None) -> RadiusProfile
    func GetRadiusProfile(ctx *Context, name string, id IDInput, state *RadiusProfileState, opts ...ResourceOption) (*RadiusProfile, error)
    public static RadiusProfile Get(string name, Input<string> id, RadiusProfileState? state, CustomResourceOptions? opts = null)
    public static RadiusProfile get(String name, Output<String> id, RadiusProfileState 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:
    AccountingEnabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    AcctServers List<Pulumiverse.Unifi.Inputs.RadiusProfileAcctServer>
    RADIUS accounting servers.
    AuthServers List<Pulumiverse.Unifi.Inputs.RadiusProfileAuthServer>
    RADIUS authentication servers.
    InterimUpdateEnabled bool
    Specifies whether to use interim_update. Defaults to false.
    InterimUpdateInterval int
    Specifies interim_update interval. Defaults to 3600.
    Name string
    The name of the profile.
    Site string
    The name of the site to associate the settings with.
    UseUsgAcctServer bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    UseUsgAuthServer bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    VlanEnabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    VlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    AccountingEnabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    AcctServers []RadiusProfileAcctServerArgs
    RADIUS accounting servers.
    AuthServers []RadiusProfileAuthServerArgs
    RADIUS authentication servers.
    InterimUpdateEnabled bool
    Specifies whether to use interim_update. Defaults to false.
    InterimUpdateInterval int
    Specifies interim_update interval. Defaults to 3600.
    Name string
    The name of the profile.
    Site string
    The name of the site to associate the settings with.
    UseUsgAcctServer bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    UseUsgAuthServer bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    VlanEnabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    VlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled Boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers List<RadiusProfileAcctServer>
    RADIUS accounting servers.
    authServers List<RadiusProfileAuthServer>
    RADIUS authentication servers.
    interimUpdateEnabled Boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval Integer
    Specifies interim_update interval. Defaults to 3600.
    name String
    The name of the profile.
    site String
    The name of the site to associate the settings with.
    useUsgAcctServer Boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer Boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled Boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode String
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers RadiusProfileAcctServer[]
    RADIUS accounting servers.
    authServers RadiusProfileAuthServer[]
    RADIUS authentication servers.
    interimUpdateEnabled boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval number
    Specifies interim_update interval. Defaults to 3600.
    name string
    The name of the profile.
    site string
    The name of the site to associate the settings with.
    useUsgAcctServer boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode string
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accounting_enabled bool
    Specifies whether to use RADIUS accounting. Defaults to false.
    acct_servers Sequence[RadiusProfileAcctServerArgs]
    RADIUS accounting servers.
    auth_servers Sequence[RadiusProfileAuthServerArgs]
    RADIUS authentication servers.
    interim_update_enabled bool
    Specifies whether to use interim_update. Defaults to false.
    interim_update_interval int
    Specifies interim_update interval. Defaults to 3600.
    name str
    The name of the profile.
    site str
    The name of the site to associate the settings with.
    use_usg_acct_server bool
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    use_usg_auth_server bool
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlan_enabled bool
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlan_wlan_mode str
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.
    accountingEnabled Boolean
    Specifies whether to use RADIUS accounting. Defaults to false.
    acctServers List<Property Map>
    RADIUS accounting servers.
    authServers List<Property Map>
    RADIUS authentication servers.
    interimUpdateEnabled Boolean
    Specifies whether to use interim_update. Defaults to false.
    interimUpdateInterval Number
    Specifies interim_update interval. Defaults to 3600.
    name String
    The name of the profile.
    site String
    The name of the site to associate the settings with.
    useUsgAcctServer Boolean
    Specifies whether to use usg as a RADIUS accounting server. Defaults to false.
    useUsgAuthServer Boolean
    Specifies whether to use usg as a RADIUS authentication server. Defaults to false.
    vlanEnabled Boolean
    Specifies whether to use vlan on wired connections. Defaults to false.
    vlanWlanMode String
    Specifies whether to use vlan on wireless connections. Must be one of disabled, optional, or required. Defaults to ``.

    Supporting Types

    RadiusProfileAcctServer, RadiusProfileAcctServerArgs

    Ip string
    IP address of accounting service server.
    Xsecret string
    RADIUS secret.
    Port int
    Port of accounting service. Defaults to 1813.
    Ip string
    IP address of accounting service server.
    Xsecret string
    RADIUS secret.
    Port int
    Port of accounting service. Defaults to 1813.
    ip String
    IP address of accounting service server.
    xsecret String
    RADIUS secret.
    port Integer
    Port of accounting service. Defaults to 1813.
    ip string
    IP address of accounting service server.
    xsecret string
    RADIUS secret.
    port number
    Port of accounting service. Defaults to 1813.
    ip str
    IP address of accounting service server.
    xsecret str
    RADIUS secret.
    port int
    Port of accounting service. Defaults to 1813.
    ip String
    IP address of accounting service server.
    xsecret String
    RADIUS secret.
    port Number
    Port of accounting service. Defaults to 1813.

    RadiusProfileAuthServer, RadiusProfileAuthServerArgs

    Ip string
    IP address of authentication service server.
    Xsecret string
    RADIUS secret.
    Port int
    Port of authentication service. Defaults to 1812.
    Ip string
    IP address of authentication service server.
    Xsecret string
    RADIUS secret.
    Port int
    Port of authentication service. Defaults to 1812.
    ip String
    IP address of authentication service server.
    xsecret String
    RADIUS secret.
    port Integer
    Port of authentication service. Defaults to 1812.
    ip string
    IP address of authentication service server.
    xsecret string
    RADIUS secret.
    port number
    Port of authentication service. Defaults to 1812.
    ip str
    IP address of authentication service server.
    xsecret str
    RADIUS secret.
    port int
    Port of authentication service. Defaults to 1812.
    ip String
    IP address of authentication service server.
    xsecret String
    RADIUS secret.
    port Number
    Port of authentication service. Defaults to 1812.

    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