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

routeros.WifiCap

Explore with Pulumi AI

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

    # routeros.WifiCap (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 settings = new routeros.WifiCap("settings", {
        discoveryInterfaces: ["bridge1"],
        enabled: true,
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    settings = routeros.WifiCap("settings",
        discovery_interfaces=["bridge1"],
        enabled=True)
    
    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 {
    		_, err := routeros.NewWifiCap(ctx, "settings", &routeros.WifiCapArgs{
    			DiscoveryInterfaces: pulumi.StringArray{
    				pulumi.String("bridge1"),
    			},
    			Enabled: pulumi.Bool(true),
    		})
    		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 settings = new Routeros.WifiCap("settings", new()
        {
            DiscoveryInterfaces = new[]
            {
                "bridge1",
            },
            Enabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.WifiCap;
    import com.pulumi.routeros.WifiCapArgs;
    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 settings = new WifiCap("settings", WifiCapArgs.builder()
                .discoveryInterfaces("bridge1")
                .enabled(true)
                .build());
    
        }
    }
    
    resources:
      settings:
        type: routeros:WifiCap
        properties:
          discoveryInterfaces:
            - bridge1
          enabled: true
    

    Create WifiCap Resource

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

    Constructor syntax

    new WifiCap(name: string, args?: WifiCapArgs, opts?: CustomResourceOptions);
    @overload
    def WifiCap(resource_name: str,
                args: Optional[WifiCapArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def WifiCap(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                ___id_: Optional[float] = None,
                ___path_: Optional[str] = None,
                caps_man_addresses: Optional[Sequence[str]] = None,
                caps_man_certificate_common_names: Optional[Sequence[str]] = None,
                caps_man_names: Optional[Sequence[str]] = None,
                certificate: Optional[str] = None,
                discovery_interfaces: Optional[Sequence[str]] = None,
                enabled: Optional[bool] = None,
                lock_to_caps_man: Optional[bool] = None,
                slaves_datapath: Optional[str] = None,
                slaves_static: Optional[bool] = None,
                wifi_cap_id: Optional[str] = None)
    func NewWifiCap(ctx *Context, name string, args *WifiCapArgs, opts ...ResourceOption) (*WifiCap, error)
    public WifiCap(string name, WifiCapArgs? args = null, CustomResourceOptions? opts = null)
    public WifiCap(String name, WifiCapArgs args)
    public WifiCap(String name, WifiCapArgs args, CustomResourceOptions options)
    
    type: routeros:WifiCap
    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 WifiCapArgs
    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 WifiCapArgs
    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 WifiCapArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WifiCapArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WifiCapArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    CapsManAddresses List<string>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    CapsManCertificateCommonNames List<string>
    List of manager certificate common names that CAP will connect to.
    CapsManNames List<string>
    An ordered list of CAPs Manager names that the CAP will connect to.
    Certificate string
    Certificate to use for authentication.
    DiscoveryInterfaces List<string>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    Enabled bool
    Disable or enable the CAP functionality.
    LockToCapsMan bool
    Lock CAP to the first CAPsMAN it connects to.
    SlavesDatapath string
    Name of the bridge interface the CAP will be added to.
    SlavesStatic bool
    An option that creates static virtual interfaces.
    WifiCapId 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.
    CapsManAddresses []string
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    CapsManCertificateCommonNames []string
    List of manager certificate common names that CAP will connect to.
    CapsManNames []string
    An ordered list of CAPs Manager names that the CAP will connect to.
    Certificate string
    Certificate to use for authentication.
    DiscoveryInterfaces []string
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    Enabled bool
    Disable or enable the CAP functionality.
    LockToCapsMan bool
    Lock CAP to the first CAPsMAN it connects to.
    SlavesDatapath string
    Name of the bridge interface the CAP will be added to.
    SlavesStatic bool
    An option that creates static virtual interfaces.
    WifiCapId 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.
    capsManAddresses List<String>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames List<String>
    List of manager certificate common names that CAP will connect to.
    capsManNames List<String>
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate String
    Certificate to use for authentication.
    discoveryInterfaces List<String>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled Boolean
    Disable or enable the CAP functionality.
    lockToCapsMan Boolean
    Lock CAP to the first CAPsMAN it connects to.
    slavesDatapath String
    Name of the bridge interface the CAP will be added to.
    slavesStatic Boolean
    An option that creates static virtual interfaces.
    wifiCapId 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.
    capsManAddresses string[]
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames string[]
    List of manager certificate common names that CAP will connect to.
    capsManNames string[]
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate string
    Certificate to use for authentication.
    discoveryInterfaces string[]
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled boolean
    Disable or enable the CAP functionality.
    lockToCapsMan boolean
    Lock CAP to the first CAPsMAN it connects to.
    slavesDatapath string
    Name of the bridge interface the CAP will be added to.
    slavesStatic boolean
    An option that creates static virtual interfaces.
    wifiCapId 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.
    caps_man_addresses Sequence[str]
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    caps_man_certificate_common_names Sequence[str]
    List of manager certificate common names that CAP will connect to.
    caps_man_names Sequence[str]
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate str
    Certificate to use for authentication.
    discovery_interfaces Sequence[str]
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled bool
    Disable or enable the CAP functionality.
    lock_to_caps_man bool
    Lock CAP to the first CAPsMAN it connects to.
    slaves_datapath str
    Name of the bridge interface the CAP will be added to.
    slaves_static bool
    An option that creates static virtual interfaces.
    wifi_cap_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.
    capsManAddresses List<String>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames List<String>
    List of manager certificate common names that CAP will connect to.
    capsManNames List<String>
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate String
    Certificate to use for authentication.
    discoveryInterfaces List<String>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled Boolean
    Disable or enable the CAP functionality.
    lockToCapsMan Boolean
    Lock CAP to the first CAPsMAN it connects to.
    slavesDatapath String
    Name of the bridge interface the CAP will be added to.
    slavesStatic Boolean
    An option that creates static virtual interfaces.
    wifiCapId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WifiCap resource produces the following output properties:

    CurrentCapsManAddress string
    Currently used CAPsMAN address.
    CurrentCapsManIdentity string
    Currently used CAPsMAN identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    RequestedCertificate string
    Requested certificate.
    CurrentCapsManAddress string
    Currently used CAPsMAN address.
    CurrentCapsManIdentity string
    Currently used CAPsMAN identity.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    RequestedCertificate string
    Requested certificate.
    currentCapsManAddress String
    Currently used CAPsMAN address.
    currentCapsManIdentity String
    Currently used CAPsMAN identity.
    id String
    The provider-assigned unique ID for this managed resource.
    lockedCapsManCommonName String
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate String
    Requested certificate.
    currentCapsManAddress string
    Currently used CAPsMAN address.
    currentCapsManIdentity string
    Currently used CAPsMAN identity.
    id string
    The provider-assigned unique ID for this managed resource.
    lockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate string
    Requested certificate.
    current_caps_man_address str
    Currently used CAPsMAN address.
    current_caps_man_identity str
    Currently used CAPsMAN identity.
    id str
    The provider-assigned unique ID for this managed resource.
    locked_caps_man_common_name str
    Common name of the CAPsMAN that the CAP is locked to.
    requested_certificate str
    Requested certificate.
    currentCapsManAddress String
    Currently used CAPsMAN address.
    currentCapsManIdentity String
    Currently used CAPsMAN identity.
    id String
    The provider-assigned unique ID for this managed resource.
    lockedCapsManCommonName String
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate String
    Requested certificate.

    Look up Existing WifiCap Resource

    Get an existing WifiCap 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?: WifiCapState, opts?: CustomResourceOptions): WifiCap
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            caps_man_addresses: Optional[Sequence[str]] = None,
            caps_man_certificate_common_names: Optional[Sequence[str]] = None,
            caps_man_names: Optional[Sequence[str]] = None,
            certificate: Optional[str] = None,
            current_caps_man_address: Optional[str] = None,
            current_caps_man_identity: Optional[str] = None,
            discovery_interfaces: Optional[Sequence[str]] = None,
            enabled: Optional[bool] = None,
            lock_to_caps_man: Optional[bool] = None,
            locked_caps_man_common_name: Optional[str] = None,
            requested_certificate: Optional[str] = None,
            slaves_datapath: Optional[str] = None,
            slaves_static: Optional[bool] = None,
            wifi_cap_id: Optional[str] = None) -> WifiCap
    func GetWifiCap(ctx *Context, name string, id IDInput, state *WifiCapState, opts ...ResourceOption) (*WifiCap, error)
    public static WifiCap Get(string name, Input<string> id, WifiCapState? state, CustomResourceOptions? opts = null)
    public static WifiCap get(String name, Output<String> id, WifiCapState state, CustomResourceOptions options)
    resources:  _:    type: routeros:WifiCap    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:
    CapsManAddresses List<string>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    CapsManCertificateCommonNames List<string>
    List of manager certificate common names that CAP will connect to.
    CapsManNames List<string>
    An ordered list of CAPs Manager names that the CAP will connect to.
    Certificate string
    Certificate to use for authentication.
    CurrentCapsManAddress string
    Currently used CAPsMAN address.
    CurrentCapsManIdentity string
    Currently used CAPsMAN identity.
    DiscoveryInterfaces List<string>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    Enabled bool
    Disable or enable the CAP functionality.
    LockToCapsMan bool
    Lock CAP to the first CAPsMAN it connects to.
    LockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    RequestedCertificate string
    Requested certificate.
    SlavesDatapath string
    Name of the bridge interface the CAP will be added to.
    SlavesStatic bool
    An option that creates static virtual interfaces.
    WifiCapId 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.
    CapsManAddresses []string
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    CapsManCertificateCommonNames []string
    List of manager certificate common names that CAP will connect to.
    CapsManNames []string
    An ordered list of CAPs Manager names that the CAP will connect to.
    Certificate string
    Certificate to use for authentication.
    CurrentCapsManAddress string
    Currently used CAPsMAN address.
    CurrentCapsManIdentity string
    Currently used CAPsMAN identity.
    DiscoveryInterfaces []string
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    Enabled bool
    Disable or enable the CAP functionality.
    LockToCapsMan bool
    Lock CAP to the first CAPsMAN it connects to.
    LockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    RequestedCertificate string
    Requested certificate.
    SlavesDatapath string
    Name of the bridge interface the CAP will be added to.
    SlavesStatic bool
    An option that creates static virtual interfaces.
    WifiCapId 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.
    capsManAddresses List<String>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames List<String>
    List of manager certificate common names that CAP will connect to.
    capsManNames List<String>
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate String
    Certificate to use for authentication.
    currentCapsManAddress String
    Currently used CAPsMAN address.
    currentCapsManIdentity String
    Currently used CAPsMAN identity.
    discoveryInterfaces List<String>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled Boolean
    Disable or enable the CAP functionality.
    lockToCapsMan Boolean
    Lock CAP to the first CAPsMAN it connects to.
    lockedCapsManCommonName String
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate String
    Requested certificate.
    slavesDatapath String
    Name of the bridge interface the CAP will be added to.
    slavesStatic Boolean
    An option that creates static virtual interfaces.
    wifiCapId 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.
    capsManAddresses string[]
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames string[]
    List of manager certificate common names that CAP will connect to.
    capsManNames string[]
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate string
    Certificate to use for authentication.
    currentCapsManAddress string
    Currently used CAPsMAN address.
    currentCapsManIdentity string
    Currently used CAPsMAN identity.
    discoveryInterfaces string[]
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled boolean
    Disable or enable the CAP functionality.
    lockToCapsMan boolean
    Lock CAP to the first CAPsMAN it connects to.
    lockedCapsManCommonName string
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate string
    Requested certificate.
    slavesDatapath string
    Name of the bridge interface the CAP will be added to.
    slavesStatic boolean
    An option that creates static virtual interfaces.
    wifiCapId 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.
    caps_man_addresses Sequence[str]
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    caps_man_certificate_common_names Sequence[str]
    List of manager certificate common names that CAP will connect to.
    caps_man_names Sequence[str]
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate str
    Certificate to use for authentication.
    current_caps_man_address str
    Currently used CAPsMAN address.
    current_caps_man_identity str
    Currently used CAPsMAN identity.
    discovery_interfaces Sequence[str]
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled bool
    Disable or enable the CAP functionality.
    lock_to_caps_man bool
    Lock CAP to the first CAPsMAN it connects to.
    locked_caps_man_common_name str
    Common name of the CAPsMAN that the CAP is locked to.
    requested_certificate str
    Requested certificate.
    slaves_datapath str
    Name of the bridge interface the CAP will be added to.
    slaves_static bool
    An option that creates static virtual interfaces.
    wifi_cap_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.
    capsManAddresses List<String>
    List of Manager IP addresses that CAP will attempt to contact during discovery.
    capsManCertificateCommonNames List<String>
    List of manager certificate common names that CAP will connect to.
    capsManNames List<String>
    An ordered list of CAPs Manager names that the CAP will connect to.
    certificate String
    Certificate to use for authentication.
    currentCapsManAddress String
    Currently used CAPsMAN address.
    currentCapsManIdentity String
    Currently used CAPsMAN identity.
    discoveryInterfaces List<String>
    List of interfaces over which CAP should attempt to discover CAPs Manager.
    enabled Boolean
    Disable or enable the CAP functionality.
    lockToCapsMan Boolean
    Lock CAP to the first CAPsMAN it connects to.
    lockedCapsManCommonName String
    Common name of the CAPsMAN that the CAP is locked to.
    requestedCertificate String
    Requested certificate.
    slavesDatapath String
    Name of the bridge interface the CAP will be added to.
    slavesStatic Boolean
    An option that creates static virtual interfaces.
    wifiCapId String
    The ID of this resource.

    Import

    $ pulumi import routeros:index/wifiCap:WifiCap settings .
    

    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