This release note and the software that accompanies it are (c)Copyright 2026
Broadcom Inc or its suppliers, and may only be installed and used in accordance
with the license that accompanies the software. All rights reserved.

This Software is furnished under license and may only be used or copied in accordance with
the terms of that license. No license, express or implied, by estoppel or otherwise,
to any intellectual property rights is granted by this document. The Software is subject
to change without notice, and should not be construed as a commitment by Broadcom Inc
or its suppliers to market, license, sell or support any product or technology.
Unless otherwise provided for in the license under which this Software is provided,
the Software is provided AS IS, with no warranties of any kind, express or implied.
Except as expressly permitted by the Software license, none of its suppliers assumes any
responsibility or liability for any errors or inaccuracies that may appear herein.
Except as expressly permitted by the Software license, no part of the Software maybe
reproduced, stored in a retrieval system, transmitted in any form, or distributed by any
means without the express written consent of Broadcom Inc.

=====================
Supported Controllers
=====================
Broadcom 3916 SAS3/PCIe4 Tri-mode RAID on Chip, SAS 3516 Ventura based MegaRAID and iMR, SAS 3108 (Invader) based MegaRAID and iMR, SAS 3008 (Fury) based HBAs,
Wellsburg & Lewisburg SATA chipset based Software RAID, SAS3816 based IOC, SAS3808 based IOC, SAS3008 based HBAs, Initiator-Target 3 (IT3) controller
9660 Family RAID Adapters, 9670 Family RAID Adapters, 9600 Family eHBA Adapters, 9620 Family eHBA Adapters

===================
Package Information
===================
LWM version = 008.018.012.000
OS supported = VMware ESXi 9.0, VMware ESXi 9.1
Language(s) supported = English

This package can be installed on ESXi x64 systems (or) platforms.

===================
Pre-Requisites
===================
1. LWM supports SMTP authorization using Auth Login. In this case user should configure LightWeightMonitor with SMTP credentials in config-current.json file


===========================
Firewall ruleset and status
===========================
LWA vib is packaged with the required firewall ruleset. By default, it will be in its disabled state and user can change it using esxcli command.

#check firewall ruleset list and status
$esxcli network firewall ruleset list | grep lwmd
Name                         Enabled
---------------------------  -------
lwmd                         false

# enable the ruleset
$esxcli network firewall ruleset set -e 1 -r lwmd

#check firewall ruleset list and status
$esxcli network firewall ruleset list | grep lwmd
lwmd                         Outbound   TCP       Dst               465       465
lwmd                         Outbound   TCP       Dst                25        25

===================
Port Numbers used
===================
Inbound:
35558 - LSA Port
Outbound:
25    - SMTP Port
465   - SMTP Port

=========================
Known Restrictions/Issues
=========================
1. Localization-Events are always shown in "English".
2. On fresh installation, LWM can process only the latest 30 events and perform the corresponding alert delivery methods.
3. As per lower layer behavior, only limited non-persistent events are maintained in its memory. In this case, those non-persistent event's sequence number would not be constant but it would be aligned with persisted events in sequential order.
4. After LWM uninstallation, delete the folder  “lwmd” from the location “/opt”. This step can be ignored if the user reboots the server after LWM uninstallation.
5. Since openssl communication failure, Email feature with SSL support is not working in ESXi 7.0 U1. Note: Issue not seen in ESXi 7.0 U3c
6. Boost version v1_79 being used in LWM due to c++ version compatibilty with later versions of boost
    Refer below link for more details:
    https://www.boost.org/users/history/version_1_80_0.html
    BREAKING: The required minimum C++ version is changed from from C++11 to C++14. Currently, large parts of GIL still compile with a C++11 compiler. 
	However, there is no guarantee that it stays that way, and any compilers that do not support at least C++14 are considered unsupported as of now.
7. SMTP can be configured on port number 25 and 465 only
8. Persistent and configuration files of LWM are available in vital folder.

=======================
Contents of the package
=======================
   LWM_ESXi.zip
     BCM_bootbank_lwmd_<version>.vib
     LWM_ESXi9x_64_readme.txt
=========================
Installation Instructions
=========================
See Detailed installation instructions below:

1.Log in to the system as root or as a user with root privileges.
  Depending on the operating system and security settings, it may be necessary to
  install LWM using root rights. This may require that, log in as root and run the installer,
  or open a command prompt as root and run the installer via the command line,

	1. VIB Installation
		a. Download BCM_bootbank_lwmd_xxxxxxxxx-1x.vib (x86_64 arch only)
		b. Copy it to host esxi machine. 
		c. Run esxcli command to install the vib
			i. esxcli software vib install --viburl=/vmfs/volumes/datastore1/BCM_bootbank_lwmd_xxxxxxxxx-1x.vib
		d. This will install LWM to /opt/lwmd directory and start the service. Since, no live-install-allowed, system will ask for reboot.
		   Service can be managed using esxcli daemon control {start|stop|restart}

	2. Component Installation
		a. Download vmware-lwmd-00x.xxx.xxx.xxx-1x.zip (x86_64 arch only)
		b. Copy it to host esxi machine. 
		c. Run esxcli command to install the component
			i. esxcli software component apply -d /vmfs/volumes/datastore1/vmware-lwmd-00x.xxx.xxx.xxx-1x.zip
		d. This will install LWM to /opt/lwmd directory and start the service. Since, no live-install-allowed, system will ask for reboot.
		   Service can be managed using esxcli daemon control {start|stop|restart}
		
	Note: In the unsigned environment, user have to use --no-sig-check argument during installation
		
==============================
Email Security Configuration:
==============================
email_password_mode - Controls content of SMTP MAIL FROM AUTH parameter

