PROSETCL.EXE Help File
======================

November 3, 2011

Contents
========
- Overview
- General Command Syntax
- Adapter Command Syntax and Required Parameters
- Team Command Syntax and Required Parameters
- Legal / Disclaimers

********************************************************************************
Overview
********************************************************************************

The purpose of the PROSETCL.EXE utility is to be able to configure and manage 
your network adapters, teams, and VLANs. Prior to running this utility, base 
drivers and Intel(R) PROSet for Windows* Device Manager must be installed from 
the command line with all options you need to perform required configurations.

For example, to use teaming and VLAN commands, at the command line prompt, 
type "setup /qn".

To run the utility, see the General Command Syntax section below.

Note: Changes to the current configuration will require running the utility 
from an elevated command prompt for operating systems that support this feature.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

Note: Many configuration changes require driver reloads, setting 
synchronization, or other modifications. The PROSETCL.EXE utility does not 
notify you either before or after these events occur.

********************************************************************************
General Command Syntax
********************************************************************************

  prosetcl.exe <command> <required parameters> [optional parameters]

Note: Required parameters are enclosed in <>, and optional parameters 
are enclosed in [].

--------------------------------------------------------------------------------
Optional Parameters for All Commands
--------------------------------------------------------------------------------

[/help | ?]     - Describes the command function and its parameters.

Commands with required parameters will display help if no parameters are 
provided.

--------------------------------------------------------------------------------
Return Codes
--------------------------------------------------------------------------------

Each command will return one of the following codes:

  ---------------------------
  | Return Code |           |
  |    Value    | Meaning   |
  ---------------------------
  |     0       | Success   |
  ---------------------------
  |     1       | Failure   |
  ---------------------------


********************************************************************************
Adapter Command Syntax and Required Parameters
********************************************************************************

Adapter_CreateVlan <AdapterIndex VlanID VlanName> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
            running the Adapter_Enumerate command.
  VlanID - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 for a 
     maximum of 64 VLANs. Only one VLAN can be 'Untagged' (0) per device.
  VlanName  Label for the VLAN. This is used for identification purposes.

This creates a VLAN on an adapter. To create a VLAN on adapter 1, type:

  prosetcl.exe Adapter_CreateVlan 1 1

The result should be:

  1) Intel(R) PRO/1000 PT Dual Port Server Adapter #2:
     Attempting to create VLAN...
     Successfully called to Create VLAN1

To add an untagged VLAN to this adapter 1:

  prosetcl.exe Adapter_CreateVlan 1 0

  1) Intel(R) PRO/1000 PT Dual Port Server Adapter #2:
     Attempting to create VLAN...
     Successfully called to Create VLAN0

Running the Adapter_EnumerateVlans command on adapter 1 after the VLANs have 
been successfully created will display VLANs installed on adapter 1:

  prosetcl.exe Adapter_EnumerateVlans 1

Output:

  1) Intel(R) PRO/1000 PT Dual Port Server Adapter #2 - VLANs :

     0) Untagged VLAN
     1) VLAN1

Note: If a VLAN ID number is already in use or and untagged VLAN already 
exists, VLAN creation will fail and an error message is displayed.

Note: A tagged VLAN must be present before an untagged VLAN can be created.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_Enumerate [/help]


Using this command results in a list of adapters installed in a system and their 
indices. For example:

  1) Intel(R) PRO/1000 PT Server Adapter
  2) Intel(R) PRO/1000 PF Server Adapter

Note: If no parameters are entered, the command defaults to local execution.

Note: If an adapter is added or removed, the Adapter_Enumerate command will 
need to be used again. 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_EnumerateCapabilities <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 using the Adapter_Enumerate command.

Using this command results in a list of features and capabilities supported on 
the specified adapter.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_EnumerateProperties <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by using 
                 the Adapter_Enumerate command.

Using this command results in a list of register values for the specified adapter. 
Only supported properties are displayed.

For a list of adapter properties, please see the Intel PROSet for Windows* 
Device Manager WMI Provider User's Guide found in WMI White Paper 2 - DMIX.PDF 
on the CD.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_EnumerateSettings <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

