HP Network Adapter Scripting Utility User Guide

August 2006 (Fifteenth Edition) Part Number 289166-00P

 Copyright 2006 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendors standard commercial license. Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation. Windows Server 2003 is a trademark of Microsoft Corporation.

August 2006 (Fifteenth Edition)

Part Number 289166-00P Audience assumptions

This document is for the person who installs, administers, and troubleshoots servers and storage systems. HP assumes you are qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy levels.

Contents
Overview..................................................................................................................................... 4
Network Configuration Utility and Scripting.................................................................................................. 4 Scripting functionality ................................................................................................................................ 4 Advanced teaming features ........................................................................................................................ 5 ProLiant Essentials network value pack license (nalicense) ............................................................................... 5 ProLiant Essentials value pack license options................................................................................................ 5 ProLiant Essentials Network License Manager................................................................................................ 6 ProLiant Essentials value pack license types................................................................................................... 6 Preliminary scripting information ................................................................................................................. 7 Script conversion....................................................................................................................................... 8 Scripting application (CQNICCMD) ............................................................................................................ 8 Command line syntax ...................................................................................................................... 9 Command line arguments ................................................................................................................. 9 Command line examples .................................................................................................................. 9 Command line help ....................................................................................................................... 10 NIC configuration properties .................................................................................................................... 11 HP Multifunction NIC properties ................................................................................................................ 11 Microsoft SNP properties.......................................................................................................................... 13 Team configuration properties................................................................................................................... 13

ProLiant Essentials licenses ............................................................................................................. 5

Scripting ...................................................................................................................................... 7

Configuration properties .............................................................................................................. 11

XML data file.............................................................................................................................. 16

XML elements and typical NIC teaming script.............................................................................................. 16 Error checking and completion code .......................................................................................................... 19

Error handling and reporting........................................................................................................ 19 Acronyms and abbreviations........................................................................................................ 20 Index......................................................................................................................................... 21

Contents

Overview
In this section
Network Configuration Utility and Scripting ................................................................................................ 4 Scripting functionality ............................................................................................................................... 4

Network Configuration Utility and Scripting

The HP Network Configuration Utility (NCU) enables configuration of network adapters (NICs) and teams of network adapters. The scripting feature of the utility provides the ability to perform adapter configuration using a batch process. This guide provides information about using the Network Adapter Scripting Utility to configure HP NICs and also provides information about ProLiant Essentials network value pack licenses that enable advanced teaming features.

Scripting functionality
Scripting functionality provides the capability to configure a target system based on configuration information saved from a source server. The target system is not required to be identical to the source server. The configuration of the source server may not be duplicated in its entirety on the target system. Both NICs and teams of NICs can be configured on the target system. When scripting is run, the NIC properties specified in the data file from the source server are used to modify the configuration of the NICs on the target system. Refer to "Preliminary scripting information" (on page 7) for details about running the scripting utility.

Overview 4

ProLiant Essentials licenses

In this section
Advanced teaming features ....................................................................................................................... 5 ProLiant Essentials network value pack license (nalicense) ............................................................................. 5 ProLiant Essentials value pack license options .............................................................................................. 5 ProLiant Essentials Network License Manager .............................................................................................. 6 ProLiant Essentials value pack license types ................................................................................................. 6

Advanced teaming features

Advanced teaming features that extend the basic networking capabilities are available through the NCU with a valid ProLiant Essentials Intelligent Networking Pack license. The Network Adapter License (nalicense) utility can be used to add a license to the system or display licenses previously installed on the system.

ProLiant Essentials network value pack license (nalicense)

Advanced teaming features can be activated through the purchase and installation of the following ProLiant Essentials network value pack licenses:

Intelligent Networking Pack (INP)Windows Edition Accelerated iSCSI Pack for Embedded Multifunction Gigabit Server Adapters RDMA Pack for Multifunction Gigabit Server Adapters

NOTE: The HP Accelerated iSCSI feature comes standard with stand-alone HP Multifunction Server Adapters and Multifunction Server Adapters for HP BladeSystem. IMPORTANT: If licensed features are used, execute the Network Adapter License (nalicense) utility first. Then run the CQNICCMD utility to duplicate NIC teaming configuration on a target server. For more information about how to use the Network Adapter License Utility, refer to the Network Adapter License Utility User Guide located on the HP ProLiant Networking Software CD packaged with the adapter.

ProLiant Essentials value pack license options

