routeros.InterfaceWireless
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";
const config = new pulumi.Config();
const wlan2ghzDisabled = config.getBoolean("wlan2ghzDisabled") || false;
const wlan_2ghz = new routeros.InterfaceWireless("wlan-2ghz", {disabled: wlan2ghzDisabled});
const testInterfaceWirelessSecurityProfiles = new routeros.InterfaceWirelessSecurityProfiles("testInterfaceWirelessSecurityProfiles", {
mode: "dynamic-keys",
authenticationTypes: [
"wpa-psk",
"wpa2-psk",
],
wpaPreSharedKey: "wpa_psk_key",
wpa2PreSharedKey: "wpa2_psk_key",
});
const testInterfaceWireless = new routeros.InterfaceWireless("testInterfaceWireless", {
securityProfile: resource.routeros_interface_wireless_security_profiles.test.name,
mode: "ap-bridge",
masterInterface: resource.routeros_interface_wireless["wlan-2ghz"].name,
ssid: "guests",
basicRatesAgs: [
"6Mbps",
"9Mbps",
],
}, {
dependsOn: [resource.routeros_interface_wireless_security_profiles.test],
});
import pulumi
import pulumi_routeros as routeros
config = pulumi.Config()
wlan2ghz_disabled = config.get_bool("wlan2ghzDisabled")
if wlan2ghz_disabled is None:
wlan2ghz_disabled = False
wlan_2ghz = routeros.InterfaceWireless("wlan-2ghz", disabled=wlan2ghz_disabled)
test_interface_wireless_security_profiles = routeros.InterfaceWirelessSecurityProfiles("testInterfaceWirelessSecurityProfiles",
mode="dynamic-keys",
authentication_types=[
"wpa-psk",
"wpa2-psk",
],
wpa_pre_shared_key="wpa_psk_key",
wpa2_pre_shared_key="wpa2_psk_key")
test_interface_wireless = routeros.InterfaceWireless("testInterfaceWireless",
security_profile=resource["routeros_interface_wireless_security_profiles"]["test"]["name"],
mode="ap-bridge",
master_interface=resource["routeros_interface_wireless"]["wlan-2ghz"]["name"],
ssid="guests",
basic_rates_ags=[
"6Mbps",
"9Mbps",
],
opts = pulumi.ResourceOptions(depends_on=[resource["routeros_interface_wireless_security_profiles"]["test"]]))
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
wlan2ghzDisabled := false
if param := cfg.GetBool("wlan2ghzDisabled"); param {
wlan2ghzDisabled = param
}
_, err := routeros.NewInterfaceWireless(ctx, "wlan-2ghz", &routeros.InterfaceWirelessArgs{
Disabled: pulumi.Bool(wlan2ghzDisabled),
})
if err != nil {
return err
}
_, err = routeros.NewInterfaceWirelessSecurityProfiles(ctx, "testInterfaceWirelessSecurityProfiles", &routeros.InterfaceWirelessSecurityProfilesArgs{
Mode: pulumi.String("dynamic-keys"),
AuthenticationTypes: pulumi.StringArray{
pulumi.String("wpa-psk"),
pulumi.String("wpa2-psk"),
},
WpaPreSharedKey: pulumi.String("wpa_psk_key"),
Wpa2PreSharedKey: pulumi.String("wpa2_psk_key"),
})
if err != nil {
return err
}
_, err = routeros.NewInterfaceWireless(ctx, "testInterfaceWireless", &routeros.InterfaceWirelessArgs{
SecurityProfile: pulumi.Any(resource.Routeros_interface_wireless_security_profiles.Test.Name),
Mode: pulumi.String("ap-bridge"),
MasterInterface: pulumi.Any(resource.Routeros_interface_wireless.Wlan2ghz.Name),
Ssid: pulumi.String("guests"),
BasicRatesAgs: pulumi.StringArray{
pulumi.String("6Mbps"),
pulumi.String("9Mbps"),
},
}, pulumi.DependsOn([]pulumi.Resource{
resource.Routeros_interface_wireless_security_profiles.Test,
}))
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 config = new Config();
var wlan2ghzDisabled = config.GetBoolean("wlan2ghzDisabled") ?? false;
var wlan_2ghz = new Routeros.InterfaceWireless("wlan-2ghz", new()
{
Disabled = wlan2ghzDisabled,
});
var testInterfaceWirelessSecurityProfiles = new Routeros.InterfaceWirelessSecurityProfiles("testInterfaceWirelessSecurityProfiles", new()
{
Mode = "dynamic-keys",
AuthenticationTypes = new[]
{
"wpa-psk",
"wpa2-psk",
},
WpaPreSharedKey = "wpa_psk_key",
Wpa2PreSharedKey = "wpa2_psk_key",
});
var testInterfaceWireless = new Routeros.InterfaceWireless("testInterfaceWireless", new()
{
SecurityProfile = resource.Routeros_interface_wireless_security_profiles.Test.Name,
Mode = "ap-bridge",
MasterInterface = resource.Routeros_interface_wireless.Wlan_2ghz.Name,
Ssid = "guests",
BasicRatesAgs = new[]
{
"6Mbps",
"9Mbps",
},
}, new CustomResourceOptions
{
DependsOn =
{
resource.Routeros_interface_wireless_security_profiles.Test,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.InterfaceWireless;
import com.pulumi.routeros.InterfaceWirelessArgs;
import com.pulumi.routeros.InterfaceWirelessSecurityProfiles;
import com.pulumi.routeros.InterfaceWirelessSecurityProfilesArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
final var config = ctx.config();
final var wlan2ghzDisabled = config.get("wlan2ghzDisabled").orElse(false);
var wlan_2ghz = new InterfaceWireless("wlan-2ghz", InterfaceWirelessArgs.builder()
.disabled(wlan2ghzDisabled)
.build());
var testInterfaceWirelessSecurityProfiles = new InterfaceWirelessSecurityProfiles("testInterfaceWirelessSecurityProfiles", InterfaceWirelessSecurityProfilesArgs.builder()
.mode("dynamic-keys")
.authenticationTypes(
"wpa-psk",
"wpa2-psk")
.wpaPreSharedKey("wpa_psk_key")
.wpa2PreSharedKey("wpa2_psk_key")
.build());
var testInterfaceWireless = new InterfaceWireless("testInterfaceWireless", InterfaceWirelessArgs.builder()
.securityProfile(resource.routeros_interface_wireless_security_profiles().test().name())
.mode("ap-bridge")
.masterInterface(resource.routeros_interface_wireless().wlan-2ghz().name())
.ssid("guests")
.basicRatesAgs(
"6Mbps",
"9Mbps")
.build(), CustomResourceOptions.builder()
.dependsOn(resource.routeros_interface_wireless_security_profiles().test())
.build());
}
}
configuration:
wlan2ghzDisabled:
type: bool
default: false
resources:
wlan-2ghz:
type: routeros:InterfaceWireless
properties:
disabled: ${wlan2ghzDisabled}
testInterfaceWirelessSecurityProfiles:
type: routeros:InterfaceWirelessSecurityProfiles
properties:
mode: dynamic-keys
authenticationTypes:
- wpa-psk
- wpa2-psk
wpaPreSharedKey: wpa_psk_key
wpa2PreSharedKey: wpa2_psk_key
testInterfaceWireless:
type: routeros:InterfaceWireless
properties:
securityProfile: ${resource.routeros_interface_wireless_security_profiles.test.name}
mode: ap-bridge
masterInterface: ${resource.routeros_interface_wireless"wlan-2ghz"[%!s(MISSING)].name}
ssid: guests
basicRatesAgs:
- 6Mbps
- 9Mbps
options:
dependsOn:
- ${resource.routeros_interface_wireless_security_profiles.test}
Create InterfaceWireless Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new InterfaceWireless(name: string, args?: InterfaceWirelessArgs, opts?: CustomResourceOptions);
@overload
def InterfaceWireless(resource_name: str,
args: Optional[InterfaceWirelessArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def InterfaceWireless(resource_name: str,
opts: Optional[ResourceOptions] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
___skip_: Optional[str] = None,
___ts_: Optional[str] = None,
___unset_: Optional[str] = None,
adaptive_noise_immunity: Optional[str] = None,
allow_sharedkey: Optional[bool] = None,
ampdu_priorities: Optional[Sequence[float]] = None,
amsdu_limit: Optional[float] = None,
amsdu_threshold: Optional[float] = None,
antenna_gain: Optional[float] = None,
antenna_mode: Optional[str] = None,
area: Optional[str] = None,
arp: Optional[str] = None,
arp_timeout: Optional[str] = None,
band: Optional[str] = None,
basic_rates_ags: Optional[Sequence[str]] = None,
basic_rates_bs: Optional[Sequence[str]] = None,
bridge_mode: Optional[str] = None,
burst_time: Optional[str] = None,
channel_width: Optional[str] = None,
comment: Optional[str] = None,
compression: Optional[bool] = None,
country: Optional[str] = None,
default_ap_tx_limit: Optional[float] = None,
default_authentication: Optional[bool] = None,
default_client_tx_limit: Optional[float] = None,
default_forwarding: Optional[bool] = None,
disable_running_check: Optional[bool] = None,
disabled: Optional[bool] = None,
disconnect_timeout: Optional[str] = None,
distance: Optional[str] = None,
frame_lifetime: Optional[float] = None,
frequency: Optional[str] = None,
frequency_mode: Optional[str] = None,
frequency_offset: Optional[float] = None,
guard_interval: Optional[str] = None,
hide_ssid: Optional[bool] = None,
ht_basic_mcs: Optional[Sequence[str]] = None,
ht_supported_mcs: Optional[Sequence[str]] = None,
hw_fragmentation_threshold: Optional[str] = None,
hw_protection_mode: Optional[str] = None,
hw_protection_threshold: Optional[float] = None,
hw_retries: Optional[float] = None,
installation: Optional[str] = None,
interface_wireless_id: Optional[str] = None,
interworking_profile: Optional[str] = None,
keepalive_frames: Optional[str] = None,
l2mtu: Optional[float] = None,
mac_address: Optional[str] = None,
master_interface: Optional[str] = None,
max_station_count: Optional[float] = None,
mode: Optional[str] = None,
mtu: Optional[str] = None,
multicast_buffering: Optional[str] = None,
multicast_helper: Optional[str] = None,
name: Optional[str] = None,
noise_floor_threshold: Optional[str] = None,
nv2_cell_radius: Optional[float] = None,
nv2_downlink_ratio: Optional[float] = None,
nv2_mode: Optional[str] = None,
nv2_noise_floor_offset: Optional[str] = None,
nv2_preshared_key: Optional[str] = None,
nv2_qos: Optional[str] = None,
nv2_queue_count: Optional[float] = None,
nv2_security: Optional[str] = None,
nv2_sync_secret: Optional[str] = None,
on_fail_retry_time: Optional[str] = None,
periodic_calibration: Optional[str] = None,
periodic_calibration_interval: Optional[float] = None,
preamble_mode: Optional[str] = None,
prism_cardtype: Optional[str] = None,
proprietary_extensions: Optional[str] = None,
rate_selection: Optional[str] = None,
rate_set: Optional[str] = None,
rx_chains: Optional[Sequence[float]] = None,
scan_list: Optional[str] = None,
secondary_frequency: Optional[str] = None,
security_profile: Optional[str] = None,
skip_dfs_channels: Optional[str] = None,
ssid: Optional[str] = None,
station_bridge_clone_mac: Optional[str] = None,
station_roaming: Optional[str] = None,
supported_rates_ag: Optional[str] = None,
supported_rates_b: Optional[str] = None,
tdma_period_size: Optional[float] = None,
tx_chains: Optional[Sequence[float]] = None,
tx_power: Optional[float] = None,
tx_power_mode: Optional[str] = None,
update_stats_interval: Optional[str] = None,
vht_basic_mcs: Optional[str] = None,
vht_supported_mcs: Optional[str] = None,
vlan_id: Optional[float] = None,
vlan_mode: Optional[str] = None,
wds_cost_range: Optional[str] = None,
wds_default_bridge: Optional[str] = None,
wds_default_cost: Optional[float] = None,
wds_ignore_ssid: Optional[bool] = None,
wds_mode: Optional[str] = None,
wireless_protocol: Optional[str] = None,
wmm_support: Optional[str] = None,
wps_mode: Optional[str] = None)
func NewInterfaceWireless(ctx *Context, name string, args *InterfaceWirelessArgs, opts ...ResourceOption) (*InterfaceWireless, error)
public InterfaceWireless(string name, InterfaceWirelessArgs? args = null, CustomResourceOptions? opts = null)
public InterfaceWireless(String name, InterfaceWirelessArgs args)
public InterfaceWireless(String name, InterfaceWirelessArgs args, CustomResourceOptions options)
type: routeros:InterfaceWireless
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 InterfaceWirelessArgs
- 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 InterfaceWirelessArgs
- 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 InterfaceWirelessArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InterfaceWirelessArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InterfaceWirelessArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
InterfaceWireless 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 InterfaceWireless resource accepts the following input properties:
- Adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- Ampdu
Priorities List<double> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- Amsdu
Limit double - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- Amsdu
Threshold double - Max frame size to allow including in AMSDU.
- Antenna
Gain double - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- Antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - Area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- Arp string
- ARP Mode.
- Arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - Band string
- Defines set of used data rates, channel frequencies and widths.
- Basic
Rates List<string>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- Basic
Rates List<string>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - Bridge
Mode string - Allows to use station-bridge mode.
- Burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- Channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - Comment string
- Compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- Country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- Default
Ap doubleTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- Default
Authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- Default
Client doubleTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - Default
Forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- Disable
Running boolCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- Disabled bool
- Disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - Distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - Frame
Lifetime double - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- Frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - Frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - Frequency
Offset double - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- Guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - Hide
Ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- Ht
Basic List<string>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- Ht
Supported List<string>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- Hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- Hw
Protection stringMode - Frame protection support property.
- Hw
Protection doubleThreshold - Frame protection support property read more >>.
- Hw
Retries double - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- Installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- Interface
Wireless stringId - Interworking
Profile string - Keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - L2mtu double
- Layer2 Maximum transmission unit. See.
- Mac
Address string - MAC address.
- Master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- Max
Station doubleCount - Maximum number of associated clients. WDS links also count toward this limit.
- Mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- Mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- Multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- Multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- Name string
- Name of the interface.
- Noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- Nv2Cell
Radius double - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - Nv2Downlink
Ratio double - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- Nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- Nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- Nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- Nv2Queue
Count double - Specifies how many priority queues are used in Nv2 network.
- Nv2Security string
- Specifies Nv2 security mode.
- Nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- On
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- Periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- Periodic
Calibration doubleInterval - This property is only effective for cards based on Atheros chipset.
- Preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- Prism
Cardtype string - Specify type of the installed Prism wireless card.
- Proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - Rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- Rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - Rx
Chains List<double> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- Secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- Security
Profile string - Name of profile from security-profiles.
- Skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- Ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- Station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- Station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- Supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- Supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - Tdma
Period doubleSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- Tx
Chains List<double> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Tx
Power double - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- Tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - Update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- Vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- Vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- Vlan
Id double - VLAN ID to use if doing VLAN tagging.
- Vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- Wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- Wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- Wds
Default doubleCost - Initial bridge port cost of the WDS links.
- Wds
Ignore boolSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- Wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- Wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- Wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - Wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- Adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- Ampdu
Priorities []float64 - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- Amsdu
Limit float64 - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- Amsdu
Threshold float64 - Max frame size to allow including in AMSDU.
- Antenna
Gain float64 - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- Antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - Area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- Arp string
- ARP Mode.
- Arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - Band string
- Defines set of used data rates, channel frequencies and widths.
- Basic
Rates []stringAgs - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- Basic
Rates []stringBs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - Bridge
Mode string - Allows to use station-bridge mode.
- Burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- Channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - Comment string
- Compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- Country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- Default
Ap float64Tx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- Default
Authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- Default
Client float64Tx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - Default
Forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- Disable
Running boolCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- Disabled bool
- Disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - Distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - Frame
Lifetime float64 - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- Frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - Frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - Frequency
Offset float64 - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- Guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - Hide
Ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- Ht
Basic []stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- Ht
Supported []stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- Hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- Hw
Protection stringMode - Frame protection support property.
- Hw
Protection float64Threshold - Frame protection support property read more >>.
- Hw
Retries float64 - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- Installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- Interface
Wireless stringId - Interworking
Profile string - Keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - L2mtu float64
- Layer2 Maximum transmission unit. See.
- Mac
Address string - MAC address.
- Master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- Max
Station float64Count - Maximum number of associated clients. WDS links also count toward this limit.
- Mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- Mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- Multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- Multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- Name string
- Name of the interface.
- Noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- Nv2Cell
Radius float64 - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - Nv2Downlink
Ratio float64 - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- Nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- Nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- Nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- Nv2Queue
Count float64 - Specifies how many priority queues are used in Nv2 network.
- Nv2Security string
- Specifies Nv2 security mode.
- Nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- On
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- Periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- Periodic
Calibration float64Interval - This property is only effective for cards based on Atheros chipset.
- Preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- Prism
Cardtype string - Specify type of the installed Prism wireless card.
- Proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - Rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- Rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - Rx
Chains []float64 - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- Secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- Security
Profile string - Name of profile from security-profiles.
- Skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- Ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- Station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- Station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- Supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- Supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - Tdma
Period float64Size - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- Tx
Chains []float64 - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Tx
Power float64 - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- Tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - Update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- Vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- Vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- Vlan
Id float64 - VLAN ID to use if doing VLAN tagging.
- Vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- Wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- Wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- Wds
Default float64Cost - Initial bridge port cost of the WDS links.
- Wds
Ignore boolSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- Wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- Wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- Wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - Wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. 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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ String - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise StringImmunity - This property is only effective for cards based on Atheros chipset.
- Boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities List<Double> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit Double - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold Double - Max frame size to allow including in AMSDU.
- antenna
Gain Double - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode String - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area String
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp String
- ARP Mode.
- arp
Timeout String - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band String
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates List<String>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates List<String>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode String - Allows to use station-bridge mode.
- burst
Time String - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width String - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment String
- compression Boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country String
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap DoubleTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication Boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client DoubleTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding Boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- disable
Running BooleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled Boolean
- disconnect
Timeout String - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance String
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime Double - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency String
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode String - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset Double - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval String - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid Boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic List<String>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported List<String>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation StringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection StringMode - Frame protection support property.
- hw
Protection DoubleThreshold - Frame protection support property read more >>.
- hw
Retries Double - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation String
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Wireless StringId - interworking
Profile String - keepalive
Frames String - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu Double
- Layer2 Maximum transmission unit. See.
- mac
Address String - MAC address.
- master
Interface String - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station DoubleCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode String
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu String
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering String - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper String - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name String
- Name of the interface.
- noise
Floor StringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius Double - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio Double - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode String
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor StringOffset - String
- Specifies preshared key to be used.
- nv2Qos String
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count Double - Specifies how many priority queues are used in Nv2 network.
- nv2Security String
- Specifies Nv2 security mode.
- nv2Sync
Secret String - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail StringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration String - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration DoubleInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode String - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype String - Specify type of the installed Prism wireless card.
- proprietary
Extensions String - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - rate
Selection String - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set String - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - rx
Chains List<Double> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List String - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency String - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile String - Name of profile from security-profiles.
- skip
Dfs StringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid String
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge StringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming String - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates StringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates StringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period DoubleSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains List<Double> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power Double - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power StringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats StringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic StringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported StringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id Double - VLAN ID to use if doing VLAN tagging.
- vlan
Mode String - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost StringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default StringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default DoubleCost - Initial bridge port cost of the WDS links.
- wds
Ignore BooleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode String - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol String - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support String - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode String - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities number[] - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit number - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold number - Max frame size to allow including in AMSDU.
- antenna
Gain number - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp string
- ARP Mode.
- arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band string
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates string[]Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates string[]Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode string - Allows to use station-bridge mode.
- burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment string
- compression boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap numberTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client numberTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- disable
Running booleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled boolean
- disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime number - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset number - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic string[]Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported string[]Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection stringMode - Frame protection support property.
- hw
Protection numberThreshold - Frame protection support property read more >>.
- hw
Retries number - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Wireless stringId - interworking
Profile string - keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu number
- Layer2 Maximum transmission unit. See.
- mac
Address string - MAC address.
- master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station numberCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name string
- Name of the interface.
- noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius number - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio number - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count number - Specifies how many priority queues are used in Nv2 network.
- nv2Security string
- Specifies Nv2 security mode.
- nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration numberInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype string - Specify type of the installed Prism wireless card.
- proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - rx
Chains number[] - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile string - Name of profile from security-profiles.
- skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period numberSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains number[] - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power number - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id number - VLAN ID to use if doing VLAN tagging.
- vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default numberCost - Initial bridge port cost of the WDS links.
- wds
Ignore booleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ str - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive_
noise_ strimmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu_
priorities Sequence[float] - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu_
limit float - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu_
threshold float - Max frame size to allow including in AMSDU.
- antenna_
gain float - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna_
mode str - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area str
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp str
- ARP Mode.
- arp_
timeout str - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band str
- Defines set of used data rates, channel frequencies and widths.
- basic_
rates_ Sequence[str]ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic_
rates_ Sequence[str]bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge_
mode str - Allows to use station-bridge mode.
- burst_
time str - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel_
width str - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment str
- compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country str
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default_
ap_ floattx_ limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default_
authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default_
client_ floattx_ limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default_
forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- disable_
running_ boolcheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled bool
- disconnect_
timeout str - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance str
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame_
lifetime float - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency str
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency_
mode str - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency_
offset float - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard_
interval str - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide_
ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht_
basic_ Sequence[str]mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht_
supported_ Sequence[str]mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw_
fragmentation_ strthreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw_
protection_ strmode - Frame protection support property.
- hw_
protection_ floatthreshold - Frame protection support property read more >>.
- hw_
retries float - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation str
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface_
wireless_ strid - interworking_
profile str - keepalive_
frames str - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu float
- Layer2 Maximum transmission unit. See.
- mac_
address str - MAC address.
- master_
interface str - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max_
station_ floatcount - Maximum number of associated clients. WDS links also count toward this limit.
- mode str
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu str
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast_
buffering str - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast_
helper str - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name str
- Name of the interface.
- noise_
floor_ strthreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2_
cell_ floatradius - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2_
downlink_ floatratio - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2_
mode str - Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2_
noise_ strfloor_ offset - str
- Specifies preshared key to be used.
- nv2_
qos str - Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2_
queue_ floatcount - Specifies how many priority queues are used in Nv2 network.
- nv2_
security str - Specifies Nv2 security mode.
- nv2_
sync_ strsecret - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on_
fail_ strretry_ time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic_
calibration str - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic_
calibration_ floatinterval - This property is only effective for cards based on Atheros chipset.
- preamble_
mode str - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism_
cardtype str - Specify type of the installed Prism wireless card.
- proprietary_
extensions str - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - rate_
selection str - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate_
set str - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - rx_
chains Sequence[float] - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan_
list str - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary_
frequency str - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security_
profile str - Name of profile from security-profiles.
- skip_
dfs_ strchannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid str
- SSID (service set identifier) is a name that identifies wireless network.
- station_
bridge_ strclone_ mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station_
roaming str - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported_
rates_ strag - List of supported rates, used for all bands except 2ghz-b.
- supported_
rates_ strb - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma_
period_ floatsize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx_
chains Sequence[float] - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx_
power float - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx_
power_ strmode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update_
stats_ strinterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht_
basic_ strmcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht_
supported_ strmcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan_
id float - VLAN ID to use if doing VLAN tagging.
- vlan_
mode str - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds_
cost_ strrange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds_
default_ strbridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds_
default_ floatcost - Initial bridge port cost of the WDS links.
- wds_
ignore_ boolssid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds_
mode str - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless_
protocol str - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm_
support str - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps_
mode str - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ String - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise StringImmunity - This property is only effective for cards based on Atheros chipset.
- Boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities List<Number> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit Number - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold Number - Max frame size to allow including in AMSDU.
- antenna
Gain Number - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode String - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area String
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp String
- ARP Mode.
- arp
Timeout String - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band String
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates List<String>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates List<String>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode String - Allows to use station-bridge mode.
- burst
Time String - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width String - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment String
- compression Boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country String
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap NumberTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication Boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client NumberTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding Boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- disable
Running BooleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled Boolean
- disconnect
Timeout String - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance String
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime Number - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency String
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode String - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset Number - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval String - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid Boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic List<String>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported List<String>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation StringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection StringMode - Frame protection support property.
- hw
Protection NumberThreshold - Frame protection support property read more >>.
- hw
Retries Number - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation String
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Wireless StringId - interworking
Profile String - keepalive
Frames String - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu Number
- Layer2 Maximum transmission unit. See.
- mac
Address String - MAC address.
- master
Interface String - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station NumberCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode String
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu String
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering String - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper String - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name String
- Name of the interface.
- noise
Floor StringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius Number - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio Number - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode String
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor StringOffset - String
- Specifies preshared key to be used.
- nv2Qos String
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count Number - Specifies how many priority queues are used in Nv2 network.
- nv2Security String
- Specifies Nv2 security mode.
- nv2Sync
Secret String - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail StringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration String - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration NumberInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode String - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype String - Specify type of the installed Prism wireless card.
- proprietary
Extensions String - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - rate
Selection String - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set String - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - rx
Chains List<Number> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List String - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency String - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile String - Name of profile from security-profiles.
- skip
Dfs StringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid String
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge StringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming String - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates StringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates StringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period NumberSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains List<Number> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power Number - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power StringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats StringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic StringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported StringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id Number - VLAN ID to use if doing VLAN tagging.
- vlan
Mode String - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost StringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default StringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default NumberCost - Initial bridge port cost of the WDS links.
- wds
Ignore BooleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode String - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol String - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support String - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode String - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
Outputs
All input properties are implicitly available as output properties. Additionally, the InterfaceWireless resource produces the following output properties:
- Default
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Interface
Type string - Radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- Running bool
- Default
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Interface
Type string - Radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- Running bool
- default
Name String - id String
- The provider-assigned unique ID for this managed resource.
- interface
Type String - radio
Name String - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- running Boolean
- default
Name string - id string
- The provider-assigned unique ID for this managed resource.
- interface
Type string - radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- running boolean
- default_
name str - id str
- The provider-assigned unique ID for this managed resource.
- interface_
type str - radio_
name str - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- running bool
- default
Name String - id String
- The provider-assigned unique ID for this managed resource.
- interface
Type String - radio
Name String - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- running Boolean
Look up Existing InterfaceWireless Resource
Get an existing InterfaceWireless 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?: InterfaceWirelessState, opts?: CustomResourceOptions): InterfaceWireless
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
___skip_: Optional[str] = None,
___ts_: Optional[str] = None,
___unset_: Optional[str] = None,
adaptive_noise_immunity: Optional[str] = None,
allow_sharedkey: Optional[bool] = None,
ampdu_priorities: Optional[Sequence[float]] = None,
amsdu_limit: Optional[float] = None,
amsdu_threshold: Optional[float] = None,
antenna_gain: Optional[float] = None,
antenna_mode: Optional[str] = None,
area: Optional[str] = None,
arp: Optional[str] = None,
arp_timeout: Optional[str] = None,
band: Optional[str] = None,
basic_rates_ags: Optional[Sequence[str]] = None,
basic_rates_bs: Optional[Sequence[str]] = None,
bridge_mode: Optional[str] = None,
burst_time: Optional[str] = None,
channel_width: Optional[str] = None,
comment: Optional[str] = None,
compression: Optional[bool] = None,
country: Optional[str] = None,
default_ap_tx_limit: Optional[float] = None,
default_authentication: Optional[bool] = None,
default_client_tx_limit: Optional[float] = None,
default_forwarding: Optional[bool] = None,
default_name: Optional[str] = None,
disable_running_check: Optional[bool] = None,
disabled: Optional[bool] = None,
disconnect_timeout: Optional[str] = None,
distance: Optional[str] = None,
frame_lifetime: Optional[float] = None,
frequency: Optional[str] = None,
frequency_mode: Optional[str] = None,
frequency_offset: Optional[float] = None,
guard_interval: Optional[str] = None,
hide_ssid: Optional[bool] = None,
ht_basic_mcs: Optional[Sequence[str]] = None,
ht_supported_mcs: Optional[Sequence[str]] = None,
hw_fragmentation_threshold: Optional[str] = None,
hw_protection_mode: Optional[str] = None,
hw_protection_threshold: Optional[float] = None,
hw_retries: Optional[float] = None,
installation: Optional[str] = None,
interface_type: Optional[str] = None,
interface_wireless_id: Optional[str] = None,
interworking_profile: Optional[str] = None,
keepalive_frames: Optional[str] = None,
l2mtu: Optional[float] = None,
mac_address: Optional[str] = None,
master_interface: Optional[str] = None,
max_station_count: Optional[float] = None,
mode: Optional[str] = None,
mtu: Optional[str] = None,
multicast_buffering: Optional[str] = None,
multicast_helper: Optional[str] = None,
name: Optional[str] = None,
noise_floor_threshold: Optional[str] = None,
nv2_cell_radius: Optional[float] = None,
nv2_downlink_ratio: Optional[float] = None,
nv2_mode: Optional[str] = None,
nv2_noise_floor_offset: Optional[str] = None,
nv2_preshared_key: Optional[str] = None,
nv2_qos: Optional[str] = None,
nv2_queue_count: Optional[float] = None,
nv2_security: Optional[str] = None,
nv2_sync_secret: Optional[str] = None,
on_fail_retry_time: Optional[str] = None,
periodic_calibration: Optional[str] = None,
periodic_calibration_interval: Optional[float] = None,
preamble_mode: Optional[str] = None,
prism_cardtype: Optional[str] = None,
proprietary_extensions: Optional[str] = None,
radio_name: Optional[str] = None,
rate_selection: Optional[str] = None,
rate_set: Optional[str] = None,
running: Optional[bool] = None,
rx_chains: Optional[Sequence[float]] = None,
scan_list: Optional[str] = None,
secondary_frequency: Optional[str] = None,
security_profile: Optional[str] = None,
skip_dfs_channels: Optional[str] = None,
ssid: Optional[str] = None,
station_bridge_clone_mac: Optional[str] = None,
station_roaming: Optional[str] = None,
supported_rates_ag: Optional[str] = None,
supported_rates_b: Optional[str] = None,
tdma_period_size: Optional[float] = None,
tx_chains: Optional[Sequence[float]] = None,
tx_power: Optional[float] = None,
tx_power_mode: Optional[str] = None,
update_stats_interval: Optional[str] = None,
vht_basic_mcs: Optional[str] = None,
vht_supported_mcs: Optional[str] = None,
vlan_id: Optional[float] = None,
vlan_mode: Optional[str] = None,
wds_cost_range: Optional[str] = None,
wds_default_bridge: Optional[str] = None,
wds_default_cost: Optional[float] = None,
wds_ignore_ssid: Optional[bool] = None,
wds_mode: Optional[str] = None,
wireless_protocol: Optional[str] = None,
wmm_support: Optional[str] = None,
wps_mode: Optional[str] = None) -> InterfaceWireless
func GetInterfaceWireless(ctx *Context, name string, id IDInput, state *InterfaceWirelessState, opts ...ResourceOption) (*InterfaceWireless, error)
public static InterfaceWireless Get(string name, Input<string> id, InterfaceWirelessState? state, CustomResourceOptions? opts = null)
public static InterfaceWireless get(String name, Output<String> id, InterfaceWirelessState state, CustomResourceOptions options)
resources: _: type: routeros:InterfaceWireless 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.
- Adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- Ampdu
Priorities List<double> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- Amsdu
Limit double - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- Amsdu
Threshold double - Max frame size to allow including in AMSDU.
- Antenna
Gain double - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- Antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - Area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- Arp string
- ARP Mode.
- Arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - Band string
- Defines set of used data rates, channel frequencies and widths.
- Basic
Rates List<string>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- Basic
Rates List<string>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - Bridge
Mode string - Allows to use station-bridge mode.
- Burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- Channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - Comment string
- Compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- Country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- Default
Ap doubleTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- Default
Authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- Default
Client doubleTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - Default
Forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- Default
Name string - Disable
Running boolCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- Disabled bool
- Disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - Distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - Frame
Lifetime double - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- Frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - Frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - Frequency
Offset double - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- Guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - Hide
Ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- Ht
Basic List<string>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- Ht
Supported List<string>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- Hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- Hw
Protection stringMode - Frame protection support property.
- Hw
Protection doubleThreshold - Frame protection support property read more >>.
- Hw
Retries double - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- Installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- Interface
Type string - Interface
Wireless stringId - Interworking
Profile string - Keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - L2mtu double
- Layer2 Maximum transmission unit. See.
- Mac
Address string - MAC address.
- Master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- Max
Station doubleCount - Maximum number of associated clients. WDS links also count toward this limit.
- Mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- Mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- Multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- Multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- Name string
- Name of the interface.
- Noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- Nv2Cell
Radius double - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - Nv2Downlink
Ratio double - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- Nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- Nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- Nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- Nv2Queue
Count double - Specifies how many priority queues are used in Nv2 network.
- Nv2Security string
- Specifies Nv2 security mode.
- Nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- On
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- Periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- Periodic
Calibration doubleInterval - This property is only effective for cards based on Atheros chipset.
- Preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- Prism
Cardtype string - Specify type of the installed Prism wireless card.
- Proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - Radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- Rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- Rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - Running bool
- Rx
Chains List<double> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- Secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- Security
Profile string - Name of profile from security-profiles.
- Skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- Ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- Station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- Station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- Supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- Supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - Tdma
Period doubleSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- Tx
Chains List<double> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Tx
Power double - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- Tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - Update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- Vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- Vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- Vlan
Id double - VLAN ID to use if doing VLAN tagging.
- Vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- Wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- Wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- Wds
Default doubleCost - Initial bridge port cost of the WDS links.
- Wds
Ignore boolSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- Wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- Wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- Wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - Wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- Adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- Ampdu
Priorities []float64 - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- Amsdu
Limit float64 - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- Amsdu
Threshold float64 - Max frame size to allow including in AMSDU.
- Antenna
Gain float64 - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- Antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - Area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- Arp string
- ARP Mode.
- Arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - Band string
- Defines set of used data rates, channel frequencies and widths.
- Basic
Rates []stringAgs - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- Basic
Rates []stringBs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - Bridge
Mode string - Allows to use station-bridge mode.
- Burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- Channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - Comment string
- Compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- Country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- Default
Ap float64Tx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- Default
Authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- Default
Client float64Tx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - Default
Forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- Default
Name string - Disable
Running boolCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- Disabled bool
- Disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - Distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - Frame
Lifetime float64 - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- Frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - Frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - Frequency
Offset float64 - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- Guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - Hide
Ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- Ht
Basic []stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- Ht
Supported []stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- Hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- Hw
Protection stringMode - Frame protection support property.
- Hw
Protection float64Threshold - Frame protection support property read more >>.
- Hw
Retries float64 - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- Installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- Interface
Type string - Interface
Wireless stringId - Interworking
Profile string - Keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - L2mtu float64
- Layer2 Maximum transmission unit. See.
- Mac
Address string - MAC address.
- Master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- Max
Station float64Count - Maximum number of associated clients. WDS links also count toward this limit.
- Mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- Mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- Multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- Multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- Name string
- Name of the interface.
- Noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- Nv2Cell
Radius float64 - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - Nv2Downlink
Ratio float64 - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- Nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- Nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- Nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- Nv2Queue
Count float64 - Specifies how many priority queues are used in Nv2 network.
- Nv2Security string
- Specifies Nv2 security mode.
- Nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- On
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- Periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- Periodic
Calibration float64Interval - This property is only effective for cards based on Atheros chipset.
- Preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- Prism
Cardtype string - Specify type of the installed Prism wireless card.
- Proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - Radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- Rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- Rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - Running bool
- Rx
Chains []float64 - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- Secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- Security
Profile string - Name of profile from security-profiles.
- Skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- Ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- Station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- Station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- Supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- Supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - Tdma
Period float64Size - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- Tx
Chains []float64 - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- Tx
Power float64 - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- Tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - Update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- Vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- Vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- Vlan
Id float64 - VLAN ID to use if doing VLAN tagging.
- Vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- Wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- Wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- Wds
Default float64Cost - Initial bridge port cost of the WDS links.
- Wds
Ignore boolSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- Wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- Wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- Wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - Wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. 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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ String - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise StringImmunity - This property is only effective for cards based on Atheros chipset.
- Boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities List<Double> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit Double - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold Double - Max frame size to allow including in AMSDU.
- antenna
Gain Double - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode String - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area String
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp String
- ARP Mode.
- arp
Timeout String - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band String
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates List<String>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates List<String>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode String - Allows to use station-bridge mode.
- burst
Time String - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width String - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment String
- compression Boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country String
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap DoubleTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication Boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client DoubleTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding Boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- default
Name String - disable
Running BooleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled Boolean
- disconnect
Timeout String - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance String
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime Double - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency String
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode String - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset Double - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval String - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid Boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic List<String>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported List<String>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation StringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection StringMode - Frame protection support property.
- hw
Protection DoubleThreshold - Frame protection support property read more >>.
- hw
Retries Double - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation String
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Type String - interface
Wireless StringId - interworking
Profile String - keepalive
Frames String - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu Double
- Layer2 Maximum transmission unit. See.
- mac
Address String - MAC address.
- master
Interface String - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station DoubleCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode String
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu String
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering String - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper String - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name String
- Name of the interface.
- noise
Floor StringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius Double - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio Double - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode String
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor StringOffset - String
- Specifies preshared key to be used.
- nv2Qos String
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count Double - Specifies how many priority queues are used in Nv2 network.
- nv2Security String
- Specifies Nv2 security mode.
- nv2Sync
Secret String - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail StringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration String - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration DoubleInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode String - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype String - Specify type of the installed Prism wireless card.
- proprietary
Extensions String - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - radio
Name String - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- rate
Selection String - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set String - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - running Boolean
- rx
Chains List<Double> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List String - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency String - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile String - Name of profile from security-profiles.
- skip
Dfs StringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid String
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge StringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming String - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates StringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates StringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period DoubleSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains List<Double> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power Double - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power StringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats StringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic StringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported StringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id Double - VLAN ID to use if doing VLAN tagging.
- vlan
Mode String - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost StringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default StringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default DoubleCost - Initial bridge port cost of the WDS links.
- wds
Ignore BooleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode String - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol String - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support String - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode String - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ string - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise stringImmunity - This property is only effective for cards based on Atheros chipset.
- boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities number[] - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit number - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold number - Max frame size to allow including in AMSDU.
- antenna
Gain number - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode string - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area string
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp string
- ARP Mode.
- arp
Timeout string - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band string
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates string[]Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates string[]Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode string - Allows to use station-bridge mode.
- burst
Time string - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width string - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment string
- compression boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country string
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap numberTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client numberTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- default
Name string - disable
Running booleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled boolean
- disconnect
Timeout string - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance string
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime number - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency string
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode string - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset number - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval string - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic string[]Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported string[]Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation stringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection stringMode - Frame protection support property.
- hw
Protection numberThreshold - Frame protection support property read more >>.
- hw
Retries number - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation string
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Type string - interface
Wireless stringId - interworking
Profile string - keepalive
Frames string - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu number
- Layer2 Maximum transmission unit. See.
- mac
Address string - MAC address.
- master
Interface string - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station numberCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode string
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu string
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering string - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper string - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name string
- Name of the interface.
- noise
Floor stringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius number - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio number - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode string
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor stringOffset - string
- Specifies preshared key to be used.
- nv2Qos string
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count number - Specifies how many priority queues are used in Nv2 network.
- nv2Security string
- Specifies Nv2 security mode.
- nv2Sync
Secret string - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail stringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration string - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration numberInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode string - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype string - Specify type of the installed Prism wireless card.
- proprietary
Extensions string - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - radio
Name string - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- rate
Selection string - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set string - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - running boolean
- rx
Chains number[] - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List string - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency string - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile string - Name of profile from security-profiles.
- skip
Dfs stringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid string
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge stringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming string - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates stringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates stringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period numberSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains number[] - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power number - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power stringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats stringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic stringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported stringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id number - VLAN ID to use if doing VLAN tagging.
- vlan
Mode string - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost stringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default stringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default numberCost - Initial bridge port cost of the WDS links.
- wds
Ignore booleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode string - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol string - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support string - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode string - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ str - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive_
noise_ strimmunity - This property is only effective for cards based on Atheros chipset.
- bool
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu_
priorities Sequence[float] - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu_
limit float - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu_
threshold float - Max frame size to allow including in AMSDU.
- antenna_
gain float - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna_
mode str - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area str
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp str
- ARP Mode.
- arp_
timeout str - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band str
- Defines set of used data rates, channel frequencies and widths.
- basic_
rates_ Sequence[str]ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic_
rates_ Sequence[str]bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge_
mode str - Allows to use station-bridge mode.
- burst_
time str - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel_
width str - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment str
- compression bool
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country str
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default_
ap_ floattx_ limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default_
authentication bool - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default_
client_ floattx_ limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default_
forwarding bool - This is the value of forwarding for clients that do not match any entry in the access-list.
- default_
name str - disable_
running_ boolcheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled bool
- disconnect_
timeout str - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance str
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame_
lifetime float - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency str
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency_
mode str - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency_
offset float - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard_
interval str - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide_
ssid bool true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht_
basic_ Sequence[str]mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht_
supported_ Sequence[str]mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw_
fragmentation_ strthreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw_
protection_ strmode - Frame protection support property.
- hw_
protection_ floatthreshold - Frame protection support property read more >>.
- hw_
retries float - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation str
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface_
type str - interface_
wireless_ strid - interworking_
profile str - keepalive_
frames str - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu float
- Layer2 Maximum transmission unit. See.
- mac_
address str - MAC address.
- master_
interface str - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max_
station_ floatcount - Maximum number of associated clients. WDS links also count toward this limit.
- mode str
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu str
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast_
buffering str - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast_
helper str - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name str
- Name of the interface.
- noise_
floor_ strthreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2_
cell_ floatradius - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2_
downlink_ floatratio - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2_
mode str - Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2_
noise_ strfloor_ offset - str
- Specifies preshared key to be used.
- nv2_
qos str - Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2_
queue_ floatcount - Specifies how many priority queues are used in Nv2 network.
- nv2_
security str - Specifies Nv2 security mode.
- nv2_
sync_ strsecret - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on_
fail_ strretry_ time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic_
calibration str - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic_
calibration_ floatinterval - This property is only effective for cards based on Atheros chipset.
- preamble_
mode str - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism_
cardtype str - Specify type of the installed Prism wireless card.
- proprietary_
extensions str - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - radio_
name str - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- rate_
selection str - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate_
set str - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - running bool
- rx_
chains Sequence[float] - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan_
list str - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary_
frequency str - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security_
profile str - Name of profile from security-profiles.
- skip_
dfs_ strchannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid str
- SSID (service set identifier) is a name that identifies wireless network.
- station_
bridge_ strclone_ mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station_
roaming str - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported_
rates_ strag - List of supported rates, used for all bands except 2ghz-b.
- supported_
rates_ strb - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma_
period_ floatsize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx_
chains Sequence[float] - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx_
power float - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx_
power_ strmode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update_
stats_ strinterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht_
basic_ strmcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht_
supported_ strmcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan_
id float - VLAN ID to use if doing VLAN tagging.
- vlan_
mode str - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds_
cost_ strrange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds_
default_ strbridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds_
default_ floatcost - Initial bridge port cost of the WDS links.
- wds_
ignore_ boolssid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds_
mode str - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless_
protocol str - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm_
support str - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps_
mode str - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
- ___
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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
ts_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- ___
unset_ String - A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
- adaptive
Noise StringImmunity - This property is only effective for cards based on Atheros chipset.
- Boolean
- Allow WEP Shared Key clients to connect. Note that no authentication is done for these clients (WEP Shared keys are not compared to anything) - they are just accepted at once (if access list allows that).
- ampdu
Priorities List<Number> - Frame priorities for which AMPDU sending (aggregating frames and sending using block acknowledgment) should get negotiated and used. Using AMPDUs will increase throughput, but may increase latency, therefore, may not be desirable for real-time traffic (voice, video). Due to this, by default AMPDUs are enabled only for best-effort traffic.
- amsdu
Limit Number - Max AMSDU that device is allowed to prepare when negotiated. AMSDU aggregation may significantly increase throughput especially for small frames, but may increase latency in case of packet loss due to retransmission of aggregated frame. Sending and receiving AMSDUs will also increase CPU usage.
- amsdu
Threshold Number - Max frame size to allow including in AMSDU.
- antenna
Gain Number - Antenna gain in dBi, used to calculate maximum transmit power according to country regulations.
- antenna
Mode String - Select antenna to use for transmitting and for receiving:
ant-a
- use only 'a'; antennaant-b
- use only 'b'; antennatxa-rxb
- use antenna 'a' for transmitting, antenna 'b' for receiving;rxa-txb
- use antenna 'b' for transmitting, antenna 'a' for receiving. - area String
- Identifies group of wireless networks. This value is announced by AP, and can be matched in connect-list by area-prefix. This is a proprietary extension.
- arp String
- ARP Mode.
- arp
Timeout String - ARP timeout is time how long ARP record is kept in ARP table after no packets are received from IP. Value auto equals to
the value of arp-timeout in
/ip settings
, default is 30s. - band String
- Defines set of used data rates, channel frequencies and widths.
- basic
Rates List<String>Ags - Similar to the basic-rates-b property, but used for 5ghz, 5ghz-10mhz, 5ghz-5mhz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-onlyg, 2ghz-10mhz, 2ghz-5mhz and 2.4ghz-g-turbo bands.
- basic
Rates List<String>Bs - List of basic rates, used for
2.4ghz-b
,2.4ghz-b/g
and2.4ghz-onlyg
bands.Client will connect to AP only if it supports all basic rates announced by the AP. AP will establish WDS link only if it supports all basic rates of the other AP.This property has effect only in AP modes, and when value of rate-set is configured. - bridge
Mode String - Allows to use station-bridge mode.
- burst
Time String - Time in microseconds which will be used to send data without stopping. Note that no other wireless cards in that network will be able to transmit data during burst-time microseconds. This setting is available only for AR5000, AR5001X, and AR5001X+ chipset based cards.
- channel
Width String - Use of extension channels (e.g.
C
e,eC
etc) allows additional 20MHz extension channels and if it should be located below or above the control (main) channel. Extension channel allows 802.11n devices to use up to 40MHz (802.11ac up to 160MHz) of spectrum in total thus increasing max throughput. Channel widths withXX
andXXXX
extensions automatically scan for a less crowded control channel frequency based on the number of concurrent devices running in every frequency and chooses theC
- Control channel frequency automatically. - comment String
- compression Boolean
- Setting this property to yes will allow the use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
- country String
- Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of scan-list. Value no_country_set is an FCC compliant set of channels.
- default
Ap NumberTx Limit - This is the value of ap-tx-limit for clients that do not match any entry in the access-list. 0 means no limit.
- default
Authentication Boolean - For AP mode, this is the value of authentication for clients that do not match any entry in the access-list. For station mode, this is the value of connect for APs that do not match any entry in the connect-list.
- default
Client NumberTx Limit - This is the value of
client-tx-limit
for clients that do not match any entry in the access-list. 0 means no limit. - default
Forwarding Boolean - This is the value of forwarding for clients that do not match any entry in the access-list.
- default
Name String - disable
Running BooleanCheck - When set to yes interface will always have running flag. If value is set to no', the router determines whether the card is up and running - for AP one or more clients have to be registered to it, for station, it should be connected to an AP.
- disabled Boolean
- disconnect
Timeout String - This interval is measured from third sending failure on the lowest data rate. At this point
3 * (hw-retries + 1)
frame transmits on the lowest data rate had failed. During disconnect-timeout packet transmission will be retried with on-fail-retry-time interval. If no frame can be transmitted successfully during disconnect-timeout, the connection is closed, and this event is logged asextensive data loss
. Successful frame transmission resets this timer. - distance String
- How long to wait for confirmation of unicast frames (ACKs) before considering transmission unsuccessful, or in short
ACK-Timeout. Distance value has these behaviors: * Dynamic - causes AP to detect and use the smallest timeout that works
with all connected clients. * Indoor - uses the default ACK timeout value that the hardware chip manufacturer has set. *
Number - uses the input value in formula:
ACK-timeout = ((distance * 1000) + 299) / 300 us
Acknowledgments are not used in Nstreme/NV2 protocols. - frame
Lifetime Number - Discard frames that have been queued for sending longer than frame-lifetime. By default, when value of this property is 0, frames are discarded only after connection is closed.
- frequency String
- Channel frequency value in MHz on which AP will operate. Allowed values depend on the selected band, and are restricted
by country setting and wireless card capabilities. This setting has no effect if interface is in any of station modes,
or in wds-slave mode, or if DFS is active.Note: If using mode
superchannel
. - frequency
Mode String - Three frequency modes are available: * regulatory-domain - Limit available channels and maximum transmit power for each
channel according to the value of country * manual-txpower - Same as above, but do not limit maximum transmit power
*
superchannel
- Conformance Testing Mode. Allow all channels supported by the card. List of available channels for each band can be seen in/interface wireless
info allowed-channels. This mode allows you to test wireless channels outside the default scan-list and/or regulatory domain. This mode should only be used in controlled environments, or if you have special permission to use it in your region. Before v4.3 this was called Custom Frequency Upgrade, or Superchannel. Since RouterOS v4.3 this mode is available without special key upgrades to all installations. - frequency
Offset Number - Allows to specify offset if the used wireless card operates at a different frequency than is shown in RouterOS, in case a frequency converter is used in the card. So if your card works at 4000MHz but RouterOS shows 5000MHz, set offset to 1000MHz and it will be displayed correctly. The value is in MHz and can be positive or negative.
- guard
Interval String - Whether to allow use of short guard interval (refer to 802.11n MCS specification to see how this may affect throughput).
any
will use either short or long, depending on data rate,long
will use long. - hide
Ssid Boolean true
- AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.false
- AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.This property has an effect only in AP mode. Setting it to yes can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve the security of the wireless network, because SSID is included in other frames sent by the AP.- ht
Basic List<String>Mcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11n for MCS specification.
- ht
Supported List<String>Mcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11n for MCS specification.
- hw
Fragmentation StringThreshold - Specifies maximum fragment size in bytes when transmitted over the wireless medium. 802.11 standard packet (MSDU in 802.11 terminologies) fragmentation allows packets to be fragmented before transmitting over a wireless medium to increase the probability of successful transmission (only fragments that did not transmit correctly are retransmitted). Note that transmission of a fragmented packet is less efficient than transmitting unfragmented packet because of protocol overhead and increased resource usage at both - transmitting and receiving party.
- hw
Protection StringMode - Frame protection support property.
- hw
Protection NumberThreshold - Frame protection support property read more >>.
- hw
Retries Number - Number of times sending frame is retried without considering it a transmission failure. Data-rate is decreased upon failure and the frame is sent again. Three sequential failures on the lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, the frame is sent again. The frame is being retransmitted until transmission success, or until the client is disconnected after disconnect-timeout. The frame can be discarded during this time if frame-lifetime is exceeded.
- installation String
- Adjusts scan-list to use indoor, outdoor or all frequencies for the country that is set.
- interface
Type String - interface
Wireless StringId - interworking
Profile String - keepalive
Frames String - Applies only if wireless interface is in
mode = ap-bridge
. If a client has not communicated for around 20 seconds, AP sends akeepalive-frame
. Note, disabling the feature can lead toghost
clients in registration-table. - l2mtu Number
- Layer2 Maximum transmission unit. See.
- mac
Address String - MAC address.
- master
Interface String - Name of wireless interface that has virtual-ap capability. Virtual AP interface will only work if master interface is in ap-bridge, bridge, station or wds-slave mode. This property is only for virtual AP interfaces.
- max
Station NumberCount - Maximum number of associated clients. WDS links also count toward this limit.
- mode String
- Selection between different station and access point (AP) modes. * Station modes:
station
- Basic station mode. Find and connect to acceptable AP.station-wds
- Same as station, but create WDS link with AP, using proprietary extension. AP configuration has to allow WDS links with this device. Note that this mode does not use entries in wds.station-pseudobridge
- Same as station, but additionally perform MAC address translation of all traffic. Allows interface to be bridged.station-pseudobridge-clone
- Same as station-pseudobridge, but use station-bridge-clone-mac address to connect to AP.station-bridge
- Provides support for transparent protocol-independent L2 bridging on the station device. RouterOS AP accepts clients in station-bridge mode when enabled using bridge-mode parameter. In this mode, the AP maintains a forwarding table with information on which MAC addresses are reachable over which station device. Only works with RouterOS APs. With station-bridge mode, it is not possible to connect to CAPsMAN controlled CAP.- AP modes:
ap-bridge
- Basic access point mode.bridge
- Same as ap-bridge, but limited to one associated client.wds-slave
- Same as ap-bridge, but scan for AP with the same ssid and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If dfs-mode is radar-detect, then APs with enabled hide-ssid will not be found during scanning. * Special modes:alignment-only
- Put the interface in a continuous transmit mode that is used for aiming the remote antenna.nstreme-dual-slave
- allow this interface to be used in nstreme-dual setup. MAC address translation in pseudobridge modes works by inspecting packets and building a table of corresponding IP and MAC addresses. All packets are sent to AP with the MAC address used by pseudobridge, and MAC addresses of received packets are restored from the address translation table. There is a single entry in the address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. Note: Currently IPv6 doesn't work over Pseudobridge.
- AP modes:
- mtu String
- Layer3 Maximum transmission unit ('auto', 0 .. 65535)
- multicast
Buffering String - For a client that has power saving, buffer multicast packets until next beacon time. A client should wake up to receive a beacon, by receiving beacon it sees that there are multicast packets pending, and it should wait for multicast packets to be sent.
- multicast
Helper String - When set to full, multicast packets will be sent with a unicast destination MAC address, resolving multicast problem on the wireless link. This option should be enabled only on the access point, clients should be configured in station-bridge mode. Available starting from v5.15.disabled - disables the helper and sends multicast packets with multicast destination MAC addressesdhcp - dhcp packet mac addresses are changed to unicast mac addresses prior to sending them outfull - all multicast packet mac address are changed to unicast mac addresses prior to sending them outdefault - default choice that currently is set to dhcp. Value can be changed in future releases.
- name String
- Name of the interface.
- noise
Floor StringThreshold - For advanced use only, as it can badly affect the performance of the interface. It is possible to manually set noise floor threshold value. By default, it is dynamically calculated. This property also affects received signal strength. This property is only effective on non-AC chips.
- nv2Cell
Radius Number - Setting affects the size of contention time slot that AP allocates for clients to initiate connection and also size of
time slots used for estimating distance to client. When setting is too small, clients that are farther away may have
trouble connecting and/or disconnect with
ranging timeout
error. Although during normal operation the effect of this setting should be negligible, in order to maintain maximum performance, it is advised to not increase this setting if not necessary, so AP is not reserving time that is actually never used, but instead allocates it for actual data transfer.on AP: distance to farthest client in kmon station: no effect. - nv2Downlink
Ratio Number - Specifies the Nv2 downlink ratio. Uplink ratio is automatically calculated from the downlink-ratio value. When using dynamic-downlink mode the downlink-ratio is also used when link get fully saturated. Minimum value is 20 and maximum 80.
- nv2Mode String
- Specifies to use dynamic or fixed downlink/uplink ratio.
- nv2Noise
Floor StringOffset - String
- Specifies preshared key to be used.
- nv2Qos String
- Sets the packet priority mechanism, firstly data from high priority queue is sent, then lower queue priority data until 0 queue priority is reached. When link is full with high priority queue data, lower priority data is not sent. Use it very carefully, setting works on APframe-priority - manual setting that can be tuned with Mangle rules.default - default setting where small packets receive priority for best latency.
- nv2Queue
Count Number - Specifies how many priority queues are used in Nv2 network.
- nv2Security String
- Specifies Nv2 security mode.
- nv2Sync
Secret String - Specifies secret key for use in the Nv2 synchronization. Secret should match on Master and Slave devices in order to establish the synced state.
- on
Fail StringRetry Time - After third sending failure on the lowest data rate, wait for specified time interval before retrying.
- periodic
Calibration String - Setting default enables periodic calibration if info default-periodic-calibration property is enabled. Value of that property depends on the type of wireless card. This property is only effective for cards based on Atheros chipset.
- periodic
Calibration NumberInterval - This property is only effective for cards based on Atheros chipset.
- preamble
Mode String - Short preamble mode is an option of 802.11b standard that reduces per-frame overhead.On AP: * long - Do not use short preamble. * short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. * both - Announce short preamble capability. On station: *long - do not use short preamble. * short - do not connect to AP if it does not support short preamble. * both - Use short preamble if AP supports it.
- prism
Cardtype String - Specify type of the installed Prism wireless card.
- proprietary
Extensions String - RouterOS includes proprietary information in an information element of management frames. This parameter controls how
this information is included.
pre-2.9.25
- This is older method. It can interoperate with newer versions of RouterOS. This method is incompatible with some clients, for example, Centrino based ones.post-2.9.25
- This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. - radio
Name String - Descriptive name of the device, that is shown in registration table entries on the remote devices. This is a proprietary extension.
- rate
Selection String - Starting from v5.9 default value is advanced since legacy mode was inefficient.
- rate
Set String - Two options are available:
default
- default basic and supported rate sets are used. Values from basic-rates and supported-rates parameters have no effect.configured
- use values from basic-rates, supported-rates, basic-mcs, mcs. - running Boolean
- rx
Chains List<Number> - Which antennas to use for receive. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- scan
List String - The default value is all channels from selected band that are supported by card and allowed by the country and frequency-mode settings (this list can be seen in info). For default scan list in 5ghz band channels are taken with 20MHz step, in 5ghz-turbo band - with 40MHz step, for all other bands - with 5MHz step. If scan-list is specified manually, then all matching channels are taken. (Example: scan-list=default,5200-5245,2412-2427 - This will use the default value of scan list for current band, and add to it supported frequencies from 5200-5245 or 2412-2427 range.) Since RouterOS v6.0 with Winbox or Webfig, for inputting of multiple frequencies, add each frequency or range of frequencies into separate multiple scan-lists. Using a comma to separate frequencies is no longer supported in Winbox/Webfig since v6.0.Since RouterOS v6.35 (wireless-rep) scan-list support step feature where it is possible to manually specify the scan step. Example: scan-list=5500-5600:20 will generate such scan-list values 5500,5520,5540,5560,5580,5600.
- secondary
Frequency String - Specifies secondary channel, required to enable 80+80MHz transmission. To disable 80+80MHz functionality, set secondary-frequency to `` or unset the value via CLI/GUI.
- security
Profile String - Name of profile from security-profiles.
- skip
Dfs StringChannels - These values are used to skip all DFS channels or specifically skip DFS CAC channels in range 5600-5650MHz which detection could go up to 10min.
- ssid String
- SSID (service set identifier) is a name that identifies wireless network.
- station
Bridge StringClone Mac - This property has effect only in the station-pseudobridge-clone mode.Use this MAC address when connection to AP. If this value is 00:00:00:00:00:00, station will initially use MAC address of the wireless interface.As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address.
- station
Roaming String - Station Roaming feature is available only for 802.11 wireless protocol and only for station modes.
- supported
Rates StringAg - List of supported rates, used for all bands except 2ghz-b.
- supported
Rates StringB - List of supported rates, used for
2ghz-b,
2ghz-b/gand
2ghz-b/g/n` bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of rate-set is configured. - tdma
Period NumberSize - Specifies TDMA period in milliseconds. It could help on the longer distance links, it could slightly increase bandwidth, while latency is increased too.
- tx
Chains List<Number> - Which antennas to use for transmitting. In current MikroTik routers, both RX and TX chain must be enabled, for the chain to be enabled.
- tx
Power Number - For 802.11ac wireless interface it's total power but for 802.11a/b/g/n it's power per chain.
- tx
Power StringMode - Sets up tx-power mode for wireless card
default
- use values stored in the cardall-rates-fixed
- use same transmit power for all data rates. Can damage the card if transmit power is set above rated value of the card for used rate.manual-table
- define transmit power for each rate separately. Can damage the card if transmit power is set above rated value of the card for used rate.card-rates
- use transmit power calculated for each rate based on value of tx-power parameter. Legacy mode only compatible with currently discontinued products. - update
Stats StringInterval - How often to request update of signals strength and ccq values from clients. Access to registration-table also triggers update of these values.This is proprietary extension.
- vht
Basic StringMcs - Modulation and Coding Schemes that every connecting client must support. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - client must support MCS-0 to MCS-7; * mcs0-8 - client must support MCS-0 to MCS-8; * mcs0-9 - client must support MCS-0 to MCS-9.
- vht
Supported StringMcs - Modulation and Coding Schemes that this device advertises as supported. Refer to 802.11ac for MCS specification. You can set MCS interval for each of Spatial Stream * none - will not use selected; * mcs0-7 - devices will advertise as supported MCS-0 to MCS-7; * mcs0-8 - devices will advertise as supported MCS-0 to MCS-8; * mcs0-9 - devices will advertise as supported MCS-0 to MCS-9.
- vlan
Id Number - VLAN ID to use if doing VLAN tagging.
- vlan
Mode String - VLAN tagging mode specifies if traffic coming from client should get tagged (and untagged when going to client).
- wds
Cost StringRange - Bridge port cost of WDS links are automatically adjusted, depending on measured link throughput. Port cost is recalculated and adjusted every 5 seconds if it has changed by more than 10%, or if more than 20 seconds have passed since the last adjustment.Setting this property to 0 disables automatic cost adjustment.Automatic adjustment does not work for WDS links that are manually configured as a bridge port.
- wds
Default StringBridge - When WDS link is established and status of the wds interface becomes running, it will be added as a bridge port to the bridge interface specified by this property. When WDS link is lost, wds interface is removed from the bridge. If wds interface is already included in a bridge setup when WDS link becomes active, it will not be added to bridge specified by , and will (needs editing).
- wds
Default NumberCost - Initial bridge port cost of the WDS links.
- wds
Ignore BooleanSsid - By default, WDS link between two APs can be created only when they work on the same frequency and have the same SSID value. If this property is set to yes, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in station-wds mode. It also does not work if wds-mode is static-mesh or dynamic-mesh.
- wds
Mode String - Controls how WDS links with other devices (APs and clients in station-wds mode) are established. * disabled does not allow WDS links. * static only allows WDS links that are manually configured in WDS. * dynamic also allows WDS links with devices that are not configured in WDS, by creating required entries dynamically. Such dynamic WDS entries are removed automatically after the connection with the other AP is lost. * -mesh modes use different (better) method for establishing link between AP, that is not compatible with APs in non-mesh mode. This method avoids one-sided WDS links that are created only by one of the two APs. Such links cannot pass any data.When AP or station is establishing WDS connection with another AP, it uses connect-list to check whether this connection is allowed. If station in station-wds mode is establishing connection with AP, AP uses access-list to check whether this connection is allowed.If mode is station-wds, then this property has no effect.
- wireless
Protocol String - Specifies protocol used on wireless interface; * unspecified - protocol mode used on previous RouterOS versions (v3.x, v4.x). Nstreme is enabled by old enable-nstreme setting, Nv2 configuration is not possible. * any : on AP - regular 802.11 Access Point or Nstreme Access Point; on station - selects Access Point without specific sequence, it could be changed by connect-list rules. * nstreme - enables Nstreme protocol (the same as old enable-nstreme setting). * nv2 - enables Nv2 protocol. * nv2 nstreme : on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point. * nv2 nstreme 802.11 - on AP - uses first wireless-protocol setting, always Nv2; on station - searches for Nv2 Access Point, then for Nstreme Access Point, then for regular 802.11 Access Point.Warning! Nv2 doesn't have support for Virtual AP.
- wmm
Support String - Specifies whether to enable WMM. Only applies to bands
B
andG
. Other bands will have it enabled regardless of this setting. - wps
Mode String - WPS Server allows to connect wireless clients that support WPS to AP protected with the Pre-Shared Key without specifying that key in the clients configuration.
Import
#The ID can be found via API or the terminal
#The command for the terminal is -> :put [/interface/wireless get [print show-ids]]
$ pulumi import routeros:index/interfaceWireless:InterfaceWireless test *3
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.