Chelsio ® is a registered trademark of Chelsio Communications.
All other marks and names mentioned herein may be trademarks of their respective companies.
Chelsio T5/T4 Unified Wire for Windows ii
Version
Revision Date
1.0.0
10/10/2011
1.0.1
10/18/2011
1.0.2
10/25/2011
1.0.3
10/31/2011
1.0.4
01/09/2012
1.0.5
01/18/2012
1.0.6
06/07/2012
1.0.7
07/11/2012
1.0.8
03/04/2013
1.0.9
03/21/2013
1.1.0
06/24/2013
1.1.1
07/19/2013
1.1.2
08/21/2013
1.1.3
09/04/2013
1.1.4
09/18/2013
1.1.5
09/23/2013
1.1.6
09/30/2013
1.1.7
10/12/2013
1.1.8
11/12/2013
1.1.9
12/02/2013
1.2.0
12/05/2013
1.2.1
12/16/2013
1.2.2
01/13/2014
1.2.3
01/23/2014
1.2.4
02/05/2014
1.2.5
02/11/2014
1.2.6
02/28/2014
1.2.7
04/22/2014
1.2.8
05/27/2014
1.2.9
07/21/2014
1.3.0
09/01/2014
1.3.1
11/06/2014
Version History
Chelsio T5/T4 Unified Wire for Windows iii
TABLE OF CONTENTS
I. CHELSIO UNIFIED WIRE 6
1.Introduction 7
1.1. Features 7
1.2. Hardware Requirements 7
1.3. Software Requirements 8
1.4. Package Contents 8
2. Hardware Installation 9
3. Software/Driver Installation 10
3.1. Manual Installation 10
4. cxgbtool help 12
5. Firmware Update 52
6. Software/Driver Update 53
II. NDIS FUNCTION 54
1.Introduction 55
1.1. Hardware Requirements 55
1.2. Software Requirements 56
2.Software/Driver Configuration and Fine-tuning 57
2.1. Assigning IP address to the Chelsio Network Adapter 57
2.2. Advanced Configuration 57
2.3. NVGRE Offload 62
2.4. Enabling SMB Direct 63
2.5. Verifying RDMA 63
2.6. Troubleshooting 63
III. UNIFIED WIRE MANAGER (UM) 65
1.Introduction 66
1.1. Features 66
1.2. Reference Architecture 67
1.3. Unified Wire Manager Components 67
1.4. Authentication and encryption 68
2.Hardware and Software 69
2.1. Supported Adapters 69
2.2. Platform/Component Matrix 69
2.3. Platform/Driver Matrix 70
3.Installing Unified Wire Manager 71
3.1. Pre-requisites 71
3.2. Installation 72
4.Configuring Unified Wire Manager 80
4.1. Configuring Management Station 80
Chelsio T5/T4 Unified Wire for Windows iv
5.Verifying UM components status 82
5.1. Verifying Management Agent 82
5.2. Verifying Management Client 83
5.3. Verifying Management Station 83
6.Management Agent 85
6.1. Communication 85
6.2. Service configuration 85
6.3. Firewall 85
7.CLI client 86
7.1. CLI Help system 86
7.2. Client conflict resolution 86
8.Web GUI client 87
8.1. Management Station 87
8.2. Accessing Web Management Interface 88
8.3. Layout and Navigation 90
8.4. Home page 91
8.5. System page 104
8.6. Network page 111
8.7. Storage 132
8.8. Hardware Features 164
9.Uninstalling Unified Wire Manager 178
IV. UM FOR WIN PE 179
1.Introduction 180
1.1. Hardware Requirements 180
1.2. Software Requirements 181
1.3. Examples 181
V. APPENDIX 185
Chelsio End-User License Agreement (EULA) 186
Chelsio T5/T4 Unified Wire for Windows v
Chapter I. Chelsio Unified Wire
I. Chelsio Unified Wire
Chelsio T5/T4 Unified Wire for Windows 6
Chapter I. Chelsio Unified Wire
The Chelsio Unified Wire supports 3.3v PCI bus only. Running an adapter on a
PCI x4 slot is not recommended as performance will be significantly reduced by
the limitations of PCI.
Note
Chelsio T5/T4 NDIS function driver supports NIC, NDK and NVGRE Offload
functionalities.
Note
1. Introduction
Thank you for choosing Chelsio T5/T4 Unified Wire adapters. These high speed, single chip,
single firmware cards provide enterprises and data centers with high performance solutions for
various Network and Storage related requirements.
The Terminator 5 (T5) is Chelsio‟s next generation of highly integrated, hyper-virtualized
40/10GbE controllers. The T5 is built around a programmable protocol-processing engine, with
full offload of a complete Unified Wire solution comprising NIC, TOE, iWARP RDMA, ISCSI,
FCoE and NAT support. It scales true 40Gb line rate operation from a single TCP connection to
thousands of connections, and allows simultaneous low latency and high bandwidth operation
thanks to multiple physical channels through the ASIC.
The T4 adapters can fully offload TCP, UDP, iSCSI, iWARP and FCoE over a single Unified
Wire. The adapters also fully support SR-IOV, EVB/VNTag, DCB, Traffic Management and
Filtering.
Ideal for all data, storage and high performance clustering applications, the T5/T4 Adapters
enable a unified fabric over a single wire by simultaneously running all unmodified IP sockets,
Fibre Channel and InfiniBand applications over Ethernet at line rate.
Designed for deployment in virtualized data centers, cloud service installations and high
performance computing environments, Chelsio T5/T4 adapters bring a new level of performance
metrics and functional capabilities to the computer networking industry.
1.1. Features
Chelsio's T5/T4 Unified Wire package contains Chelsio's NDIS function driver. The
driver supports NIC and NDK functionalities. The software package also contains management
tool, UM for Win PE (Windows Preinstallation Environment).
1.2. Hardware Requirements
The Chelsio T5/T4 Unified Wire supports all x64 architectures supporting PCIE (x4, x8) slots.
Chelsio T5/T4 Unified Wire has been developed to run on Windows based platforms. To know
more about the complete list of versions supported by each driver/software, please refer to their
respective sections.
1.4. Package Contents
Chelsio T5/T4 Unified Wire driver package contains driver files, UM installer, UM for Win PE
application, firmware binaries and support documentation (docs folder).
Chelsio T5/T4 Unified Wire for Windows 8
Chapter I. Chelsio Unified Wire
Network device names for Chelsio’s physical ports are assigned using the
following convention: the port farthest from the motherboard will appear as the
first Ethernet interface. However, for T5 40G and T420-BT adapters, the
association of physical Ethernet ports and their corresponding network device
names is opposite. For this adapter, the port nearest to the motherboard will
appear as the first network interface.
Note
2. Hardware Installation
1. Shutdown/power off your system.
2. Power off all remaining peripherals attached to your system.
3. Unpack the Chelsio adapter and place it on an anti-static surface.
4. Remove the system case cover according to the system manufacturer‟s instructions.
5. Remove the PCI filler plate from the slot where you will install the Ethernet adapter.
6. For maximum performance, it is highly recommended to install the adapter into a PCIE x8
slot.
7. Holding the Chelsio adapter by the edges, align the edge connector with the PCI connector
on the motherboard. Apply even pressure on both edges until the card is firmly seated. It
may be necessary to remove the SFP (transceiver) modules prior to inserting the adapter.
8. Secure the Chelsio adapter with a screw, or other securing mechanism, as described by the
system manufacturer‟s instructions. Replace the case cover.
9. After securing the card, ensure that the card is still fully seated in the PCIE x8 slot as
sometimes the process of securing the card causes the card to become unseated.
10. Connect a fiber cable, multi-mode for short range (SR) optics or single-mode for long range
(LR) optics, to the 10Gb Ethernet adapter or regular Ethernet cable for the 1Gb Ethernet
adapter.
11. Power on your system.
12. Verify if the adapter was installed successfully. To do so, open Device Manager in Control
Panel.
13. Under Other devices section, Chelsio adapter should be listed as Ethernet Controller. If
the adapter is not listed, right-click on the system name or click on the Actions menu and
select Scan for hardware changes
For Chelsio adapters, the physical functions are currently assigned as:
Physical functions 0 - 3: for the SR-IOV functions
Physical function 4: for all NIC functions of the card
Physical function 5: for iSCSI
Physical function 6: for FCoE
Physical function 7: Currently not assigned
14. Once the Unified Wire package is installed, open Device Manager again. Expand Network
adapters section and now Chelsio adapter should be listed.
Chelsio T5/T4 Unified Wire for Windows 9
Chapter I. Chelsio Unified Wire
3. Software/Driver Installation
Chelsio Unified Wire can be installed using any of the following methods:
a. Windows Update
b. Chelsio‟s Unified Wire Installer
c. Manual Installation
Alternatively, you can install or remove driver files in an offline Windows image using
procedures mentioned in the following links:
The driver components need to be installed in the order described here:
3.1.1. Virtual Bus Driver
1. Open the Device Manager (Control Panel -> System & Security-> System -> Device
Manager), click on the System Devices, right click on the Chelsio T5/T4 40G/10G Enumerator and select Update Driver Software.
2. Select Browse my computer for driver software.
3. Select Let me pick from a list of device drivers on my computer.
4. Click on Have Disk Button and on the next screen browse for chvbdx64.inf file and
click Open and then OK.
5. Click Next and driver installation will progress. Click Finish once the installation is
complete.
3.1.2. NDIS Miniport driver
1. Open the Device Manager (Control Panel -> System & Security-> System -> Device
Manager), click on the Network Adapters, right click on the Chelsio Network Adapter
and select Update Driver Software.
2. Select Browse my computer for driver software.
Chelsio T5/T4 Unified Wire for Windows 10
Chapter I. Chelsio Unified Wire
Important
Installing drivers using any other order is not supported.
3. Select Let me pick from a list of device drivers on my computer.
4. Click on Have Disk Button and on the next screen browse for chnetx64.inf file and click
Open and then OK
5. Click Next and driver installation will progress. Click Finish once the installation is
complete.
6. Repeat the above steps for the other Chelsio Network Adapters.
3.1.3. Generic Function
1. Open the Device Manager (Control Panel -> System & Security-> System -> Device
Manager), click on the Network Adapters, right click on the Chelsio T5/T4 40G/10G Generic Function and select Update Driver Software.
2. Select Browse my computer for driver software.
3. Select Let me pick from a list of device drivers on my computer.
4. Click on Have Disk Button and on the next screen browse for chnullx64.inf file and
click Open and then OK
5. Click Next and driver installation will progress. Click Finish once the installation is
complete.
Chelsio T5/T4 Unified Wire for Windows 11
Chapter I. Chelsio Unified Wire
4. cxgbtool help
The cxgbtool command queries or sets various aspects of Chelsio network interface cards. It
complements standard tools used to configure network settings and provides functionality not
available through such tools.
Some of the commands provided can be used to query running statistics to aid in debugging.
Definitions
[adapterInterface] is the name of the network device to work on, given in the format "nic[0,1,..n]"
[vbdInterface] is the name of the Chelsio Bus Enumerator instance to work on, given in the
Description: Flashes the Option ROM image.
Syntax: cxgbtool [vbdInterface] loadboot [bootImageFile] [pf {0|1|2|…|7}|offset {val}|clear]
Parameters:
pf{val}: Flash Option ROM image to the offset defined by the PFs EXPROM_OFST in the serial
configuration.
offset {val}: Flash Option ROM image to the offset specified by the user.
clear: The flash area reserved for Option ROM image will be cleared.
Example:
Flashing Option ROM image to the offset defined by the PFs EXPROM_OFST:
uP RAM: 0x3a802000-0x405fffff [93.9 MiB]
uP Extmem2: 0-0xffffffff [0 B]
1968 Rx pages of size 64KiB for 1 channels
6144 Tx pages of size 64KiB for 2 channels
8184 p-structs
Port 0 using 2 pages out of 432 allocated
Port 1 using 2 pages out of 432 allocated
Port 2 using 2 pages out of 432 allocated
Port 3 using 2 pages out of 432 allocated
Loopback 0 using 0 pages out of 144 allocated
Loopback 1 using 0 pages out of 144 allocated
Loopback 2 using 0 pages out of 144 allocated
Loopback 3 using 0 pages out of 144 allocated
Chelsio T5/T4 Unified Wire for Windows 17
Chapter I. Chelsio Unified Wire
qsets
Description: Reads # of qsets
Syntax: cxgbtool [adapterInterface] qsets
Example:
PCI Express Interface common register set. This module implements the
PCI-Express SR-IOV physical logical, data link, and transaction layers.
dbg
Debug Engine Common register set.
mc0
Memory controller 0 common register set. This module implements the
memory controller for the optional external DDR-II/DDR-III SDRAM.
mc1
Memory controller 1 common register set. This module implements the
memory controller for the optional external DDR-II/DDR-III SDRAM.
ma
Memory Arbiter common register set. This module implements the
arbitration of memory requests from the various on-chip sources to the
memory hierarchy consisting of on-chip eDRAM, external DDR2/DDR3
memory, and host memory that is accessed through the PCIe.
edc0
eDRAM and Controller 0 common register set. This is the on-chip
eDRAM and controller.
edc1
eDRAM and Controller 1 common register set. This is the on-chip
eDRAM and controller.
cim
CIM common register set. This module implements the CPU interface
and μP is the embedded microprocessor. The CIM incorporates
functions to improve the performance of CPU accesses to external
memory.
tp
Transport Protocol Engine common register set. This module
implements the main packet processing pipeline.
ulp_rx
Ingress Upper Layer Protocol common register set. This module
implements the upper layer protocol processing in the ingress direction
for protocols that are layered on top of TCP, such as iSCSI and RDMA.
ulp_tx
Egress Upper Layer Protocol common register set. This module provides
Upper Layer support for RDMA and iSCSI offload in the transmit
direction, and also implements LSO/TSO functionality.
pmrx
Ingress Payload Manager common register set. These modules
implement the payload manager for receive/ingress.
pmtx
Egress Payload Manager common register set. These modules
implement the payload manager for transmit/egress.
mps
Multi-port support common register set. This module implements the
multi-port support for T4, and switches egress packets to the ingress
path when their Ethernet DA (Destination Address) matches an address
in the exact match Ethernet Address database, or if the outer-VLAN
regdump
Description: Displays registers of a hardware module. Not specifying any parameter will display
registers for all the modules. Not all modules are available on all adapters.
Syntax:
Display registers for all available modules: cxgbtool [vbdInterface] regdump
Display registers for specific module: cxgbtool [vbdInterface] regdump [registerModule] Register module parameters:
Chelsio T5/T4 Unified Wire for Windows 20
Chapter I. Chelsio Unified Wire
indicates that the packet is destined to another virtual machine
connected to the T4, or if another virtual machine is subscribing to an L2
multicast group that is the MAC destination address of the packet.
cplsw
CPL Switch common register set. This module implements a
configurable switch for ingress CPL messages to the SGE and/or CIM.
The embedded μP is assigned a receive queue number and can be
assigned one or more MAC addresses and IP addresses, and any of
these can be used to switch ingress packets to the μP for processing.
smb
System Management Bus common register set. This module implements
an SMBus Master/Slave for system management.
i2c
I2C-Bus Master common register set. This module implements an I2CBus Master for PHY management and I/O expansion.
mi
MI common register set. This module implements an MDIO Master for
PHY management.
uart
pmu
Power Management Unit common register set. Power management unit.
sf
Serial Flash controller common register set. This module implements the
serial flash controller. It interfaces to the external serial flash device.
pl
PIO Local Bus controller common register set. This module implements
the PIO Local Bus controller. It is physically distributed across T4/T5.
le
Lookup Engine Common register set. The Lookup Engine implements
the connection, filter and ACL databases. This module includes a TCAM
Memory controller that interfaces with the on-chip TCAM memory array,
and it implements the interface to the external memory that is used to
scale the support of the connection database to 1M connections. The LE
stores ACL rules, it stores routing information to handle routing for SYNcookie mode offloaded listening servers, and it stores tuple information
for offloaded connections, and FCoE exchanges.
ncsi
Network Controller sideband Interface common register set. The module
implements the NCSI (Network Controller Sideband Interface) protocol.
Link State Connected
Link Speed 10 Gbps
Hw Addr 00:07:43:04:7d:60
Cur Addr 00:07:43:04:7d:60
Port No 0
NetIfIdx 18
Mtu 1500
Pkt Filter 0xb
CurOfldCaps 0xd7fe00
Tx Pend 42
FwdTx Pend 0
CtrlTx RefCount 1
ToeTx Pend 0
RdmaTx RefCount 1
Rx Pend 0
ToeRx Pend 0
ToeRxData Pend 0
Ndk Connect 0
Ndk Accept 0
Ndk ConnectFail 0
Ndk ConnectErr 0
Ndk Active 0
Ndk CQErr 0
Chelsio T5/T4 Unified Wire for Windows 25
Chapter I. Chelsio Unified Wire
version
Description: Displays the Adapter Part Number, Serial Number, Device ID, Firmware Version,
TP, NDIS Driver version, and VBD version.
Syntax: cxgbtool [vbdInterface] version
Example:
C:\Users\Administrator>cxgbtool vbd0 version
P/N: 11011605002
S/N: RE14130227
NIC DeviceID 5401 (T520-CR)
NIC FW Version 1.12.14.0
NIC TP Version 0.1.4.7
Ndis Driver Version 5.3.12.0
VBD Version 5.3.12.0
Description: Installs driver package specified in the setup information file (.inf).
Syntax: cxgbtool [vbdInterface] inst [infFilePath]
Example:
C:\Users\Administrator>cxgbtool vbd0 inst .\chnetx64.inf
ENTER: DriverPackageInstallA
ENTER: DriverPackageInstallW
Installing INF file '.\chnetx64.inf' (Plug and Play).
Looking for Model Section [Chelsio.NTamd64.6.2]...
Installing devices with Id "CHT5BUS\chnet" using INF
"C:\Windows\System32\DriverStore\FileRepository\chnetx64.inf_amd64_
dd8d3a55aa5c4536\chnetx64.inf".
Installation did not occur because the current driver on the device is the
same or better.
No drivers installed. Drivers contained in
'C:\Windows\System32\DriverStore\FileRepository\chnetx64.inf_amd64_dd8d3a55a
a5c4536\chnetx64.inf' are not better than current one's.
RETURN: DriverPackageInstallW (0x103)
RETURN: DriverPackageInstallA (0x103)
uninst
Description: Uninstalls driver package specified in the setup information file (.inf).
Syntax: cxgbtool [vbdInterface] uninst [infFile]
Example:
Serial Number : RE14130227
Id : T520-CR
Ec : 0000000000000000
Core Clock : 250000
Pn : 11011605002
Network Addr : 000743047D60
Chelsio T5/T4 Unified Wire for Windows 28
Chapter I. Chelsio Unified Wire
wtp
Description: Traces the Ingress and Egress path of a packet through the Chelsio adapter.
Syntax: cxgbtool [vbdInterface] wtp
Example:
C:\Users\Administrator>cxgbtool vbd0 wtp
LOW 0x00000000
HIGH 0x00aa0000
LOW 0x0003f000
HIGH 0x00660022
LOW 0x00000000
HIGH 0x0000eeee
LOW 0x00000000
HIGH 0x0000eeee
LOW 0x00000000
HIGH 0x00aa00aa
LOW 0x0070000b
HIGH 0x0000eeee
LOW 0x00000008
HIGH 0x0000eeee
LOW 0x00000013
HIGH 0x00550033
LOW 0x00000016
HIGH 0x0002006e
LOW 0x0000000b
HIGH 0x00880022
LOW 0x00c00001
HIGH 0x00000000
LOW 0x00000001
HIGH 0x00000000
LOW 0x00000000
HIGH 0x00000000
LOW 0x00000000
HIGH 0x00000000
LOW 0x01534745
HIGH 0x45475301
LOW 0xfeacb8ba
HIGH 0xbab8acfe
ifaces = nic0 nic1
*************************EGGRESS (TX) PATH *********************************
MOD : core---->PCIE---->SGE<-| #Ring Doorbell
SOP ? ??? |
EOP ? ??? |
MOD |<-core<----PCIE<----SGE<-| #Request Work Request
SOP | 1fe a
EOP | ? a
MOD |->core---->PCIE---->SGE------>CIM/uP->| #Work Request to uP
Description: Prints MAC statistics for a given port or TP MIB statistics.
Syntax: cxgbtool [vbdInterface] stats [mac{portInstance}|mib]
Example:
C:\Users\Administrator>cxgbtool vbd0 stats mac0
LOW 0x00000000
HIGH 0x00000066
LOW 0x0003f000
HIGH 0x00aa00ee
LOW 0x00000000
HIGH 0x0000eeee
LOW 0x00000000
HIGH 0x0000eeee
LOW 0x00000000
HIGH 0x00000000
LOW 0x0070000b
HIGH 0x0000eeee
LOW 0x00000013
HIGH 0x0000eeee
LOW 0x00000013
HIGH 0x001199cc
LOW 0x00000016
HIGH 0x00020491
LOW 0x0000000b
HIGH 0x00cc0022
LOW 0x00c0000a
HIGH 0x00000000
LOW 0x0000000a
cxgbtool: This may take a while. Please be patient
cxgbtool: Reading MEM_EDC0 (0) memory of size 3145728 bytes
cxgbtool: Writing memory block to file edc...
cxgbtool: Done writing memory block to file edc0
edc1
Description:Redirects EDC1 memory details to a file.
Syntax:cxgbtool [vbdInterface] debugfs edc1 [fileName]
Chelsio T5/T4 Unified Wire for Windows 35
Chapter I. Chelsio Unified Wire
It is recommended that the fileName provided be flash without any extension.
Note
Example:
C:\Users\Administrator>cxgbtool vbd0 debugfs edc1 edc1
cxgbtool: This may take a while. Please be patient
cxgbtool: Reading MEM_EDC1 (1) memory of size 3145728 bytes
cxgbtool: Writing memory block to file edc1...
cxgbtool: Done writing memory block to file edc1
flash
Description: Redirects Flash memory details to a file.
Syntax: cxgbtool [vbdInterface] debugfs flash [fileName]
Example:
C:\Users\Administrator>cxgbtool vbd0 debugfs flash flash
cxgbtool: This may take a while. Please be patient
cxgbtool: Reading Flash memory of size 4194304 bytes
cxgbtool: Writing memory block of size 4194304 bytes to file flash...
cxgbtool: Done writing memory block to file flash
C:\Users\Administrator>cxgbtool vbd0 debugfs mc1 mc1
cxgbtool: This may take a while. Please be patient
cxgbtool: Reading MEM_MC1 (3) memory of size 1073741824 bytes
cxgbtool: Writing memory block to file mc1...
cxgbtool: Done writing memory block to file mc1
Description: Prints RSS Configuration.
Syntax: cxgbtool [vbdInterface] rss_config
Example:
C:\Users\Administrator>cxgbtool vbd0 rss_config
TP_RSS_CONFIG: 0x300003c
Tnl4TupEnIpv6: no
Tnl2TupEnIpv6: no
Tnl4TupEnIpv4: no
Tnl2TupEnIpv4: no
TnlTcpSel: no
Chelsio T5/T4 Unified Wire for Windows 46
Chapter I. Chelsio Unified Wire
TnlIp6Sel: no
TnlVrtSel: yes
TnlMapEn: yes
OfdHashSave: no
OfdVrtSel: no
OfdMapEn: no
OfdLkpEn: no
Syn4TupEnIpv6: no
Syn2TupEnIpv6: no
Syn4TupEnIpv4: no
Syn2TupEnIpv4: no
Syn4TupEnIpv6: no
SynIp6Sel: no
.
.
.
rss_key
Description: Prints RSS Key.
Syntax: cxgbtool [vbdInterface] rss_key
Example:
PF Map Chn Prt Map Size Size Four Two Four Two Four Ch1 Ch0
1 yes no no 1 4 7 no no no no no 0 0
2 yes no no 2 4 7 no no no no no 0 0
3 yes no no 3 4 7 no no no no no 0 0
4 yes no no 4 4 7 no no no no no 0 0
Chelsio T5/T4 Unified Wire for Windows 47
Chapter I. Chelsio Unified Wire
5 yes no no 5 4 7 no no no no no 0 0
6 yes no no 6 4 7 no no no no no 0 0
7 yes yes no 7 4 7 yes yes yes yes no 0 0
rss_vf_config
Description: Prints RSS VF Configuration.
Syntax: cxgbtool [vbdInterface] rss_vf_config
Example:
VF Chn Prt Map VLAN uP Four Two Four Two Four Que Idx Hash
1 no no 0 no no no no no no no 0 0 0
2 no no 0 no no no no no no no 0 0 0
3 no no 0 no no no no no no no 0 0 0
.
.
.
coalesce
Description: Changes the coalescing settings for tunnel Rx queues of the specified Ethernet
device.
Syntax: cxgbtool [
Parameters
rx-usecs-irq: Rx Coalescing Timer. Number of microseconds after which interrupt will be sent.
rx-frames-irq: Rx Coalescing Threshold Packets. Number of packets after which interrupt will be
Description: Prints endpoints (eps) if NDK/ND is enabled.
Syntax: cxgbtool [adapterInterface] eps
Example:
C:\Users\Administrator>cxgbtool nic0 eps
ep FFFFE00005734AE0 cm_id FFFFE000071C0250 state 1 flags 0x0 stid 1920
backlog 1024 fe80:0000:0000:0000:2c51:690a:9289:f 543:5445
ep FFFFE00004822810 cm_id FFFFE000049261C0 state 1 flags 0x0 stid 1928
backlog 1024 169.254.245.67:5445
qps
Description: Prints queue paris (qps) if NDK/ND is enabled.
Syntax: cxgbtool [adapterInterface] qps
Example:
C:\Users\Administrator>cxgbtool nic0 qps
rc qp sq id 1026 in_use 0 rq id 1180 in_use 176 state 1 onchip 0 ep tid 152
state 7 0.0.0.0:4341->0.0.0.0:5445
rc qp sq id 1027 in_use 0 rq id 1393 in_use 256 state 1 onchip 0 ep tid 114
state 7 0.0.0.0:4322->0.0.0.0:5445
rc qp sq id 1039 in_use 0 rq id 1823 in_use 256 state 1 onchip 0 ep tid 414
state 7 0.0.0.0:4884->0.0.0.0:5445
rc qp sq id 1044 in_use 0 rq id 1374 in_use 256 state 1 onchip 0 ep tid 136
state 7 0.0.0.0:4333->0.0.0.0:5445
rc qp sq id 1048 in_use 0 rq id 2169 in_use 256 state 1 onchip 0 ep tid 78
state 7 0.0.0.0:4304->0.0.0.0:5445
rdma_stats
Description: Prints RDMA statistics if NDK/ND is enabled
Syntax: cxgbtool [vbdInterface] rdma_stats
Chelsio T5/T4 Unified Wire for Windows 49
Chapter I. Chelsio Unified Wire
Example:
C:\Users\Administrator>cxgbtool vbd0 rdma_stats
Object: Total Current Max Fail
PDID: 65536 0 0 0
QID: 31744 0 0 0
TPTMEM: 40265280 0 0 0
PBLMEM: 273804160 0 0 0
RQTMEM: 80530624 0 0 0
OCQPMEM: 0 0 0 0
DB FULL: 0
DB EMPTY: 0
DB DROP: 0
DB State: NORMAL Transitions 0
TCAM_FULL: 0
ACT_OFLD_CONN_FAILS: 0
PAS_OFLD_CONN_FAILS: 0
AVAILABLE IRD: 589824
stags
Description: Prints STAG contents if NDK/ND is enabled.
Syntax: cxgbtool [adapterInterface] stags
Example:
The driver will auto-load the T5 and T4 firmwares if an update is required. The firmware version
can be verified using cxgbtool:
C:\Users\Administrator> cxgbtool nic0 version
The Firmware binaries are present in ChelsioUwire-x.x.x.xx/firmware/ directory.
Chelsio T5/T4 Unified Wire for Windows 52
Chapter I. Chelsio Unified Wire
6. Software/Driver Update
For any distribution specific problems, please check README and Release Notes included in
the release for possible workaround.
Please visit Chelsio support web site http://service.chelsio.com/ for regular updates on various
software/drivers. You can also subscribe to our newsletter for the latest software updates.
Chelsio T5/T4 Unified Wire for Windows 53
Chapter II. NDIS Function
II. NDIS Function
Chelsio T5/T4 Unified Wire for Windows 54
Chapter II. NDIS Function
1. Introduction
Chelsio‟s T5/T4 series of Unified Wire Adapters provide extensive support for NIC operation,
including all stateless offload mechanisms for both IPv4 and IPv6 (IP, TCP and UDP checksum
offload, LSO - Large Send Offload aka TSO - TCP Segmentation Offload, Network Direct and
assist mechanisms for accelerating LRO - Large Receive Offload).
1.1. Hardware Requirements
1.1.1. Supported Adapters
The following are the currently shipping Chelsio Adapters that are compatible with Chelsio NDIS
driver:
NDIS driver supports NIC, NDK and NVGRE Offload functionalities.
Note
1.2. Software Requirements
1.2.1. Windows Requirement
Currently Chelsio T5/T4 NDIS Function driver is available for the following version:
Windows Server 2012 R2
Chelsio T5/T4 Unified Wire for Windows 56
Chapter II. NDIS Function
This parameter is available only for T5 adapters.
Note
2. Software/Driver Configuration and Fine-tuning
2.1. Assigning IP address to the Chelsio Network Adapter
1. Double click on the Network Connections icon and choose the Chelsio card entry and
double click it.
2. Click on the Properties button from the Local Area Connection X Status.
3. Select “Internet Protocol (TCP/IP)” from the list and click on Properties button below it.
4. From the Internet Protocol (TCP/IP) Properties window, assign an IP Address (e.g.
192.169.1.10) and subnet mask (e.g. 255.255.255.0).
5. Click on Ok and close on the other window.
6. Check to see if you can ping to some other address on this subnet.
2.2. Advanced Configuration
The Chelsio Network driver provides advanced configuration options under the Device
Properties. In the Network Connections window, select the Chelsio Adapter‟s Local Area
Connection interface (right-click -> properties). Click the Configure button.
2.2.1. VBD Driver Parameters
To see all tunable VBD driver parameters, open the Device Manager (Control Panel -> System
& Security-> System -> Device Manager), click on the System Devices, double click on the
Chelsio T5/T4 40G/10G Bus Enumerator, and then click the Advanced tab.
Nic Instances:
Description: Specifies the number of NIC instances.
Value: 0-8 | default
Default: default
2.2.2. NDIS Miniport Driver Parameters
To see all tunable NDIS Miniport Driver parameters, open the Device Manager (Control Panel > System & Security-> System -> Device Manager), click on the Network adapters, double
click on any Chelsio Network Adapter, and then click the Advanced tab.
Encapsulated Task Offload
Description: Enable or disable the stateless offloads (checksums, LSO, VMQ and
filtering) of encapsulated traffic.
Value: Disabled | Enabled
Default: Enabled
Chelsio T5/T4 Unified Wire for Windows 57
Chapter II. NDIS Function
Flow Control
Description: Enable or disable the receipt or transmission of PAUSE frames. If Rx is
enabled, all incoming PAUSE frames will be honored. If Tx is enabled, the HW will send
PAUSE frames when its MAC Rx FIFO usage is beyond a high-watermark. If Disabled
option is selected, no PAUSE will be sent. When Rx MAC FIFO gets full, further ingress
packets will be dropped. If Rx & Tx Enabled is selected, both Rx and Tx options will be
enabled.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
Default: Rx & Tx Enabled
IPv4 Checksum Offload
Description: Allows the checksum to be computed by the adapter for IPV4 packets.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
Default: Rx & Tx Enabled
Jumbo Packet (Maximum Transmission Unit)
Description: Specifies the Maximum Transmission Unit (MTU) value.
Value: 1500-9000
Default: 1500
Large Send Offload V2 (IPv4)
Description: Allows for configuring Large Send Offload (LSO) using version 2 for the
IPv4 traffic.
Value: Disabled | Enabled
Default: Enabled
Large Send Offload V2 (IPv6)
Description: Allows for configuring Large Send Offload (LSO) using version 2 for the
IPv6 traffic.
Value: Disabled | Enabled
Default: Enabled
Locally Administered Address
Description: Specifies a new MAC address for the port. If Not Present, the default MAC
from EEPROM is used. If specified, the new MAC overwrites the default MAC. This
specified MAC is persistent across machine reboot.
Chelsio T5/T4 Unified Wire for Windows 58
Chapter II. NDIS Function
Value: Not Present | Any legal 6-byte MAC address
Default: Not Present
Maximum Number of RSS Processors
Description: For changing the number of RSS Processors.
Value: 1-8
Default: 8
Maximum Number of RSS Queues
Description: For changing the number of RSS Queues.
Value: 1-8
Default: 4
NetworkDirect Functionality
Description: For enabling or disabling Network Direct Functionality.
Value: Disabled | Enabled
Default: Enabled
NetworkDirect Interrupt Moderation
Description: This parameter controls the interrupts generated during NDK traffic.
Value: Disabled | Enabled
Default: Enabled
For more information, refer http://msdn.microsoft.com/en-
Description: This parameter controls the RSS functions. If on, the Microsoft RSS function
is enabled. If off, the Chelsio RSS function is enabled.
Value: Disabled | Enabled
Default: Enabled
Recv Segment Coalescing (IPv4)
Description: Enables or Disables the Receive Segment Coalescing feature for IPv4
traffic. This is a receiver packets aggregating feature which helps reduce the receive
host CPU load and improve throughput in a 40/10Gb network environment where CPU
can be the bottleneck.
Value: Disabled | Enabled
Default: Enabled
Recv Segment Coalescing (IPv6)
Description: Enables or Disables the Receive Segment Coalescing feature for IPv6
traffic. This is a receiver packets aggregating feature which helps reduce the receive
Chelsio T5/T4 Unified Wire for Windows 59
Chapter II. NDIS Function
This feature is not fully tested and available for experimental usage only.
Note
host CPU load and improve throughput in a 40/10Gb network environment where CPU
can be the bottleneck.
Value: Disabled | Enabled
Default: Enabled
RSS Base processor
Description: This parameter is used to specify the number of the base RSS processors.
Value: 0-16
Default: 1
RSS load balancing profile
Description: This parameter controls the RSS load balancing profile.
Value: Closest Processor | Closest Processor Static | Conservative Scaling | NUMA
Scaling | NUMA Scaling Static
Default: NUMA Scaling Static
For more information, refer http://technet.microsoft.com/en-us/library/hh997036.aspx
Rx Ethernet Queue Size
Description: This parameter is used to set different Rx Queue sizes. Driver ships with
reasonable defaults.
Value: 512-4096
Default: 2048
Rx Offload Queue Size
Description: This parameter is used to set different Offload Rx Queue sizes. Driver ships
with reasonable defaults.
Value: 256-2048
Default: 512
TCP Checksum Offload (IPv4)
Description: This parameter enables or disables computation of TCP checksum by the
adapter for IPv4 packets.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
Default: Rx & Tx Enabled
Chelsio T5/T4 Unified Wire for Windows 60
Chapter II. NDIS Function
This feature is not fully tested and available for experimental usage only.
Note
This feature is not fully tested. This feature is available for experimental usage
only.
Note
TCP Checksum Offload (IPv6)
Description: This parameter enables or disables computation of TCP checksum by the
adapter for IPv6 packets.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
o Default: Rx & Tx Enabled
TCP Offload:
Description: Controls the enable or disable of TCP Offload.
Range: Disabled | Enabled
Default: Disabled
Tx Ethernet Queue Size:
Description: This parameter is used to set different Tx Queue sizes. Driver ships with
reasonable defaults.
Value: 512-4096
Default: 1024
Tx Offload Queue Size:
Description: This parameter is used to set different Offload Tx Queue sizes. Driver ships
with reasonable defaults.
Value: 256-4096
Default: 512
UDP Checksum Offload (IPv4):
Description: This parameter enables or disables computation of UDP checksum by the
adapter for IPv4 packets.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
Default: Rx & Tx Enabled
Chelsio T5/T4 Unified Wire for Windows 61
Chapter II. NDIS Function
UDP Checksum Offload (IPv6):
Description: This parameter enables or disables computation of UDP checksum by the
adapter for IPv6 packets.
Value:
o Disabled
o Rx & Tx Enabled
o Rx Enabled
o Tx Enabled
Default: Rx & Tx Enabled
User Mode NetworkDirect
Description: Enable or disable Microsoft's Remote Direct memory Access (RDMA)
interface for high speed, low latency networks.
Value: Disabled | Enabled
Default: Enabled
Virtual Machine Queues:
Description: Enable or disable the virtual machine queue feature on the interface.
Value: Disabled | Enabled
Default: Enabled
VLAN Identifier:
Description: Specifies the VLAN ID to be inserted.
Value: 0-4095
Default: 0
VMQ LookAhead Split:
Description: Enable or disable the ability to split receive buffers into lookahead and post-
lookahead buffers.
Value: Disabled | Enabled
Default: Enabled
VMQ VLAN ID Filtering:
Description: Enable or disable the ability to filter network packets by using the VLAN
identifier in the media access control (MAC) header.
Value: Disabled | Enabled
Default: Enabled
2.3. NVGRE Offload
Chelsio‟s T5 based adapters are uniquely capable of offloading the processing of NVGRE
encapsulated frames such that all stateless offloads (checksums, LSO, VMQ and filtering) are
Chelsio T5/T4 Unified Wire for Windows 62
Chapter II. NDIS Function
At least one adapter should indicate “RDMA Capable” true to take advantage of
SMB RDMA capability.
Note
preserved, resulting in significant performance benefits. This feature is enabled by default.
Configure the relevant customer and provider network settings on the host.
2.4. Enabling SMB Direct
SMB Direct is installed and enabled by default on Windows Server 2012 and 2012 R2 systems.
RDMA functionality on Chelsio adapters will be enabled after installing the driver from the
package.
You can use the following PowerShell command Get-NetAdapterRdma to get a list of RDMA
capable interfaces in your system.
The next step is to configure your network so that SMB server and client machines can
communicate with each other. Please configure the Microsoft firewall to allow traffic between the
SMB clients and server.
2.5. Verifying RDMA
There are number of ways to verify if RDMA is working:
2.5.1. Verify active connections using PowerShell
Open PowerShell window and execute the command Get-SmbConnection
2.5.2. Use Event Viewer
You can use Event Viewer to view SMB connection events. To do this:
i. Open Event Viewer
ii. In the console tree, expand Event Viewer.
iii. Navigate to Application and Service Logs-> Microsoft->Windows->SMBClient
->Operational
2.6. Troubleshooting
If RDMA is not working in your system, please check for the following:
Operating system version should be Windows Server 2012 or 2012 R2.
Chelsio T5/T4 Unified Wire for Windows 63
Chapter II. NDIS Function
Verify network interface configurations on both sides.
Please ensure that the interfaces are reachable using ping command.
In the Event Viewer (on the client side), please ensure that the traffic running is not over
TCP.
Verify that SMB driver is loaded and working. Open PowerShell window and execute the
Confirm that traffic is running over Chelsio adapter.
Look for potential errors in Event Log.
Chelsio T5/T4 Unified Wire for Windows 64
Chapter III. Unified Wire Manager (UM)
III. Unified Wire Manager (UM)
Chelsio T5/T4 Unified Wire for Windows 65
Chapter III. Unified Wire Manager (UM)
1. Introduction
Chelsio's Unified Wire Manager is a powerful management software tool, allowing you to view
and configure different aspects of the system, including Chelsio hardware installed in the
system. The software includes a command line interface (CLI) tool and a web management
interface (Web GUI) to help you manage all Chelsio network adapter cards on the network
across multiple operating systems.
Unified Wire Manager enables the management of all aspects of the client side of the iSCSI
SAN in two main areas. The ability to configure Chelsio adapter‟s boot option ROM without
entering each individual adapter‟s configuration screen and manage group of iSCSI initiators
remotely from a common user interface saves administrator‟s time considerably. Unified Wire
Manager fully supports Microsoft iSCSI initiator. All supported Chelsio FCoE initiators available
on Linux can be managed.
Users can manage Option ROM (PXE and FCoE) capability for Chelsio cards using various
tools available in the software.
Additionally, Unified Wire Manager allows for Chelsio adapter NIC and TOE parameters to be
centrally managed through the same easy-to-use user interface. It can bring interfaces up or
down, tune parameters for optimal performance, and any number of administrative tasks
normally done at each individual machine.
Chelsio‟s Unified Wire Manager is an indispensable tool for saving administrator‟s time for
managing the network and SAN. Chelsio‟s high performance network adapters with its Unified
Wire approach to networking can now be managed centrally in a simple and fast way!
1.1. Features
Chelsio‟s Unified Wire Manager is designed to provide the following features to the end-user:
Remotely manage Chelsio adapters and various related tasks like driver installation from a
single application.
Single tool with CLI and Web interface that works across Storage, Networking and
Hardware.
Manage all Chelsio adapters installed on the system.
Tool for FAE to debug issues on the Customer front.
Freedom to choose various modes of management i.e. CLI or Web GUI.
Chelsio T5/T4 Unified Wire for Windows 66
Chapter III. Unified Wire Manager (UM)
1.2. Reference Architecture
Chelsio’s Web GUI is a web-based management interface that lets you remotely manage
several Chelsio CNAs from anywhere, at anytime on the network using a web browser. The
Web GUI provides a great amount of flexibility, efficiency and accessibility to system
administrators in managing the Network and SAN .The users have the freedom to access the
interface using any of the major browsers available, based on individual preferences and
corporate policy.
System performance degradation issues will not be observed when using the Web GUI, since
it‟s lightweight and utilizes very less system resources.
Figure 1.2 – Chelsio Unified Wire Manager with web interface (Web GUI)
1.3. Unified Wire Manager Components
1.3.1. Management Agent
The Management Agent is a binary executable, which runs as a service on the system that has
at least one Chelsio card installed. It is installed along with libraries that can manage various
components of the system and enabled during system startup.
1.3.2. Management Client
The Management Client can be used to connect to agents and manage them. Once connected
you can view and configure Chelsio CNAs and related networking, storage and hardware
properties. You can use either the CLI or Web GUI client to manage agents based on your
Chelsio T5/T4 Unified Wire for Windows 67
Chapter III. Unified Wire Manager (UM)
preference. It makes service requests based on the command issued by the user and returns
the appropriate information.
CLI Client
The CLI Client (chelsio_uwcli) is an executable binary which allows you to manage and
configure agents using the command-line interface. It is not a command shell with a prompt; it
accepts all command parameters as arguments when launching it, making it script-friendly.
Web GUI Client
The Web Management Interface (Web GUI) client is a web-based management interface
which allows you to securely manage agents from anywhere using a web browser. The
management interface uses a secure 256-bit encrypted HTTP connection, ensuring that
authentication and configuration data are protected during transmission from the web browser to
the system and vice versa. Many agents can be accessed on single interface making it very
efficient & user-friendly.
Currently supported browsers are Internet Explorer 9+, Mozilla Firefox 3.6.9+, Google
Chrome 5+ and Apple Safari 5+.
1.4. Authentication and encryption
The Unified Wire Manager requires user authentication to manage a system. A user must have
administrative privileges to manage a system. The authentication credentials, as well as all data
exchanged between the CLI client or the Web GUI and the agent, are encrypted using SSL.
This ensures that the data cannot be accessed when it is being transmitted over the network.
Chelsio T5/T4 Unified Wire for Windows 68
Chapter III. Unified Wire Manager (UM)
Version/Distribution
Supported UM Components
Windows Server 2012 R2
Management Agent, Management Client, Management
Station
2. Hardware and Software
2.1. Supported Adapters
Following are the currently shipping Chelsio Adapters that are compatible with Chelsio Unified
Wire Manager:
4. If the Apache Server is running, it should be stopped before starting the installation process.
Chelsio T5/T4 Unified Wire for Windows 71
Chapter III. Unified Wire Manager (UM)
3.2. Installation
The following section describes the procedure to install UM. If an older version of the software
exists, the Installer will upgrade it to the current version.
1. Run the UnifiedWireManager-x.x.xx-x64 installer application.
2. Click the Next button for the Chelsio End User License Agreement Window.
Figure 3.2 (a) – UM installer welcome window
Chelsio T5/T4 Unified Wire for Windows 72
Chapter III. Unified Wire Manager (UM)
3. Select the radio button I accept the terms of the license agreement and click Next.
Figure 3.2 (b) – Chelsio EULA window
Chelsio T5/T4 Unified Wire for Windows 73
Chapter III. Unified Wire Manager (UM)
4. The next window will display the pre-requisites for various UM components. Ensure that they
are met before proceeding. Click Next.
Figure 3.2 (c) – UM prerequisites window
Chelsio T5/T4 Unified Wire for Windows 74
Chapter III. Unified Wire Manager (UM)
5. Now, either select Complete for complete package installation or else select Custom radio
button to customize the installation. Click Next.
Figure 3.2 (d) – Select setup (installation) type
Chelsio T5/T4 Unified Wire for Windows 75
Chapter III. Unified Wire Manager (UM)
i. If you selected Custom, the next window will display the location where UM will be
installed by default. You can change the location by using the Change button or click
Next to continue with the default path.
Figure 3.2 (e) – Changing UM installation path
Chelsio T5/T4 Unified Wire for Windows 76
Chapter III. Unified Wire Manager (UM)
If Management Station is selected, please make sure that all related
prerequisites are met before proceeding (See Pre-requisites) or else the
component will be skipped during installation.
Note
ii. Next, you can choose the UM components you wish to install. Deselect the components
you don‟t wish to install and click Next.
Figure 3.2 (f) – Selecting UM components to install
Chelsio T5/T4 Unified Wire for Windows 77
Chapter III. Unified Wire Manager (UM)
6. Click Install to start the installation. Unified Wire Manager will now be installed with the
selected options.
Figure 3.2 (g) – Starting UM installation
Chelsio T5/T4 Unified Wire for Windows 78
Chapter III. Unified Wire Manager (UM)
7. Select Finish to exit the UM Installer.
Figure 3.2 (h) – Finishing UM installation
Chelsio T5/T4 Unified Wire for Windows 79
Chapter III. Unified Wire Manager (UM)
4. Configuring Unified Wire Manager
4.1. Configuring Management Station
Follow the steps mentioned below to configure Apache Server and SSL certificate.
4.1.1. Apache HTTP Server
1. Assuming that Apache HTTP Server 2.2 is installed at the default location, append the
following lines in C:\Program Files (x86)\Apache Software
2. Perform the following tasks in C:\Program Files (x86)\Apache Software
Foundation\Apache2.2\Conf\httpd.conf file
i. Change "DocumentRoot" to “C:/Program Files (x86)/Apache Software
Foundation/Apache2.2/htdocs/chelsio”
ii. Uncomment "LoadModule rewrite_module modules/mod_rewrite.so"
iii. Uncomment "Include conf/extra/httpd-ssl.conf"
iv. Uncomment "LoadModule ssl_module modules/mod_ssl.so"
v. Add the following lines:
RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L]
4.1.2. SSL Certificate
1. Execute the following lines in command prompt and provide info to generate OpenSSL
certificate and keys:
Chelsio T5/T4 Unified Wire for Windows 80
Chapter III. Unified Wire Manager (UM)
On some installation, Apache is seen to report problems regarding SSL cache.
In such a case, do the following in C:\Program Files (x86)\Apache Software
Foundation\Apache2.2\conf\extra\httpd-ssl.conf
1. Open the file httpd-ssl.conf and make the following modifications:
i. Modify "SSLCertificateFile" to “C:\Program Files (x86)\Apache Software
Foundation\Apache2.2\conf\blarg.crt”
ii. Modify "SSLCertificateKeyFile" to “C:\Program Files (x86)\Apache Software
Foundation\Apache2.2\conf\blarg.key”
Chelsio T5/T4 Unified Wire for Windows 81
Chapter III. Unified Wire Manager (UM)
5. Verifying UM components status
The following section explains how to verify status of various UM components.
5.1. Verifying Management Agent
1. On the system running Management Agent, launch Services from the Control Panel. You
can also type services.msc in the Run command. This will open the Services window.
Chelsio T5/T4 Unified Wire for Windows 82
Figure 5.1(a) – Windows Services
Chapter III. Unified Wire Manager (UM)
2. Search for Unified Wire Manager in the list of services. You should get the options to stop
and restart in the Actions menu on the left side, indicating that Management Agent is
already running.
Figure 5.1(b) – Actions available for Unified Wire Manager service
5.2. Verifying Management Client
Execute the following query command to determine if Management Client is installed:
C:\Users Administrator>chelsio_uwcli.exe -V
The above query should confirm that Management Client is installed by displaying a similar
result:
Unified Manager client CLI version : 2.x.yy
5.3. Verifying Management Station
1. Launch Services from the Control Panel. You can also type services.msc in the Run
command. This will open the Services window.
2. Search for Unified Wire Management Station in the list of services. You should get the
options to stop,start and restart the service in the Actions menu on the left side.
Figure 5.3 – Verifying Management Station service status
Chelsio T5/T4 Unified Wire for Windows 83
Chapter III. Unified Wire Manager (UM)
While accessing the Web Management Interface, if an error “Management
Station is not running” is displayed at the log-in page, follow the above steps to
restart Management Station and try again.
Note
Chelsio T5/T4 Unified Wire for Windows 84
Chapter III. Unified Wire Manager (UM)
6. Management Agent
6.1. Communication
The agent uses a TCP connection over IP to communicate with the client. After the connection
is established, SSL (Secure Sockets Layer) encryption is enabled using the Open SSL libraries.
The agent listens on a TCP port for new incoming connections from clients. This port is set to
35001 by default.
6.2. Service configuration
The agent is installed as a service on the system, and enabled to start on boot. The following
sections will describe the procedure to configure service startup manually:
6.2.1. Service startup configuration
The service name on Windows is Unified Wire Manager and the service startup configuration
can be changed by following these steps:
1. Launch Services from the Control Panel. You can also type services.msc in the Run
command. This will open the Services window.
2. Scroll and highlight the "Unified Wire Manager" service, and double-click on it.
3. Select the startup type, either “Automatic (Delayed Start)”, "Automatic", "Manual", or
"Disabled".
6.2.2. Service start/stop/restart
1. Launch Services from the Control Panel. You can also type services.msc in the Run
command. This will open the Services window.
2. Scroll and highlight the "Unified Wire Manager" service.
3. Click on Start/Stop/Restart to carry out the respective tasks in the Description section on
the left.
6.3. Firewall
If the system has a firewall configured, it should be configured to allow traffic to the
management agent‟s default TCP port configured i.e. 35001. Review the firewall documentation
and configure it appropriately. If there is a firewall appliance / software protecting the network
that the system is on, and you wish to connect to the system from a different network, using the
client, the firewall appliance also needs to be configured appropriately.
Chelsio T5/T4 Unified Wire for Windows 85
Chapter III. Unified Wire Manager (UM)
7. CLI client
7.1. CLI Help system
A detailed help and usage documentation is built into the CLI, and is accessible through its help
system. The help can be invoked by the usual argument of /? or --help.
7.1.1. Viewing help
1. Open command prompt by typing cmd in the Run command.
2. Type chelsio_uwcli.exe --help. Press enter to view the built-in help.
7.2. Client conflict resolution
The CLI and Web GUI cannot manage the same system at the same time by default. This is to
ensure that configuration changes being applied by one client are not interrupted by another
client. Also, two different Web GUI or CLI clients cannot connect to a management agent at the
same time. There is no mechanism to allow this scenario.
Chelsio T5/T4 Unified Wire for Windows 86
Chapter III. Unified Wire Manager (UM)
8. Web GUI client
8.1. Management Station
In order to access the Web Management Interface, start the Apache HTTP server, if it‟s not
running already. Also, Cookies and Javascript must be enabled in the browser.
8.1.1. Running Management Station
1. Launch Services from the Control Panel. You can also type services.msc in the Run
command. This will open the Services window.
2. Search for “Apachex.x” in the list of services and click Start in the Action menu on the left.
Figure 8.1.1 (a) – Starting Apache HTTP server
3. Search for “Unified Wire Management Station” and click Start in the Action menu on the left.
Figure 8.1.1(b) – Starting Management Station service
Chelsio T5/T4 Unified Wire for Windows 87
Chapter III. Unified Wire Manager (UM)
8.2. Accessing Web Management Interface
1. To access the Web GUI, type in the URL https://<management station IP address> in a web
browser.
2. The security certificate used by the web server is a generic one. It may cause the following
types of prompts in different browsers. You will need to select the correct option to continue.
Figure 8.2 (a) - Security Certificate prompt in Internet Explorer
Figure 8.2 (b) - Security Certificate prompt in Mozilla Firefox
Chelsio T5/T4 Unified Wire for Windows 88
Chapter III. Unified Wire Manager (UM)
Not performing any operation/action for 5 minutes will result in session timeout.
You will have to re-login and connect to the Agents again.
Note
Figure 8.2 (c) - Security Certificate prompt in Apple Safari
Figure 8.2 (d) - Security Certificate prompt in Google Chrome
3. The web interface requires password authorization to be accessed. Enter the username and
corresponding password that was set up on the management station system and click on
the Login button.
Figure 8.2 (e) - Web GUI Login page
Chelsio T5/T4 Unified Wire for Windows 89
Chapter III. Unified Wire Manager (UM)
8.3. Layout and Navigation
The Web Management Interface consists of the following:
Title bar displaying the username on the left, Unified Wire Manager logo and name in the
centre; and a Logout button on the right.
MenuBar consisting of the Home, Add System, Remove System, Refresh, Subscribe
and Bulk Configuration buttons.
The Navigation Pane with a cascading tree of links to various configuration modules for a
UM Agent. You can navigate between connected agents and various sections of the
managed agent‟s interface. You can view and hide the configuration modules for each
Agent by clicking on the “+”and “-”links respectively
The Details Pane on the right displaying panels associated with the tree menu item
selected in the Navigation Pane. The panels can be expanded and collapsed by clicking on
the panel heading.
The Bottom bar has the About link on the right and copyright details on the left.
Chelsio T5/T4 Unified Wire for Windows 90
Figure 8.3 – Web Management Interface
Chapter III. Unified Wire Manager (UM)
Storing login passwords for the managed systems is inherently
insecure. The passwords are encrypted, but it is still advisable to store
passwords only if the system you are running the GUI client on, is secure.
Important
8.4. Home page
The home page is displayed by default on launching the Web GUI. It displays Bookmarks and
History, Service Discovery and Bulk Driver Installation modules. Options to go back to
home page, add/remove system, refresh and configure email alerts are also available.
8.4.1. Home
This option will display the home page.
Bookmarks and History
A history of the last 128 systems that were managed from this system, by the current user, will
be shown here in a list. Each system's management IP address, TCP port, and Login details are
also stored. This may be edited and saved. Any systems that are not required in the list may be
deleted.
Figure 8.4.1 (a) - Bookmarks and history module
Chelsio T5/T4 Unified Wire for Windows 91
Chapter III. Unified Wire Manager (UM)
Once removed, the system will no longer appear in the Bookmarks and History
module. If you wish to manage that system again, you will have to use the “Add
system” option.
Note
Connecting to a system
Select the system from the Bookmark list and click Connect. Once successfully connected, the
system will appear on the left pane with different related modules on the right to view and
manage.
Deleting a system
Select the system from the Bookmark list and click Delete system to remove it.
Chelsio T5/T4 Unified Wire for Windows 92
Chapter III. Unified Wire Manager (UM)
Service Discovery
Using this module, all the Unified Wire Manager agents connected in the same or different
subnet can be discovered. One can choose to discover agents based on OS type or search for
a particular agent if the agent's IP or hostname is known. Select the appropriate discovery
method and provide the relevant information. For example, to search using hostname, select
Hostname as the Input Type and provide the agent's hostname in the Search for Hostname/IP
field. Finally click Discover Agents.
The Add Agents button adds the selected system to the list of discovered agents in the
Bookmarks and History module. The Clear Agents button resets the list of discovered agents.
Figure 8.4.1 (b) - Services Discovery module
Bulk Driver Installation
This module allows you to install drivers for multiple systems simultaneously. Drivers available
for installation for a particular system may differ depending on the network adapter (T5, T4 or
T3) and operating system selected.
Installing Driver
1. In the Choose the card fields, select T3 or T4/T5 depending on the chip revision of the
network card.
2. Select the operating system for which drivers are to be installed in the Choose the OS Type
field. All the systems with the selected operating system will be displayed in the list below.
Chelsio T5/T4 Unified Wire for Windows 93
Chapter III. Unified Wire Manager (UM)
Agents that report errors or whose passwords are not stored, will be
automatically skipped during the driver installation.
Note
3. Select a system or systems from the list and choose the driver to be installed in the Driver Installation section.
4. Download the appropriate driver from Chelsio‟s Download Center, service.chelsio.com.
Use this option to connect to new Agents using their IP or Hostname. The TCP port for
connection is by default 35001. You will have to provide correct user credentials for the agent in
order to connect successfully.
Chelsio T5/T4 Unified Wire for Windows 94
Chapter III. Unified Wire Manager (UM)
After connecting to the Agent, the menu bar on the left will display the connected system and its
related modules.
If you deselect the „Remember Password‟ option, you will be asked to enter the password every
time you try to connect to the system.
Figure 8.4.2 (a) - Adding a UM Agent
Chelsio T5/T4 Unified Wire for Windows 95
Chapter III. Unified Wire Manager (UM)
8.4.3. Remove System
Use this option to disconnect an Agent. To remove an agent, click on the name of the system in
the tree menu in the left and click Remove System. Then click Yes to confirm.
Figure 8.4.3 - Removing a UM Agent
8.4.4. Refresh
This option can be used to reload the Web GUI or UM Agent.
To reload the Web GUI, navigate to the Home page (by clicking on the “Home” button and click
Refresh. You can use this option to refresh Home page panes (Bookmarks and History, Service
Discovery and Bulk Driver Installation).
To reload an Agent, click on the name of the system in the tree menu in the left and click
“Refresh”. You can use this option to update any changes made to system settings like
load/unload drivers.
8.4.5. Subscribe (Email Alerts)
This feature is available only on the Web Management Interface.
Using this option, you can receive email alerts regarding the link status of a Chelsio Network
Interface Card. This feature sends email notifications regarding the port and the card, on which
the link up/down event has occurred. Not only can you configure multiple email addresses to
receive notifications, but also customize the email id of the sender for troubleshooting purposes.
To subscribe to Email Alerts, enter the sender‟s email address in the Email address field. It
should be in the format of <name>@<domain>.<extension>. You can enter multiple email
addresses for the Recipients field separated a comma. Enter Mail server details and ensure that
the “Enable email Alerts” field is enabled. Select the Agent(s), for which you want to receive
alerts and Click on Save.
Chelsio T5/T4 Unified Wire for Windows 96
Chapter III. Unified Wire Manager (UM)
Figure 8.4.5 - Subscribing to Email Alerts
8.4.6. Bulk Configuration
The Bulk Configuration page allows you to execute common configuration changes to multiple
agents and their network adapters simultaneously. You can conveniently perform bulk
operations like installing option ROM, setting MTU and VLAN ID, changing adapter and port
parameters on various devices, without having to access multiple modules and thus saving
considerable amount of administration time.
Various configurable parameters have been categorized into several modules like Boot Configuration module to install and erase option ROM, Network Configuration module to set
MTU and VLAN ID, Card Configuration module to change driver parameters, etc.
Chelsio T5/T4 Unified Wire for Windows 97
Chapter III. Unified Wire Manager (UM)
Before accessing these modules, you will have to create groups and then add members to that
group. Once done, you can select the group in the modules and the new setting will be applied
to all members of that particular group.
Manage Groups
This is where you can add, delete and manage groups. Use the Create a Group section to
create a group by specifying agent‟s platform and group type. There are various types of groups
to choose from depending on the type of configuration setting you want to change. For example,
to change the MTU size of a network interface (in the Network Configuration module), create a
group with group type Network. To install or erase option ROM on a Chelsio T4 adapter (in the
Boot Configuration module), create a group with group type t4adapter.
Here is a list of available configuration modules and corresponding group type:
After the group has been created, add members to that group using the Add a member row
button. Depending on the group type selected, you may be asked to provide additional details
for the new member. Use the Fetch Details button to do so and finally click Save a member
button to add the member to the group.
To delete a group, select it from the Select a Group drop-down list, and click Delete Group. To
delete a member from a group, select the group to which the member belongs, select the radio
button corresponding to the member to be deleted in the SNO field and finally click Delete
Member(s).
Chelsio T5/T4 Unified Wire for Windows 98
Figure 8.4.6 (a) – Creating a group
Chapter III. Unified Wire Manager (UM)
Figure 8.4.6 (b) – Managing a group
Boot Configuration
Using this module, you can install option ROM or erase option ROM on Chelsio network
devices. The Set Default Boot Settings button will reset the adapter to factory boot settings.
Figure 8.4.6 (c) – Boot Configuration module
Chelsio T5/T4 Unified Wire for Windows 99
Chapter III. Unified Wire Manager (UM)
Network Configuration
In the Network Configuration module, you can set Maximum Transfer Unit (MTU),Virtual LAN
(VLAN) ID and change the IP address type for the members (network interfaces) of the Network
group. MTU can be set between 1500-9000 bytes. VLAN id can be set for an adapter within the
range 0-4094 (enter 0 to disable it). The IP type can be static or DHCP.
Figure 8.4.6 (d) – Network Configuration module
Chelsio T5/T4 Unified Wire for Windows 100
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.