DiskBoss Logo
Flexense Data Management Software

DiskBoss Command Line Utility

DiskBoss Ultimate and DiskBoss Server provide a command line utility, which is capable of performing disk space analysis, file classification, duplicate files detection, file synchronization, file organizing, file search, disk change monitoring, file copy, file delete and data wiping operations from shell scripts and batch files. In addition, the command line utility allows one to control and configure one or more DiskBoss Servers locally or through the network.

Disk Space Analysis Commands:

diskboss -analyze -dir <Directory 1> [ ... <Directory X> <Options> ]

This command analyzes the specified disks, directories or network shares.

diskboss -analyze -server <Host Name 1> [ ... <Host Name X> <Options> ]

This command analyzes all network shares in the specified servers or NAS storage devices.

diskboss -analyze -network [ Options ]

This command analyzes all network shares in all servers on the network.

diskboss -execute <User-Defined Disk Space Analysis Command>

This command executes a user-defined disk space analysis command.

File Classification Commands:

diskboss -classify -dir <Directory 1> [ ... <Directory X> <Options> ]

This command classifies files in the specified disks, directories or network shares.

diskboss -classify -server <Host Name 1> [ ... <Host Name X> <Options> ]

This command classifies files in all network shares in the specified servers.

diskboss -classify -network [ Options ]

This command classifies files in all network shares in all servers on the network.

diskboss -execute <User-Defined File Classification Command>

This command executes the specified user-defined file classification command.

Duplicate Files Search Commands:

diskboss -duplicates -dir <Directory 1> [ ... <Directory X> <Options> ]

This command searches duplicate files in the specified disks, directories or network shares.

diskboss -duplicates -server <Host Name 1> [ ... <Host Name X> <Options> ]

This command searches duplicate files in all network shares in the specified servers.

diskboss -duplicates -network [ Options ]

This command searches duplicate files in all network shares in all servers on the network.

diskboss -execute <User-Defined Duplicate Files Search Command>

This command executes the specified user-defined duplicate files search command.

File Search Commands:

diskboss -search <File Wildcard> -dir <Dir 1> ... [ <Dir X> ] [ <Options> ]

This command searches files using the specified file wildcard.

diskboss -search <File Wildcard> -server <Host Name 1> ... [ <Host Name X> ]

This command searches files in all network shares in the specified servers.

diskboss -search <File Wildcard> -network

This command searches files in all network shares in all servers on the network.

diskboss -search -regex <RegEx> -dir <Dir 1> ... [ <Dir X> ] [ <Options> ]

This command searches files using the specified regular expression.

diskboss -search -rules <XML File Name> -dir <Dir 1> ... [ <Dir X> ] [ <Options> ]

This command executes XML search queries defined according to the DiskBoss XML-Based format using input directories and files specified in the command line. For detailed information about the XML format, please refer to the DiskBoss XML format specification.

diskboss -execute <User-Defined File Search Command>

This command executes a user-defined file search operation pre-configured using the DiskBoss GUI application or imported from an XML file.

Parameters:

-dir <Directory 1> [ ... <Directory X> ]

This parameter specifies the list of input disks or directories to process. In order to ensure proper parsing of input disks and directories, directories containing space characters should be double quoted. By default, DiskBoss generates combined reports showing information about all processed disks, directories or network shares. In order to generate an individual report for each input directory use the '-batch' command line option to enable the batch report generation mode.

-server <Host Name 1> [ ... <Host Name X> ]

This parameter specifies the list of host names or IP addresses of servers or NAS storage devices that should be processed. DiskBoss will enumerate all network shares accessible in the specified servers or NAS storage devices, perform the required operation and generate reports if required. By default, DiskBoss generates combined reports showing information about all processed network shares. In order to generate an individual report for each network share use the '-batch' command line option to enable the batch report generation mode.

-network

In the network-wide operation mode, DiskBoss will discover servers and NAS storage devices accessible on the network, enumerate all network shares available in all detected servers and NAS storage devices, perform the requested operation and generate reports if required. By default, DiskBoss generates combined reports showing information about all processed network shares. In order to generate an individual report for each network share use the '-batch' command line option to enable the batch report generation mode.

Options:

-exclude_dir <Exclude Directory 1> [ ... <Exclude Directory X> ]

This option specifies the list of directories that should be excluded from the operation. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted.

-save_html_report [ Report File Name ]

This option saves results to an HTML report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].html

-save_csv_report [ Report File Name ]

This option saves results to an Excel CSV report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].csv

-save_text_report [ Report File Name ]

This option saves results to a text report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].txt

-save_pdf_report [ Report File Name ]

This option saves results to a PDF report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].pdf

-save_xml_report [ Report File Name ]

This option saves results to an XML report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].xml

-save_report [ Report File Name ]

This option saves results to a native DiskBoss report file, which may be later loaded in the DiskBoss GUI application for future review and analysis. If no file name is specified, DiskBoss will automatically generate a file name according to the following file name template: diskboss_[date]_[time].flr

-save_to_database

This option saves results to an SQL Database using the ODBC interface configured in the DiskBoss GUI application options dialog.

-title <Report Title>

This option sets a custom report title.

-label <Report Label>

This option sets a custom report label.

-levels <File System Levels>

This option sets the maximum number of file system hierarchy levels for disk space analysis operations and the maximum number of file class hierarchy levels for file classification operations.

-files_per_dir <Files Per Directory>

This option sets the maximum number of files (or subdirectories) per directory (default is 20) for disk space analysis operations.

-files_per_class <Files Per Class>

This option sets the maximum number of files per class (default is 20) for file classification operations.

-compress

This option instructs to save compressed disk space analysis reports.

-batch

This option enables the batch report generation mode. In the batch report generation mode DiskBoss saves an individual report file for each input disk, directory or network share.

-v

This option shows the product's major and minor versions.

-help

This option shows the command line usage information.