1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. Radius
Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse

unifi.setting.Radius

Explore with Pulumi AI

unifi logo
Unifi v0.1.0 published on Monday, Oct 28, 2024 by Pulumiverse

    unifi.setting.Radius manages settings for the built-in RADIUS server.

    Create Radius Resource

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

    Constructor syntax

    new Radius(name: string, args?: RadiusArgs, opts?: CustomResourceOptions);
    @overload
    def Radius(resource_name: str,
               args: Optional[RadiusArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Radius(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               accounting_enabled: Optional[bool] = None,
               accounting_port: Optional[int] = None,
               auth_port: Optional[int] = None,
               enabled: Optional[bool] = None,
               interim_update_interval: Optional[int] = None,
               secret: Optional[str] = None,
               site: Optional[str] = None,
               tunneled_reply: Optional[bool] = None)
    func NewRadius(ctx *Context, name string, args *RadiusArgs, opts ...ResourceOption) (*Radius, error)
    public Radius(string name, RadiusArgs? args = null, CustomResourceOptions? opts = null)
    public Radius(String name, RadiusArgs args)
    public Radius(String name, RadiusArgs args, CustomResourceOptions options)
    
    type: unifi:setting:Radius
    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 RadiusArgs
    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 RadiusArgs
    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 RadiusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RadiusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RadiusArgs
    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 radiusResource = new Unifi.Setting.Radius("radiusResource", new()
    {
        AccountingEnabled = false,
        AccountingPort = 0,
        AuthPort = 0,
        Enabled = false,
        InterimUpdateInterval = 0,
        Secret = "string",
        Site = "string",
        TunneledReply = false,
    });
    
    example, err := setting.NewRadius(ctx, "radiusResource", &setting.RadiusArgs{
    	AccountingEnabled:     pulumi.Bool(false),
    	AccountingPort:        pulumi.Int(0),
    	AuthPort:              pulumi.Int(0),
    	Enabled:               pulumi.Bool(false),
    	InterimUpdateInterval: pulumi.Int(0),
    	Secret:                pulumi.String("string"),
    	Site:                  pulumi.String("string"),
    	TunneledReply:         pulumi.Bool(false),
    })
    
    var radiusResource = new Radius("radiusResource", RadiusArgs.builder()
        .accountingEnabled(false)
        .accountingPort(0)
        .authPort(0)
        .enabled(false)
        .interimUpdateInterval(0)
        .secret("string")
        .site("string")
        .tunneledReply(false)
        .build());
    
    radius_resource = unifi.setting.Radius("radiusResource",
        accounting_enabled=False,
        accounting_port=0,
        auth_port=0,
        enabled=False,
        interim_update_interval=0,
        secret="string",
        site="string",
        tunneled_reply=False)
    
    const radiusResource = new unifi.setting.Radius("radiusResource", {
        accountingEnabled: false,
        accountingPort: 0,
        authPort: 0,
        enabled: false,
        interimUpdateInterval: 0,
        secret: "string",
        site: "string",
        tunneledReply: false,
    });
    
    type: unifi:setting:Radius
    properties:
        accountingEnabled: false
        accountingPort: 0
        authPort: 0
        enabled: false
        interimUpdateInterval: 0
        secret: string
        site: string
        tunneledReply: false
    

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

    AccountingEnabled bool
    Enable RADIUS accounting Defaults to false.
    AccountingPort int
    The port for accounting communications. Defaults to 1813.
    AuthPort int
    The port for authentication communications. Defaults to 1812.
    Enabled bool
    RAIDUS server enabled. Defaults to true.
    InterimUpdateInterval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    Secret string
    RAIDUS secret passphrase. Defaults to ``.
    Site string
    The name of the site to associate the settings with.
    TunneledReply bool
    Encrypt communication between the server and the client. Defaults to true.
    AccountingEnabled bool
    Enable RADIUS accounting Defaults to false.
    AccountingPort int
    The port for accounting communications. Defaults to 1813.
    AuthPort int
    The port for authentication communications. Defaults to 1812.
    Enabled bool
    RAIDUS server enabled. Defaults to true.
    InterimUpdateInterval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    Secret string
    RAIDUS secret passphrase. Defaults to ``.
    Site string
    The name of the site to associate the settings with.
    TunneledReply bool
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled Boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort Integer
    The port for accounting communications. Defaults to 1813.
    authPort Integer
    The port for authentication communications. Defaults to 1812.
    enabled Boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval Integer
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret String
    RAIDUS secret passphrase. Defaults to ``.
    site String
    The name of the site to associate the settings with.
    tunneledReply Boolean
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort number
    The port for accounting communications. Defaults to 1813.
    authPort number
    The port for authentication communications. Defaults to 1812.
    enabled boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval number
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret string
    RAIDUS secret passphrase. Defaults to ``.
    site string
    The name of the site to associate the settings with.
    tunneledReply boolean
    Encrypt communication between the server and the client. Defaults to true.
    accounting_enabled bool
    Enable RADIUS accounting Defaults to false.
    accounting_port int
    The port for accounting communications. Defaults to 1813.
    auth_port int
    The port for authentication communications. Defaults to 1812.
    enabled bool
    RAIDUS server enabled. Defaults to true.
    interim_update_interval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret str
    RAIDUS secret passphrase. Defaults to ``.
    site str
    The name of the site to associate the settings with.
    tunneled_reply bool
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled Boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort Number
    The port for accounting communications. Defaults to 1813.
    authPort Number
    The port for authentication communications. Defaults to 1812.
    enabled Boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval Number
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret String
    RAIDUS secret passphrase. Defaults to ``.
    site String
    The name of the site to associate the settings with.
    tunneledReply Boolean
    Encrypt communication between the server and the client. Defaults to true.

    Outputs

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

    Get an existing Radius 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?: RadiusState, opts?: CustomResourceOptions): Radius
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accounting_enabled: Optional[bool] = None,
            accounting_port: Optional[int] = None,
            auth_port: Optional[int] = None,
            enabled: Optional[bool] = None,
            interim_update_interval: Optional[int] = None,
            secret: Optional[str] = None,
            site: Optional[str] = None,
            tunneled_reply: Optional[bool] = None) -> Radius
    func GetRadius(ctx *Context, name string, id IDInput, state *RadiusState, opts ...ResourceOption) (*Radius, error)
    public static Radius Get(string name, Input<string> id, RadiusState? state, CustomResourceOptions? opts = null)
    public static Radius get(String name, Output<String> id, RadiusState 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
    Enable RADIUS accounting Defaults to false.
    AccountingPort int
    The port for accounting communications. Defaults to 1813.
    AuthPort int
    The port for authentication communications. Defaults to 1812.
    Enabled bool
    RAIDUS server enabled. Defaults to true.
    InterimUpdateInterval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    Secret string
    RAIDUS secret passphrase. Defaults to ``.
    Site string
    The name of the site to associate the settings with.
    TunneledReply bool
    Encrypt communication between the server and the client. Defaults to true.
    AccountingEnabled bool
    Enable RADIUS accounting Defaults to false.
    AccountingPort int
    The port for accounting communications. Defaults to 1813.
    AuthPort int
    The port for authentication communications. Defaults to 1812.
    Enabled bool
    RAIDUS server enabled. Defaults to true.
    InterimUpdateInterval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    Secret string
    RAIDUS secret passphrase. Defaults to ``.
    Site string
    The name of the site to associate the settings with.
    TunneledReply bool
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled Boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort Integer
    The port for accounting communications. Defaults to 1813.
    authPort Integer
    The port for authentication communications. Defaults to 1812.
    enabled Boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval Integer
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret String
    RAIDUS secret passphrase. Defaults to ``.
    site String
    The name of the site to associate the settings with.
    tunneledReply Boolean
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort number
    The port for accounting communications. Defaults to 1813.
    authPort number
    The port for authentication communications. Defaults to 1812.
    enabled boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval number
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret string
    RAIDUS secret passphrase. Defaults to ``.
    site string
    The name of the site to associate the settings with.
    tunneledReply boolean
    Encrypt communication between the server and the client. Defaults to true.
    accounting_enabled bool
    Enable RADIUS accounting Defaults to false.
    accounting_port int
    The port for accounting communications. Defaults to 1813.
    auth_port int
    The port for authentication communications. Defaults to 1812.
    enabled bool
    RAIDUS server enabled. Defaults to true.
    interim_update_interval int
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret str
    RAIDUS secret passphrase. Defaults to ``.
    site str
    The name of the site to associate the settings with.
    tunneled_reply bool
    Encrypt communication between the server and the client. Defaults to true.
    accountingEnabled Boolean
    Enable RADIUS accounting Defaults to false.
    accountingPort Number
    The port for accounting communications. Defaults to 1813.
    authPort Number
    The port for authentication communications. Defaults to 1812.
    enabled Boolean
    RAIDUS server enabled. Defaults to true.
    interimUpdateInterval Number
    Statistics will be collected from connected clients at this interval. Defaults to 3600.
    secret String
    RAIDUS secret passphrase. Defaults to ``.
    site String
    The name of the site to associate the settings with.
    tunneledReply Boolean
    Encrypt communication between the server and the client. Defaults to true.

    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