PROSETCL.EXE Help File
======================
October 31, 2012
Contents
========
- Overview
- General Command Syntax
- Adapter Command Syntax and Required Parameters
- Team Command Syntax and Required Parameters
- DCB/FCoE 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 the PROSETCL.EXE
utility, you must use the DxSetup.exe utility to install base drivers and
Intel(R) PROSet for Windows* Device Manager with all options you need to
perform your required configurations.
The following launches a typical install (base drivers, Intel PROSet,
Intel ANS) silently:
DxSetup.exe /qn /liew install.log
See the User Guide for a complete explanation of the DxSetup.exe utility.
To run the PROSETCL.EXE utility, see the General Command Syntax section below.
Notes:
- Changes to the current configuration will require running the utility
from an elevated command prompt for operating systems that support this
feature.
- Not all features (options) are supported on all adapters. The setting
values or range of values for supported features depend on the adapter.
- Setting DCB_Settings to "Local Settings", and using the associated
options, is unsupported at this time.
- 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 [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:
0: A return code value of 0 means Success
1: A return code value of 1 means Failure
********************************************************************************
Adapter Command Syntax and Required Parameters
********************************************************************************
Adapter_CreateVlan [/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 VLAN1
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 VLAN0
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
Notes:
- If a VLAN ID number is already in use or an untagged VLAN already
exists, VLAN creation will fail and an error message is displayed.
- 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
Notes:
- If no parameters are entered, the command defaults to local execution.
- If an adapter is added or removed, the Adapter_Enumerate command will
need to be used again.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_EnumerateCapabilities [/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 [/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 [/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.
Notes:
- Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
- 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 [/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 [/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 [/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 [/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 [/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 [/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.
Note: Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_GetProfiles [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
using the Adapter_Enumerate command.
Displays the current profile and all supported profiles for the specified
adapter.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_GetSetting [/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_EnumerateSettings command.
Running this command displays the value for a particular Advanced Setting on the
specified adapter.
Notes:
- Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
- RSS is not supported on some adapters configured to use Virtual Machine
Queues (VMQ) or SR-IOV. On these adapters VMQ or SR-IOV will take
precedence over RSS. RSS will appear disabled.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_GetVirtualizationInfo [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
using the Adapter_Enumerate command.
Displays virtual queue information for the specified adapter.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_GetVirtualizationStatus [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
Running this command displays the Queue ID, CPU ID, Rx Packets, and Tx Packets.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_GetVlanInfo [/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 [/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 [/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 [/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 [/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 [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
OptionName - Name of setting to use. To obtain setting names, use the
Adapter_GetPowerUsageOptions command.
Option - Value to be applied to setting.
Running this command allows you to configure power saver options for a
particular adapter.
Note: Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_SetProfile [/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.
If you have selected the Virtualization Server profile or the Storage +
Virtualization profile, and you uninstall the Hyper-V role, you should select
a new profile.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_SetSetting [/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_EnumerateSettings command.
SettingValue - Value to be applied to setting.
Running this command allows you to configure Advanced Settings for a
particular adapter.
Notes:
- Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
- 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.
- You cannot change the Link Speed and Duplex setting if FCoE Boot is
enabled on the adapter.
- You cannot enable RSS when SR-IOV is enabled on the adapter.
- You must enable VMQ for SR-IOV to function.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_SetWakeOnSetting [/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 settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Adapter_SetVlanSetting [/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 [/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: You can add Intel(R) Active Management Technology (Intel(R) AMT) enabled
devices to Adapter Fault Tolerance (AFT), Switch Fault Tolerance (SFT), and
Adaptive Load Balancing (ALB) teams. All other team types are not supported.
The Intel AMT enabled device must be designated as the primary adapter for the
team.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_AddAdapter [/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: You can add Intel(R) Active Management Technology (Intel(R) AMT) enabled
devices to Adapter Fault Tolerance (AFT), Switch Fault Tolerance (SFT), and
Adaptive Load Balancing (ALB) teams. All other team types are not supported.
The Intel AMT enabled device must be designated as the primary adapter for the
team.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_Create [/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:
Attempting to create team 'TeamNew' ...
Successfully created team 'TeamNew'
Notes:
- You can add Intel(R) Active Management Technology (Intel(R) AMT) enabled
devices to Adapter Fault Tolerance (AFT), Switch Fault Tolerance (SFT),
and Adaptive Load Balancing (ALB) teams. All other team types are not
supported. The Intel AMT enabled device must be designated as the primary
adapter for the team.
- Microsoft* Windows Powershell* users must put the AdapterList in quotes.
For example: prosetcl.exe Team_Create "1,2" TeamNew ALB
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_CreateVlan [/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.
Notes:
- If a VLAN ID is already in use or an untagged VLAN already exists, an
error message is displayed.
- 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 [/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 [/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.
Note: Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_EnumerateVlans [/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 [/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 [/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 [/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.
This displays the value for a particular team setting.
Note: Not all settings are supported on all adapters. The setting values or
range of values for supported features depend on the adapter and operating
system.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_GetTeamInfo [/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 [/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 [/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 [/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 [/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 [/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.
This removes the specified adapter from a team. A team with no adapters in it
will automatically be removed.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_RemoveVlan [/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 [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
Priority - Valid priority values are: PRIMARY or SECONDARY.
This sets the adapter’s priority within the team.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Team_SetSetting [/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 [/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 [/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 [/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 [/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 [/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.
********************************************************************************
DCB/FCoE Command Syntax and Required Parameters
********************************************************************************
DCB_GetStatus [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
Displays the DCB status of the indicated adapter.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_CreateVport [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
VirtualPortWWPN - World Wide Port Name to use. You can pass "generate" as a
valid parameter. If you use generate, a WWPN will be
automatically generated and used.
Creates an FCoE Virtual port.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_DeleteVport [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
VirtualPortWWPN - World Wide Port Name to use. The WWPN is obtained by
running the FCoE_EnumeratePorts command.
Deletes the specified virtual port.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_EnumerateLUNs [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
PortWWPN - World Wide Port Name to use. The WWPN is obtained by
running the FCoE_EnumeratePorts command.
TargetWWPN - Target WWPN to use. The WWPN is obtained by running the
FCoE_EnumerateTargets command.
This displays a list of the LUNs for the specified target.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_EnumeratePorts [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
This displays all WWPNs associated with the specified device. The first WWPN in
the list is the WWPN for the physical port. The subsequent WWPNs are associated
with virtual ports.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_EnumerateSettings [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
This displays a list of FCoE features and capabilities supported on the
specified adapter.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_EnumerateTargets [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
PortWWPN - World Wide Port Name to use. The WWPN is obtained by running
the FCoE_EnumeratePorts command.
This displays a list of the targets for the specified WWPN.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_EnumerateVLANs [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
This displays all SAN VLANs installed on the specified device.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_FabricView [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
This displays information on the FCoE Fabric for the specified adapters.
Displayed information includes the virtual and physical port WWPNs associated
with the specified adapter, the Target WWPNs for each physical and virtual port
WWPN, and the LUNs for each target WWPN.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetLunInfo [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
PortWWPN - World Wide Port Name to use. The WWPN is obtained by running
the FCoE_EnumeratePorts command.
TargetWWPN - Target WWPN to use. The WWPN is obtained by running the
FCoE_EnumerateTargets command.
LunID – ID of the LUN. The LUN IDs are obtained by running the
FCoE_EnumerateLUNs command.
This displays the OS Device Name, Capacity, and Block Size for the specified
LUN.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetPortInfo [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
PortWWPN - World Wide Port Name to use. The WWPN is obtained by running
the FCoE_EnumeratePorts command.
This displays the World Wide Node Name and FCID for the specified port.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetSetting [/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
FCoE_EnumerateSettings command.
This displays the value for a particular FCoE setting.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetStatistics [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
This displays the DCB status for the specified device.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetTargetInfo [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
PortWWPN - World Wide Port Name to use. The WWPN is obtained by running
the FCoE_EnumeratePorts command.
TargetWWPN - Target WWPN to use. The WWPN is obtained by running the
FCoE_EnumerateTargets command.
This displays the Serial Number, FCID, and Vendor Info for the specified FCoE
target.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_GetVLANInfo [/help]
AdapterIndex - Index of the adapter. The adapter indices are obtained by
running the Adapter_Enumerate command.
SANVLANID - ID of the SAN VLAN. The VLAN ID is obtained by running the
FCoE_EnumerateVLANs command.
This displays the VLAN status for the specified VLAN.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
FCoE_SetSetting [/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
FCoE_EnumerateSettings command.
SettingValue - Value to be applied to setting.
Running this command allows you to configure FCoE Settings for a particular
adapter.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
Legal / Disclaimers
===================
Copyright (C) 2008-2012, 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.