Running this command results in a list of the specified adapter's Advanced 
Settings and their current value. Advanced Settings include:

  - Gigabit Master Slave Mode (MasterSlave)
  - Jumbo Packets (JumboPacket or MaxFrameSize)
  - Locally Administered Address (NetworkAddress)
  - Log Link State Event (LogLinkStateEvent)
  - Priority & VLAN (PriorityVLANTag)
  - Receive Side Scaling (RSS)
  - Wait For Link (WaitAutoNegComplete)
  - Adaptive Inter-Frame Spacing (AdaptiveIFS) 
  - Flow Control (FlowControl)
  - Interrupt Moderation Rate (ITR)
  - Receive Buffers (ReceiveBuffers or NumRxDescriptors)
  - Transmit Buffers (TransmitBuffers or NumTxDescriptors)
  - IPv4 Checksum Offload (IpChecksumOffloadIPv4)
  - TCP Checksum Offload IPv4 (TCPChecksumOffloadIPv4)
  - UDP Checksum Offload IPv4 (UDPChecksumOffloadIPv4)
  - Offload Receive IP Checksum (ChecksumRxIp) 
  - Offload Transmit IP Checksum (ChecksumTxIp)
  - Offload Receive TCP Checksum (ChecksumRxTcp)
  - Offload Transmit TCP Checksum (ChecksumTxTcp)
  - Offload TCP Segmentation (TcpSegmentation)
  - Power Management (EnablePME)
  - Smart Power Down (SPDEnabled)
  - Wake on Settings (WakeOn)
  - Wake On Link Settings (WakeOnLink)
  - Link Speed & Duplex (SpeedDuplex) 


Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

Note: Some Advanced Settings include an asterisk in their name. The '*' must be 
used when specifying the setting as it is the actual registry parameter defined 
by Microsoft*.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_EnumerateVlans <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

This displays all VLANs installed on the specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_EnumerateVlanSettings <AdapterIndex VlanID> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 
                 1-4094 or 'Untagged'.

This displays VLAN settings for the specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetHardwareInfo <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

Displays the EEPROM Version for the specified adapter. 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetLinkStatus <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

Displays the link status for the specified adapter. 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetNDISVersion <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.

Running this command displays the NDIS driver version number for the 
specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetPowerUsageOptions <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.

Running this command displays all power saver options for the specified adapter. 
Power saver options include:

  - ACBS Mode (ACBSMode)
  - Auto Power Save Mode (AutoPowerSaveModeEndabled)
  - Enhanced ASPM Power Saver (EnhancedASPMPowerSaver)
  - Link Speed Battery Saver (LinkSpeedBatterySaver)
  - Reduce Speed on Power Down (ReduceSpeedOnPowerDown)
  - Save Power Now (SavePowerNowEnabled)
  - Smart Power Down (SmartPowerDown)
  - System Idle Power Saver (SystemIdlePowerSaver)

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetProfiles <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 using the Adapter_Enumerate command.
This displays the current profile and all supported profiles for the 
specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetSetting <AdapterIndex SettingName> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
            running the Adapter_Enumerate command.
  SettingName  - Name of setting to use. To obtain setting names, use the 
            Adapter_EnumerateSetting command.

Running this command displays the value for a particular Advanced Setting on the 
specified adapter.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

Note: RSS is not supported on some adapters configured to use Virtual Machine 
Queues (VMQ). On these adapters VMQ will take precedence over RSS. RSS will 
appear disabled.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetVlanInfo <AdapterIndex VlanID> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
            	 running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
            	 or 'Untagged'.

This lists VLAN information on the specified adapter. It displays the VLAN name, 
VLAN number, caption, parent ID and status of the VLAN.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetWakeOnSettings <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.
	
Running this command displays all Wake on settings for the specified adapter. 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_Identify <AdapterIndex NumberOfSeconds> [/help]
	
  AdapterIndex    - Index of the adapter. The adapter indices are obtained by 
		    running the Adapter_Enumerate command.
  NumberofSeconds - Number of seconds for the LED to blink.

Running this command allows you to identify an adapter in the system by blinking 
its LED light. For example:

  prosetcl.exe Adapter_IdentifyAdapter 1 10

will result in the LED on adapter 1 blinking for 10 seconds.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_ModifyVlanInfo <AdapterIndex VlanID SettingName SettingValue> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
		 or 'Untagged'.
  SettingName  - Name of setting to use. To obtain setting names, use the 
                 Adapter_GetVLANInfo command.
  SettingValue - Value to be applied to setting.

