python.conf

The SANBlaze Python api allows users to override certain behaviors by setting values in the python.conf file.

To modify the system configuration, the built in program ‘configuration’ should be run from the cli:

configuration

Note

The python.conf is located on the vlun at /virtualun/python.conf

Warning

The file can be changed by opening it with any text editor and inserting the proper value. Although the file can be modified directly, this is not recommended. Any mistakes in the json will cause the software to crash.

Note

If the configuration file is successfully used to override default behavior, an entry will be added to the beginning of the test log to indicate this modified behavior.

The configuration file is a json formatted file. The following are the valid values:

Valid Values
Outer Value	Inner Value	Valid Inputs
logging	resolution	us, ms
errors	link width	“ignore”, “notify”, “warn”, “error”
errors	link speed	“ignore”, “notify”, “warn”, “error”
reporting	SMART	0, 1
extras	skip_restore	0, 1
BlockErase	N/A	A string matched as a substring against the drive Model

Link Speed and Link Width Error Action

Link speed and link width are checked at the start and end of the test. By default, if the starting and ending values are not the same, a item will be logged the level ‘NOTE’.

If different behavior is required, this can be override in the python.conf file by setting the desired fail action.

If the link width value is incorrect, handle this as an error. The script state will be adjusted accordingly and an error message will be logged.

{"errors":
    {"link width": "error"}
}

If the link speed or the link width value is incorrect, handle this as a warning. The script state will be adjusted accordingly and a warning message will be logged.

{"errors":
            {"link width": "error",
            "link speed": "error"}
}

To turn off this notification:

{"errors":
            {"link width": "ignore",
            "link speed": "ignore"}
}

Note

Invalid values will be ignored.

Health information data (SMART)

Add SMART data as part of the standard report.

To turn on this notification:

{"reporting":
            {"SMART": 1}
}

To turn off this notification:

{"reporting":
            {"SMART": 0}
}

Skip Restore

When combined with the ‘Stop on First Error’ setting, this allows the user to skip any skip restore actions and stop the test on the first error.

Warning

This may leave the drive in a state that will require manual cleanup. Before running any further tests the drive will have to be examined and corrected. Use with caution.

Block Erase Before FDP

Some drives require a sanitize block erase after any write has been issued before the Flexible Data Placement (FDP) feature can be enabled or disabled. On these drives, toggling FDP with a Set Features command (FID 1Dh) after IO has been issued returns NVMe status 6h (Internal Error).

Setting BlockErase causes the FDP scripts to perform a sanitize block erase (Sanitize command with SANACT = 010b) before enabling FDP. The configured value is matched as a substring against the connected drive’s Model string; the block erase is only performed when the drive Model contains the configured value. This allows the behavior to be enabled for specific drive models, or an entire model family, without modifying the test scripts.

After issuing the block erase, the script polls the Sanitize Status Log Page (LID 81h) every 30 seconds until the SSTAT field reports the operation is no longer in progress.

To enable a block erase before FDP on any drive whose Model contains MZWL:

{"BlockErase": "MZWL"}