Manual:Interface/Wireless: Difference between revisions
mNo edit summary |
moving content |
||
Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
= | <div class="properties"> | ||
<h3>Basic settings</h3> | |||
<h5><var>master-interface</var></h5> | |||
<br><strong>Syntax: </strong> | |||
interface name | |||
<br><strong>Description: </strong> | |||
Name of wireless interface that has <i>virtual-ap</i> capability. | |||
<br>Virtual AP interface will only work if master interface is in <i>ap-bridge</i>, <i>bridge</i> or <i>wds-slave</i> mode. | |||
<br>This property is only for virtual AP interfaces. | |||
Special modes: | <h5><var>mode</var></h5> | ||
<br><strong>Syntax: </strong> | |||
One of <i>station</i>, <i>station-wds</i>, <i>ap-bridge</i>, <i>bridge</i>, <i>alignment-only</i>, <i>nstreme-dual-slave,</i> <i>wds-slave</i>, <i>station-pseudobridge</i> or <i>station-pseudobridge-clone</i> | |||
<br><strong>Default value: </strong> | |||
station | |||
<br><strong>Description: </strong> | |||
<br>Station modes:<ul> | |||
<li><i>station</i> - Basic station mode. Find and connect to acceptable AP. | |||
<li><i>station-wds</i> - Same as <i>station</i>, 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]]. | |||
<li><i>station-pseudobridge</i> - Same as <i>station</i>, but additionally perform MAC address translation of all traffic. Allows interface to be bridged. | |||
<li><i>station-pseudobridge-clone</i> - Same as <i>station-pseudobridge</i>, but use <var>station-bridge-clone-mac</var> address to connect to AP. | |||
</ul> | |||
<br>AP modes:<ul> | |||
<li><i>ap-bridge</i> - Basic access point mode. | |||
<li><i>bridge</i> - Same as <i>ap-bridge</i>, but limited to one associated client. | |||
<li><i>wds-slave</i> - Same as <i>ap-bridge</i>, but scan for AP with the same <var>ssid</var> and establishes WDS link. If this link is lost or cannot be established, then continue scanning. If <var>dfs-mode</var> is <i>radar-detect</i>, then APs with enabled <var>hide-ssid</var> will not be found during scanning. | |||
</ul> | |||
<br>Special modes:<ul> | |||
<li><i>alignment-only</i> - Put interface in a continuous transmit mode that is used for aiming remote antenna. | |||
<li><i>nstreme-dual-slave</i> - allow this interface to be used in nstreme-dual setup. | |||
</ul> | |||
<br>MAC address translation in pseudobridge modes works by inspecting packets and building 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 single entry in address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols. | |||
<br>Virtual AP interfaces do not have this property, they follow the <var>mode</var> of their master interface. | |||
<h5><var>ssid</var></h5> | |||
<br><strong>Syntax: </strong> | |||
text, up to 32 characters long | |||
<br><strong>Default value: </strong> | |||
value of [[system/identity]] | |||
<br><strong>Description: </strong> | |||
SSID (service set identifier) is a name that identifies wireless network. | |||
<h5><var>frequency</var></h5> | |||
<br><strong>Syntax: </strong> | |||
Frequency value in MHz. | |||
<br><strong>Description: </strong> | |||
Channel frequency on which AP will operate. | |||
Allowed values depend on selected band, and are restricted by <var>country</var> setting and wireless card capabilities. | <br>Allowed values depend on selected band, and are restricted by <var>country</var> 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. | This setting has no effect if interface is in any of station modes, or in 'wds-slave' mode, or if DFS is active. | ||
<h5><var>band</var></h5> | |||
<br><strong>Syntax: </strong> | |||
one of <i>2.4ghz-b</i>, <i>5ghz</i>, <i>5ghz-turbo</i>, <i>2.4ghz-b/g</i>, <i>2.4ghz-g-turbo</i>, <i>5ghz-10mhz</i>, <i>5ghz-5mhz</i>, <i>2ghz-10mhz</i>, <i>2ghz-5mhz</i>, <i>5ghz-11n</i>, <i>2ghz-11n</i>, <i>2.4ghz-onlyg</i> | |||
<h5><var>scan-list</var></h5> | |||
<br><strong>Syntax: </strong> | |||
comma separated list of frequencies and frequency ranges, or <i>default</i> | |||
<br><strong>Description: </strong> | |||
The <i>default</i> value is all channels from selected band that are supported by card and allowed by the <var>country</var> and <var>frequency-mode</var> settings (this list can be seen in [[info]]). For default scan list in <i>5ghz</i> band channels are taken with 20MHz step, in <i>5ghz-turbo</i> band - with 40MHz step, for all other bands - with 5MHz step. If <var>scan-list</var> is specified manually, then all matching channels are taken. | |||
<br><em>Example: </em> | |||
<code>scan-list=default,5200-5245,2412-2427</code> | |||
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. | |||
<h5><var>antenna-mode</var></h5> | |||
<br><strong>Syntax: </strong> | |||
one of these values:<ul> | |||
<li><i>ant-a</i> - use only 'a' antenna | |||
<li><i>ant-b</i> - use only 'b' antenna | |||
<li><i>txa-rxb</i> - use antenna 'a' for transmitting, antenna 'b' for receiving | |||
<li><i>rxa-txb</i> - use antenna 'b' for transmitting, antenna 'a' for receiving | |||
</ul> | |||
<h5><var>wds-mode</var></h5> | |||
<br><strong>Syntax: </strong> | |||
one of <i>disabled</i>, <i>static</i>, <i>dynamic</i>, <i>static-mesh</i> or <i>dynamic-mesh</i> | |||
<br><strong>Description: </strong> | |||
Controls how WDS links with other devices (APs and clients in <i>station-wds</i> mode) are established.<ul> | |||
<li><i>disabled</i> does not allow WDS links. | |||
<li><i>static</i> only allows WDS links that are manually configured in [[wds]] | |||
<li><i>dynamic</i> 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. | |||
</ul> | |||
<br>"<i>-mesh</i>" 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. | |||
<br>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 <i>station-wds</i> mode is establishing connection with AP, AP uses [[access-list]] to check whether this connection is allowed. | |||
<br>If <var>mode</var> is <i>station-wds</i>, then this property has no effect. | |||
<h5><var>wds-default-bridge</var></h5> | |||
<br><strong>Syntax: </strong> | |||
<i>none</i>, or name of bridge interface | |||
<br><strong>Description: </strong> | |||
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. | |||
<br>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 | |||
<h5><var>wds-ignore-ssid</var></h5> | |||
<br><strong>Syntax: </strong> | |||
<i>yes</i> or <i>no</i> | |||
<br><strong>Default value: </strong> | |||
<i>no</i> | |||
<br><strong>Description: </strong> | |||
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 <i>yes</i>, then SSID of the remote AP will not be checked. This property has no effect on connections from clients in <i>station-wds</i> mode. It also does not work if <var>wds-mode</var> is <i>static-mesh</i> or <i>dynamic-mesh</i>. | |||
<h5><var>default-authentication</var></h5> | |||
Antenna gain in dBi, used to calculate maximum transmit power according to <var>country</var> limitations. | <br><strong>Syntax: </strong> | ||
<i>yes</i> or <i>no</i> | |||
<table class=infobox><caption>Default basic and supported rates, depending on selected band</caption> | <br><strong>Default value: </strong> | ||
<i>yes</i> | |||
<tr><td>2.4ghz-b<td>1<td>1 .. 11 | <br><strong>Description: </strong> | ||
<tr><td>5ghz<td>6<td>6 .. 54 | For AP mode, this is the value of <var>authentication</var> for clients that do not match any entry in the [[access-list]]. For station mode, this is the value of <var>connect</var> for APs that do not match any entry in the [[connect-list]]. | ||
<tr><td>2.4ghz-onlyg<td>6<td>1 .. 11 and 6 .. 54 | |||
<tr><td>2.4ghz-b/g<td>1 .. 11<td>1 .. 11 and 6 .. 54 | <h5><var>default-forwarding</var></h5> | ||
<tr><td>2.4ghz-g-turbo<td>6<td>6 .. 54 | <br><strong>Syntax: </strong> | ||
<i>yes</i> or <i>no</i> | |||
<br><strong>Default value: </strong> | |||
<i>yes</i> | |||
<br><strong>Description: </strong> | |||
This is the value of <var>forwarding</var> for clients that do not match any entry in the [[access-list]]. | |||
<h5><var>default-ap-tx-limit</var></h5> | |||
<br><strong>Description: </strong> | |||
This is the value of <var>ap-tx-limit</var> for clients that do not match any entry in the [[access-list]]. | |||
<h5><var>default-client-tx-limit</var></h5> | |||
<br><strong>Description: </strong> | |||
This is the value of <var>client-tx-limit</var> for clients that do not match any entry in the [[access-list]]. | |||
<h5><var>hide-ssid</var></h5> | |||
<br><strong>Syntax: </strong> | |||
<i>yes</i> or <i>no</i> | |||
<br><strong>Default value: </strong> | |||
<i>no</i> | |||
<br><strong>Description: </strong><ul> | |||
<li><i>yes</i> - AP does not include SSID the beacon frames, and does not reply to probe requests that have broadcast SSID. | |||
<li><i>no</i> - AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID. | |||
</ul> | |||
<br>This property has effect only in AP mode. Setting it to <i>yes</i> can remove this network from the list of wireless networks that are shown by some client software. Changing this setting does not improve security of the wireless network, because SSID is included in other frames sent by the AP. | |||
<h5><var>security-profile</var></h5> | |||
<br><strong>Syntax: </strong> | |||
name of profile from [[security-profiles]] | |||
<h5><var>compression</var></h5> | |||
<br><strong>Syntax: </strong> | |||
<i>yes</i> or <i>no</i> | |||
<br><strong>Default value: </strong> | |||
<i>no</i> | |||
<br><strong>Description: </strong> | |||
Setting this property to <i>yes</i> will allow use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work. | |||
<h5><var>interface-type</var></h5> | |||
<br><strong>Syntax: </strong> | |||
<i>virtual-AP</i>, <i>Prism</i>, or <i>Atheros <em>model_name</em></i> | |||
<br><strong>Read-only property</strong> | |||
<br><strong>Description: </strong> | |||
This specifies type of wireless interface. Some properties have meaning only for certain types of interfaces. | |||
<h3>Advanced settings</h3> | |||
<h5><var>frequency-mode</var></h5> | |||
<br><strong>Syntax: </strong> | |||
one of these values:<ul> | |||
<li><i>regulatory-domain</i> - Limit available channels and maximum transmit power for each channel according to the value of <var>country</var> | |||
<li><i>manual-txpower</i> - Same as above, but do not limit maximum transmit power. | |||
<li><i>superchannel</i> - Allow all channels supported by the card. | |||
</ul> | |||
<br><strong>Description: </strong> | |||
List of available channels for each band can be seen in [[info]]. | |||
<h5><var>country</var></h5> | |||
<br><strong>Syntax: </strong> | |||
either <i>no_country_set</i>, or name of regulatory domain | |||
<br><strong>Description: </strong> | |||
Limits available bands, frequencies and maximum transmit power for each frequency. Also specifies default value of <var>scan-list</var>. Value <i>no_country_set</i> is an FCC compliant set of channels. | |||
<h5><var>antenna-gain</var></h5> | |||
<br><strong>Default value: </strong> | |||
<i>0</i> | |||
<br><strong>Description: </strong> | |||
<br>Antenna gain in dBi, used to calculate maximum transmit power according to <var>country</var> limitations. | |||
<table class="infobox"> | |||
<caption>Default basic and supported rates, depending on selected band</caption> | |||
<tr><th>band<th>basic rates<th>supported rates | |||
<tr><td>2.4ghz-b<td>1<td>1 .. 11 | |||
<tr><td>5ghz<td>6<td>6 .. 54 | |||
<tr><td>2.4ghz-onlyg<td>6<td>1 .. 11 and 6 .. 54 | |||
<tr><td>2.4ghz-b/g<td>1 .. 11<td>1 .. 11 and 6 .. 54 | |||
<tr><td>2.4ghz-g-turbo<td>6<td>6 .. 54 | |||
</table> | </table> | ||
Client will connect to AP only if it supports all basic rates announced by the AP. | <h5><var>rate-set</var></h5> | ||
<br><strong>Syntax: </strong> | |||
<i>default</i> or <i>configured</i> | |||
<br><strong>Description: </strong><ul> | |||
<li><i>default</i> - default basic and supported rate sets are used. Values from <var>basic-rates</var> and <var>supported-rates</var> parameters have no effect. | |||
<li><i>configured</i> - use values from <var>basic-rates</var> and <var>supported-rates</var> parameters. Note that g mode bands use rates from both "<var>rates-b</var>" and "<var>rates-a/g</var>" properties. | |||
</ul> | |||
<h5><var>supported-rates-b</var></h5> | |||
<br><strong>Description: </strong> | |||
<br>List of supported rates, used for <i>2.4ghz-b</i>, <i>2.4ghz-b/g</i> and <i>2.4ghz-onlyg</i> bands. Two devices will communicate only using rates that are supported by both devices. This property has effect only when value of <var>rate-set</var> is <i>configured</i>. | |||
<h5><var>supported-rates-a/g</var></h5> | |||
<br><strong>Description: </strong> | |||
<br>Similar to the above 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. | |||
<h5>basic-rates-b</h5> | |||
<br><strong>Description: </strong> | |||
<br>List of basic rates, used for 2.4ghz-b, 2.4ghz-b/g and 2.4ghz-onlyg bands. | |||
<br>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. | 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 <var>rate-set</var> is 'configured'. | This property has effect only in AP modes, and when value of <var>rate-set</var> is 'configured'. | ||
<h5>basic-rates-a/g</h5> | |||
<br><strong>Description: </strong> | |||
Similar to the above 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. | <br>Similar to the above 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. | ||
<h5>max-station-count</h5> | |||
<br><strong>Syntax: </strong> | |||
1..2007 | |||
How long to wait for confirmation of unicast frames before considering transmission unsuccessful. Value 'dynamic' causes AP to detect and use smallest timeout that works with all connected clients. | <br><strong>Default value: </strong> | ||
2007 | |||
<br><strong>Description: </strong> | |||
Maximum number of associated clients. WDS links also count toward this limit. | |||
<h5>ack-timeout</h5> | |||
<br><strong>Syntax: </strong> | |||
'indoors', 'dynamic', or value in microseconds | |||
<br><strong>Description: </strong> | |||
<br>How long to wait for confirmation of unicast frames before considering transmission unsuccessful. Value 'dynamic' causes AP to detect and use smallest timeout that works with all connected clients. | |||
Acknowledgements are not used in Nstreme protocol. | Acknowledgements are not used in Nstreme protocol. | ||
<h5>tx-power</h5> | |||
<br><strong>Syntax: </strong> | |||
value in the -30..30 range</p></div> | |||
<h5>tx-power-mode</h5> | |||
<br><strong>Syntax: </strong> | |||
one of these values:<ul> | |||
<li>default - | |||
<li>all-rates-fixed - | |||
<li>card-rates - | |||
<li>manual-table - | |||
Controls DFS (Dynamic Frequency Selection). | </ul> | ||
<h5>dfs-mode</h5> | |||
<br><strong>Syntax: </strong> | |||
one of 'none', 'no-radar-detect' and 'radar-detect' | |||
<br><strong>Default value: </strong> | |||
This property has effect only in AP mode. | none | ||
<br><strong>Description: </strong> | |||
<br>Controls DFS (Dynamic Frequency Selection).<ul> | |||
<li>none - disables DFS. | |||
<li>no-radar-detect - Select channel from <var>scan-list</var> with the lowest number of detected networks. In 'wds-slave' mode this setting has no effect. | |||
<li>radar-detect - Select channel with the lowest number of detected networks and use it if no radar is detected on it for 60 seconds. Otherwise, select different channel. This setting may be required by the country regulations. | |||
</ul> | |||
<br>This property has effect only in AP mode. | |||
<h5>wds-default-cost</h5> | |||
<br><strong>Syntax: </strong> | |||
Number | |||
<br><strong>Default value: </strong> | |||
100 | |||
<br><strong>Description: </strong> | |||
Initial bridge port cost of the WDS links. | Initial bridge port cost of the WDS links. | ||
<h5>wds-cost-range</h5> | |||
<br><strong>Syntax: </strong> | |||
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. | Numeric range | ||
<br><strong>Default value: </strong> | |||
50-150 | |||
<br><strong>Description: </strong> | |||
<br>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. | 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. | Automatic adjustment does not work for WDS links that are manually configured as a bridge port. | ||
<h5>wmm-support</h5> | |||
<br><strong>Syntax: </strong> | |||
'disabled', 'enabled' or 'required' | |||
This interval is measured from third sending failure on the lowest data rate. At this point 3 * (<var>hw-retries</var> + 1) frame transmits on the lowest data rate had failed. | <h5>disconnect-timeout</h5> | ||
<br><strong>Syntax: </strong> | |||
time interval in the 0..15s range, in units of 10ms | |||
<br><strong>Default value: </strong> | |||
3s | |||
<br><strong>Description: </strong> | |||
<br>This interval is measured from third sending failure on the lowest data rate. At this point 3 * (<var>hw-retries</var> + 1) frame transmits on the lowest data rate had failed. | |||
During <var>disconnect-timeout</var> packet transmission will be retried with <var>on-fail-retry-time</var> interval. If no frame can be transmitted successfully during <var>diconnect-timeout</var>, connection is closed, and this event is logged as "extensive data loss". Successful frame transmission resets this timer. | During <var>disconnect-timeout</var> packet transmission will be retried with <var>on-fail-retry-time</var> interval. If no frame can be transmitted successfully during <var>diconnect-timeout</var>, connection is closed, and this event is logged as "extensive data loss". Successful frame transmission resets this timer. | ||
<h5>on-fail-retry-time</h5> | |||
<br><strong>Syntax: </strong> | |||
time interval in the 10ms..1s range, in 10ms units | |||
<br><strong>Default value: </strong> | |||
100ms | |||
<br><strong>Description: </strong> | |||
After third sending failure on the lowest data rate, wait for this long before retrying. | After third sending failure on the lowest data rate, wait for this long before retrying. | ||
<h5>frame-lifetime</h5> | |||
<br><strong>Syntax: </strong> | |||
Discard frames that have been queued for sending longer than <var>frame-lifetime</var>. By default, when value of this property is 0, frames are discarded only after connection is closed. | time in hundredths of a second | ||
<br><strong>Default value: </strong> | |||
0 | |||
<br><strong>Description: </strong> | |||
<br>Discard frames that have been queued for sending longer than <var>frame-lifetime</var>. By default, when value of this property is 0, frames are discarded only after connection is closed. | |||
<h5>preamble-mode</h5> | |||
<br><strong>Syntax: </strong> | |||
one of 'long', 'short' or 'both' | |||
<br><strong>Default value: </strong> | |||
both | |||
<br><strong>Description: </strong> | |||
Short preamble mode is an option of 802.11b standard that reduces per-frame overhead. | Short preamble mode is an option of 802.11b standard that reduces per-frame overhead. | ||
On AP: | On AP:<ul> | ||
<li>long - Do not use short preamble. | |||
<li>short - Announce short preamble capability. Do not accept connections from clients that do not have this capability. | |||
<li>both - Announce short preamble capability. | |||
On station: | </ul> | ||
<br>On station:<ul> | |||
<li>long - do not use short preamble. | |||
<li>short - do not connect to AP if it does not support short preamble. | |||
<li>both - Use short preamble if AP supports it. | |||
</ul> | |||
<h5>allow-sharedkey</h5> | |||
<br><strong>Syntax: </strong> | |||
'yes' or 'no' | |||
<br><strong>Default value: </strong> | |||
no | |||
<br><strong>Description: </strong> | |||
Allow WEP Shared Key cilents 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). | |||
<h5>station-bridge-clone-mac</h5> | |||
<br><strong>Syntax: </strong> | |||
MAC address | |||
<br><strong>Description: </strong> | |||
This property has effect only in the 'station-pseudobridge-clone' mode. | This property has effect only in the 'station-pseudobridge-clone' mode. | ||
<br>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. | |||
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. | As soon as packet with MAC address of another device needs to be transmitted, station will reconnect to AP using that address. | ||
<h5>hw-retries</h5> | |||
<br><strong>Syntax: </strong> | |||
Number of times sending frame is retried without considering it a transmission failure. | number 0..15 | ||
<br><strong>Default value: </strong> | |||
15 | |||
<br><strong>Description: </strong> | |||
<br>Number of times sending frame is retried without considering it a transmission failure. | |||
Data rate is decreased upon failure and frame is sent again. Three sequential failures on lowest supported rate suspend transmission to this destination for the duration of <var>on-fail-retry-time</var>. After that, frame is sent again. The frame is being retransmitted until transmission success, or until client is disconnected after <var>disconnect-timeout</var>. Frame can be discarded during this time if <var>frame-lifetime</var> is exceeded. | Data rate is decreased upon failure and frame is sent again. Three sequential failures on lowest supported rate suspend transmission to this destination for the duration of <var>on-fail-retry-time</var>. After that, frame is sent again. The frame is being retransmitted until transmission success, or until client is disconnected after <var>disconnect-timeout</var>. Frame can be discarded during this time if <var>frame-lifetime</var> is exceeded. | ||
<h4>Proprietary extensions</h4> | |||
<h5>radio-name</h5> | |||
<br><strong>Syntax: </strong> | |||
This is a proprietary extension. | Text | ||
<br><strong>Description: </strong> | |||
Descriptive name of the device, that is shown in registration table entries on the remote devices. | |||
Identifies group of wireless networks. This value is announced by AP, and can be matched in [[ | <br>This is a proprietary extension. | ||
<h5>area</h5> | |||
<br><strong>Syntax: </strong> | |||
Text | |||
<br><strong>Default value: </strong> | |||
empty | |||
<br><strong>Description: </strong> | |||
Identifies group of wireless networks. This value is announced by AP, and can be matched in [[connect-list]] by <var>area-prefix</var>. | |||
This is a proprietary extension. | This is a proprietary extension. | ||
<h5>update-stats-interval</h5> | |||
<br><strong>Syntax: </strong> | |||
'disabled' or time interval in the 10s..5h range | |||
<br><strong>Default value: </strong> | |||
disabled | |||
<br><strong>Description: </strong> | |||
How often to request update of signals strength and ccq values from clients. | How often to request update of signals strength and ccq values from clients. | ||
Access to [[ | Access to [[registration-table]] also triggers update of these values. | ||
This is proprietary extension. | This is proprietary extension. | ||
<h5>proprietary-extensions</h5> | |||
<br><strong>Syntax: </strong> | |||
RouterOS includes proprietary information in an information element of management frames. This parameter controls how this information is included. | 'pre-2.9.25' or 'post-2.9.25' | ||
<br><strong>Default value: </strong> | |||
post-2.9.25 | |||
<br><strong>Description: </strong> | |||
RouterOS includes proprietary information in an information element of management frames. This parameter controls how this information is included.</p><ul> | |||
<li>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. | |||
<li>post-2.9.25 - This uses standardized way of including vendor specific information, that is compatible with newer wireless clients. | |||
</ul> | |||
<h4>Atheros specific</h4> | |||
<h5>noise-floor-threshold</h5> | |||
<br><strong>Syntax: </strong> | |||
'default' or value in the -128..127 range | |||
<br><strong>Description: </strong> | |||
This property is only effective for cards based on AR5211 chipset. | This property is only effective for cards based on AR5211 chipset. | ||
<h5>adaptive-noise-immunity</h5> | |||
<br><strong>Syntax: </strong> | |||
'yes' or 'no' | |||
<br><strong>Default value: </strong> | |||
yes | |||
<br><strong>Description: </strong> | |||
This property is only effective for cards based on Atheros chipset. | This property is only effective for cards based on Atheros chipset. | ||
<h5>periodic-calibration</h5> | |||
<br><strong>Syntax: </strong> | |||
Setting 'default' enables periodic calibration if [[ | one of 'default', 'enabled' or 'disabled' | ||
<br><strong>Description: </strong> | |||
Setting 'default' enables periodic calibration if [[info]] <var>default-periodic-calibration</var> 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. | This property is only effective for cards based on Atheros chipset. | ||
<h5>periodic-calibration-interval</h5> | |||
<br><strong>Syntax: </strong> | |||
value in range 1..10000 | |||
<br><strong>Default value: </strong> | |||
60 | |||
<br><strong>Description: </strong> | |||
This property is only effective for cards based on Atheros chipset. | This property is only effective for cards based on Atheros chipset. | ||
<h4>Prism specific</h4> | |||
<h5>prism-cardtype</h5> | |||
<br><strong>Syntax: </strong> | |||
'30mW', '100mW', '200mW' | |||
<br><strong>Description: </strong> | |||
Specify type of the installed wireless card. | |||
{{ManFooter|Reference}} | {{ManFooter|Reference}} |
Revision as of 09:39, 17 September 2008
Basic settings
master-interface
Syntax:
interface name
Description:
Name of wireless interface that has virtual-ap capability.
Virtual AP interface will only work if master interface is in ap-bridge, bridge or wds-slave mode.
This property is only for virtual AP interfaces.
mode
Syntax:
One of station, station-wds, ap-bridge, bridge, alignment-only, nstreme-dual-slave, wds-slave, station-pseudobridge or station-pseudobridge-clone
Default value:
station
Description:
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.
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 interface in a continuous transmit mode that is used for aiming 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 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 single entry in address translation table for all non-IP packets, hence more than one host in the bridged network cannot reliably use non-IP protocols.
Virtual AP interfaces do not have this property, they follow the mode of their master interface.
ssid
Syntax:
text, up to 32 characters long
Default value:
value of system/identity
Description:
SSID (service set identifier) is a name that identifies wireless network.
frequency
Syntax:
Frequency value in MHz.
Description:
Channel frequency on which AP will operate.
Allowed values depend on 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.
band
Syntax:
one of 2.4ghz-b, 5ghz, 5ghz-turbo, 2.4ghz-b/g, 2.4ghz-g-turbo, 5ghz-10mhz, 5ghz-5mhz, 2ghz-10mhz, 2ghz-5mhz, 5ghz-11n, 2ghz-11n, 2.4ghz-onlyg
scan-list
Syntax:
comma separated list of frequencies and frequency ranges, or default
Description:
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.
antenna-mode
Syntax:
- ant-a - use only 'a' antenna
- ant-b - use only 'b' antenna
- txa-rxb - use antenna 'a' for transmitting, antenna 'b' for receiving
- rxa-txb - use antenna 'b' for transmitting, antenna 'a' for receiving
wds-mode
Syntax:
one of disabled, static, dynamic, static-mesh or dynamic-mesh
Description:
- 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.
wds-default-bridge
Syntax:
none, or name of bridge interface
Description:
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
wds-ignore-ssid
Syntax:
yes or no
Default value:
no
Description:
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.
default-authentication
Syntax:
yes or no
Default value:
yes
Description:
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-forwarding
Syntax:
yes or no
Default value:
yes
Description:
This is the value of forwarding for clients that do not match any entry in the access-list.
default-ap-tx-limit
Description:
This is the value of ap-tx-limit for clients that do not match any entry in the access-list.
default-client-tx-limit
Description:
This is the value of client-tx-limit for clients that do not match any entry in the access-list.
hide-ssid
Syntax:
yes or no
Default value:
no
Description:
- yes - AP does not include SSID the beacon frames, and does not reply to probe requests that have broadcast SSID.
- no - AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.
This property has 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 security of the wireless network, because SSID is included in other frames sent by the AP.
security-profile
Syntax:
name of profile from security-profiles
compression
Syntax:
yes or no
Default value:
no
Description:
Setting this property to yes will allow use of the hardware compression. Wireless interface must have support for hardware compression. Connections with devices that do not use compression will still work.
interface-type
Syntax:
virtual-AP, Prism, or Atheros model_name
Read-only property
Description:
This specifies type of wireless interface. Some properties have meaning only for certain types of interfaces.
Advanced settings
frequency-mode
Syntax:
- 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 - Allow all channels supported by the card.
Description:
List of available channels for each band can be seen in info.
country
Syntax:
either no_country_set, or name of regulatory domain
Description:
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.
antenna-gain
Default value:
0
Description:
Antenna gain in dBi, used to calculate maximum transmit power according to country limitations.
band | basic rates | supported rates |
---|---|---|
2.4ghz-b | 1 | 1 .. 11 |
5ghz | 6 | 6 .. 54 |
2.4ghz-onlyg | 6 | 1 .. 11 and 6 .. 54 |
2.4ghz-b/g | 1 .. 11 | 1 .. 11 and 6 .. 54 |
2.4ghz-g-turbo | 6 | 6 .. 54 |
rate-set
Syntax:
default or configured
Description:
- 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 and supported-rates parameters. Note that g mode bands use rates from both "rates-b" and "rates-a/g" properties.
supported-rates-b
Description:
List of supported rates, used for 2.4ghz-b, 2.4ghz-b/g and 2.4ghz-onlyg 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.
supported-rates-a/g
Description:
Similar to the above 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-b
Description:
List of basic rates, used for 2.4ghz-b, 2.4ghz-b/g and 2.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'.
basic-rates-a/g
Description:
Similar to the above 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.
max-station-count
Syntax:
1..2007
Default value:
2007
Description:
Maximum number of associated clients. WDS links also count toward this limit.
ack-timeout
Syntax:
'indoors', 'dynamic', or value in microseconds
Description:
How long to wait for confirmation of unicast frames before considering transmission unsuccessful. Value 'dynamic' causes AP to detect and use smallest timeout that works with all connected clients.
Acknowledgements are not used in Nstreme protocol.
tx-power
Syntax:
tx-power-mode
Syntax:
one of these values:
- default -
- all-rates-fixed -
- card-rates -
- manual-table -
dfs-mode
Syntax:
one of 'none', 'no-radar-detect' and 'radar-detect'
Default value:
none
Description:
Controls DFS (Dynamic Frequency Selection).
- none - disables DFS.
- no-radar-detect - Select channel from scan-list with the lowest number of detected networks. In 'wds-slave' mode this setting has no effect.
- radar-detect - Select channel with the lowest number of detected networks and use it if no radar is detected on it for 60 seconds. Otherwise, select different channel. This setting may be required by the country regulations.
This property has effect only in AP mode.
wds-default-cost
Syntax:
Number
Default value:
100
Description:
Initial bridge port cost of the WDS links.
wds-cost-range
Syntax:
Numeric range
Default value:
50-150
Description:
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.
wmm-support
Syntax:
'disabled', 'enabled' or 'required'
disconnect-timeout
Syntax:
time interval in the 0..15s range, in units of 10ms
Default value:
3s
Description:
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 diconnect-timeout, connection is closed, and this event is logged as "extensive data loss". Successful frame transmission resets this timer.
on-fail-retry-time
Syntax:
time interval in the 10ms..1s range, in 10ms units
Default value:
100ms
Description:
After third sending failure on the lowest data rate, wait for this long before retrying.
frame-lifetime
Syntax:
time in hundredths of a second
Default value:
0
Description:
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.
preamble-mode
Syntax:
one of 'long', 'short' or 'both'
Default value:
both
Description:
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.
Syntax:
'yes' or 'no'
Default value:
no
Description:
Allow WEP Shared Key cilents 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).
station-bridge-clone-mac
Syntax:
MAC address
Description:
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.
hw-retries
Syntax:
number 0..15
Default value:
15
Description:
Number of times sending frame is retried without considering it a transmission failure.
Data rate is decreased upon failure and frame is sent again. Three sequential failures on lowest supported rate suspend transmission to this destination for the duration of on-fail-retry-time. After that, frame is sent again. The frame is being retransmitted until transmission success, or until client is disconnected after disconnect-timeout. Frame can be discarded during this time if frame-lifetime is exceeded.
Proprietary extensions
radio-name
Syntax:
Text
Description:
Descriptive name of the device, that is shown in registration table entries on the remote devices.
This is a proprietary extension.
area
Syntax:
Text
Default value:
empty
Description:
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.
update-stats-interval
Syntax:
'disabled' or time interval in the 10s..5h range
Default value:
disabled
Description:
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.
proprietary-extensions
Syntax:
'pre-2.9.25' or 'post-2.9.25'
Default value:
post-2.9.25
Description:
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.
Atheros specific
noise-floor-threshold
Syntax:
'default' or value in the -128..127 range
Description:
This property is only effective for cards based on AR5211 chipset.
adaptive-noise-immunity
Syntax:
'yes' or 'no'
Default value:
yes
Description:
This property is only effective for cards based on Atheros chipset.
periodic-calibration
Syntax:
one of 'default', 'enabled' or 'disabled'
Description:
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-interval
Syntax:
value in range 1..10000
Default value:
60
Description:
This property is only effective for cards based on Atheros chipset.
Prism specific
prism-cardtype
Syntax:
'30mW', '100mW', '200mW'
Description:
Specify type of the installed wireless card.
{{ #if: Reference|}}{{ #if: |[[Category:{{{2}}}]]}}{{ #if: |[[Category:{{{3}}}]]}}{{ #if: |[[Category:{{{4}}}]]}}{{ #if: |[[Category:{{{5}}}]]}}{{ #if: |[[Category:{{{6}}}]]}}{{ #if: |[[Category:{{{7}}}]]}}{{ #if: |[[Category:{{{8}}}]]}}{{ #if: |[[Category:{{{9}}}]]}}