Release Notes/README instructions for mount_clean.sh script

Version 1.0

January 2022
Copyright (c) 2022 Intel Corporation.
===========================================

Contents
--------

1. Introduction
2. Supported Intel(R) Platforms
3. Supported Operating Systems
4. Pre-requisites/Failing Environment
5. Installation and Un-installation
6. Usage
7. Legal Information.

1. Introduction
---------------
The Intel(R) "mount_clean.sh" is used clearing mount errors when using SDPToolv3.0 or older. In the event of Nutanix* Foundation* installation failure, the embedded  SDPTool may leave a residual mounting record that can prevent future images from being mounted. This is indicated by the message “Error: Mount Error: Allowed only 4 Images on the same target system” during Foundation* installation. The “mount_clean” script when run on the Foundation host system will clear this log. 

2. Supported Intel(R) Platforms
----------------------
•	HNS2600BPSNUR
•	HNS2600BPB24NUR
•	HNS2600BPS24NUR
•	LCY2312NXxxxxxx
•	LCY2216NX1xxxxx
•	LCY2216NX2xxxxx
•	LCY2224NX1xxxxx
•	LCY2224NX2xxxxx
•	LCY2224NX3xxxxx 
  
 3. Supported Operating Systems  
------------------------------
•	Red Hat* Enterprise Linux* 8.x 64 Bit.
•	SuSE* Linux* Enterprise Server 15 64 Bit
•	CentOS 8.x and CentOS 7.x
•	Ubuntu 18.04 LTS and Ubuntu 20.04 LTS

4. Pre-requisites
-----------------
•	SDPToolv3.0 or older
•	root user access / sudo user to run the script 

 
5. Installation and Un-installation
-----------------------------------
 The script doesn’t need any special installation. The script requires to be run in the privileged mode or as superuser.

       Prompt #> ./mount_clean.sh [BMC_IP]
   
6. Usage
--------

The script is used to unmount all virtual media mounted to BMC via SDPTool.

 Prompt #> ./mount_clean.sh [BMC_IP]

1) To unmount ALL active virtual media mount, run below command:
    Prompt #> ./mount_clean.sh
 
2) The script takes BMC IP as optional argument to unmount virtual media on
    specific BMC IP
    Prompt #> ./mount_clean.sh 10.140.60.23
 
The IP address is optional, by default the clean script will unmount and clean all the virtual media mounts created by SDPTool. If [BMC IP] is provided the script cleans only the virtual media mounts belonging to the IP.


7. Legal Information
--------------------
========================================================
                  LEGAL INFORMATION
========================================================

Information in this document is provided in connection with Intel Products and for the purpose of supporting Intel developed server boards and systems. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document. Except as provided in Intel's
Terms and Conditions of Sale for such products, Intel assumes no liability whatsoever, and Intel disclaims any express or implied warranty, relating to sale and/or use of Intel products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Intel Corporation may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the presented subject matter. The furnishing of documents and other materials and information does not provide any license, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights. Intel products are not intended for use in medical, life saving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice.
Intel is a registered trademark of Intel Corporation.
*Other names and brands are the property of their respective owners.
Copyright (c) 2022 Intel Corporation.
(end)