This modifies the VLAN number or caption for a particular VLAN on a specified 
adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_RemoveVlan <AdapterIndex VlanID> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
                 'Untagged'.

This removes a VLAN on an adapter. For example,

  prosetcl.exe Adapter_RemoveVlan 1 2

will remove VLAN 2 from adapter 1.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_SetPowerUsageOption <AdapterIndex SettingName SettingValue> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.
  SettingName  - Name of setting to use. To obtain setting names, use the 
                 Adapter_GetPowerUsageOptions command.
  SettingValue - Value to be applied to setting.

Running this command allows you to configure power saver options for a 
particular adapter.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

Note: Setting values vary depending on your adapter. 

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_SetProfile <AdapterIndex ProfileIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 using the Adapter_Enumerate command.

  ProfileIndex - Index of the desired profile. The profile indices are obtained
                 by using the Adapter_GetProfiles command.

Running this command allows you to set the specified profile on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_SetSetting <AdapterIndex SettingName SettingValue> [/help]

  AdapterIndex  - Index of the adapter. The adapter indices are obtained by 
                  running the Adapter_Enumerate command.
  SettingName   - Name of setting to use. To obtain setting names, use the 
		  Adapter_EnumerateSetting command.
  SettingValue  - Value to be applied to setting.

Running this command allows you to configure Advanced Settings for a 
particular adapter.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

Note: Some Advanced Settings include an asterisk in their name. The '*' must be 
used when specifying the setting as it is the actual registry parameter defined 
by Microsoft*.

Note: You cannot change the Link Speed and Duplex setting if FCoE Boot is 
enabled on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_SetWakeOnSetting <AdapterIndex SettingName SettingValue> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.
  SettingName  - Name of setting to use. To obtain setting names, use the 
		 Adapter_GetWakeOnSettings command.
  SettingValue - Value to be applied to setting.

Running this command allows you to configure Wake On settings for a 
particular adapter.

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_SetVlanSetting <AdapterIndex VlanID SettingName SettingValue> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
            	 or 'Untagged'.
  SettingName  - Name of setting to use. To obtain setting names, use the 
                 Adapter_EnumerateVlanSettings command.
  SettingValue - Value to be applied to setting.

This changes the value of a VLAN setting on the specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Adapter_GetVlanSetting <AdapterIndex VlanID SettingName> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
       	         running the Adapter_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
                 or 'Untagged'.
  SettingName  - Name of setting to use. To obtain setting names, use the 
                 Adapter_EnumerateVlanSettings command.

This displays the current value of a VLAN advanced setting for the 
specified adapter.
It will also display the type and range (if available) of valid values as well 
as the default value for the setting.

********************************************************************************
Team Command Syntax and Required Parameters
********************************************************************************

To create a team, we recommended running the following commands in order:

  1. Team_Create - To create a team.
  2. Team_Enumerate - To verify that the team was created successfully.

To change a team setting, we recommended running the following commands in order:

  1. Team_EnumerateSettings - To display list of team settings and their values. 
     The Team_GetSetting command can also be used instead of this.
  2. Team_SetSetting - To change a team setting to a new value.
  3. Team_EnumerateSettings - To verify that the team setting was successfully 
     changed. The Team_GetSetting command can also be used instead of this.

Note: If Intel(R) Active Management Technology has been enabled on a device, then 
you cannot add the device to a team.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_AddAdapter <TeamIndex AdapterIndex> [/help]

  TeamIndex    - Index of the team. The team indices are obtained by running 
                 the Team_Enumerate command.
  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

Note: If Intel(R) Active Management Technology has been enabled on a device, then 
you cannot add the device to a team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_Create <AdapterList TeamName TeamMode> [/help]

  AdapterList - Comma delimited list of adapter indices (i.e., 1,2,3). To obtain 
                adapter indices, use the Adapter_Enumerate command.
  TeamName    - Name to apply to the team.
  TeamMode    - Type of team to create. Valid team modes are: ALB, AFT, SLA, 
                802.3AD, SFT, and VMLB.
                Note:  SFT teams can only be created with 2 or fewer adapters.

