Writing Sample
Hardware / Installation Guide

Hardware Documentation Sample

Installing and Verifying a Server NIC (Data Center Procedure)

This guide provides a safe, repeatable procedure to install a PCIe network interface card (NIC) in a rack-mounted server, verify detection in BIOS/UEFI and the operating system, and confirm link status.

Scope

  • Applies to common rack-mounted servers with PCIe expansion slots.
  • Examples use Linux commands; adapt as needed for other operating systems.
  • Follow site safety, ESD, and change-control requirements.

Prerequisites

  • Correct NIC model and supported firmware/driver version
  • Maintenance window and approval (if required)
  • ESD strap and standard tools
  • Network details: expected port speed, cabling, and switch port assignment

Procedure

1) Prepare and power down

  1. Notify stakeholders and confirm the maintenance window.
  2. Stop workloads gracefully or migrate services as required.
  3. Shut down the server from the OS (preferred), then power off the chassis.
  4. Disconnect power and wait per vendor guidance before opening the chassis.

2) Install the NIC

  1. Attach an ESD strap and work on an ESD-safe surface.
  2. Remove the server cover and select a compatible PCIe slot.
  3. Remove the slot cover, seat the NIC firmly, and secure it with the retention mechanism.
  4. Reinstall the server cover and reconnect power.

3) Verify detection in BIOS/UEFI

  • Boot to BIOS/UEFI and confirm the adapter appears in the PCI/PCIe device inventory.
  • If the NIC is not detected, re-seat the card and verify slot compatibility.

4) Verify detection in Linux

After booting the OS, confirm the device is present:

lspci | grep -i -E 'ethernet|network'
ip link show

Confirm the driver is loaded:

lspci -k | grep -A 3 -i ethernet
lsmod | grep -i -E 'ixgbe|i40e|bnx2|mlx'

5) Validate link status and negotiated speed

Connect cables and validate link:

ethtool <interface>
# Example:
ethtool ens3f0
  • Verify Link detected is yes.
  • Confirm Speed and Duplex match expectations.

6) Post-install checks

  • Confirm the switch port configuration (VLANs, trunk/access mode, speed settings).
  • Validate routing and firewall rules if the interface will carry production traffic.
  • Update inventory: serial number, slot location, and interface mapping.
  • Record results in the change ticket and close the maintenance window.

Troubleshooting

  • NIC not detected: confirm detection in BIOS/UEFI; re-seat the card; try a different slot.
  • Link down: verify cabling and switch port; check transceivers; validate speed compatibility.
  • Driver issues: install the vendor driver package or update kernel/firmware per vendor guidance.

This is a sample article to demonstrate how I write.