When you purchase a ProLiant Essentials network value pack license, you will receive a 25-digit license activation key that enables one or more licensed seats on your system and grants access to the advanced features. Value pack license options include:

Single license packAuthorizes one seat. Depending upon the type of product a seat may be a single server (INP) or a single port (iSCSI Pack or RDMA Pack). Flexible quantity license packAuthorizes a set number of seats ordered. Activation Key Agreements (AKA) license pack(For use with signed and implemented AKAs) Allows you to activate additional seats under the terms of an existing AKA.
ProLiant Essentials licenses 5

Demo(For evaluation purposes only) This trial license is for a set number of seats and a set number of days.

For additional information about ProLiant Essentials value pack products, go to the HP website (http://h18004.www1.hp.com/products/servers/proliantessentials/valuepack/licensing.html).

ProLiant Essentials Network License Manager

The License Manager also tracks the following:

Number of authorized seats available for each license key. Number of "used" seats for each license key. Number of days authorized for use by a demo key. Number of days remaining for a demo key. List of devices that are capable of being licensed for iSCSI and RDMA. Enabled or disabled status of each iSCSI and RDMA device.

ProLiant Essentials value pack license types

ProLiant Essentials value pack licenses are either server-based (associated with servers) or port-based (associated with individual ports).

INP licenses are server-based. After the server is licensed, the seat enables all INP features on the server. When installed, the license is attached to the server and cannot be revoked; the license stays with the server for the life of the server. After you install an INP license key, go to the Network and Configuration Utility (NCU) to configure the INP features on the server. Accelerated iSCSI Pack and RDMA Pack licenses for Multifunction Gigabit Server adapters are portbased. When installed, the licensed seats are available to individual ports (or more specifically to the port's MAC address) on multifunction adapters. After installing a license key, go to the NCU to enable individual ports. When a port is enabled for iSCSI or RDMA, the system automatically associates the port to an unused seat for the appropriate product type. If the port is disabled for that feature, the seat is made available so that it can be used to enable a different port.

ProLiant Essentials licenses 6

Scripting
In this section
Preliminary scripting information ................................................................................................................ 7 Script conversion...................................................................................................................................... 8 Scripting application (CQNICCMD) ........................................................................................................... 8

Preliminary scripting information

When using scripting to configure target systems, NICs are identified by their relative order in the system. The relative order is determined by the slot and port order in the system. NICs embedded on the system board are assigned the lowest numbers, followed by NICs ordered by their slot number with the lowest slot number first. Multiport NICs are ordered by ascending port number within each slot. Order of NICs on target systems NICs on the target system are configured to match the corresponding NIC number on the source server.

The first NIC on the target system is configured using data from the first NIC on the source server The second NIC on the target system is configured according to the saved data for the second NIC on the source server, and so on. If the target system has more NICs than the source server, then the extra NICs retain their current settings. If the target system has fewer NICs than the source server, data for additional NICs on the source server is ignored.

HP Multifunction NICs on target systems To transfer iSCSI, TCP/IP Offload Engine (TOE), Receive-Side Scaling (RSS), or Remote Direct Memory Access (RDMA) parameters on an HP Multifunction NIC, the Multifunction NIC must be located in the same relative position on the target machine as on the source machine.

If these multifunction parameters are assigned to a NIC that does not support iSCSI, TOE, RSS, or RDMA they are ignored.

NOTE: RDMA is supported on Windows Server 2003 (SP1 and above) or Windows Server 2003 x64 (SP1 and above) only.

If a NIC supports these multifunction parameters but the parameters are not assigned, the existing settings are left unchanged.

NOTE: TOE and RSS capabilities are only available through Multifunction Server Adapters running Microsoft Scalable Networking Pack (SNP) on Windows Server 2003 SP1 and above or Windows Server 2003 x64. Teams on target systems The target system is configured with the same number of teams that were present on the source server.

Teams are created on the target system consisting of the same relative NICs that were teamed on the source server. For example, if NICs 3 and 5 were teamed on the source server, then that teaming information is saved in the data file, and NICs 3 and 5 are teamed on the target system.

Scripting 7

In general, the NICs on the team on the target system do not have to be the same type of NICs that were teamed on the source server. However, some NICs cannot be teamed and if an attempt is made to form a team with invalid combinations of NICs an error occurs. For example, teams with different speed capabilities cannot be teamed on a load balancing team. An error occurs in the configuration if the NICs forming the team on the source server are not present on the target system. For example, if NICs 3 and 5 are teamed on the source server, but the target system has only four NICs, an error is reported and the configuration is not applied. When teams are configured on the target system, the team properties are set to the values read from the data file for the corresponding team on the source server. Properties not specified in the data file (and properties specified with invalid data values) are configured using their default settings. If no teams are configured on the source server, no teaming information is written to the data file and configuration of the target system consists only of configuring individual NICs. If the data file defines an advanced team, but a valid ProLiant Essentials Intelligent Networking Pack license is not on the target system, an error message is written to the log and the script exits without performing any actions. Refer to the Network Adapter License Utility User Guide located on the HP ProLiant Networking Software CD for information on how to add a ProLiant Essentials Intelligent Networking Pack license to the system or display licenses previously installed on the system.

Script conversion
Scripts created with previous versions of the NCU are supported; however, HP recommends that you recreate the script using the latest version of the NCU. Several operating modes in scripts generated with NCU versions 7.7x and earlier have changed and are converted as follows:

Manual is converted to Network Fault Tolerance Only (NFT). SmartSwitch is converted to Network Fault Tolerance Only with Preference Order. For Smart Switch Teams, the existing PreferredPrimaryNic attribute determines which team member should be more highly ranked than others within the PreferredPrimaryRanking attribute.

All other unspecified parameters use their defaults.

Scripting application (CQNICCMD)

CQNICCMD is a Windows 2000, Windows Server 2003, and Windows Server 2003 x64 utility that processes a network adapter configuration script file to duplicate the NIC Teaming configuration of a source ProLiant BL/ML/DL server on a target server. Run the utility from the command line in a Command Prompt window, from the Run option on the Windows Start menu, or from a Windows command file. NOTE: To execute the CQNICCMD utility from the command line the HP NCU must be closed. HP recommends that you use this application as part of the SmartStart Scripting Toolkit (SSST) deployment. However, the application can be used outside of this environment. Follow these steps when using the scripting application.
1. 2. 3.

Configure NIC teaming on the source server. Generate a script file on the source server by clicking Save in the HP NCU user interface or running CQNICCMD /S<filename> in the Command Line utility. Modify the script file as necessary.

NOTE: If you modify the script file, HP recommends that you run CQNICCMD /P to check the syntax of the modified file and check the log file for errors and warnings. The default location of the log file is \cpqsystem\log\cpqteam.log on the system drive. The syntax of the /P option is cqniccmd /p<filename>.
4.

Install the HP NCU on the target system.

Scripting 8

5. 6.

Run the Command Line utility with the following syntax. cqniccmd /c<filename> Check the log file for errors and warnings. The default location of the log file is \cpqsystem\log\cpqteam.log on the system drive.

NOTE: For use of this utility with the SmartStart Scripting Toolkit (SSST), refer to the documentation included with SSST. The SSST can be downloaded from http://www.hp.com/servers/proliantessentials (http://www.hp.com/servers/proliantessentials).

Command line syntax

CQNICCMD [[F/] /C<filename>] [/D] [/L <filename>] [/P <filename>] [/S<filename>] [/?] Only one of the following configuration options can be specified at a time: /S /D /C /P The /L argument can be used with any of the configuration options. The /F argument can only be used with the /C configuration option.

Command line arguments

Argument /S Description This configuration option causes the source server configuration to be saved. The name of the XML configuration data file must be specified and the path to the data file must exist. This option is identical to saving the source server configuration by clicking Save in the Network Teaming Configuration user interface. This configuration option causes all teams on the target server to be dissolved, all VLANs to be removed, and 802.1p/q Packet Tagging to be disabled for all NICs that had no VLANs. No additional arguments are required or allowed with this option. This configuration option applies the configuration specified in the data file to the target system. An existing XML configuration data file must be specified following the target switch. A space following the switch is optional. Any teams that exist on the target server will be dissolved before the configuration is applied, all VLANs will be removed, and 802.1p/q Packet Tagging will be disabled. This option is identical to the /C option, except that the configuration options are not applied to the target system. This is useful for syntax checking the XML data file. This option can be used to change the name and location of the cpqteam.log default log file that is created in \cpqsystem\log on the system drive. The supplied path must exist. An invalid log file name will cause the configuration to terminate with no changes. HP recommends this option only in batch files. This option causes all errors, including those errors normally treated as non-fatal errors, to be treated as fatal errors. This argument can be used only with the /C option.

/D

/C

/P /L

/F

Command line examples

/S cqniccmd /Sc:\Compaq\teamcfg.xml cqniccmd /S c:\Compaq\teamcfg.xml cqniccmd /S"c:\Compaq\teamcfg.xml" /D

Scripting 9

cqniccmd /D /C cqniccmd /Cc:\Compaq\teamcfg.xml cqniccmd /C c:\Compaq\teamcfg.xml cqniccmd /C"c:\Compaq\teamcfg.xml" /P cqniccmd /Pc:\Compaq\teamcfg.xml cqniccmd /P c:\Compaq\teamcfg.xml cqniccmd /P"c:\Compaq\teamcfg.xml" /L cqniccmd /Cc:\Compaq\teamcfg.xml /Lc:\Compaq\config.log cqniccmd /C c:\Compaq\teamcfg.xml /L c:\Compaq\config.log cqniccmd /C"c:\Compaq\teamcfg.xml" /L" c:\Compaq\config.log" /F cqniccmd /F /C c:\Compaq\teamcfg.xml

Command line help

The following option can be used to display usage information. /? For example: cqniccmd /? Usage: cqniccmd [[/F] /C<filename>] [/D] [/L<filename>] [/P<filename>] [/S<filename>] [/?] /C Configures the source server according to the specified filename. /D Dissolves all teams on the target server. /F Causes all errors to be treated as fatal errors. /L Changes the name and location of the logfile to the specified filename. /P Parses the specified filename to check for syntax errors. /S Saves the source server configuration to the specified filename. Examples: To apply a script: cqniccmd /Cc:\teamcfg.xml To apply a script and specify the logfile location: cqniccmd /Cc:\teamcfg.xml /Lc:\logs\teamcfg.log

Scripting 10

Configuration properties
In this section
NIC configuration properties ................................................................................................................... 11 HP Multifunction NIC properties............................................................................................................... 11 Microsoft SNP properties ........................................................................................................................ 13 Team configuration properties ................................................................................................................. 13

NIC configuration properties

The following properties are configured on the target server NICs from the source server data. Properties that are common to all HP NICs include:

SpeedDuplexDetermines the current speed and duplex of the NIC. Possible values include Auto/Auto, 10/Half, 10/Full, 100/Half, 100/Full, 1000/Full. The default is Auto/Auto. The value must be valid for the NIC on the target system. PreferredPrimaryRankingDetermines the preferred primary ranking of the NIC. This value is written only for NICs that are teamed. DualChannelGroupIf dual channel teaming is used, this value identifies the group to which the NIC belongs. The default value is 0. This value is written only for NICs that are teamed. For non-Dual Channel Teams, the value is always 0. ConfiguredPortCostDefines the port cost for the NIC. The default is 0. This value is written only for NICs that are teamed. DefaultVlanIdDetermines the VLAN ID used for any un-tagged packets received by the NIC. This only applies to NICs that have VLANs defined. VlanIDSpecifies the VLAN identifier value for the device. VlanNameSpecifies the descriptive name for the VLAN Id. Every VLAN must have a name assigned to it. Duplicate names are allowed if you want to use the same names for different Vlan IDs. NetworkAddressThis value is written only for NICs that are not teamed. It overrides the burnedin address with a locally administered address. A null value is always written to the XML data file because locally administered addresses must be unique. A null value is valid and indicates the network address is the burned-in address. This value must be a valid unicast address if it is edited.

HP Multifunction NIC properties

The following properties are common only to HP Multifunction NICs. To transfer iSCSI, TCP/IP Offload Engine (TOE), Receive-Side Scaling (RSS), and Remote Direct Memory Access (RDMA) parameters on an HP Multifunction NIC the Multifunction NIC must be located in the same relative position on the target machine as on the source machine. If these multifunction parameters are assigned to a NIC that does not support iSCSI, TOE, RSS, or RDMA they are ignored. If a NIC supports these multifunction parameters but the parameters are not assigned, the existing settings are left unchanged.

Configuration properties 11

iSCSI properties include:

iSCSIEnabledCauses Internet Small Computer System Interface (iSCSI) to be configured for the adapter. 0=Disabled. 1=Enabled. The default setting is Disabled. iSCSISRBTimeoutDeltaSpecifies the timeout value for I/O operations on the iSCSI enabled device. The default value is 15 seconds. The range of possible values is 0-60 seconds. iSCSIVlanIdSpecifies the iSCSI VLAN identifier value for the iSCSI enabled device. iSCSIVlanNameSpecifies the descriptive name for the iSCSI VLAN Id. iSCSIPacketPrioritySpecifies the QoS Packet Priority for the iSCSI enabled device. Possible values are D=Disabled and 1-7. The default setting is D (Disabled). iSCSIDHCPEnabledSpecifies that DHCP is used to acquire an IP configuration for the iSCSI enabled device. Possible settings are Enabled and Disabled. The default setting is Enabled. iSCSIIPAddressIf DHCP is not used, this specifies the IPv4 address (dotted decimal) for the iSCSI enabled device. If DHCP is enabled, the value is 0.0.0.0; otherwise, enter the actual IP address. iSCSISubnetMaskIf DHCP is not used, this property specifies the network subnet mask (dotted decimal) for the iSCSI enabled device. If DHCP is enabled, the value is 0.0.0.0, otherwise, enter the actual subnet mask. iSCSIGatewayIf DHCP is not used, this specifies the default route for the iSCSI enabled device. If DHCP is enabled or no gateway is used, the value is 0.0.0.0, otherwise, type the actual IP address. iSCSILAA(Locally Administered Address) specifies the user-defined MAC address of the iSCSI enabled device. A null value is always written to the XML data file because locally administered addresses must be unique. A null value is valid and indicates the network address is the burned-in address. This value must be a valid unicast address if it is edited.

NOTE: When iSCSI is enabled, RDMA cannot be enabled. If the configuration file indicates that an iSCSI-enabled adapter is included in one of the following team types, the team type is changed to TransmitLoadBalancing.

Automatic 802.3ad Dynamic Dual Channel Load Balancing (INP) Switch-assisted Dual Channel Load Balancing (INP) 802.2ad Dynamic with Fault Tolerance Switch-assisted Load Balancing with Fault Tolerance (SLB) TOEEnabledReduces the CPU cycles required to process incoming network traffic by shifting processing of TCP/IP from the server CPU to the HP Multifunction Server Adapter. 0=Disabled. 1=Enabled. The default setting is Enabled. RSSEnabledEnables Receive-Side Scaling on the adapter, which enables dynamic load balancing of incoming traffic across CPUs. 0=Disabled. 1=Enabled. The default setting is Enabled.

Microsoft Scalable Networking Pack (SNP) properties include:

NOTE: When TOE is enabled, RDMA cannot be enabled.

If the configuration file indicates that a TOE-enabled adapter is included in one of the following team types, the team type is changed to TransmitLoadBalancing.

Automatic 802.3ad Dynamic Dual Channel Load Balancing (INP) Switch-assisted Dual Channel Load Balancing (INP) 802.2ad Dynamic with Fault Tolerance Switch-assisted Load Balancing with Fault Tolerance (SLB)

Configuration properties 12

NOTE: TOE and RSS capabilities are only available through Multifunction Server Adapters running Microsoft Scalable Networking Pack (SNP) on Windows Server 2003 SP1 and above or Windows Server 2003 x64. RDMA properties include:

RDMAEnabledRDMA (Remote Direct Memory Access) provides the fastest communication between two RDMA-capable adapters by moving data from the memory of one computer directly into the memory of another with minimal CPU and memory overhead. 0=Disabled. 1=Enabled. The default setting is Disabled.

NOTE: When RDMA is enabled, iSCSI cannot be enabled. NOTE: RDMA is supported on Windows Server 2003 (SP1 and above) or Windows Server 2003 x64 (SP1 and above) only.

Microsoft SNP properties

Microsoft Scalable Networking Pack (SNP) properties include:

TOEEnabledReduces the CPU cycles required to process incoming network traffic by shifting processing of TCP/IP from the server CPU to the HP Multifunction Server Adapter. 0=Disabled. 1=Enabled. The default setting is Enabled. RSSEnabledEnables Receive-Side Scaling on the adapter, which enables dynamic load balancing of incoming traffic across CPUs. 0=Disabled. 1=Enabled. The default setting is Enabled.

NOTE: When TOE is enabled, RDMA cannot be enabled.

Team configuration properties

Team configuration properties that are configured on the target server include:

TeamNameDetermines the unique identifier for the NIC team. Each team name on the target system must be unique. OpModeDetermines the operating mode of the team. Possible values are Auto, DynamicDualSlb, StaticDualSlb, DynamicSingleSlb, StaticSingleSlb, FailOnFault, PrefPrimary, TransmitLoadBalancing, and TLBwithPref. If the OpMode is DynamicDualSlb or StaticDualSlb, the team is considered to be using advanced teaming. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions.

LoadBalAlgorithmDetermines the team load balancing algorithm. Possible values are MACAddress, IPAddress, TCPConnection, RoundRobin, and Auto. TeamNetworkAddressEstablishes the MAC address for the NIC team. A null value is always written to the XML data file because locally administered addresses must be unique. A null value is valid and computes a default address. This value must be a valid unicast address if it is edited. TxPathValidationModeEnables or disables the packet signal transmitted between the team NICs. Possible values are Enabled or Disabled. RxPathValidationModeEnables or disables the packet signal received between the team NICs. Possible values are Enabled or Disabled. TxPathValidationIntervalDetermines how frequently the packet signals are transmitted. The range of acceptable values is 3 to 60. Values less than 3 are set to 3, and values greater than 60 are set to 60.

Configuration properties 13

RxPathValidationIntervalDetermines how frequently the packet signals are received. The range of acceptable values is 3 to 60. Values less than 3 are set to 3, and values greater than 60 are set to 60. RxPathValidationVlanIdDetermines the VLAN on which Receive Path Validation packet frames are transmitted. This value is only written when a VLAN is defined for the team. The default is the VLAN on the team with the lowest VLAN ID at the time the team is created. FastPathEnabledEnables or disables the port cost with path cost monitoring feature. Possible values are Enabled or Disabled. If the FastPathEnabled is set to Enabled, the team is considered to be using advanced teaming. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions.

FastPathSpanningTreeTypeDetermines the spanning tree protocol. Possible values are IEEE 802.1D and Cisco PVST+. The default is IEEE 802.1D. FastPathSpanningTreeType is only relevant if FastPathEnabled is enabled. FastPathVlanIdDetermines the VLAN ID used for path cost monitoring. This value is written only if a VLAN is defined for the team. FastPathVlanID is only relevant if FastPathEnabled is enabled and Cisco PVST is selected. ActivePathEnabledWhen activated, this option allows the team member to send a packet to a remote node and receive a reply to determine that the team member sending the packet has a path to the echo node. The absence of a reply within the specified time period can be used to determine if a team member should be disabled. The option setting for Active Path Failover is selected (enabled) or unselected (disabled). The default setting is unselected. A valid echo node IP address must be entered when the selected option is used. The team is using advanced teaming if Active Path Failover is selected. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions. The following values are written only when the ActivePathEnabled option is used:

EchoNodeResponseMechIdentifies which echo node response mechanism to use: DirectedARP or CommunityAddressARP. If CommunityAddressARP is chosen, Community Probe IP Address, Community Probe MAC Address, and Use Default options are used. EchoNodeProbeIPAddressIdentifies the IP address where the echo node responds and is a reserved address that can be used by all teams on a subnet. It must be a valid unicast IP address and is enforced by scripting. This option is used only when Active Path and Community Address ARP response mechanism are selected. EchoNodeProbeAddressIdentifies the MAC address where the echo node responds and is a reserved address that can be used by all teams. It must be a valid unicast addresss and is enforced by scripting. This option is used only when Active Path and Community Address ARP response mechanism are selected. EchoNodeUseDefMacDetermines whether to use the reserved MAC address defined in NTID or allow the user to specify the address. This option is used only when both Active Path and Community Address ARP response mechanism are selected. Valid values are Yes and No: Yes = use the default MAC address, No = use the EchoNodeProbeAddress. EchoNodeAddress(Optional) Determines the MAC address of the echo node. EchoNodeIPAddress(Required) Determines the IP address of the echo node.

EchoNodeTimeDefines the time interval between packet transfers to the echo node. The default setting is 3 seconds. EchoNodeTimeoutDefines the maximum time interval to wait for a response from the echo node before designating the team member as failed. The default setting is 3 seconds.

Configuration properties 14

ActivePathVlanIdDetermines the VLAN ID used for the Active Path validation. This value is written only if a VLAN is defined for the team. ActivePathVlanID is only relevant if ActivePathEnabled is enabled. CriteriaRankingDetermines the priority of the redundancy mechanisms used in selecting the next port to become the Primary port. Possible values are: 2 = User Preference Order, 9 = Router Path, 1 = Active Path, 0 = Fast Path. Format is 0:1:9:2. DefaultVlanIdDetermines the VLAN ID used for any un-tagged packets received by the team. This property only applies to teams that have VLANs defined. RouterPathEnabledEnables or disables the router path protocol feature. Possible values are Enabled or Disabled. If RouterPathEnabled is set to Enabled, the team is using advanced teaming. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions. RouterPathProtocolDetermines the router path protocol. Possible values are HSRPv1 and VRRP. The default is HSRPv1. RouterPathProtocol is relevant only when RouterPathEnabled is Enabled. RouterPathIPAddressDetermines the IP address for the router path. This option is written only if RouterPathEnabled is enabled. RouterPathVlanIdDetermines the Vlan ID used for the router path validation. This option is written only if a VLAN is defined for the team. RouterPathVlanID is relevant only when RouterPathEnabled is Enabled. CDPv1EnabledEnables or disables the CDPv1 discovery protocol feature. Possible values are Enabled or Disabled. If CDPv1Enabled is set to Enabled, the team is using advanced teaming. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions. CDPv2EnabledEnables or disables the CDPv2 discovery protocol feature. Possible values are Enabled or Disabled. If CDPv2Enabled is set to Enabled, the team is using advanced teaming. A valid ProLiant Essentials Intelligent Networking Pack license must be on the target system to configure advanced teaming options on the target server. If a valid license does not exist, an error message is written to the log and the script exits without performing any actions. TOEEnabledReduces the CPU cycles required to process network traffic by shifting processing of TCP/IP from the server CPU to the HP Multifunction Server Adapters in a team. The TOEEnabled property is only valid when all the team members are HP Multifunction Server Adapters. 0=Disabled. 1=Enabled. The default setting is Disabled.

If the configuration file indicates that a TOE-enabled adapter is included in one of the following team types, the team type is changed to TransmitLoadBalancing.

Automatic 802.3ad Dynamic Dual Channel Load Balancing (INP) Switch-assisted Dual Channel Load Balancing (INP) 802.2ad Dynamic with Fault Tolerance Switch-assisted Load Balancing with Fault Tolerance (SLB)

NOTE: TOE and RSS capabilities are only available through Multifunction Server Adapters running Microsoft Scalable Networking Pack (SNP) on Windows Server 2003 SP1 and above or Windows Server 2003 x64.

Configuration properties 15

XML data file

In this section
XML elements and typical NIC teaming script ............................................................................................ 16

XML elements and typical NIC teaming script

The XML data file contains configuration properties for NICs and teams and consists of the following XML elements:

<teamingconfig>-Brackets the entire data file and is required. <nic>-Defines NIC properties. <team>-Defines teams and their properties. <vlan>-Defines VLANs and their properties.

The 'relnics' attribute of the <team> element lists the NICs that are to be configured on the team. The following example is a typical NIC teaming script. <teamingconfig> <!-<!-<!-<!-<!-The comment lines in this file make it convenient to reference <nic>, <team>, and <vlan> elements within the file. It is recommended that these comment lines remain unchanged if the user edits the file. --> --> --> --> -->

<!-<!-<!--

Version Data

--> --> -->

<version UtilityVersion='8.40.0.9' ScriptVersion='3.1'/> <!-<!-<!---> --> -->

Adapter Data

<!-- <nic> element 1 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='NetworkAddress' value='' /> </nic> <!-- <nic> element 2 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='PreferredPrimaryRanking' value='0'/> <property id='DualChannelGroup' value='0'/> <property id='ConfiguredPortCost' value='0'/> </nic>

XML data file 16

<!-- <nic> element 3 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='PreferredPrimaryRanking' value='1'/> <property id='DualChannelGroup' value='0'/> <property id='ConfiguredPortCost' value='0'/> </nic> <!-- <nic> element 4 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='RDMAEnabled' value='0'/> <property id='iSCSIEnabled' value='1'/> <property id='NetworkAddress' value='' /> <property id='TOEEnabled' value='1'/> <property id='RSSEnabled' value='1'/> <property id='iSCSISRBTimeoutDelta' value='15'/> <property id='iSCSIVlanId' value='0'/> <property id='iSCSIVlanName' value=''/> <property id='iSCSIPacketPriority' value='Disabled'/> <property id='iSCSIDHCPEnabled' value='Enabled'/> <property id='iSCSIIPAddress' value='0.0.0.0'/> <property id='iSCSISubnetMask' value='0.0.0.0'/> <property id='iSCSIGateway' value='0.0.0.0'/> <property id='iSCSILAA' value='' /> </nic> <!-- <nic> element 5 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='NetworkAddress' value='' /> </nic> <!-- <nic> element 6 --> <nic> <property id='SpeedDuplex' value='Auto/Auto'/> <property id='NetworkAddress' value='' /> </nic>

<!-<!-<!--

Team Data

--> --> -->

<!-- <team> element 1 --> <team relnics='2 3'> <property id='TeamName' value='HP Network Team #1'/> <property id='OpMode' value='TransmitLoadBalancing'/> <property id='LoadBalAlgorithm' value='Auto'/> <property id='RxPathValidationInterval' value='3'/> <property id='TxPathValidationInterval' value='3'/> <property id='RxPathValidationMode' value='Enabled'/> <property id='TxPathValidationMode' value='Enabled'/> <property id='TeamNetworkAddress' value='' /> <property id='FastPathEnabled' value='Enabled'/> <property id='FastPathSpanningTreeType' value='IEEE 802.1D'/> <property id='EchoNodeTime' value='3'/> <property id='EchoNodeTimeout' value='3'/>

XML data file 17

<property id='CriteriaRanking' value='9;1;0;2'/> <property id='RouterPathProtocol' value='HSRPv1'/> <property id='ActivePathEnabled' value='Enabled'/> <property id='EchoNodeIPAddress' value='192.168.0.2'/> <property id='EchoNodeResponseMech' value='CommunityAddressARP'/> <property id='EchoNodeProbeAddress' value='00-01-FA-FE-FE-FE'/> <property id='EchoNodeProbeIPAddress' value='192.168.0.3'/> <property id='EchoNodeUseDefMac' value='Yes'/> <property id='RouterPathEnabled' value='Enabled'/> <property id='RouterPathIPAddress' value='192.168.0.4'/> <property id='CDPv1Enabled' value='Enabled'/> <property id='CDPv2Enabled' value='Disabled'/> <property id='DefaultVlanId' value='10'/> <property id='RxPathValidationVlanId' value='10'/> <property id='FastPathVlanId' value='10'/> <property id='ActivePathVlanId' value='10'/> <property id='RouterPathVlanId' value='10'/> <property id='TOEEnabled' value='1'/> <!-- <vlan> element 1 --> <vlan> <property id='VlanId' value='10'/> <property id='VlanName' value='VLAN 10'/> </vlan> </team> </teamingconfig>

XML data file 18

Error handling and reporting

In this section
Error checking and completion code......................................................................................................... 19

Error checking and completion code

Errors can occur for a variety of reasons including differences between the source and target system NICs or because of errors introduced by editing the XML data file. The software performs extensive error checking as the XML data file is read and processed. When invalid property values are detected, a WARNING error message is written to a log file and configuration continues with either default or existing values. When the cqniccmd is run from a command line or a Windows command file, a completion code is written as an error level code to both a log file and the screen. This error code can be used by the Windows command file to determine how to proceed. The error level codes are as follows:

Successful start of the action returns a completion code of error level zero (0). Non fatal errors return a completion code of error level one (1). An invalid log file returns a completion code of error level two (2). Other fatal errors return a completion code of error level three (3) or greater.

The specific information about all errors can be determined by viewing the log file located at \cpqsystem\log\cpqteam.log (defaulted location).

Error handling and reporting 19

Acronyms and abbreviations

iSCSI
Internet small computer system interface

NCU
Network Configuration Utility

NFT
network fault tolerant

RDMA
Remote Direct Memory Access

RSS
Receive-Side Scaling

TOE
TCP/IP Offload Engine

VLAN
virtual local-area network

XML
extensible markup language

Acronyms and abbreviations

20

Index
A
Accelerated iSCSI pack 5, 6 team properties 13

X
XML sample file 16

C
command line options 9

E
error code 19 examples 9

L
license agreements 5 license key 5, 6 log file 19

N
nalicense utility 5 Network Configuration Utility 4

O
overview of configuration procedure 7

P
ProLiant Essentials Intelligent Networking Pack 5, 6

R
RDMA (Remote Direct Memory Access) 7 RDMA Pack for Multifunction Gigabit Server Adapters 5

S
script conversion 8 scripting application 8 scripting syntax 9

T
team configuration 13

Index 21