For example, to create a new team, type:

  prosetcl.exe Team_Create 1,2 TeamNew ALB

If a team has been successfully created, the following will appear:

  Specified ports:
    1) Intel(R) PRO/1000 PT Dual Port Server Adapter #1
    2) Intel(R) PRO/1000 PT Dual Port Server Adapter #2

    Attempting to create ALB team with the adapters above...

    Call to create team was successful.

Note: If Intel(R) Active Management Technology has been enabled on a device, then 
you cannot add the device to a team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_CreateVlan  <TeamIndex VlanID VlanName> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running the 
              Team_Enumerate command.
  VlanID    - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 for 
              a maximum of 64 VLANs. Only one VLAN can be 'Untagged' (0) per 
              device.
  VlanName  - Name for the VLAN <32 Characters Maximum>

This creates a VLAN on a team.

Note: If a VLAN ID is already in use or an untagged VLAN already exists, an 
error message is displayed.

Note: A tagged VLAN must be present before an untagged VLAN can be created.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_Enumerate [/help]

Running this command results in a list of teams installed in a system and their 
indices. For example:

  1) TEAM : Team1
  2) TEAM : Team2

Note: If no parameters are entered, the command defaults to local execution.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_EnumerateAdaptersInTeam <TeamIndex> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running 
              the Team_Enumerate command.

Running this command results in a list of all adapters in the specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_EnumerateSettings <TeamIndex> [/help]
	
  TeamIndex - Index of a team. The team indices are obtained by running 
              the Team_Enumerate command.

The result is a list of team settings and their current value. Team 
settings include:

  - ProbeEnabled
  - ProbePacketType
  - ReceiveLoadBalancing
  - TaggingMode
  - BalanceInterval
  - CheckTime
  - MaxNumProbeRetry
  - NumRxPackets
  - NumTxPackets 
  - STForwardDelay
  - UserSelectedAddress

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_EnumerateVlans <TeamIndex> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running 
              the Team_Enumerate command.

This displays all VLANs installed on the specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_EnumerateVlanSettings <TeamIndex VlanID> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running 
              the Team_Enumerate command.
  VlanID    - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
              or 'Untagged'.

This displays VLAN settings for the specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_GetAdapterInfo <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

This displays the adapter information for the specified adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_GetSetting <TeamIndex SettingName> [/help]

  TeamIndex   - Index of the team. The team indices are obtained by running 
                the Team_Enumerate command.
  SettingName - Name of setting to use. To obtain setting names, use the 
                Adapter_EnumerateSetting command.

This displays the value for a particular team setting. Team settings include:

  - ProbeEnabled
  - ProbePacketType
  - ReceiveLoadBalancing
  - TaggingMode
  - BalanceInterval
  - CheckTime
  - MaxNumProbeRetry
  - NumRxPackets
  - NumTxPackets 
  - STForwardDelay
  - UserSelectedAddress

Note: Not all features (options) are supported on all adapters. The setting 
values or range of values for supported features depend on the adapter.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_GetTeamInfo <TeamIndex> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running the 
              Team_Enumerate command.

This displays the team name, teaming mode, and MAC address for a specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_GetVlanInfo <TeamIndex VlanID> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running the 
              Team_Enumerate command.
  VlanID    - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
              or 'Untagged'.

This lists VLAN information on the specified team. It displays the VLAN name, 
VLAN number, caption, parent ID and status of the VLAN.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_ModifyTeamInfo <TeamIndex SettingName SettingValue> [/help]

  TeamIndex    - Index of the team. The team indices are obtained by running the 
	         Team_Enumerate command.
  SettingName  - Name of setting to use.
                 Valid setting names: 'mode' or 'name'
  SettingValue - Value to be applied to setting.
                 Valid teaming modes: ALB, AFT, SLA, 802.3AD, SFT, and VMLB.

Sets the specified setting ('mode' or 'name') to a new value.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_ModifyVlanInfo <TeamIndex VlanID SettingName SettingValue> [/help]

  TeamIndex    - Index of the team. The team indices are obtained by running 
                 the Team_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
		 or 'Untagged'.
  SettingName  - Name of setting to use. To obtain setting names, use the 
		 Team_GetVlanInfo command.
  SettingValue - Value to be applied to setting.

