Administrator Guide: Cisco Aironet Client Utility Auto Configuration for Mac OS X, Version 1.0.0
Configuration Script Parameters

Table Of Contents

Configuration Script Parameters

Configuration Parameters

Root Parameters

Profile Parameters

Configuration Parameter Examples

Example 1

Example 2

Example 3


Configuration Script Parameters


This chapter describes the configuration script parameters. The following topics are covered in this section:

Configuration Parameters

Configuration Parameter Examples

Configuration Parameters

The client utility enables you to specify multiple configuration profiles for different operating environments. In these profiles you can specify the desired parameter values used to configure your client adapter and network security for operation in specific areas, such as the home, office, factory, or airport.

The configuration script contains two types of parameters:

Root—parameters that are specified only once

Profile—parameters that can be unique for each wireless network

The configuration script supports a directory-like structure. Multiple structures (location profiles) can originate from the main root directory and each structure can contain unique parameters. The directory-like structure is shown in the following example (tabs are used for clarity)

Root Parameter 1

Root Parameter 2

Location Profile 1

Parameter 1

Parameter 2

Parameter n

Location Profile 2

Parameter 1

Parameter 2

Parameter 3

Location Profile n

Parameter 1

Parameter 2

Parameter n

Root Parameters

The root parameters described in Table 2-1 consist of commands and location profile names.

Table 2-1 Root Parameters

Parameter
Description

(Location Profile Name)

Specifies the root structure name of a wireless network profile to be configured. This allows you to define different wireless network profiles for various operating locations. For each location you can specify unique operating parameters.


Note Parentheses are used to indicate that you must enter the name of the profile being configured.


Options: A unique name using alphanumeric characters

Default: None

Set Location

Specifies the name of the location profile to use as the default location during power up initialization.

Options: Location profile name

Default: None

fw file

Specifies the firmware image file to load into the client adapter. Typically, this file is located on the root directory but you can specify a full path relative to the root directory by beginning the value with a \; for example: \Cisco\Radio\PC350v42510.img.

Options: Firmware image file name

Default: None


Profile Parameters

Table 2-2 contains and describes the configuration script profile parameters.


Note Only a limited subset of the Mac OS X client utility parameters are supported by the configuration script.


Table 2-2 Profile Parameters  

Parameter
Description

Client Name

Specifies a name for your client adapter on the wireless network.

Option: Up to 16 alphanumeric characters

Default: None

SSID1

Service set identifier (SSID) or network name identifies the specific wireless network that you want to access. See the note below.

Option: Up to 32 ASCII characters (case sensitive)

Default: None

SSID2

Identifies an optional SSID or network name for a second wireless network that enables you to roam to the network without having to reconfigure your client adapter. See the note below.

Option: Up to 32 ASCII characters (case sensitive)

Default: None

SSID3

Identifies an optional SSID or network name for a third wireless network that enables you to roam to the network without having to reconfigure your client adapter. See the note below.

Option: Up to 32 ASCII characters (case sensitive)

Default: None

Note If you do not specify an SSID parameter, your client adapter can associate to any access point on the network that is configured to allow broadcast SSIDs (see the AP Radio Hardware page in the Cisco Aironet Access Point Software Configuration Guide). If the access points with which you wish to communicate are not configured to allow broadcast SSIDs, the value of this parameter must match the SSID of the access points. Otherwise, you will not be able to access the wireless network.

Network Type

Specifies the type of network in which your client adapter is installed.

Options: infrastructure or ad hoc

Default: infrastructure

Network Type

Description

infrastructure

Also referred to as Computer to Access Point. Used to set up a connection to a wired Ethernet network (through an access point).

ad hoc

Also referred to as computer to computer or peer to peer. Used to set up a small network between two or more wireless devices. For example, an ad hoc network could be set up between computers in a conference room so users can share information in a meeting.

Authentication Type

Defines how your client adapter attempts to authenticate to an access point.

Options: open or shared

Default: open

Authentication

Description

open

Allows your client adapter, regardless of its WEP settings, to authenticate and attempt to communicate with an access point.

