proxcfg


NAME

proxcfg - Configure parameters at run time for Proxim's RangeLAN2 and Symphony drivers.  

SYNOPSIS

proxcfg --help

proxcfg [<ifname>]

proxcfg [<ifname>] [options]

DESCRIPTION

Proxcfg is used to configure MAC parameters in rlmod.o. This document is distributed with the RangeLAN2 and Symphony driver library.

The driver will configure multi-mode cards.  Parameters not associated with the current mode can be set but won't affect the mode with which they are not associated.

OPTIONS

ifname

Configure RangeLAN2 or Symphony device with interface ifname.  Defaults to eth0.  The tool tries to be intelligent if the ifname doesn't represent the driver. It will report that it can't configure that devices.  Without any other parameters, proxcfg prints the current driver status.

channel <channel>

Set the channel of the master. Stations don't use this parameter. Be sure that adjacent masters don't use the same channel.  The driver chooses a random channel by default so you normally can ignore this parameter.  Allowed values are 1-15.

debug on, off, <zone>

Turn debugging on or off in the driver. Activates RL2DEBUG functions. Allowed zones are 0-7.  Multiple zones can be turned on at once.  Allows for run-time debugging.  Really only useful if you are debugging the driver.

domain <domain>

Set the domain of the wireless network. Symphony uses domain 0 by default. Allowed values are 0-15.

hard_nwid <network ID>

Set the nwid into the card. This only needs to be run when changing the nwid. The value is saved in the card's firmware. This is the same as Symphony's security code.

harden_nwid

Stores the currently sync-to nwid into the card.  Useful after a successful learn has been executed. Note that harden_nwid doesn't remember the nwid string, it only stores the calculated nwid.

harden_secid

Stores the currently sync-to security ID into the card.  Useful after a successful learn has been executed. Note that harden_secid doesn't remember the security ID string, it only stores the hashed security ID value to the card.

ITO <seconds>

Sets the inactivity timeout.  Only valid on stations.  0 disables.  It's best to leave at 30, the default.  Allowed values are 0, 1, 2, 3, 4, 5, 10, 15, 20 ...

learn

The opposite of teach.  Will stay in learn until it sync's with a teaching device, the driver is reset, or a timeout of approximately 60 seconds.  The synchronization is temporary unless you use harden_nwid and/or harden_secid or update your config file. Note that harden_nwid doesn't remember the nwid string, it only stores the calculated nwid.  To save the current nwid in a file for use with the nwid paramter, try this:

      proxcfg eth0 learn wait 60 | grep NWID | cut -d : -f 2 > /etc/rlmod.nwid

To save the current soft security ID in a file for use with the soft_secid parameter, try this:

      proxcfg eth0 learn wait 60 | grep Soft | cut -d : -f 2 > /etc/rlmod.secid

MAC vlite, lite, norm

Optimize the MAC layer of the master. Stations don't use this parameter.

name <master name>

Set the master name of the master. Stations don't normally use this parameter however the driver will respond to a Symphony network map query with this parameter.  Maximum length is 11 characters.  Try this to set to the name of your system:

      proxcfg eth0 name $(hostname –s)

nwid <network ID>

Set the HomeRF network ID into the card. This needs to be run every time at driver load.   Any string is allowed but use the format "0000 0000" to set an explicit network ID.  You can “grab” a nwid from a file by using:

proxcfg eth0 nwid $(cat /etc/rlmod.nwid)

Put the HomeRF network ID into the file using something like this:

proxcfg eth0 | grep NWID | cut -d : -f 2 > /etc/rlmod.nwid

peer-to-peer on, off

Disables communication between peers.  The only advantage is slightly reduced latency at the beginning of communication.  Enabling repeating on an AP allows communication to occur even when this parameter is off.  It's best to leave on, the default.

reset

Resets the card and driver.  However all previously set parameters are retained.   Should never be needed with a few exceptions as proxcfg resets automatically when necessary.

roam on, off

Enables or disables roaming.  Only valid on stations and on RangeLAN2.

roamconfig slow, norm, fast

Configure the roam setting. Masters don't use this parameter. It only applies to RangeLAN2.  It's best to leave at norm, the default.

secid <security ID>

Set the security ID into the card. This only needs to be run when changing the security ID. The value is saved in the card's firmware. This is the same as Symphony's security code.

soft_secid <security ID>

Set the Security ID into the card. This needs to be run every time at driver load.   Any string is allowed less than 20 characters.  You can “grab” a soft security from a file by using:

proxcfg eth0 soft_secid $(cat /etc/rlmod.secid)

To save the current soft security ID in a file for use with the soft_secid parameter, try this:

      proxcfg eth0 | grep Soft | cut -d : -f 2 > /etc/rlmod.secid

sta, alt, msta

Configure the radio as a station, alternate master or master respectively.

sub <subchannel>

Set the subchannel of the master. Stations don't use this parameter.   The driver chooses a random channel by default so you normally can ignore this parameter.   Allowed values are 1-15.

teach

Puts the card into the teach mode.  Stays in the mode for about a minute.   After choosing this, put another device into learn mode to synchronize. It will teach the nwid and soft security. The f/w nwid is taught if the soft isn't present. Hard security ID is never taught.

wait <seconds>

Sleeps proxcfg for the specified number of seconds or until the card synchronizes.  Useful for pausing execution, for example, when up’ing an interface.  Depending on the order of start of processes on your system, some functions such as dhcp might time out if the card hasn’t yet synchronized with a master.  Usually 5 seconds is a good number to wait for OpenAir.

SEE ALSO

isapnp(1), modprobe(1), proxnet(1).

Proxim's web site for the manuals and further documentation on radio parameters: http://www.proxim.com