This modifies the VLAN number or caption for a particular VLAN on a 
specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_Remove <TeamIndex> [/help]

  TeamIndex - Index of the team. The team indices are obtained by running the 
              Team_Enumerate command.

This removes the specified team. VLANs bound to the team will also be removed.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_RemoveAdapter <AdapterIndex> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
                 running the Adapter_Enumerate command.

This removes the specified adapter from a team. A team with no adapters in it 
will automatically be removed.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_RemoveVlan <TeamIndex VlanID> [/help]

  TeamIndex  - Index of the team. The team indices are obtained by running 
               the Team_Enumerate command.
  VlanID     - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
	       or 'Untagged'.

This removes a VLAN on a team. For example,

  prosetcl.exe Team_RemoveVlan 1 2

will remove VLAN 2 from team 1.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_SetAdapterPriority <AdapterIndex AdapterPriority> [/help]

  AdapterIndex    - Index of the adapter. The adapter indices are obtained by 
		    running the Adapter_Enumerate command.
  AdapterPriority - Valid priority values are: PRIMARY or SECONDARY.

This sets the adapters priority within the team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_SetSetting <TeamIndex SettingName SettingValue> [/help]

  TeamIndex    - Index of the team. The team indices are obtained by running 
                 the Team_Enumerate command.
  SettingName  - Name of setting to use. To obtain setting names, use the 
		 Team_EnumerateSettings command.
  SettingValue - Value to be applied to setting.

This enables you to change a team setting. For example, to change the Tagging 
Mode setting from 0 to 1, type:

  prosetcl.exe Team_SetSetting 1 TaggingMode 1

When the setting has been successfully modified, the following will appear.

  1) TEAM : TeamNew

     Successfully set setting: TaggingMode

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_SetVlanSetting <TeamIndex VlanID <SettingName SettingValue> [/help]

  TeamIndex    - Index of the adapter. The adapter indices are obtained by 
                 running the Team_Enumerate command.
  VlanID       - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
		 or 'Untagged'.
  SettingName  - Name of setting to use. To obtain setting names, use the 
		 Team_EnumerateVlanSettings command.
  SettingValue - Value to be applied to setting.

This changes the value of a VLAN setting on the specified team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_GetVlanSetting <TeamIndex VlanID SettingName> [/help]

  TeamIndex   - Index of the team. The team indices are obtained by running 
                the Team_Enumerate command.
  VlanID      - ID number of the VLAN. Valid ranges for the VlanID are 1-4094 
                or 'Untagged'.
  SettingName - Name of setting to use. To obtain setting names, use the 
                Team_EnumerateVlanSettings command.

This displays the current value of a VLAN advanced setting for the specified team.
It will also display the type and range (if available) of valid values as well as 
the default value for the setting.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_ValidateAdaptersForTeaming <AdapterList> [/help]

  AdapterList - Comma delimited list of adapter indices (i.e., 1,2,3). To 
		obtain adapter indices, use the Adapter_Enumerate command.
	
Takes a list of adapters and returns any warnings that would be displayed if 
you teamed them together.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_ValidateAddAdapter <TeamIndex AdapterIndex> [/help]

  TeamIndex    - Index of the team. The team indices are obtained by running 
		 the Team_Enumerate command.
  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.

Returns any warnings that would be displayed if you added the specified 
adapter to the team.

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Team_ValidateSetting <AdapterIndex SettingName SettingValue> [/help]

  AdapterIndex - Index of the adapter. The adapter indices are obtained by 
		 running the Adapter_Enumerate command.
  SettingName  - Name of setting to use. To obtain setting names, use 
		 Team_EnumerateSettings command.
  SettingValue - Value to be applied to setting.

Tests whether changing a specific setting on an adapter will cause any teaming 
warnings. For example, if another adapter in the team did not support Jumbo 
Packets, and you executed the following:

  prosetcl.exe Team_ValidateSetting 1 JumboPacket Enable

You would see the jumbo packet warning.


Legal / Disclaimers
===================

Copyright (C) 2008-2011, Intel Corporation.  All rights reserved.

Intel Corporation assumes no responsibility for errors or omissions in this document. 
Nor does Intel make any commitment to update the information contained herein.

* Other product and corporate names may be trademarks of other companies and are 
used only for explanation and to the owners' benefit, without intent to infringe.

