Versions Compared

Old Version 12

changes.mady.by.user Anjali Tyagi

Saved on

compared with

New Version 13

changes.mady.by.user Aaron Enfield

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Unnecessary with SCS

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

...

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:

  1. Download the latest support bundle:

...

  1. How to collect a support bundle

    Info
    titleImportant

    Always verify the latest downloaded version is available when using this tool for settings analysis before upgrading.

  2. Unpack the support tools.

  3. Generate the complete tarball by running the following script with the settings option included from the support tools directory: 

    Code Block
    languagebash
    techsupport-bundle-grab.sh -s

    Note: The admin password is required if it is changed from the default of admin:caringo.
    -A [admin pass]

    Code Block
    languagebash
    techsupport-bundle-grab.sh -s -A password_of_cluster_admin

  4. Create a new ticket for the configuration review on the Support site and note the ticket number (such as

...

  1. 210621-

...

  1. 000063), which is required later.

  2. Upload the tarball.

    • Run the following command from the directory where the support tools are located if the machine has access to the internet: 

      Code Block
      source bashrcforcustomers

      Then run:

      Code Block
      languagebash
      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

...

    • .

  2. Support is notified for the upload and works on any configuration issues that are surfaced.

Running the Checker (Non‑CSN)

...

Info

Python 3 not available

Follow this process if Python 3 is not available:

  1. On a RHEL/CentOS 6/7 server, download and unpack the support tools:

 swarm-support-tools.tgz

  1. How to collect a support bundle

  2. Run the following from the support tools directory and collect the outputs:

platform

  1. swarmctl -

read-pss.sh -A [admin pass] -a [

  1. P -d [Swarm node IP] -

S [snmp r/w pass]

  1. p "admin:[admin password]" -x
    hwinfo-dmesg-grab.sh -m [Swarm node IP]

  2. Collect all node configuration files. Several may exist if a custom PXE server is used.

  3. Zip together all configurations and script outputs above and upload to the Support Uploader as described below.

  1. Download the latest support bundle: swarm-support-tools.tgz on the Support site

  2. Check whether Python 3 is installed: 

    Code Block
    python --version

    Install it now if it is not.

  3. Unpack the support tools.

  4. Run the following Python script with the needed options: 

    Code Block
    languagepy
    python3 settings_checker.py [options]

    See Script Options below.

  5. 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.

  6. Create a new ticket for the configuration review on the Support site and note the ticket number (such as

...

  1. 210621-

...

  1. 000063).

  2. Upload the file with the Support Uploader. 

  3. Enter the ticket number when prompted; the file is attached to the ticket.

  4. 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:

...

Info

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.

Code Block
-v, --version



Show program's version number and exit.

Code Block
-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

Code Block
-c, --console



Disabled by default. Print to the console, as well as the output file.

-m



Display more output.

Code Block
-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.

Code Block
-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.

Code Block
-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'

Code Block
-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. 

Code Block
-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.

Child pages (Children Display)