1. Secure Mode (0) - Default, Recommended
   a. MAIL FROM AUTH contains: email address only
   b. Password transmitted separately during SMTP authentication
   c. Prevents password from appearing in SMTP server logs
   
2. Full Credentials Mode (1) - NOT RECOMMENDED (Security Risk)
   a. MAIL FROM AUTH contains: email:password
   b. Password may be logged in plain text by SMTP server
   c. Use ONLY if SMTP server explicitly requires this format

Default: 0 (Secure)

When to Use Mode 1:
   Only if email authentication fails with Mode 0 AND your SMTP administrator confirms 
   the server requires credentials in MAIL FROM command. Most modern SMTP servers work with Mode 0.

Troubleshooting: 
   Verify username/password and SMTP settings (host, port, SSL/TLS) before changing to Mode 1.

Note: Both modes perform authentication. Mode 0 keeps password out of logs.

===========================
Un-installation Instructions
===========================
 esxcli software vib remove -n lwmd
 LWM package name can be derived using 
 esxcli software vib list |grep -i BCM
 
============================
LWM Service Status:
============================
	1: To Start LWM, run "esxcli daemon control start -s lwmd".
	2: To Stop LWM, run "esxcli daemon control stop -s lwmd".
	3: To retsrat LWM, run "esxcli daemon control restart -s lwmd".
Note: There is no esxcli daemon command to check solution status and above commands will not give any console ouput.

=============
How to Rekey
=============
LSA mainatains the sensitive data in encrypted format. To encrypt, LSA uses AES algorithm with key pair.
If user wants to periodically change the key pair, follow the below steps.

1. Stop LSA Service
   esxcli daemon control stop -s lwmd
   
2. Execute rekey command in the terminal (Make sure user having the admin privilege - for other user, result may unexpected)
   >$LSA_HOME/LSA.sh -rekey
   
3. LSA automatically delete the old keys and encrypt the sensitive data with new key pair

4. Start the LSA service
  esxcli daemon control start -s lwmd
  
=========================================
How to configure LightWeightMonitor Agent
=========================================
Except config-current.JSON none of the file shouldn't be edit by user from LightWeightMonitor package.
The configuration for LightWeightMonitor can be done on config-current.JSON, which is packaged with write permission.

Basic understanding about config file:
--------------------------------------
1. Different alert actions:
  i) email
  ii) systemlog

2. Different severity level
  i) INFO - Informational message where no user action is necessary
  ii) WARNING - when a component is close to failure point
  iii) CRITICAL - when a component fails
  iv) FATAL - when a component fails and data loss occurs
  v) FAULT / DEAD - The controller faulted due to a catastrophic error

3. Global rule (default alert actions for different severity of an event1)
  i) INFO event - systemlog
  ii) WARNING - systemlog
  iii) CRITICAL - systemlog
  iv) FATAL / FAULT / DEAD - systemlog and email

4. global (apply global rule for that particular severity event)


Start Configuration:
--------------------
1. After installing the LightWeightMonitor in Linux platform, this will be installed in below mentioned path.
  cd /opt/lwmd/

2. Go to the path to monitor under /opt/lwmd/conf
  cd /opt/lwmd/conf/monitor
  
3. Stop LightWeightMonitor service
   esxcli daemon control stop -s lwmd

4.Make the required changes in below file under monitor
  vi config-current.JSON (or)
  gedit config-current.JSON

5. Changes to be made in "config-current.JSON" file:

  I) E-mail Configuration:

    default:
	  "email": {
                    "isActive": true,
                    "type": "EMAIL",
                    "sender": "lsa-monitor@server.com",
                    "server": "127.0.0.1",
                    "to": [
                        "root@localhost"
                    ],
                    "authentication": {
                        "type": "NONE"
                    }
                }

	updated:
	  "email": {
                    "isActive": true,
                    "type": "EMAIL",
                    "sender": "lsa-monitor@server.com",
                    "server": "135.24.227.243",
                    "to": [
                        "root@localhost"
                    ],
                    "authentication": {
                        "type": "NONE"
                    }
                }


  II) Change alert actions for specific Severity
    default:
      {
        "warning": [
          "systemmessage"
        ]
      },
    example change to:
      {
        "warning": [
          "systemmessage",
          "email"
        ]
      },

  III) Change alert actions and severity for specific Event
    default:
      "events": [
		"gen7": [],
		"gen8": []
	  ]
    example change to:
      "events": {
        "gen7": [
          {
            "typeId": 4,
            "severity": "DEAD",
            "actions": [
              "systemmessage"
            ]
          }
        ],
        "gen8": [
          {
            "typeId": 4,
            "severity": "CRITICAL",
            "actions": [
              "systemmessage"
            ]
          }
        ]
      }

  IV) Auth Login Support
    default:
	  "email": {
                    "isActive": true,
                    "type": "EMAIL",
                    "sender": "lsa-monitor@server.com",
                    "server": "127.0.0.1",
                    "to": [
                        "root@localhost"
                    ],
                    "authentication": {
                        "type": "NONE"
                    }
                }
	Execute below command:
	>$LSA_HOME/LSA.sh -console
	It will prompt the user interface to configure e-mail configuration related changes
	Note: This particular step not require any service restart. User can chage the e-mail configuration on fly.
	example change to:
      "email": {
                    "isActive": true,
                    "type": "EMAIL",
                    "sender": "lsa-monitor@server.com",
                    "server": "127.0.0.1",
                    "to": [
                        "root@localhost"
                    ],
					// if your SMTP server supports authlogin authorization protocol then add authentication information
					"username": "lsi",  // where lsi is SMTP server's Username
                    "password": "", // The entered password could be encrypted and persisted in LSA
                    "authentication": {
                        "type": "AUTH-LOGIN"
                    }
                }
6.Start the LightWeightMonitor service
  esxcli daemon control start -s lwmd