shared

Allows your client adapter to communicate only with access points that have the same WEP keys.

The access point sends a known unencrypted challenge packet to the client adapter, which encrypts the packet and sends it back to the access point. The access point attempts to decrypt the encrypted packet and sends an authentication response packet indicating the success or failure of the decryption back to the client adapter.


Note If LEAP is enabled on your client adapter, Open is the only available option.



Note The Shared Authentication option is available only if the client adapter has been assigned a WEP key and WEP is enabled. Refer to Chapter 4 of the Cisco Aironet Wireless LAN Adapters Installation and Configuration Guide for MacOS for instructions on setting a WEP key and enabling WEP.


Enable WEP

Enables or disables Wired Equivalent Privacy (WEP) for your client adapter.

If you want to enable WEP for your client adapter, you must specify yes and create a WEP key using the ACU. You can disable WEP by specifying no. Refer to Refer to Chapter 4 of the Cisco Aironet Wireless LAN Adapters Installation and Configuration Guide for MacOS for more information on WEP and instructions on setting a WEP key.

Options: yes or no

Default: no

Enable LEAP

Enables or disables LEAP (also referred to as EAP - Cisco Wireless) for your client adapter.

If you want to enable LEAP for your client adapter, you must specify yes and set a LEAP username and password using the ACU. Refer to Refer to Chapter 4 of the Cisco Aironet Wireless LAN Adapters Installation and Configuration Guide for MacOS for more information about LEAP and instructions on setting a LEAP username and password.

Options: yes or no

Default: no

Transmit Power

Defines the power level at which your client adapter transmits signals. This value must not be higher than that allowed by your country's regulatory agency (FCC in the U.S., DOC in Canada, ETSI in Europe, MKK in Japan, etc.). When World Mode is enabled, only the transmit power levels supported by the country of operation's regulatory agency are available (refer to Appendix D of the Cisco Aironet Wireless LAN Adapters Installation and Configuration Guide for MacOS).

Range: 1, 5, 15, 30 mW (340 series client adapters)

1, 5, 20, 30, 50, or 100 mW (350 series client adapters)

Default: Minimum level allowed by your country's regulatory agency


Note Reducing the transmit power level conserves battery power but decreases radio range.


Power Mode

Sets your client adapter to its optimum power consumption setting.

Options CAM, PSP, or Maximum

Default: CAM

Power Save Mode

Description

CAM (Constantly Awake Mode)

Keeps the client adapter powered up continuously so there is little lag in message response time.

Consumes the most power but offers the highest throughput. Is recommended for desktop computers and devices that use AC power.

PSP (Power Save Mode)

Switches between a PSP mode and CAM, depending on network traffic. This mode switches to CAM when retrieving a large number of packets and switches back to PSP after the packets have been retrieved.

Is recommended when power consumption is a concern but you need greater throughput than that allowed by Max PSP.

Maximum (Max Power Savings)

Causes the access point to buffer incoming messages for the client adapter, which wakes up periodically and polls the access point to see if any buffered messages are waiting for it. The adapter can request each message and then go back to sleep.

Conserves the most power but offers the lowest throughput. Is recommended for devices for which power consumption is the ultimate concern (such as small battery-powered devices).

Mixed Cells

If your network's access points are set to communicate with both WEP-enabled or WEP-disabled clients (that is, if the Use of Data Encryption by Stations parameter on the AP Radio Data Encryption screen is set to Optional), you must specify yes, even if your client adapter is not using WEP. If you specify no, your client adapter will not be able to establish a connection with the access point.


Note For security reasons, Cisco recommends that both WEP-enabled and WEP-disabled clients not be allowed in the same cell because broadcast packets will be sent unencrypted, even to clients running WEP.


Options: yes or no

Default: no

Transmit Antenna

Specifies the type of antenna that your client adapter uses to receive data.

Options: both, right, or left

PC card - The PC card's integrated, permanently attached antenna operates best when used in diversity mode. Diversity mode enables the card to use the better signal from its two antenna ports.

