The MBUtility Command

< Previous section | Table of Contents | Index | Next section >

The MBUtility command offers a command-line interface to selected MainBoss operations. This allows administrators and IT personnel to create shell scripts (e.g. .bat or .cmd command files) which perform common administrative functions.

MBUtility is installed as an .exe file in the same folder as other MainBoss software. To execute MBUtility, you can cd to this folder or you can create a shortcut to the program. You can also add the MainBoss software folder to your PATH environment variable.

MBUtility is only available if you have installed the MainBoss package manually. The software will not be available on your computer if you use ClickOnce deployment.

In general, the format of the command is

mbutility verb option option option ...

The verb must always come immediately after mbutility, but the options may appear in any order.

Options may have any of the following forms:

/keyword:value: Specifies a value. For example, /Output:filename specifies an output file.

+Option: Turns on an option. For example, +Probe may be used with the AddOrganization verb; it tells MBUtility to check that the corresponding database is actually accessible from the current computer.

-Option: Turns off an option. For example, -Probe may be used with the AddOrganization verb; it tells MBUtility not to check the database's accessibility, but just to add it to the list of known organizations.

Abbreviations on the MBUtility Command Line: Most keywords on the MBUtility command line may be abbreviated. In the sections that follow, letters that must be included are shown in upper case; any or all other letters may be omitted. For example, the following are all valid abbreviations for the option /DatabaseName

/databasename
/databasen
/dbname
/dn

Although the documentation shows some letters in upper case and some in lower, you can type letters in any case you want. For example, /DBN is exactly the same as /dbn or /Dbn on the MainBoss command line.