Solaris Bandwidth Manager 1.5 Administration Guide

Using `batool`

This section describes how to start and navigate in batool, and the available modes of operation.

Starting `batool`

You can run batool as:

An application on your local machine. You must have the SUNWbac and SUNWbat packages installed. To run the application locally, you also need the following Sun JDMK packages: SUNWjawco, SUNWjawcl.
An applet accessed through a browser such as HotJava^TM 1.0.1 or Netscape 4.0 or compatible versions with Java Activator plug-in. If you want to configure a remote system, you must have a web server such as Sun WebServer^TM installed on the system that is running Solaris Bandwidth Manager.

Starting the `batool` Application

If you run batool as an application, you can configure Solaris Bandwidth Manager on a local or remote system.

Start the batool application by running the batool script:
```
hostname% /opt/SUNWconn/ba/sbin/batool
```

The application window starts and displays the batool Overview window.

Starting the `batool` Applet

As root, start the Solaris Bandwidth Manager policy agent on the system where Solaris Bandwidth Manager is installed:
```
# /etc/init.d/bagent.control start
```

Create a link between /opt/SUNWconn/ba/html and a directory (badir) that is below the documentation root for your web server.

The web server must be installed on the same machine as Solaris Bandwidth Manager.

On your local system, start the HotJava 1.0.1 browser and open the URL http://hostname/badir/batool.html, where hostname is the name of the system running Solaris Bandwidth Manager and badir is the directory containing the link to /opt/SUNWconn/ba/html.

Connecting to a Host System

When using batool to configure a system running Solaris Bandwidth Manager, you need to connect to the host running the Solaris Bandwidth Manager software. This applies even if the Solaris Bandwidth Manager software is installed on the local system.

To connect to the system where Solaris Bandwidth Manager is installed, select Connect from the Connection menu. The connection dialog box is displayed. Specify:

The name of the server hosting the Solaris Bandwidth Manager software.
The username for the server. This is the username set when the Solaris Bandwidth Manager software was installed. It is defined in the file /etc/opt/SUNWconn/ba/agent.properties.
The password for the server. This is the password set when the Solaris Bandwidth Manager software was installed. It is defined in the file /etc/opt/SUNWconn/ba/agent.properties. You can change the password using the Change Password option of the Connection menu.

If your username and password are valid, the Overview window is displayed.

Note -

If you log in withoug specifying a username or password, you have read-only access to the configuration information.

Connecting to a Directory Service

If the configuration for Solaris Bandwidth Manager is stored in a directory service, you must connect to it. To do so, select Open URL from the File menu. In the Location field, type the URL of the directory you want to use.

Use the format ldap://host:port/distinguishedName. distinguishedName is the entry in the directory tree that holds the configuration information in a series of sub-entries and attributes.

The Directory configuration is opened and the application window displays the Overview window. For information on using a Directory Service with Solaris Bandwidth Manager, see Chapter 6, Configuring Solaris Bandwidth Manager with a Directory Service.

Working in On-line and Off-line Mode

You can configure Solaris Bandwidth Manager in on-line or off-line mode. This mode determines how modifications to the configuration are handled. Toggle between on-line and off-line mode using the button at the top left hand side of the tool-bar.

Modifications are not automatically saved to the configuration file. To save a file, choose Save from the File menu.

Running `batool` in On-line Mode

Use the on-line mode to configure batool dynamically. If any modifications are made, the configuration for the kernel module is updated immediately. This is useful if an immediate temporary change is required because of a problem in your network. Online mode allows you to observe the consequences of a particular configuration before you save it.

Caution -

Care must be taken when modifying the configuration file in on-line mode as changes are effective immediately. For example, by reducing the bandwidth allocation to your own connection, you can disconnect yourself from the host system.

Running `batool` in Off-line Mode

Use the off-line mode to edit a Solaris Bandwidth Manager configuration file without disturbing the current behavior of the kernel module. This is useful if you want to make multiple changes in the configuration and have them implemented next time the policy agent is restarted. This is the default mode.

Navigating in `batool`

batool has a set of menus and an icon bar which you can use to navigate in the tool and make changes to the configuration.

Using the File Menu and Icon Panel

You can use the File menu to create a new configuration file, open an existing configuration file (by specifying either a filename or a URL), save a configuration file, and save a configuration file with a new name. You can also save your current configuration file and restart the Solaris Bandwidth Manager policy agent.

Alternatively, you can use the icon panel to perform most of the same functions:

Icon	Menu Item	Description
	none	Refreshes the screen display.
none	New	Creates a new configuration file, with the name `new.conf`.
	Open	Opens the specified file and displays its contents in the Overview window.
	Save	Saves a file. If the file has not been saved before, use the file selection window to specify a filename and directory. The file name should have the extension `.conf`.
none	Save As	Saves the configuration file with a new name, or writes it to a Directory Service using the specified URL.
	Save and Restart	Saves the configuration file and restarts the policy agent using the saved version of the file.
none	Restart URL	Restarts the policy agent using the configuration saved in the Directory Service specified using the URL.

Using the Edit Menu and Icon Panel

You can use the Edit menu to create, cut, copy, and paste definitions in many of the windows in batool. The exact function of each option depends on the active window. For example, the paste option will paste a URL group in the URL Group window and will paste a class as child or sibling in the Classes window.

Alternatively, you can use the icon panel to perform the same functions as the Edit menu:

Icon	Menu Item	Description
	New	Creates a new definition. If you create a new class, it is added as a child of the currently selected definition. New definitions always have the name `new`. Change this before saving the configuration.
	Cut	Deletes a definition from the definition hierarchy.
	Copy	Adds a duplicate definition as a child of the selected destination. It inherits parameter values and a name, appended by a number, from the original definition.
	Paste	Adds the definition as a child of the selected destination.
	none	Navigate up and down the definition hierarchy