Storage Settings Checker

Unnecessary with SCS

Storage Setting Checker tool is unnecessary if running on SCS. It is not useful with any Swarm version above v14.

Swarm Storage version 10 and higher are supported by a configuration checker, which is bundled with the support tools downloaded from the Support site. The report establishes the current configuration across the cluster and surfaces any setting issues (such as deprecations and new requirements) that need to be addressed. (v10.0)

To evaluate all active settings for the Swarm cluster, the checker requires both types of configuration settings:

Dynamic — The persisted settings stream (PSS object) for the cluster, which is updated in real-time by the Swarm UI or SNMP.
Static — The configuration file(s) used at node startup.

Best practice

Before troubleshooting Storage or starting an upgrade (versus a point update, such as from 11.0.1 to 11.0.3), download and run the latest settings checker and verify the results with Support.

Running the Checker (CSN)

For CSN sites only, use the techsupport‑bundle‑grab.sh with the ‑s option to run the settings checker and bundle the output along with the other needed logs and support information:

Download the latest support bundle: How to collect a support bundle
Important

Always verify the latest downloaded version is available when using this tool for settings analysis before upgrading.
Unpack the support tools.
Generate the complete tarball by running the following script with the settings option included from the support tools directory:
```
techsupport-bundle-grab.sh -s
```
Note: The admin password is required if it is changed from the default of admin:caringo.
-A [admin pass]
```
techsupport-bundle-grab.sh -s -A password_of_cluster_admin
```
Create a new ticket for the configuration review on the Support site and note the ticket number (such as 210621-000063), which is required later.
Upload the tarball.
- Run the following command from the directory where the support tools are located if the machine has access to the internet:
```
source bashrcforcustomers
```
  Then run:
```
uploadtosupport [output-file] -u [ticket number]
```
- Use scp to securely copy the file to a location with internet access and then use the Support Uploader if no internet access is available.
Support is notified for the upload and works on any configuration issues that are surfaced.

Running the Checker (Non‑CSN)

For non‑CSN sites, run the settings checker as a standalone Python 3 script.

Python 3 not available

Follow this process if Python 3 is not available:

On a RHEL/CentOS 6/7 server, download and unpack the support tools: How to collect a support bundle
Run the following from the support tools directory and collect the outputs:
swarmctl -P -d [Swarm node IP] -p "admin:[admin password]" -x
hwinfo-dmesg-grab.sh -m [Swarm node IP]
Collect all node configuration files. Several may exist if a custom PXE server is used.
Zip together all configurations and script outputs above and upload to the Support Uploader as described below.

Download the latest support bundle: swarm-support-tools.tgz on the Support site
Check whether Python 3 is installed:
```
python --version
```
Install it now if it is not.
Unpack the support tools.
Run the following Python script with the needed options:
```
python3 settings_checker.py [options]
```
See Script Options below.
The script outputs a text file that does not need to be compressed. Use scp to secure copy the file to a location with internet access.
Create a new ticket for the configuration review on the Support site and note the ticket number (such as 210621-000063).
Upload the file with the Support Uploader.
Enter the ticket number when prompted; the file is attached to the ticket.
Support is notified of the upload and works on any configuration issues

Script Options

Which options are required depend on the type of Swarm environment running:

CSN environments - None of these options are required if the /var/opt/caringo/netboot/content/cluster.cfg file has the correct admin and SNMP r/w passwords.
Non‑CSN environments - Options (user, settings) are required to enable locating and loading of the dynamic settings (PSS).

Typical usage, non-CSN

Locate the settings config file — Add ‑f FILE (for one or more file paths).
Locate the PSS (persisted settings stream) — Add -a [storage node ip] and -w [admin password].
Add ‑c to see the output on the console.

Options	Rules	Scope	Notes
`-h, --help`			Show program help and exit.
-v, --version			Show program's version number and exit.
-o OUTPUT			The pathname of the output file, which opens in append mode. Defaults to timestamped output in the current working directory: `./swarm_settings_$HOSTNAME_v$TOOLVERSION_$TIMESTAMP.out`
-c, --console			Disabled by default. Print to the console, as well as the output file.
`-m`			Display more output.
-w PASSWORD	Do not use with ‑u	CSN	The password of the cluster admin, used to retrieve the cluster's PSS (persisted settings stream). The password is read from the cluster.cfg file if not specified.
-u USERNAME_PASSWORD	Do not use with ‑`w`	Non‑CSN	The `username:password` of the cluster admin, which is needed to read the PSS. The username is read from the node.cfg file if not specified.
-p PATH, --path=PATH	Do not use with ‑`f`	Non‑CSN	The script defaults to legacy CSN configuration locations if not specified.
`-g SUFFIX`	Only use with ‑`p`	Non‑CSN	Optionally, specifies the file type, if other than '`.cfg`'.
`-f FILE [FILE ...],` `--file FILE [FILE ...]`	Do not use with ‑`p`	Non‑CSN	The location of the configuration file (or files separated by a space), or the path to all configuration files. Defaults to file type '`.cfg`'
-s SETTINGS	use ‑`a` if not known	Non‑CSN	The host/UUID of the PSS for the cluster if known, in URI form: `http://HOST/UUID.`
-a ADDRESS	Only provide if requested	Non‑CSN	The IP of a node in the cluster, to help obtain the PSS.
`-r PSSFILE`		Non‑CSN	The location of a PSS file.