LinuxCommandLibrary

nbcheckers

Check Jupyter notebooks for various issues

SYNOPSIS

nbcheckers [options]

Common usage examples:
/usr/openv/netbackup/bin/nbcheckers [-i | -u | -r] [-v]
/usr/openv/netbackup/bin/nbcheckers -m [-v]
/usr/openv/netbackup/bin/nbcheckers -d [-v]
/usr/openv/netbackup/bin/nbcheckers -c <client_name> [-v]

PARAMETERS

-i
    Performs checks specifically for a NetBackup installation process.

-u
    Performs checks specifically for a NetBackup upgrade process.

-r
    Performs general readiness or pre-flight checks for NetBackup operations.

-m
    Executes checks relevant to a NetBackup master server role.

-d
    Executes checks relevant to a NetBackup media server role.

-c <client_name>
    Performs checks on a specified NetBackup client, typically requiring a client name.

-v
    Enables verbose output, providing more detailed information and progress during checks.

DESCRIPTION

nbcheckers is a diagnostic utility used within the Veritas NetBackup environment. Its primary function is to perform a series of pre-installation, pre-upgrade, or general health checks on a NetBackup server (master or media server) or client. It verifies various critical aspects of the system, including: Disk space availability for installation, logs, and catalogs; Network connectivity and name resolution (DNS/hosts file entries); User/group permissions; Kernel parameters; Firewall settings; NTP synchronization; and Specific NetBackup configuration files and directories.

The tool helps identify potential issues that could hinder NetBackup operations or lead to failed installations/upgrades, allowing administrators to remediate problems proactively. It provides detailed output, often suggesting corrective actions. It's an essential tool for ensuring a healthy NetBackup infrastructure.

CAVEATS

Requires NetBackup Installation: This command is not a standard Linux utility; it is specific to Veritas NetBackup software and must be run from a system with NetBackup installed.
Path Dependency: It's typically located in the NetBackup installation path (e.g., /usr/openv/netbackup/bin/). Running it without the full path or without adding the path to PATH might fail.
Root Privileges: Many checks performed by nbcheckers require root privileges to access system resources, kernel parameters, and sensitive configuration files.
Version Specificity: Its exact behavior, available options, and scope of checks can vary slightly between different versions of NetBackup. Always consult the Veritas NetBackup documentation for the specific version in use.
Diagnostic Only: It's a diagnostic tool; it identifies problems but does not fix them automatically. Administrators must manually address any issues reported.

OUTPUT INTERPRETATION

nbcheckers typically provides clear, often color-coded (on a terminal) output, indicating PASSED, WARNING, or FAILED for each check. Failed checks usually include specific reasons and sometimes recommended actions to remediate the issue.

LOG FILES

The detailed output of nbcheckers is often logged to a file, which is crucial for post-execution analysis, auditing, and troubleshooting. The log file location is usually within the NetBackup logs directory (e.g., /usr/openv/netbackup/logs/nbcheckers or a subdirectory within /usr/openv/netbackup/logs/).

HISTORY

nbcheckers has been a part of Veritas (formerly Symantec) NetBackup for many years, evolving alongside the product. Its role has consistently been to serve as a pre-flight checklist tool, particularly emphasized for major upgrades or installations to minimize common deployment issues. Over time, its capabilities have expanded to include checks for more complex environments, such as cluster readiness, cloud integration prerequisites, and specific performance-related parameters. Its continuous development reflects the growing complexity of enterprise backup environments and the need for robust validation steps.

SEE ALSO

bpps, bpclntcmd, nbtstat, bpmsg

Copied to clipboard