1. Packages
  2. Routeros Provider
  3. API Docs
  4. WifiProvisioning
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

routeros.WifiProvisioning

Explore with Pulumi AI

routeros logo
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

    # routeros.WifiProvisioning (Resource)

    This resource requires a minimum version of RouterOS 7.13.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as routeros from "@pulumi/routeros";
    
    const configuration1 = new routeros.WifiConfiguration("configuration1", {
        country: "Netherlands",
        manager: "capsman",
        mode: "ap",
        ssid: "my-network",
    });
    const provisioning1 = new routeros.WifiProvisioning("provisioning1", {
        action: "create-enabled",
        masterConfiguration: configuration1.name,
        nameFormat: "cap1:",
        radioMac: "00:11:22:33:44:55",
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    configuration1 = routeros.WifiConfiguration("configuration1",
        country="Netherlands",
        manager="capsman",
        mode="ap",
        ssid="my-network")
    provisioning1 = routeros.WifiProvisioning("provisioning1",
        action="create-enabled",
        master_configuration=configuration1.name,
        name_format="cap1:",
        radio_mac="00:11:22:33:44:55")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		configuration1, err := routeros.NewWifiConfiguration(ctx, "configuration1", &routeros.WifiConfigurationArgs{
    			Country: pulumi.String("Netherlands"),
    			Manager: pulumi.String("capsman"),
    			Mode:    pulumi.String("ap"),
    			Ssid:    pulumi.String("my-network"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = routeros.NewWifiProvisioning(ctx, "provisioning1", &routeros.WifiProvisioningArgs{
    			Action:              pulumi.String("create-enabled"),
    			MasterConfiguration: configuration1.Name,
    			NameFormat:          pulumi.String("cap1:"),
    			RadioMac:            pulumi.String("00:11:22:33:44:55"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Routeros = Pulumi.Routeros;
    
    return await Deployment.RunAsync(() => 
    {
        var configuration1 = new Routeros.WifiConfiguration("configuration1", new()
        {
            Country = "Netherlands",
            Manager = "capsman",
            Mode = "ap",
            Ssid = "my-network",
        });
    
        var provisioning1 = new Routeros.WifiProvisioning("provisioning1", new()
        {
            Action = "create-enabled",
            MasterConfiguration = configuration1.Name,
            NameFormat = "cap1:",
            RadioMac = "00:11:22:33:44:55",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.WifiConfiguration;
    import com.pulumi.routeros.WifiConfigurationArgs;
    import com.pulumi.routeros.WifiProvisioning;
    import com.pulumi.routeros.WifiProvisioningArgs;
    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 configuration1 = new WifiConfiguration("configuration1", WifiConfigurationArgs.builder()
                .country("Netherlands")
                .manager("capsman")
                .mode("ap")
                .ssid("my-network")
                .build());
    
            var provisioning1 = new WifiProvisioning("provisioning1", WifiProvisioningArgs.builder()
                .action("create-enabled")
                .masterConfiguration(configuration1.name())
                .nameFormat("cap1:")
                .radioMac("00:11:22:33:44:55")
                .build());
    
        }
    }
    
    resources:
      configuration1:
        type: routeros:WifiConfiguration
        properties:
          country: Netherlands
          manager: capsman
          mode: ap
          ssid: my-network
      provisioning1:
        type: routeros:WifiProvisioning
        properties:
          action: create-enabled
          masterConfiguration: ${configuration1.name}
          nameFormat: 'cap1:'
          radioMac: 00:11:22:33:44:55
    

    Create WifiProvisioning Resource

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

    Constructor syntax

    new WifiProvisioning(name: string, args?: WifiProvisioningArgs, opts?: CustomResourceOptions);
    @overload
    def WifiProvisioning(resource_name: str,
                         args: Optional[WifiProvisioningArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WifiProvisioning(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ___id_: Optional[float] = None,
                         ___path_: Optional[str] = None,
                         action: Optional[str] = None,
                         address_ranges: Optional[Sequence[str]] = None,
                         comment: Optional[str] = None,
                         common_name_regexp: Optional[str] = None,
                         disabled: Optional[bool] = None,
                         identity_regexp: Optional[str] = None,
                         master_configuration: Optional[str] = None,
                         name_format: Optional[str] = None,
                         radio_mac: Optional[str] = None,
                         slave_configurations: Optional[Sequence[str]] = None,
                         slave_name_format: Optional[str] = None,
                         supported_bands: Optional[Sequence[str]] = None,
                         wifi_provisioning_id: Optional[str] = None)
    func NewWifiProvisioning(ctx *Context, name string, args *WifiProvisioningArgs, opts ...ResourceOption) (*WifiProvisioning, error)
    public WifiProvisioning(string name, WifiProvisioningArgs? args = null, CustomResourceOptions? opts = null)
    public WifiProvisioning(String name, WifiProvisioningArgs args)
    public WifiProvisioning(String name, WifiProvisioningArgs args, CustomResourceOptions options)
    
    type: routeros:WifiProvisioning
    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 WifiProvisioningArgs
    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 WifiProvisioningArgs
    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 WifiProvisioningArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WifiProvisioningArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WifiProvisioningArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Action string
    Provisioning action.
    AddressRanges List<string>
    Match CAPs by IPs within configured address ranges.
    Comment string
    CommonNameRegexp string
    Regular expression to match radios by common name.
    Disabled bool
    IdentityRegexp string
    Regular expression to match radios by router identity.
    MasterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    NameFormat string
    Specify the format of the CAP interface name creation.
    RadioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    SlaveConfigurations List<string>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    SlaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    SupportedBands List<string>
    Match CAPs by supported modes.
    WifiProvisioningId string
    The ID of this resource.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    Action string
    Provisioning action.
    AddressRanges []string
    Match CAPs by IPs within configured address ranges.
    Comment string
    CommonNameRegexp string
    Regular expression to match radios by common name.
    Disabled bool
    IdentityRegexp string
    Regular expression to match radios by router identity.
    MasterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    NameFormat string
    Specify the format of the CAP interface name creation.
    RadioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    SlaveConfigurations []string
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    SlaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    SupportedBands []string
    Match CAPs by supported modes.
    WifiProvisioningId string
    The ID of this resource.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action String
    Provisioning action.
    addressRanges List<String>
    Match CAPs by IPs within configured address ranges.
    comment String
    commonNameRegexp String
    Regular expression to match radios by common name.
    disabled Boolean
    identityRegexp String
    Regular expression to match radios by router identity.
    masterConfiguration String
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat String
    Specify the format of the CAP interface name creation.
    radioMac String
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations List<String>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat String
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands List<String>
    Match CAPs by supported modes.
    wifiProvisioningId String
    The ID of this resource.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action string
    Provisioning action.
    addressRanges string[]
    Match CAPs by IPs within configured address ranges.
    comment string
    commonNameRegexp string
    Regular expression to match radios by common name.
    disabled boolean
    identityRegexp string
    Regular expression to match radios by router identity.
    masterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat string
    Specify the format of the CAP interface name creation.
    radioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations string[]
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands string[]
    Match CAPs by supported modes.
    wifiProvisioningId string
    The ID of this resource.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action str
    Provisioning action.
    address_ranges Sequence[str]
    Match CAPs by IPs within configured address ranges.
    comment str
    common_name_regexp str
    Regular expression to match radios by common name.
    disabled bool
    identity_regexp str
    Regular expression to match radios by router identity.
    master_configuration str
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    name_format str
    Specify the format of the CAP interface name creation.
    radio_mac str
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slave_configurations Sequence[str]
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slave_name_format str
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supported_bands Sequence[str]
    Match CAPs by supported modes.
    wifi_provisioning_id str
    The ID of this resource.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action String
    Provisioning action.
    addressRanges List<String>
    Match CAPs by IPs within configured address ranges.
    comment String
    commonNameRegexp String
    Regular expression to match radios by common name.
    disabled Boolean
    identityRegexp String
    Regular expression to match radios by router identity.
    masterConfiguration String
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat String
    Specify the format of the CAP interface name creation.
    radioMac String
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations List<String>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat String
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands List<String>
    Match CAPs by supported modes.
    wifiProvisioningId String
    The ID of this resource.

    Outputs

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

    Get an existing WifiProvisioning 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?: WifiProvisioningState, opts?: CustomResourceOptions): WifiProvisioning
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            action: Optional[str] = None,
            address_ranges: Optional[Sequence[str]] = None,
            comment: Optional[str] = None,
            common_name_regexp: Optional[str] = None,
            disabled: Optional[bool] = None,
            identity_regexp: Optional[str] = None,
            master_configuration: Optional[str] = None,
            name_format: Optional[str] = None,
            radio_mac: Optional[str] = None,
            slave_configurations: Optional[Sequence[str]] = None,
            slave_name_format: Optional[str] = None,
            supported_bands: Optional[Sequence[str]] = None,
            wifi_provisioning_id: Optional[str] = None) -> WifiProvisioning
    func GetWifiProvisioning(ctx *Context, name string, id IDInput, state *WifiProvisioningState, opts ...ResourceOption) (*WifiProvisioning, error)
    public static WifiProvisioning Get(string name, Input<string> id, WifiProvisioningState? state, CustomResourceOptions? opts = null)
    public static WifiProvisioning get(String name, Output<String> id, WifiProvisioningState state, CustomResourceOptions options)
    resources:  _:    type: routeros:WifiProvisioning    get:      id: ${id}
    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:
    Action string
    Provisioning action.
    AddressRanges List<string>
    Match CAPs by IPs within configured address ranges.
    Comment string
    CommonNameRegexp string
    Regular expression to match radios by common name.
    Disabled bool
    IdentityRegexp string
    Regular expression to match radios by router identity.
    MasterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    NameFormat string
    Specify the format of the CAP interface name creation.
    RadioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    SlaveConfigurations List<string>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    SlaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    SupportedBands List<string>
    Match CAPs by supported modes.
    WifiProvisioningId string
    The ID of this resource.
    ___id_ double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    Action string
    Provisioning action.
    AddressRanges []string
    Match CAPs by IPs within configured address ranges.
    Comment string
    CommonNameRegexp string
    Regular expression to match radios by common name.
    Disabled bool
    IdentityRegexp string
    Regular expression to match radios by router identity.
    MasterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    NameFormat string
    Specify the format of the CAP interface name creation.
    RadioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    SlaveConfigurations []string
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    SlaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    SupportedBands []string
    Match CAPs by supported modes.
    WifiProvisioningId string
    The ID of this resource.
    ___id_ float64
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    ___id_ Double
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action String
    Provisioning action.
    addressRanges List<String>
    Match CAPs by IPs within configured address ranges.
    comment String
    commonNameRegexp String
    Regular expression to match radios by common name.
    disabled Boolean
    identityRegexp String
    Regular expression to match radios by router identity.
    masterConfiguration String
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat String
    Specify the format of the CAP interface name creation.
    radioMac String
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations List<String>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat String
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands List<String>
    Match CAPs by supported modes.
    wifiProvisioningId String
    The ID of this resource.
    ___id_ number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ string
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action string
    Provisioning action.
    addressRanges string[]
    Match CAPs by IPs within configured address ranges.
    comment string
    commonNameRegexp string
    Regular expression to match radios by common name.
    disabled boolean
    identityRegexp string
    Regular expression to match radios by router identity.
    masterConfiguration string
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat string
    Specify the format of the CAP interface name creation.
    radioMac string
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations string[]
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat string
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands string[]
    Match CAPs by supported modes.
    wifiProvisioningId string
    The ID of this resource.
    ___id_ float
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ str
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action str
    Provisioning action.
    address_ranges Sequence[str]
    Match CAPs by IPs within configured address ranges.
    comment str
    common_name_regexp str
    Regular expression to match radios by common name.
    disabled bool
    identity_regexp str
    Regular expression to match radios by router identity.
    master_configuration str
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    name_format str
    Specify the format of the CAP interface name creation.
    radio_mac str
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slave_configurations Sequence[str]
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slave_name_format str
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supported_bands Sequence[str]
    Match CAPs by supported modes.
    wifi_provisioning_id str
    The ID of this resource.
    ___id_ Number
    Resource ID type (.id / name). This is an internal service field, setting a value is not required.
    ___path_ String
    Resource path for CRUD operations. This is an internal service field, setting a value is not required.
    action String
    Provisioning action.
    addressRanges List<String>
    Match CAPs by IPs within configured address ranges.
    comment String
    commonNameRegexp String
    Regular expression to match radios by common name.
    disabled Boolean
    identityRegexp String
    Regular expression to match radios by router identity.
    masterConfiguration String
    If action specifies to create interfaces, then a new master interface with its configuration set to this configuration profile will be created.
    nameFormat String
    Specify the format of the CAP interface name creation.
    radioMac String
    MAC address of radio to be matched, empty MAC means match all MAC addresses. 00:00:00:00:00:00 is not considered empty MAC-address.
    slaveConfigurations List<String>
    If action specifies to create interfaces, then a new slave interface for each configuration profile in this list is created.
    slaveNameFormat String
    The name format of the slave CAP interfaces. This option is available in RouterOS starting from version 7.16.
    supportedBands List<String>
    Match CAPs by supported modes.
    wifiProvisioningId String
    The ID of this resource.

    Import

    #The ID can be found via API or the terminal

    #The command for the terminal is -> :put [/interface/wifi/provisioning get [print show-ids]]

    $ pulumi import routeros:index/wifiProvisioning:WifiProvisioning provisioning1 '*1'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    routeros terraform-routeros/terraform-provider-routeros
    License
    Notes
    This Pulumi package is based on the routeros Terraform Provider.
    routeros logo
    routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros