DESCRIPTION
apple80211 is used to interact with IO80211Family wireless card drivers.
apple80211 is capable of reading and writing settings, scanning, and
monitoring 802.11 interface events.
COMMANDS
The following options are available:
-antdiv
Display antenna diversity setting for each RF chain.
-antdiv=[chain1_index,chain2_index,chain3_index,chain4_index]
Set a fixed receive antenna index for each RF chain. Indexes
start at zero. If the antenna index is -1, the RF chain will
begin automatically selecting the optimal receive antenna.
-apmode
Output current target network mode.
-apmode=[ibss/infrastructure]
Set the mode of the network in which the interface will be par-
ticipating.
-assoc_result
Output result of last association attempt.
-assoc_status
Retrieve association status code sent in response to the inter-
face's last association attempt.
-authtype
Display 802.11 layer authentication (lower), and follow on
authentication (upper).
-authtype=[lower,upper]
Set 802.11 layer and follow on authentication types. lower:
open, shared, cisco upper: none, wpa, wpa-psk, wpa2, wpa2-psk,
leap, 8021x
-background_scan
Print current background scan parameters
Enable or disable the different types of block acks. The four
on/off arguments, in order, correspond to "block ack", "immediate
block ack", "compressed bit map block ack", and "implicit block
ack".
-bssid
If acting as a station, the BSSID of the access point to which
the interface is associated is displayed. If participating in an
IBSS network, the random BSSID generated for the IBSS network is
printed.
-cardcap
Display a list of supported card capabilities.
-channel
Display the channel to which the interface is currently tuned.
--channel=[new_channel,[1/-1]]
Tune the interface to the specified channel. An optional band-
width and extension channel location parameter may also be speci-
fied. The '1' parameter indicates that the channel is 40 MHz
wide, and the extension channel is located above (at a higher
frequency). The '-1' parameter indicates that the channel is 40
MHz wide, and the extension channel is located below (at a lower
frequency). If no bandwidth and extension channel parameter is
present, the channel is assumed to be 20 MHz wide.
--cipher_key=[none/hex_key]
If set to "none", no cipher key will be used the next time the
interface attempts to participate in a network. If a 40 or 104
bit hex key is specified, the cipher key will be used the next
time the interface attempts to participate in a network.
-country_code
Retrieve country code dictating regulatory requirements currently
in use by the interface.
-deauth
Retrieve current deauth reason code.
-debug
Display current debug verbosity flags.
-debug=[none,err,info,rsn,scan]
-dtim
Print the DTIM interval.
-dtim=[new_interval]
Set a new DTIM interval.
-dump_rom
Display a hex dump of the wireless card's ROM.
-events
Monitor status events posted by the interface.
-frag
Print the interface's fragmentation threshold in bytes.
-frag=[threshold]
Set the interface's fragmentation threshold in bytes.
-guard
Print guard interval.
-guard=[short/long]
Set the guard interval to short (400 ns) or long (800 ns).
-hardware_ver
Display wireless card hardware version information.
-hostap=[ssid]
Create an open infrastructure network using the specified SSID.
-ibss=[ssid]
Create an open IBSS network using the specified SSID.
-intmit
Output interface's active interference mitigation mode.
-intmit=[off/auto]
Set the interface mitigation mode.
Enable or disable low density parity check.
-locale
Print interface's regulatory region.
-locale=[new_locale]
Change interface's regulatory region. Supported locales: fcc,
etsi, japan, korea
-lrl
Print long retry limit.
-lrl=[new_limit]
Set long retry limit.
-mcs
Display current modulation coding scheme index
-mcs=[index/auto]
Set modulation coding scheme index (0-76). If set to auto, the
interface will go back to auto rate selection and no longer honor
any previously configured static MCS indices.
-mcs_index_set
If participating in an 802.11n network, this command displays the
interface's current mcs index set.
-mcs_index_set=[index,index,...]
Set the mcs index set to be used the next time the interface cre-
ates an 802.11n infrastructure or IBSS network.
-mimo_ps
Display current MIMO power save setting.
-mpdu
Display current mpdu factor and maximum density.
-mpdu=[factor,density]
Set MPDU factor and maximum density. The factor may be from 0-3
and the density may be from 0-7.
Set maximum MSDU length.
-noise
If the interface is participating in a network, displays noise as
recently measured by the radio in dBm.
-opmode
Print the interface's current modes of operation.
-phymode
Display the interface's current PHY mode.
-phymode=[a,b,g,n]
Enable the specified PHY modes only.
-physubmode
Display current 802.11n submode.
-physubmode=[[auto/legacy/legacy_dup/ht/ht_dup/gf],[2/5/2-5],[20/20-40]]
Set an 802.11n phy sub mode. This command requires three comma-
separated arguments. The first argument is the 802.11n phy sub
mode:
auto: Optimal PPDU format determined at association time.
legacy: Use legacy PPDU format.
legacy_dup: Use legacy duplicate PPDU format.
ht: Use high throughput PPDU format.
ht_dup: Use high throughput duplicate PPDU format.
gf: Use Green Field PPDU format.
The second argument is the channel band(s) in which the submode
is allowed to operate:
2: 2.4 GHz
5: 5 GHz
2-5: 2.4 and 5 GHz
The last argument is the channel bandwidth(s) in which the sub-
mode is permitted to operate:
20: 20 MHz
20-40: 20 and 40 MHz
Example: To force legacy PPDU format to be used on the 2.4 GHz
band using either 20 or 40 MHz wide channels, one would use the
following command: apple80211 -physubmode=legacy,2,20-40
-pls
of each RF chain. For example, a card with four RF chains may be
configured as follows to enable chain 0 for RX and TX, chain 1
for TX, chain 2 for RX, and power off chain 3.
--power=on,tx,rx,off If an interface supports multiple RF chains,
all RF chains will be powered on or off if the --power=on/off
command is used with no additional arguments. To power on or off
the first RF chain, but leave the rest operational, the user must
explicitly specify the power state of each RF chain.
-powersave
Output the current power-save mode of the interface.
-powersave=[off/80211/vendor]
off: Disable power-savings mode
80211: Put the interface into 802.11 power savings mode
vendor: Put the interface into a non-specific vendor power
savings mode.
-protmode
Display the current protection mode in use by the interface and
the packet size threshold before the protection mechanism is
invoked.
-protmode=[mode,threshold]
Configure the interface to use a specific protection mechanism
and threshold. Valid modes are: off, auto, cts, rts-cts, and
dual_cts. Threshold is specified in bytes.
-psmp
Display whether or not power save multi-poll is enabled.
-psmp=[on/off]
Enable or disable power save multi-poll spacing.
-radio
Display information about the interface's radio hardware.
-rate
Display current transmit rate in Mbps.
-rate=[new_rate]
Force the interface to transmit at a fixed rate.
-rifs=[on/off]
Enable or disable reduced inter-frame spacing.
-rssi
If the interface is currently acting as a station, RSSI is dis-
played in dBm.
-rxant
Output index of last antenna used to receive a packet on each RF
chain.
-scan=[ssid]
Perform a scan. If an optional SSID is specified, a directed scan
is performed for the specified network name.
-shortslot
Display active short slot timing mode.
-shortslot=[auto/long/short]
Set short slot timing mode.
-srl
Output short retry limit.
-srl=[new_limit]
Set short retry limit.
-ssid
If operating in STA mode, retrieve the SSID of the access point
to which the interface is currently associated. If participating
in an IBSS network, the SSID of the IBSS is returned. If in host
AP mode, the SSID of the network currently being created by the
interface is output.
-ssid=[new_ssid]
Initiate an association attempt using any previously configured
parameters to the specified SSID.
-stalist
If the interface is currently creating an infrastructure network,
-suppchannels
Output list of channels currently supported in the interface's
regulatory region.
-txant
Display transmit antenna index for each RF chain.
-txant=[chain1_index,chain2_index,chain3_index,chain4_index]
Set a fixed transmit antenna index for each RF chain. Indexes
start at zero. If the antenna index is -1, the RF chain will
begin automatically selecting the optimal transmit antenna.
-txpower
Print interface transmit power in milliwatts.
-txpower=[new_power]
Force the interface to use a fixed transmit power specified in
milliwatts.
EXAMPLES
Associating to a 40bit WEP network with SSID 'wep_test' and hex cipher
key 0x7465737431:
apple80211 -disassociate -cipher_key=7465737431
-authtype=shared,none -apmode=infrastructure -ssid=wep_test
Associating to an open network with SSID 'test_net':
apple80211 -disassociate -cipher_key=none -authtype=open,none
-apmode=infrastructure -ssid=test_net
SEE ALSO
ifconfig(8)
HISTORY
The apple80211 command first appeared in Mac OS X Version ???
BSD May 10, 2006 BSD
Man(1) output converted with
man2html
|