Default: both (Diversity)

LM card - The LM card is shipped without an antenna; however, an antenna can be connected through the card's external connector. If a snap-on antenna is used, diversity mode is recommended. Otherwise, select the mode that corresponds to the antenna port to which the antenna is connected.

Default: both (Diversity)

PCI client adapter - The PCI client adapter must use the right antenna option.

Default: right

Receive Antenna

Specifies the antenna that your client adapter uses to transmit data. See the Transmit Antenna parameter above for information on the options available for your client adapter.

World Mode

Selecting this checkbox enables the client adapter to assume the legal transmit power level and channel set of the access point to which it is associated. This parameter is available only in computer to access point (infrastructure) mode and is designed for users who travel between countries because it allows the adapter to be used in different regulatory domains.

Options: yes or no

Default: no


Note When World Mode is enabled, only the transmit power levels supported by the country of operation's regulatory agency are available.


Channel

Specifies which frequency your client adapter will use as the channel for communications. These channels conform to the IEEE 802.11 Standard for your regulatory domain.

In infrastructure mode, this parameter is set automatically and cannot be changed. The client adapter listens to the entire spectrum, selects the best access point to associate to, and uses the same frequency as that access point.

In ad hoc mode, the channel of the client adapter must be set to match the channel used by the other clients with which you wish to communicate.

Options: 1 to 11 (Dependent on regulatory domain)
Example: 1 (Channel 1, 2412 MHz)


Note Refer to Appendix D of the Cisco Aironet Wireless LAN Adapters Installation and Configuration Guide for MacOS for a list of channel identifiers, channel center frequencies, and regulatory domains.


Wep Transmit Key

Specifies the WEP key to use to transmit packets.

Options: 1, 2, 3, or 4

Default: 1

LEAP Username

Specifies the LEAP username.


Note In some networks, you must enter the domain name prior to the username, such as domain\ username, where domain represents the domain name.


Options: Unique name (alphanumeric characters)

Default: None


Configuration Parameter Examples

Tabs are used in the following examples for clarity.

Example 1

Table 2-3 Single Profile

Parameter
Value

Office

Office

Client Name

NancyA

SSID1

Charlie Brown

SSID2

Golden Retriever

SSID3

Big Red Fox

Network Type

infrastructure

Authentication Type

open

Enable LEAP

yes

Power Mode

PSP

Mixed Cells

no

Transmit antenna

both

Receive antenna

both

World mode

yes

LEAP Username

domain_1\nancy

Set Location

Office

fw file

\Cisco\Radio\PC350v42510.img


Example 2

Table 2-4 Multiple Profiles

Parameter
Value

Office

Office

Client Name

TomA

SSID1

Charlie Brown

SSID2

Golden Retriever

SSID3

Big Red Fox

Network Type

infrastructure

Authentication Type

open

Enable LEAP

yes

Transmit Power

30

Power Mode

PSP

Mixed Cells

no

LEAP Username

domain_a\toma

Factory

Factory

Client Name

TomA

SSID1

Production Area 1

Network Type

infrastructure

Authentication Type

open

Enable LEAP

yes

Transmit Power

100

Power Mode

PSP

Mixed Cells

no

LEAP Username

domain_b\toma

Home

Home

SSID1

Star Trek 101

Enable WEP

yes

Transmit Power

100

Power Mode

PSP

Set Location

Office

fw file

\Cisco\Radio\PC350v42510.img


Example 3

Table 2-5 Multiple Profiles Using Defaults

Parameter
Value

Office

Office

SSID1

quality is 1st priority

Enable LEAP

yes

LEAP Username

domain_101\jimb

Power Mode

PSP

Conference Rooms

Conference Rooms

SSID1

no smoking here

Enable LEAP

yes

LEAP Username

domain_102\jimb

Power Mode

PSP

Airport

Airport

SSID1

100*air flight@hopkins

Enable WEP

yes

Power Mode

PSP

Set Location

Office

fw file

\Cisco\Radio\PC350v42510.img