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

routeros.WifiSteering

Explore with Pulumi AI

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

    # routeros.WifiSteering (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 steering1 = new routeros.WifiSteering("steering1", {neighborGroups: ["something"]});
    
    import pulumi
    import pulumi_routeros as routeros
    
    steering1 = routeros.WifiSteering("steering1", neighbor_groups=["something"])
    
    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.NewWifiSteering(ctx, "steering1", &routeros.WifiSteeringArgs{
    			NeighborGroups: pulumi.StringArray{
    				pulumi.String("something"),
    			},
    		})
    		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 steering1 = new Routeros.WifiSteering("steering1", new()
        {
            NeighborGroups = new[]
            {
                "something",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.WifiSteering;
    import com.pulumi.routeros.WifiSteeringArgs;
    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 steering1 = new WifiSteering("steering1", WifiSteeringArgs.builder()
                .neighborGroups("something")
                .build());
    
        }
    }
    
    resources:
      steering1:
        type: routeros:WifiSteering
        properties:
          neighborGroups:
            - something
    

    Create WifiSteering Resource

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

    Constructor syntax

    new WifiSteering(name: string, args?: WifiSteeringArgs, opts?: CustomResourceOptions);
    @overload
    def WifiSteering(resource_name: str,
                     args: Optional[WifiSteeringArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def WifiSteering(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     ___id_: Optional[float] = None,
                     ___path_: Optional[str] = None,
                     comment: Optional[str] = None,
                     disabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     neighbor_groups: Optional[Sequence[str]] = None,
                     rrm: Optional[bool] = None,
                     wifi_steering_id: Optional[str] = None,
                     wnm: Optional[bool] = None)
    func NewWifiSteering(ctx *Context, name string, args *WifiSteeringArgs, opts ...ResourceOption) (*WifiSteering, error)
    public WifiSteering(string name, WifiSteeringArgs? args = null, CustomResourceOptions? opts = null)
    public WifiSteering(String name, WifiSteeringArgs args)
    public WifiSteering(String name, WifiSteeringArgs args, CustomResourceOptions options)
    
    type: routeros:WifiSteering
    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 WifiSteeringArgs
    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 WifiSteeringArgs
    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 WifiSteeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WifiSteeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WifiSteeringArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Comment string
    Disabled bool
    Name string
    Name of the steering profile.
    NeighborGroups List<string>
    Neighbor group of potential roaming candidates.
    Rrm bool
    An option to enable sending 802.11k neighbor reports.
    WifiSteeringId string
    The ID of this resource.
    Wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    Comment string
    Disabled bool
    Name string
    Name of the steering profile.
    NeighborGroups []string
    Neighbor group of potential roaming candidates.
    Rrm bool
    An option to enable sending 802.11k neighbor reports.
    WifiSteeringId string
    The ID of this resource.
    Wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment String
    disabled Boolean
    name String
    Name of the steering profile.
    neighborGroups List<String>
    Neighbor group of potential roaming candidates.
    rrm Boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId String
    The ID of this resource.
    wnm Boolean
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment string
    disabled boolean
    name string
    Name of the steering profile.
    neighborGroups string[]
    Neighbor group of potential roaming candidates.
    rrm boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId string
    The ID of this resource.
    wnm boolean
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment str
    disabled bool
    name str
    Name of the steering profile.
    neighbor_groups Sequence[str]
    Neighbor group of potential roaming candidates.
    rrm bool
    An option to enable sending 802.11k neighbor reports.
    wifi_steering_id str
    The ID of this resource.
    wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment String
    disabled Boolean
    name String
    Name of the steering profile.
    neighborGroups List<String>
    Neighbor group of potential roaming candidates.
    rrm Boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId String
    The ID of this resource.
    wnm Boolean
    An option to enable sending 802.11v BSS transition management requests.

    Outputs

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

    Get an existing WifiSteering 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?: WifiSteeringState, opts?: CustomResourceOptions): WifiSteering
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            comment: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            neighbor_groups: Optional[Sequence[str]] = None,
            rrm: Optional[bool] = None,
            wifi_steering_id: Optional[str] = None,
            wnm: Optional[bool] = None) -> WifiSteering
    func GetWifiSteering(ctx *Context, name string, id IDInput, state *WifiSteeringState, opts ...ResourceOption) (*WifiSteering, error)
    public static WifiSteering Get(string name, Input<string> id, WifiSteeringState? state, CustomResourceOptions? opts = null)
    public static WifiSteering get(String name, Output<String> id, WifiSteeringState state, CustomResourceOptions options)
    resources:  _:    type: routeros:WifiSteering    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:
    Comment string
    Disabled bool
    Name string
    Name of the steering profile.
    NeighborGroups List<string>
    Neighbor group of potential roaming candidates.
    Rrm bool
    An option to enable sending 802.11k neighbor reports.
    WifiSteeringId string
    The ID of this resource.
    Wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    Comment string
    Disabled bool
    Name string
    Name of the steering profile.
    NeighborGroups []string
    Neighbor group of potential roaming candidates.
    Rrm bool
    An option to enable sending 802.11k neighbor reports.
    WifiSteeringId string
    The ID of this resource.
    Wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment String
    disabled Boolean
    name String
    Name of the steering profile.
    neighborGroups List<String>
    Neighbor group of potential roaming candidates.
    rrm Boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId String
    The ID of this resource.
    wnm Boolean
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment string
    disabled boolean
    name string
    Name of the steering profile.
    neighborGroups string[]
    Neighbor group of potential roaming candidates.
    rrm boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId string
    The ID of this resource.
    wnm boolean
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment str
    disabled bool
    name str
    Name of the steering profile.
    neighbor_groups Sequence[str]
    Neighbor group of potential roaming candidates.
    rrm bool
    An option to enable sending 802.11k neighbor reports.
    wifi_steering_id str
    The ID of this resource.
    wnm bool
    An option to enable sending 802.11v BSS transition management requests.
    ___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.
    comment String
    disabled Boolean
    name String
    Name of the steering profile.
    neighborGroups List<String>
    Neighbor group of potential roaming candidates.
    rrm Boolean
    An option to enable sending 802.11k neighbor reports.
    wifiSteeringId String
    The ID of this resource.
    wnm Boolean
    An option to enable sending 802.11v BSS transition management requests.

    Import

    #The ID can be found via API or the terminal

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

    $ pulumi import routeros:index/wifiSteering:WifiSteering steering1 '*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