HP 289166-40B User Manual
HP Pr oL ian t Netw or k Adapt er S c r ipting Utilit y User G u ide Part Number 289166-40B March 2008 (Twentieth Edition)
© Copyright 2006, 2008 Hewlett-Packard Develop ment Company, L.P. The information contained herein is subject to chan ge without no tice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such produc ts and services. Noth ing herein should be construed as constituting an a dditional w arranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Va lid license from HP required for possession, use or copying. Con sistent with FAR 12.211 and 1 2.212 , Commercial Computer Software, Co mputer Software Documentation, and Technical Da ta for Commercial Items are licens ed to the U.S. Government under vendorâs standard commercial license. Microsoft, Windows, Windows Server 2003 and Wi ndows Server 2008 are U.S. registered trademarks of Microsoft Corporation. Audience assumptions This document is for the person who insta lls, adminis ters, and troubleshoots serv ers and storage systems. HP assumes you are qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy level s.
Con t en t s Overv iew ..................................................................................................................................... 4 Network Configuration Ut il ity and Sc ripting .................................................................................... .............. 4 Scripting func tionality ........................................................................................................ ........................ 4 Scripting ...................................................................................................................................... 5 Preliminary script ing information .............................................................................................. ................... 5 Script co nversion .............................................................................................................. ......................... 6 Scripting applicat ion (CQNICCMD) ............................................................................................... ............. 7 Command line syntax ............................................................................................................ .......... 7 Command line arguments ......................................................................................................... ........ 8 Command line exam ples .......................................................................................................... ........ 8 Command li ne help .............................................................................................................. ........... 9 Configuration proper ties ....................................................................................................... ....... 10 Adapter configurati on properties ............................................................................................... ................ 10 HP Multifunction ada pter properties ............................................................................................ ............... 10 Team configurat ion properties .................................................................................................. ................. 12 XML data file .................................................................................................................. ............ 14 XML elements and typical adapter team ing script ................................................................................ ........ 14 Error handling and repo rting ................................................................................................... ..... 17 Error checking and completion code ............................................................................................. ............. 17 Acronyms and abbreviati ons ..................................................................................................... ... 18 Index .......................................................................................................................... ............... 19 Contents 3
Ov er v i e w Network Configuration Utility and Scripting The HP Network Configuration Utility (NCU) enables configuration of network adapters and teams of network adapters. The scripting feature of the utility provides the abili ty to perform adapter configuration using a batch process. This guide provides information about using the HP Network Adapter Scripting Utility to configure HP adapters. Scripting functionality Scripting functionality provides the capability to configure a target system based on configuration information saved from a source server. The target syst em is not required to be identical to the source server. The configuration of the so urce server may not be duplicated in its entirety on the target sy stem. Both adapters and teams of adapters can be configured on the target system. When scripting is run, the adapter properties specified in the data file from the source server are u sed to modify the configuration of the adapters on the target system. Refer to " Preliminary scripting information (on page 5)" for details about running the scripting utility. Overview 4
Sc r i pt i ng Preliminary scripting information When using scripting to configure target systems, adapt ers are identified by their relative order in the system. The relative order is determined by the following properties. ⢠Slot and port order for adapters in non-HP BladeSystem configu rations ⢠Enclosure switch bay number and switch port or der for adapters in HP BladeSystem configurations Adapters embedded on the system board are assigned the lowest numbers, followed by adapters ordered by their slot or switch bay number with the lowest slot or switch bay nu mber first. Multiport adapters are ordered by ascending port or switch port number within each slot. Order of adapters on target systems Adapters on the target system are configured to match the co rrespond ing adapter number on the source server. ⢠The first adapter on the target syst em is configured using data from the first adapter on the source server. ⢠The second adapter on the target system is conf igured us ing data from the second adapter on the source server, and so on. ⢠If the target system has more adapters than the so urce server, then the extra adapters retain their current settings. ⢠If the target system ha s fewer adapters than the source server, data for additional adapters on the source server is ignored. HP Multifunction adapters on target systems eive-Side Scaling (RSS) parameters on an HP ltifu ⢠n adapter must be located in the same relative position on the target server as on the ⢠ameters are assigned to an adapter that does not support iSCSI, TOE, or ⢠tion param eters but the parameters are not assigned, the t To transfer iSCSI, TCP/IP Offload Engine (TOE), or Rec mu nction adapter, the following conditions apply: The multifunctio source server. If these multifunction par RSS, they are ignored. If an adapter supports these multifunc existing settings are left unchanged. Microsoft Scalable Networking Pack (SNP) is req u ired when enabling TOE or RSS and is included on systems running Windows Server 2003 (SP2) an d Windows Ser ver 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE or RSS adapter functi onality on a system running Windows Server 2003 (SP1) or Windows Server 2003 x64 (SP1), you must downlo ad SNP and required Microsof hotfixes and install them on the system. See the Microsoft ( http://www.microsoft.com ) website to Scripting 5
download the latest version of the Microsoft Wind ows Server 2003 Scalable Net working Pack (SNP) and required Microsoft Windows Serv er 2003 (SP1) hotfixes in article numbers 9 21136, 919948, and 923187 of the Microsoft Knowledg e Base (KB). These Microsoft hotfixes are required only for ows Server 2003 x64 (SP1). 2). Windows Server 2003 (SP1) and Wind RSS support on PCIe gigabit server adapters RSS is supported on NC110T, NC 360T, and NC364T PCIe gigabit server adapters running Microsoft Scalable Networking Pack (SNP) on Wind ows Server 2003 (SP2) and Windows Server 2003 x64 (SP These adapters also support RSS ru nning SNP on Windows Server 2003 (SP1) and Windows Server 2003 x64 (SP1); however, SNP is not included with SP1 and must be downloaded and installed along with required Microsoft hot fixes. See the Microsoft ( http://www.microsoft.com ) website to download latest version of the Microsoft Window s Server 2003 Scalable Networking Pack (SNP) and required Microsoft Windows Server 2003 (SP1) hotfixes in article numbers 92113 6, 919948, and 923187 of t Microsoft Knowledg e Base (KB). These Micros the he oft hotfixes are require d only for Windows Server 2003 tr ⢠pter must be located in the same relative po sition on the target server as on the source ⢠ports the RSS parameter but the param eter is not assigned, the existing settings are ⢠on t information is saved in the data file, and adapters 3 and 5 are teamed on the target ⢠d if ⢠⢠d from ile ⢠If no teams are configured on the so urce server, no teaming information is written to the data file target system consis ts only of configuring individual adapters. Scrip recommends that you ating modes in scripts gen erated with (SP1) and Windows Server 2003 x64 (SP1). To ansfer the RSS parameter on one of th ese adapters, the following conditions apply: The ada server. ⢠If the RSS parameter is assigned to an adapter that does not su pport RSS, it is ignored. If an adapter sup left unchanged. Teams on target systems The target system is configured with the same number of teams that were present on the source serv er. Teams are created on the target system consisting of the same relative adapters that were teamed the source server. For example, if adapters 3 and 5 were teamed on the source server, then tha teaming system. In general, the adapters on the team on the target system do not have to be the same type of adapters that were teamed on the source server. However, some adapters ca nnot be teamed an an attempt is made to form a team with inva lid combinations of adapter s an error occurs. For example, teams with different speed capabilities cannot be teamed on a load balanci ng team. An error occurs in the configuration if the adapter s forming the team on the source server are not present on the target system. For example, if adapters 3 and 5 are teamed on the source server, but the target system has only four adapters, 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 rea the data file for the corresponding team on the source serv er. Properties not specified in the data f (and properties specified with invalid data valu es) are configured using their default settings. and configuration of the t conversion Scripts created with previous versions of the NCU are supported; however, HP recreate the script using the latest version of the NC U. Several oper NCU versions 7.7x and earlier have changed and are converted as follows: Scripting 6
⢠Manual is converted to Networ k Fault Tolerance Only (NFT). SmartSwitch is converted to Network Fault Tolerance Only with Preference Order. ⢠ri maryNic attribute determines which team member aryRanking attribute. Scrip nfigur ation script file to duplicate rce ProLiant BL/ML/DL server on a target server. is indows operating systems: e Configur ation Utility (NCU) must be closed. the SmartStart Scripting Toolkit (SSST) using ource server. 2. 3. e script file, HP recommends that you run CQNICCMD/ P to check the syntax of the ors and warnings. The default location of the log file is ntax of the /P option is cqniccmd 5. ax. 6. he SmartStart Scriptin g Toolkit (SSST), refer to the documentation included be downloaded from http://www.hp.com/servers/proliantessentials ⢠For Smart Switch Teams, the existing PreferredP should be more highly ranked than others within the PreferredPrim All other unspecified parameter s use their defaults. ting application (CQNICCMD) CQNICCMD is a Windows utility that processes a network adapter co the adapter teaming configuration of a sou Th utility is supported on the following W ⢠Windows Server 2008 ⢠Windows Server 2008 x64 Editions ⢠Windows Server 2003 ⢠Windows Server 2003 x64 Editions Run the utility from the command line in a Command Prompt window, from the Run option on th Windows Start menu, or from a Windows command file. To execute the CQNICCMD utility fr om the command line, the HP Network HP recommends that you use this application as part of deployment. However, the application can be used outs ide of this environment. Follow these steps when the scripting application. 1. Configure adapter teaming on the s Generate a script file on the source serv er by clicking Save in the HP NCU user interface or running CQNICCMD /S<filename> in the Comm and Line utility. Modify the script file as necessary. If you modify th modified file and check the log file for err \cpqsystem\log\cpqteam.log on the system drive. The sy /p<filename> 4. Install the HP NCU on the target system. Run the Command Line utility with the following synt 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. For use of this utility with t with SSST. The SSST can ( http://www.hp.com/servers/proliantessentials ). Comm CMD [[F/] /C<filename>] [/D] [/L <filename>] [/P <filename>] ilename>] [/?] Only one of the following config uratio n options can be specified at a time: and line syntax CQNIC [/S<f Scripting 7
/S /D /C /P The /L argument can be used with any of the configuration options. The /F argument can only be used ith the configuration option. Comm d line a Argument w /C an rguments Description /S This configuration option causes the source serv er configuration to be saved. The name of the XML configuration data file must be specifie d and the path to the data file must exist. This option is identical to saving the source se rver configuration by clicking Sav e in the Network Teaming Configuration user interface. /D s This configuration option causes all teams on the target server to be dissolved, all VLAN to be removed, and 802. 1p/q Packet Tagging to b e disabled for all ada pters that had no VLANs. No additional arguments are re quired or allowed with this option. /C ation specified in the data file t o the target t server This configuration option ap plies the configur system. An existing XML configuration data fi le must be specified following the target switch. A space following the switch is optional . Any teams that exist on the targe will be dissolved before the configuration is applied, all VLANs will be removed, and 802.1p/q Pack et Tagging will be disabled . /P r syntax checking the XML data file. This option is identical to the /C option, except that the configuration options are not applied to the target system. This is useful fo /L 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 config uration to terminate with no changes. HP recommends this option only in batch files. /F This option causes be treated as fatal errors. This ar all errors, including those errors normally treated as non-fatal errors, to gument can be used only with the /C option. Comman \HP\teamcfg.xml :\HP\teamcfg.xml ccmd /S"c:\HP\teamcfg.xml" d line examples /S cqniccmd /Sc: qniccmd /S c c cqni /D cqniccmd /D /C cqniccmd /Cc:\HP\teamcfg.xml cqniccmd /C c:\HP\teamcfg.xml cqniccmd /C"c:\HP\teamcfg.xml" /P cqniccmd /Pc:\HP\teamcfg.xml cqniccmd /P c:\HP\teamcfg.xml cqniccmd /P"c:\HP\teamcfg.xml" /L Scripting 8
cqniccmd /Cc:\HP\teamcfg.xml /Lc: cqniccmd /C c:\HP\teamcfg.xml /L c \HP\config.log :\HP\config.log cqniccmd /C"c:\HP\teamcfg.xml" /L" c:\HP\config.log" Command line help The f an be used to display usage information. For e P<filename>] nges the name and location of the logfile to the specified filename to check for syntax errors. specified filename. cqniccmd /Cc:\teamcfg.xml To apply a script and specify the logfile location: cqniccmd /Cc:\teamcfg.xml /Lc:\logs\teamcfg.log /F cqniccmd /F /C c:\HP\teamcfg.xml ollowing option c /? xample: cqniccmd /? Usage: cqniccmd [[/F] /C<filename>] [/D] [/L<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 Cha filename. /P Parses the specified /S Saves the source server configuration to the Examples: To apply a script: Scripting 9
Con figu rat io n p rop e r t ie s Adapter configuration properties The following properties are configured on the target server adapters from the source server data. Properties that are common to all HP adapters in clude: ⢠SpeedDuplex âDetermines the current speed and duplex of the adapter. Possible values include Auto/Auto, 10/Half, 10/Full, 100/Half, 100/Full, 10 00/Full. The default is Auto/Aut o. The value must be valid for the adapter on the target system. ⢠PreferredPrimaryRanking âDetermines the preferred primary ra nking of the adapter. This value is written only for adapters that are teamed. ⢠ConfiguredPortCost âDefines the port cost for the adapter. The de fault is 0. This value is written only for adapters that are teamed. ⢠DefaultVlanIdâ Determines the VLAN ID used for any un -tagged packets received by the adapter. This only applies to adapters that have VLANs defined. ⢠VlanIDâ Specifies the VLAN identifi er value for the device. ⢠VlanNameâ Specifies the descriptive na me for the VLAN ID. Every VLAN must have a name assigned to it. Duplicate names are allowed if yo u want to use the same names for different VLa n ⢠d- le network address is the burned-in address. This value must be a valid unicast address if it is edited. e adapter must be located in the same relative position on the target machine as on the sou rce e multifunction parameters but the parameters are not assigned, the ⢠ured for the led device. IDs. NetworkAddress âThis value is written only for adapters that are not teamed. It overrides the burne in address with a locally administered address. A nu ll value is always written to the XML data fi because locally administered addre sses must be unique. A null value is valid and indicates the HP Multifunction adapter properties The following properties are common only to HP Multifunction adapters. To transfer iSCSI, TCP/IP Offload Engine (TOE), and Receive-Side Scaling (RSS) parameters on an adapter, th machine. If the following parameters ar e assigned to an adapter that does not support iSCSI, TOE, or RSS, they ar ignored. If an adapter supports these existing settings are left unchanged. iSCSIEnabled âCauses Internet Small Computer Syst em Interface (iSCSI) to be config adapter. 0=Disabled. 1=Enabled. The default setting is Disabled. ⢠iSCSIVlanId âSpecifies the iSCSI VLAN identifi er value for the iSCSI enab ⢠iSCSIVlanName âSpecifies the descriptive name for the iSCSI VLAN ID. Configuration properties 10
⢠iSCSIPacketPriority âSpecifies the QoS Packet Prior ity for th e iSCSI enabled device. Possible v are D=Disabled and 1-7. The de fault setting is D (Disabled). alues If . ⢠d MAC address of the iSCSI add ess is the burned-in address. T d unicast address if it is edited. o adapters. Disable iSCSI on the he incompatible team types. o or 2.0 or later on s rver ⢠⢠iSCSIDHCPEnabled âSpecifies that DHCP is used to acqu ire an IP configuration for the iSCSI enabled device. Possible settings are Enabled and Disabled. Th e default setting is Enabled. ⢠iSCSIIPAddress âIf 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. ⢠iSCSISubnetMask âIf DHCP is not used, this property sp ecifies the network subnet mask (dotted decimal) for the iSCSI enabled device. If DHCP is en abled, the value is 0.0.0. 0, otherwise, enter the actual subnet mask. ⢠iSCSIGateway âIf DHCP is not used, this specifies the de fault route for the iSCSI enabled device. DHCP is enabled or no gateway is used, the value is 0.0.0.0, otherwise, type the actual IP address iSCSILAA â(Locally Administered Addres s) specifies the user-defin e enabled device. A null value is always written to the XML data file because locally administered resses must be unique. A null value is valid and indicates the network addr his value must be a vali The following team types are no t supported for iSCSI-enabled adapter or team before changing to an y of t â Automatic â 802.3ad Dynamic with Fault Tolerance â Switch-assisted Load Balancing with Faul t Tolerance (SLB) If the NCU does not detect the presence of the Mi crosoft® iSCSI Soft ware Initiat systems running Window s Server 2003 (SP1), Windows Server 2003 x64 (SP1), Window Server 2003 (SP2), or Windows Server 2003 (SP2 ), iSCSI cannot be enabled. Window s Se 2008 and Windows Server 2008 x64 comes with the iSCSI Initiato r included. TOEEnabled âEnables the offloading of TCP connectio ns to the Multifu nction Server Adapter. Microsoft Scalable Networking Pack (SNP) is re quired when enabling TOE and is included on systems running Window s Server 2003 (SP2) or Windows Serv er 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE adapter functionalit y on a system running Windows Serv er 2003 (SP1) or Windows Server 2003 x64 (S P1), you must download SNP and required Microsoft hotfixes and install them on the system. See the Microsoft ( http://www.micro soft.com ) website to downl the latest version of the Microsoft Windows Se rver 2003 Scalable Ne oad tworking Pack (SNP) and nd ork device is configured with the round on ⢠S required Microsoft Windows Server 200 3 (SP1) hotfixes in article numbers 921136, 91994 8, a 923187 of the Microsoft K nowledge Base (KB). These Microsoft hot fixes are required only for Windows Server 2003 (SP1) and Windows Serv er 2003 x64 (SP1). TOE teaming performance is reduce d if a switc h or netw robin aggregation load balancing method. Configure the aggregat ion load balancing method the switch or network device to somethin g else ot her than round robin and then re-start the team (disable the team and enable the team for all VLANs). RSSEnabled âEnables the receiv e processing of networ king traffic to be load balanced across teamed adapters. Microsoft Scalable Network ing Pack (SNP) is requir ed when enabling RSS and is included on systems running Window s Server 2003 (SP2), Windows Server 2003 x64 (SP2), Windows Server 2008, or Windows Ser ver 2008 x64. SNP also is supported, but not includ ed, on systems running Window s Server 2003 (SP1) and Windows Server 2003 x64 (S P1). To enable RS adapter functionality on a system running Wind ows Server 2003 (SP1) or Windows Server 2003 Configuration properties 11
x64 (SP1), download SNP and required Microsoft ho tfixes and install them on the system. See the Microsoft ( http://www.microsoft.com ) website to download the late st vers ion of the Micr osoft Windows Server 2003 Scalable Networking Pa ck (SNP) and required Microsoft Windows Server 948, and 923187 of the Microsoft Knowledg e for Windows Server 2003 (SP1) and Windows Team configuration properties the target , ⢠⢠s for the adapter team. A null value is always ue is st be a valid unicast address if it is edited. ⢠alidationMode âEnables or disables the packet si gnal received between the teamed ⢠ceptable values is 3 to 60. Values less than 3 are set to 3, and values greater than 60 are set ⢠es are AN ⢠⢠s 2003 (SP1) hotfixes in article numbers 921136, 919 Base (KB). These Micro soft hotfixes are required only Server 2003 x64 (SP1). Team configuration properties that are configured on the target s erver include: ⢠TeamName âDetermines the unique identifier for the a dapter team. Each team name on system must be unique. ⢠OpMode âDetermines the operating mod e of the team. Possible values are Auto, DynamicSingl eSlb StaticSingleSlb, TransmitLoadBalancing, TLBwithPref, FailOnFault, PrefPrimary LoadBalAlgorithm âDetermines the team load balancing algorithm. Possible values are MACAddress, IPAddress, TCPConne ction, RoundRobin, and Auto. TeamNetworkAddress âEstablishes the MAC addres written to the XML data file because locally admin istered addresses must be unique. A null val valid and computes a default address. This value mu ⢠TxPathValidationMode âEnables or disables the packet sign al transmitted between the teamed adapters. Possible values are Enabled or Disabled. RxPathV adapters. Possible values are Enabled or Disabled. TxPathValidationInterval âDetermines how frequently the packet signals are transmitted. The range of ac to 60. RxPathValidationInterval âDetermines how frequently the packet signals are received. The range of acceptable values is 3 to 60. Valu es less than 3 are set to 3, and va lues gre ater than 60 are set to 60. ⢠RxPathValidationVlanId âDetermines the VLAN on which Receive Path Validation packet f ram transmitted. This value is only wr itten when a VLAN is defined for the team. The default is the VL on the team with the lowest VLAN ID at the time the team is created. DefaultVlanId âDetermines the VLAN ID used for any un-t agged packets received by the team. This property only applies to teams that have VLANs defined. TOEEnabled âEnables the offloading of TCP connectio ns to the Multifu nction Server Adapter. Microsoft Scalable Networking Pack (SNP) is re quired when enabling TOE and is included on systems running Window s Server 2003 (SP2) or Windows Serv er 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE adapter functionalit y on a system running Windows Serv er 2003 (SP1) or Windows Server 2003 x64 (S P1), you must download SNP and required Microsoft hotfixe and install them on the system. See the Microsoft ( http://www.micro soft.com ) website to do the latest version of the Microsoft Windows wnload Se rver 2003 Scalable Networking Pack (SNP) and nd Windows Server 2003 (SP1) and Windows Server 2 003 x64 (SP1). The TOEEnabled property is required Microsoft Windows Server 200 3 (SP1) hotfixes in article numbers 921136, 91994 8, a 923187 of the Microsoft K nowledge Base (KB). These Microsoft hot fixes are required only for Configuration properties 12
only valid when all the team members are HP Multifunction Server Adapters. 0=Disabled. 1=Enabled. The default setting is Enabled. TOE teaming performance is reduce d if a switc h or network device is configured with the round robin aggregation load balancing method. Configure the aggregat ion load balancing method on und robin and then re-start the team ⢠, ed, on (SP1). To enable RSS nload SNP and required Microsoft hotfixes and install them on the system. ultifunction server adapters and Disabled on NC110T, NC360T, and NC 364T PCIe gigabit server adapters. TOE and RSS teaming are not supported on Wind ows Server 2008 and Windows Server 2008 x64 in this release. Currently not supported on HP NC51xx 10 GbE adapters. the switch or network device to somethin g else ot her than ro (disable the team and enable the team for all VLANs). TOE and RSS teaming are not supported on Wind ows Server 2008 and Windows Server 2008 x64 in this release. Currently not supported on HP NC51xx 10 GbE adapters. RSSEnabledâ Enables the receive processi ng of networ king traffic to be load balanced across teamed adapters. Microsoft Scalable Network ing Pack (SNP) is requir ed when enabling RSS and is included on systems running Window s Server 2003 (SP2), Windows Server 2003 x64 (SP2) Windows Server 2008, or Windows Ser ver 2008 x64. SNP also is supported, but not includ systems running Window s Server 2003 (SP1) and Windows Server 2003 x64 adapter functionality on a system running Wind ows Server 2003 (SP1) or Windows Server 2003 x64 (SP1), dow 0=Disabled. 1=Enabled. The default setting is Enabled on m Configuration properties 13
XML data f ile XML elements and typical adapter teaming script The XML data file contains configuration properties for adapters and teams and consists of the following XML elements: ⢠<teamingconfig>-Bracket s the enti re data file and is required. ⢠<nic>-Defines adapter properties. ⢠<team>-Defines teams and their properties. ⢠<vlan>-Defines VLANs and their properties. The 'relnics' attribute of the <tea m> element lists the adapters that are to be configured on the team. The following example is a typical adapter teaming script. "1.0" encoding="ISO-8859-1" ?> <?xml version= - <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 - <!-- --> - <!-- --> 0.7" ScriptVersion="3.1" /> <version UtilityVersion="9.00. - <!-- --> Adapter Data - <!-- --> - <!-- --> <nic> element 1 - <!-- --> - <nic> " /> <property id="SpeedDuplex" value="Auto/Auto ty id="NetworkAddress" value="" /> <proper </nic> <nic> element 2 - <!-- --> - <nic> o" /> <property id="SpeedDuplex" value="Auto/Aut XML data file 14
<property id="iSCSIEnabled" value="1" /> <property id="PreferredPrimaryRanking" value="0" /> 0" /> > .0.0" /> y id="iSCSILAA" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> " /> 0" /> .0.0" /> y id="iSCSILAA" value="" /> <property id="DualChannelGroup" value="0" /> <property id="ConfiguredPortCost" value=" <property id="TOEEnabled" value="1" /> <property id="RSSEnabled" value="1" /> <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 <propert </nic> <nic> element 3 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="100/Full" <propert </nic> <nic> element 4 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="100/Full" <propert </nic> <nic> element 5 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="Auto/Auto" <propert </nic> <nic> element 6 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="Auto/Auto" <propert </nic> <nic> element 7 - <!-- --> - <nic> " /> <property id="SpeedDuplex" value="Auto/Auto <property id="iSCSIEnabled" value="0" /> <property id="PreferredPrimaryRanking" value="1 <property id="DualChannelGroup" value="0" /> <property id="ConfiguredPortCost" value=" <property id="TOEEnabled" value="1" /> <property id="RSSEnabled" value="1" /> <property id="iSCSIVlanId" value="1" /> <property id="iSCSIVlanName" value="iRon" /> <property id="iSCSIPacketPriority" value="1" /> <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 <propert </nic> - <!-- XML data file 15
--> - <!-- Team Data <team> element 1 ed" /> id="RSSEnabled" value="1" /> </teamingconfig> --> - <!-- --> - <!-- --> - <team relnics="2 7"> <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="Enabl " /> <property id="TeamNetworkAddress" value=" <property id="TOEEnabled" value="1" /> <property </team> XML data file 16
Er r or handling and r eporting Error checking and completion code Errors can occur for a variety of reasons including di fferences between the s ource and target system NICs or because of errors introduced by editin g the XML data file. The software perform s extensive error checking as the XML data file is read and processed. When invalid property values are detecte d, a WARN ING error message is written to a log file and configuration continue s with either default or existin g 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 . T his error code can be used by the Windows command file to determ ine how to proceed. The error level cod es are as follows: ⢠Successful start of the acti on returns a completion code of error l evel zero (0). ⢠Non fatal errors return a completion code of error level one (1). ⢠An invalid log file returns a comple tion 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 17
A c r on y ms and a bbr e v i ati ons iSCSI Internet Small Computer System Interfa ce NCU Network Configuration Utilit y NFT network fault tolerant RSS Receive-Side Scaling TOE TCP/IP Offload Engine VLAN virtual local-area network XML extensible markup lang uage Acronyms and abbreviations 18
Inde x A adapter properties 10 C command line options 8 CQNICCMD 7 E error code 17 examples 8 L log file 17 O overview of configuration procedur e 5 R Receive-Side Scaling (RSS) 5, 10, 12 RSS (Receive-Side Scaling) 5, 10, 12 S script conversion 6 scripting application 7 scripting syntax 7 T TCP/IP Offload Engine (TOE) 5, 10, 12 team configuration 12 team properties 12 TOE (TCP/IP Offload Engine) 5, 10, 12 X XML sample file 14 Index 19
© Copyright 2006, 2008 Hewlett-Packard Develop ment Company, L.P. The information contained herein is subject to chan ge without no tice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such produc ts and services. Noth ing herein should be construed as constituting an a dditional w arranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Va lid license from HP required for possession, use or copying. Con sistent with FAR 12.211 and 1 2.212 , Commercial Computer Software, Co mputer Software Documentation, and Technical Da ta for Commercial Items are licens ed to the U.S. Government under vendorâs standard commercial license. Microsoft, Windows, Windows Server 2003 and Wi ndows Server 2008 are U.S. registered trademarks of Microsoft Corporation. Audience assumptions This document is for the person who insta lls, adminis ters, and troubleshoots serv ers and storage systems. HP assumes you are qualified in the servicing of computer equipment and trained in recognizing hazards in products with hazardous energy level s.
Con t en t s Overv iew ..................................................................................................................................... 4 Network Configuration Ut il ity and Sc ripting .................................................................................... .............. 4 Scripting func tionality ........................................................................................................ ........................ 4 Scripting ...................................................................................................................................... 5 Preliminary script ing information .............................................................................................. ................... 5 Script co nversion .............................................................................................................. ......................... 6 Scripting applicat ion (CQNICCMD) ............................................................................................... ............. 7 Command line syntax ............................................................................................................ .......... 7 Command line arguments ......................................................................................................... ........ 8 Command line exam ples .......................................................................................................... ........ 8 Command li ne help .............................................................................................................. ........... 9 Configuration proper ties ....................................................................................................... ....... 10 Adapter configurati on properties ............................................................................................... ................ 10 HP Multifunction ada pter properties ............................................................................................ ............... 10 Team configurat ion properties .................................................................................................. ................. 12 XML data file .................................................................................................................. ............ 14 XML elements and typical adapter team ing script ................................................................................ ........ 14 Error handling and repo rting ................................................................................................... ..... 17 Error checking and completion code ............................................................................................. ............. 17 Acronyms and abbreviati ons ..................................................................................................... ... 18 Index .......................................................................................................................... ............... 19 Contents 3
Ov er v i e w Network Configuration Utility and Scripting The HP Network Configuration Utility (NCU) enables configuration of network adapters and teams of network adapters. The scripting feature of the utility provides the abili ty to perform adapter configuration using a batch process. This guide provides information about using the HP Network Adapter Scripting Utility to configure HP adapters. Scripting functionality Scripting functionality provides the capability to configure a target system based on configuration information saved from a source server. The target syst em is not required to be identical to the source server. The configuration of the so urce server may not be duplicated in its entirety on the target sy stem. Both adapters and teams of adapters can be configured on the target system. When scripting is run, the adapter properties specified in the data file from the source server are u sed to modify the configuration of the adapters on the target system. Refer to " Preliminary scripting information (on page 5)" for details about running the scripting utility. Overview 4
Sc r i pt i ng Preliminary scripting information When using scripting to configure target systems, adapt ers are identified by their relative order in the system. The relative order is determined by the following properties. ⢠Slot and port order for adapters in non-HP BladeSystem configu rations ⢠Enclosure switch bay number and switch port or der for adapters in HP BladeSystem configurations Adapters embedded on the system board are assigned the lowest numbers, followed by adapters ordered by their slot or switch bay number with the lowest slot or switch bay nu mber first. Multiport adapters are ordered by ascending port or switch port number within each slot. Order of adapters on target systems Adapters on the target system are configured to match the co rrespond ing adapter number on the source server. ⢠The first adapter on the target syst em is configured using data from the first adapter on the source server. ⢠The second adapter on the target system is conf igured us ing data from the second adapter on the source server, and so on. ⢠If the target system has more adapters than the so urce server, then the extra adapters retain their current settings. ⢠If the target system ha s fewer adapters than the source server, data for additional adapters on the source server is ignored. HP Multifunction adapters on target systems eive-Side Scaling (RSS) parameters on an HP ltifu ⢠n adapter must be located in the same relative position on the target server as on the ⢠ameters are assigned to an adapter that does not support iSCSI, TOE, or ⢠tion param eters but the parameters are not assigned, the t To transfer iSCSI, TCP/IP Offload Engine (TOE), or Rec mu nction adapter, the following conditions apply: The multifunctio source server. If these multifunction par RSS, they are ignored. If an adapter supports these multifunc existing settings are left unchanged. Microsoft Scalable Networking Pack (SNP) is req u ired when enabling TOE or RSS and is included on systems running Windows Server 2003 (SP2) an d Windows Ser ver 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE or RSS adapter functi onality on a system running Windows Server 2003 (SP1) or Windows Server 2003 x64 (SP1), you must downlo ad SNP and required Microsof hotfixes and install them on the system. See the Microsoft ( http://www.microsoft.com ) website to Scripting 5
download the latest version of the Microsoft Wind ows Server 2003 Scalable Net working Pack (SNP) and required Microsoft Windows Serv er 2003 (SP1) hotfixes in article numbers 9 21136, 919948, and 923187 of the Microsoft Knowledg e Base (KB). These Microsoft hotfixes are required only for ows Server 2003 x64 (SP1). 2). Windows Server 2003 (SP1) and Wind RSS support on PCIe gigabit server adapters RSS is supported on NC110T, NC 360T, and NC364T PCIe gigabit server adapters running Microsoft Scalable Networking Pack (SNP) on Wind ows Server 2003 (SP2) and Windows Server 2003 x64 (SP These adapters also support RSS ru nning SNP on Windows Server 2003 (SP1) and Windows Server 2003 x64 (SP1); however, SNP is not included with SP1 and must be downloaded and installed along with required Microsoft hot fixes. See the Microsoft ( http://www.microsoft.com ) website to download latest version of the Microsoft Window s Server 2003 Scalable Networking Pack (SNP) and required Microsoft Windows Server 2003 (SP1) hotfixes in article numbers 92113 6, 919948, and 923187 of t Microsoft Knowledg e Base (KB). These Micros the he oft hotfixes are require d only for Windows Server 2003 tr ⢠pter must be located in the same relative po sition on the target server as on the source ⢠ports the RSS parameter but the param eter is not assigned, the existing settings are ⢠on t information is saved in the data file, and adapters 3 and 5 are teamed on the target ⢠d if ⢠⢠d from ile ⢠If no teams are configured on the so urce server, no teaming information is written to the data file target system consis ts only of configuring individual adapters. Scrip recommends that you ating modes in scripts gen erated with (SP1) and Windows Server 2003 x64 (SP1). To ansfer the RSS parameter on one of th ese adapters, the following conditions apply: The ada server. ⢠If the RSS parameter is assigned to an adapter that does not su pport RSS, it is ignored. If an adapter sup left unchanged. Teams on target systems The target system is configured with the same number of teams that were present on the source serv er. Teams are created on the target system consisting of the same relative adapters that were teamed the source server. For example, if adapters 3 and 5 were teamed on the source server, then tha teaming system. In general, the adapters on the team on the target system do not have to be the same type of adapters that were teamed on the source server. However, some adapters ca nnot be teamed an an attempt is made to form a team with inva lid combinations of adapter s an error occurs. For example, teams with different speed capabilities cannot be teamed on a load balanci ng team. An error occurs in the configuration if the adapter s forming the team on the source server are not present on the target system. For example, if adapters 3 and 5 are teamed on the source server, but the target system has only four adapters, 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 rea the data file for the corresponding team on the source serv er. Properties not specified in the data f (and properties specified with invalid data valu es) are configured using their default settings. and configuration of the t conversion Scripts created with previous versions of the NCU are supported; however, HP recreate the script using the latest version of the NC U. Several oper NCU versions 7.7x and earlier have changed and are converted as follows: Scripting 6
⢠Manual is converted to Networ k Fault Tolerance Only (NFT). SmartSwitch is converted to Network Fault Tolerance Only with Preference Order. ⢠ri maryNic attribute determines which team member aryRanking attribute. Scrip nfigur ation script file to duplicate rce ProLiant BL/ML/DL server on a target server. is indows operating systems: e Configur ation Utility (NCU) must be closed. the SmartStart Scripting Toolkit (SSST) using ource server. 2. 3. e script file, HP recommends that you run CQNICCMD/ P to check the syntax of the ors and warnings. The default location of the log file is ntax of the /P option is cqniccmd 5. ax. 6. he SmartStart Scriptin g Toolkit (SSST), refer to the documentation included be downloaded from http://www.hp.com/servers/proliantessentials ⢠For Smart Switch Teams, the existing PreferredP should be more highly ranked than others within the PreferredPrim All other unspecified parameter s use their defaults. ting application (CQNICCMD) CQNICCMD is a Windows utility that processes a network adapter co the adapter teaming configuration of a sou Th utility is supported on the following W ⢠Windows Server 2008 ⢠Windows Server 2008 x64 Editions ⢠Windows Server 2003 ⢠Windows Server 2003 x64 Editions Run the utility from the command line in a Command Prompt window, from the Run option on th Windows Start menu, or from a Windows command file. To execute the CQNICCMD utility fr om the command line, the HP Network HP recommends that you use this application as part of deployment. However, the application can be used outs ide of this environment. Follow these steps when the scripting application. 1. Configure adapter teaming on the s Generate a script file on the source serv er by clicking Save in the HP NCU user interface or running CQNICCMD /S<filename> in the Comm and Line utility. Modify the script file as necessary. If you modify th modified file and check the log file for err \cpqsystem\log\cpqteam.log on the system drive. The sy /p<filename> 4. Install the HP NCU on the target system. Run the Command Line utility with the following synt 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. For use of this utility with t with SSST. The SSST can ( http://www.hp.com/servers/proliantessentials ). Comm CMD [[F/] /C<filename>] [/D] [/L <filename>] [/P <filename>] ilename>] [/?] Only one of the following config uratio n options can be specified at a time: and line syntax CQNIC [/S<f Scripting 7
/S /D /C /P The /L argument can be used with any of the configuration options. The /F argument can only be used ith the configuration option. Comm d line a Argument w /C an rguments Description /S This configuration option causes the source serv er configuration to be saved. The name of the XML configuration data file must be specifie d and the path to the data file must exist. This option is identical to saving the source se rver configuration by clicking Sav e in the Network Teaming Configuration user interface. /D s This configuration option causes all teams on the target server to be dissolved, all VLAN to be removed, and 802. 1p/q Packet Tagging to b e disabled for all ada pters that had no VLANs. No additional arguments are re quired or allowed with this option. /C ation specified in the data file t o the target t server This configuration option ap plies the configur system. An existing XML configuration data fi le must be specified following the target switch. A space following the switch is optional . Any teams that exist on the targe will be dissolved before the configuration is applied, all VLANs will be removed, and 802.1p/q Pack et Tagging will be disabled . /P r syntax checking the XML data file. This option is identical to the /C option, except that the configuration options are not applied to the target system. This is useful fo /L 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 config uration to terminate with no changes. HP recommends this option only in batch files. /F This option causes be treated as fatal errors. This ar all errors, including those errors normally treated as non-fatal errors, to gument can be used only with the /C option. Comman \HP\teamcfg.xml :\HP\teamcfg.xml ccmd /S"c:\HP\teamcfg.xml" d line examples /S cqniccmd /Sc: qniccmd /S c c cqni /D cqniccmd /D /C cqniccmd /Cc:\HP\teamcfg.xml cqniccmd /C c:\HP\teamcfg.xml cqniccmd /C"c:\HP\teamcfg.xml" /P cqniccmd /Pc:\HP\teamcfg.xml cqniccmd /P c:\HP\teamcfg.xml cqniccmd /P"c:\HP\teamcfg.xml" /L Scripting 8
cqniccmd /Cc:\HP\teamcfg.xml /Lc: cqniccmd /C c:\HP\teamcfg.xml /L c \HP\config.log :\HP\config.log cqniccmd /C"c:\HP\teamcfg.xml" /L" c:\HP\config.log" Command line help The f an be used to display usage information. For e P<filename>] nges the name and location of the logfile to the specified filename to check for syntax errors. specified filename. cqniccmd /Cc:\teamcfg.xml To apply a script and specify the logfile location: cqniccmd /Cc:\teamcfg.xml /Lc:\logs\teamcfg.log /F cqniccmd /F /C c:\HP\teamcfg.xml ollowing option c /? xample: cqniccmd /? Usage: cqniccmd [[/F] /C<filename>] [/D] [/L<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 Cha filename. /P Parses the specified /S Saves the source server configuration to the Examples: To apply a script: Scripting 9
Con figu rat io n p rop e r t ie s Adapter configuration properties The following properties are configured on the target server adapters from the source server data. Properties that are common to all HP adapters in clude: ⢠SpeedDuplex âDetermines the current speed and duplex of the adapter. Possible values include Auto/Auto, 10/Half, 10/Full, 100/Half, 100/Full, 10 00/Full. The default is Auto/Aut o. The value must be valid for the adapter on the target system. ⢠PreferredPrimaryRanking âDetermines the preferred primary ra nking of the adapter. This value is written only for adapters that are teamed. ⢠ConfiguredPortCost âDefines the port cost for the adapter. The de fault is 0. This value is written only for adapters that are teamed. ⢠DefaultVlanIdâ Determines the VLAN ID used for any un -tagged packets received by the adapter. This only applies to adapters that have VLANs defined. ⢠VlanIDâ Specifies the VLAN identifi er value for the device. ⢠VlanNameâ Specifies the descriptive na me for the VLAN ID. Every VLAN must have a name assigned to it. Duplicate names are allowed if yo u want to use the same names for different VLa n ⢠d- le network address is the burned-in address. This value must be a valid unicast address if it is edited. e adapter must be located in the same relative position on the target machine as on the sou rce e multifunction parameters but the parameters are not assigned, the ⢠ured for the led device. IDs. NetworkAddress âThis value is written only for adapters that are not teamed. It overrides the burne in address with a locally administered address. A nu ll value is always written to the XML data fi because locally administered addre sses must be unique. A null value is valid and indicates the HP Multifunction adapter properties The following properties are common only to HP Multifunction adapters. To transfer iSCSI, TCP/IP Offload Engine (TOE), and Receive-Side Scaling (RSS) parameters on an adapter, th machine. If the following parameters ar e assigned to an adapter that does not support iSCSI, TOE, or RSS, they ar ignored. If an adapter supports these existing settings are left unchanged. iSCSIEnabled âCauses Internet Small Computer Syst em Interface (iSCSI) to be config adapter. 0=Disabled. 1=Enabled. The default setting is Disabled. ⢠iSCSIVlanId âSpecifies the iSCSI VLAN identifi er value for the iSCSI enab ⢠iSCSIVlanName âSpecifies the descriptive name for the iSCSI VLAN ID. Configuration properties 10
⢠iSCSIPacketPriority âSpecifies the QoS Packet Prior ity for th e iSCSI enabled device. Possible v are D=Disabled and 1-7. The de fault setting is D (Disabled). alues If . ⢠d MAC address of the iSCSI add ess is the burned-in address. T d unicast address if it is edited. o adapters. Disable iSCSI on the he incompatible team types. o or 2.0 or later on s rver ⢠⢠iSCSIDHCPEnabled âSpecifies that DHCP is used to acqu ire an IP configuration for the iSCSI enabled device. Possible settings are Enabled and Disabled. Th e default setting is Enabled. ⢠iSCSIIPAddress âIf 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. ⢠iSCSISubnetMask âIf DHCP is not used, this property sp ecifies the network subnet mask (dotted decimal) for the iSCSI enabled device. If DHCP is en abled, the value is 0.0.0. 0, otherwise, enter the actual subnet mask. ⢠iSCSIGateway âIf DHCP is not used, this specifies the de fault route for the iSCSI enabled device. DHCP is enabled or no gateway is used, the value is 0.0.0.0, otherwise, type the actual IP address iSCSILAA â(Locally Administered Addres s) specifies the user-defin e enabled device. A null value is always written to the XML data file because locally administered resses must be unique. A null value is valid and indicates the network addr his value must be a vali The following team types are no t supported for iSCSI-enabled adapter or team before changing to an y of t â Automatic â 802.3ad Dynamic with Fault Tolerance â Switch-assisted Load Balancing with Faul t Tolerance (SLB) If the NCU does not detect the presence of the Mi crosoft® iSCSI Soft ware Initiat systems running Window s Server 2003 (SP1), Windows Server 2003 x64 (SP1), Window Server 2003 (SP2), or Windows Server 2003 (SP2 ), iSCSI cannot be enabled. Window s Se 2008 and Windows Server 2008 x64 comes with the iSCSI Initiato r included. TOEEnabled âEnables the offloading of TCP connectio ns to the Multifu nction Server Adapter. Microsoft Scalable Networking Pack (SNP) is re quired when enabling TOE and is included on systems running Window s Server 2003 (SP2) or Windows Serv er 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE adapter functionalit y on a system running Windows Serv er 2003 (SP1) or Windows Server 2003 x64 (S P1), you must download SNP and required Microsoft hotfixes and install them on the system. See the Microsoft ( http://www.micro soft.com ) website to downl the latest version of the Microsoft Windows Se rver 2003 Scalable Ne oad tworking Pack (SNP) and nd ork device is configured with the round on ⢠S required Microsoft Windows Server 200 3 (SP1) hotfixes in article numbers 921136, 91994 8, a 923187 of the Microsoft K nowledge Base (KB). These Microsoft hot fixes are required only for Windows Server 2003 (SP1) and Windows Serv er 2003 x64 (SP1). TOE teaming performance is reduce d if a switc h or netw robin aggregation load balancing method. Configure the aggregat ion load balancing method the switch or network device to somethin g else ot her than round robin and then re-start the team (disable the team and enable the team for all VLANs). RSSEnabled âEnables the receiv e processing of networ king traffic to be load balanced across teamed adapters. Microsoft Scalable Network ing Pack (SNP) is requir ed when enabling RSS and is included on systems running Window s Server 2003 (SP2), Windows Server 2003 x64 (SP2), Windows Server 2008, or Windows Ser ver 2008 x64. SNP also is supported, but not includ ed, on systems running Window s Server 2003 (SP1) and Windows Server 2003 x64 (S P1). To enable RS adapter functionality on a system running Wind ows Server 2003 (SP1) or Windows Server 2003 Configuration properties 11
x64 (SP1), download SNP and required Microsoft ho tfixes and install them on the system. See the Microsoft ( http://www.microsoft.com ) website to download the late st vers ion of the Micr osoft Windows Server 2003 Scalable Networking Pa ck (SNP) and required Microsoft Windows Server 948, and 923187 of the Microsoft Knowledg e for Windows Server 2003 (SP1) and Windows Team configuration properties the target , ⢠⢠s for the adapter team. A null value is always ue is st be a valid unicast address if it is edited. ⢠alidationMode âEnables or disables the packet si gnal received between the teamed ⢠ceptable values is 3 to 60. Values less than 3 are set to 3, and values greater than 60 are set ⢠es are AN ⢠⢠s 2003 (SP1) hotfixes in article numbers 921136, 919 Base (KB). These Micro soft hotfixes are required only Server 2003 x64 (SP1). Team configuration properties that are configured on the target s erver include: ⢠TeamName âDetermines the unique identifier for the a dapter team. Each team name on system must be unique. ⢠OpMode âDetermines the operating mod e of the team. Possible values are Auto, DynamicSingl eSlb StaticSingleSlb, TransmitLoadBalancing, TLBwithPref, FailOnFault, PrefPrimary LoadBalAlgorithm âDetermines the team load balancing algorithm. Possible values are MACAddress, IPAddress, TCPConne ction, RoundRobin, and Auto. TeamNetworkAddress âEstablishes the MAC addres written to the XML data file because locally admin istered addresses must be unique. A null val valid and computes a default address. This value mu ⢠TxPathValidationMode âEnables or disables the packet sign al transmitted between the teamed adapters. Possible values are Enabled or Disabled. RxPathV adapters. Possible values are Enabled or Disabled. TxPathValidationInterval âDetermines how frequently the packet signals are transmitted. The range of ac to 60. RxPathValidationInterval âDetermines how frequently the packet signals are received. The range of acceptable values is 3 to 60. Valu es less than 3 are set to 3, and va lues gre ater than 60 are set to 60. ⢠RxPathValidationVlanId âDetermines the VLAN on which Receive Path Validation packet f ram transmitted. This value is only wr itten when a VLAN is defined for the team. The default is the VL on the team with the lowest VLAN ID at the time the team is created. DefaultVlanId âDetermines the VLAN ID used for any un-t agged packets received by the team. This property only applies to teams that have VLANs defined. TOEEnabled âEnables the offloading of TCP connectio ns to the Multifu nction Server Adapter. Microsoft Scalable Networking Pack (SNP) is re quired when enabling TOE and is included on systems running Window s Server 2003 (SP2) or Windows Serv er 2003 x64 (SP2). SNP also is supported, but not included, on systems running Windows Serv er 2003 (SP1) and Windows Server 2003 x64 (SP1). To enable TOE adapter functionalit y on a system running Windows Serv er 2003 (SP1) or Windows Server 2003 x64 (S P1), you must download SNP and required Microsoft hotfixe and install them on the system. See the Microsoft ( http://www.micro soft.com ) website to do the latest version of the Microsoft Windows wnload Se rver 2003 Scalable Networking Pack (SNP) and nd Windows Server 2003 (SP1) and Windows Server 2 003 x64 (SP1). The TOEEnabled property is required Microsoft Windows Server 200 3 (SP1) hotfixes in article numbers 921136, 91994 8, a 923187 of the Microsoft K nowledge Base (KB). These Microsoft hot fixes are required only for Configuration properties 12
only valid when all the team members are HP Multifunction Server Adapters. 0=Disabled. 1=Enabled. The default setting is Enabled. TOE teaming performance is reduce d if a switc h or network device is configured with the round robin aggregation load balancing method. Configure the aggregat ion load balancing method on und robin and then re-start the team ⢠, ed, on (SP1). To enable RSS nload SNP and required Microsoft hotfixes and install them on the system. ultifunction server adapters and Disabled on NC110T, NC360T, and NC 364T PCIe gigabit server adapters. TOE and RSS teaming are not supported on Wind ows Server 2008 and Windows Server 2008 x64 in this release. Currently not supported on HP NC51xx 10 GbE adapters. the switch or network device to somethin g else ot her than ro (disable the team and enable the team for all VLANs). TOE and RSS teaming are not supported on Wind ows Server 2008 and Windows Server 2008 x64 in this release. Currently not supported on HP NC51xx 10 GbE adapters. RSSEnabledâ Enables the receive processi ng of networ king traffic to be load balanced across teamed adapters. Microsoft Scalable Network ing Pack (SNP) is requir ed when enabling RSS and is included on systems running Window s Server 2003 (SP2), Windows Server 2003 x64 (SP2) Windows Server 2008, or Windows Ser ver 2008 x64. SNP also is supported, but not includ systems running Window s Server 2003 (SP1) and Windows Server 2003 x64 adapter functionality on a system running Wind ows Server 2003 (SP1) or Windows Server 2003 x64 (SP1), dow 0=Disabled. 1=Enabled. The default setting is Enabled on m Configuration properties 13
XML data f ile XML elements and typical adapter teaming script The XML data file contains configuration properties for adapters and teams and consists of the following XML elements: ⢠<teamingconfig>-Bracket s the enti re data file and is required. ⢠<nic>-Defines adapter properties. ⢠<team>-Defines teams and their properties. ⢠<vlan>-Defines VLANs and their properties. The 'relnics' attribute of the <tea m> element lists the adapters that are to be configured on the team. The following example is a typical adapter teaming script. "1.0" encoding="ISO-8859-1" ?> <?xml version= - <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 - <!-- --> - <!-- --> 0.7" ScriptVersion="3.1" /> <version UtilityVersion="9.00. - <!-- --> Adapter Data - <!-- --> - <!-- --> <nic> element 1 - <!-- --> - <nic> " /> <property id="SpeedDuplex" value="Auto/Auto ty id="NetworkAddress" value="" /> <proper </nic> <nic> element 2 - <!-- --> - <nic> o" /> <property id="SpeedDuplex" value="Auto/Aut XML data file 14
<property id="iSCSIEnabled" value="1" /> <property id="PreferredPrimaryRanking" value="0" /> 0" /> > .0.0" /> y id="iSCSILAA" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> y id="NetworkAddress" value="" /> " /> 0" /> .0.0" /> y id="iSCSILAA" value="" /> <property id="DualChannelGroup" value="0" /> <property id="ConfiguredPortCost" value=" <property id="TOEEnabled" value="1" /> <property id="RSSEnabled" value="1" /> <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 <propert </nic> <nic> element 3 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="100/Full" <propert </nic> <nic> element 4 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="100/Full" <propert </nic> <nic> element 5 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="Auto/Auto" <propert </nic> <nic> element 6 - <!-- --> - <nic> /> <property id="SpeedDuplex" value="Auto/Auto" <propert </nic> <nic> element 7 - <!-- --> - <nic> " /> <property id="SpeedDuplex" value="Auto/Auto <property id="iSCSIEnabled" value="0" /> <property id="PreferredPrimaryRanking" value="1 <property id="DualChannelGroup" value="0" /> <property id="ConfiguredPortCost" value=" <property id="TOEEnabled" value="1" /> <property id="RSSEnabled" value="1" /> <property id="iSCSIVlanId" value="1" /> <property id="iSCSIVlanName" value="iRon" /> <property id="iSCSIPacketPriority" value="1" /> <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 <propert </nic> - <!-- XML data file 15
--> - <!-- Team Data <team> element 1 ed" /> id="RSSEnabled" value="1" /> </teamingconfig> --> - <!-- --> - <!-- --> - <team relnics="2 7"> <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="Enabl " /> <property id="TeamNetworkAddress" value=" <property id="TOEEnabled" value="1" /> <property </team> XML data file 16
Er r or handling and r eporting Error checking and completion code Errors can occur for a variety of reasons including di fferences between the s ource and target system NICs or because of errors introduced by editin g the XML data file. The software perform s extensive error checking as the XML data file is read and processed. When invalid property values are detecte d, a WARN ING error message is written to a log file and configuration continue s with either default or existin g 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 . T his error code can be used by the Windows command file to determ ine how to proceed. The error level cod es are as follows: ⢠Successful start of the acti on returns a completion code of error l evel zero (0). ⢠Non fatal errors return a completion code of error level one (1). ⢠An invalid log file returns a comple tion 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 17
A c r on y ms and a bbr e v i ati ons iSCSI Internet Small Computer System Interfa ce NCU Network Configuration Utilit y NFT network fault tolerant RSS Receive-Side Scaling TOE TCP/IP Offload Engine VLAN virtual local-area network XML extensible markup lang uage Acronyms and abbreviations 18
Inde x A adapter properties 10 C command line options 8 CQNICCMD 7 E error code 17 examples 8 L log file 17 O overview of configuration procedur e 5 R Receive-Side Scaling (RSS) 5, 10, 12 RSS (Receive-Side Scaling) 5, 10, 12 S script conversion 6 scripting application 7 scripting syntax 7 T TCP/IP Offload Engine (TOE) 5, 10, 12 team configuration 12 team properties 12 TOE (TCP/IP Offload Engine) 5, 10, 12 X XML sample file 14 Index 19