AIdirector Version 2.1x Configuration Guide - Westell, Incsupport.westell.com/.../Director-v2-1x-Configuration-Guide-(1).pdf · Configuration Guide Version 2.1x ... Commands This

AIdirectorTM

Configuration Guide

Version 2.1x

Part Number CF-DIR Rev 3
© 2008 by Kentrox, Inc. All rights reserved.

Copyright © 2008 by Kentrox, Inc. All Rights Reserved. The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication.

Kentrox is a registered trademark of Kentrox, Inc. Applied Innovation, Applied Innovation Inc., the AI logo, and other names are the intellectual property of Kentrox. All other product names are trademarks or registered trademarks of their respective owners.

Information published here is current as of this document’s date of publication, but is subject to change without notice. You may verify product information by contacting our headquarters in Oregon. Kentrox is an Equal Opportunity/Affirmative Action employer.

Kentrox, Inc.5800 Innovation Dr.

Dublin, Ohio USA 43016-3271Toll Free: (800) 247-9482

International: +1 (614) 798-2000Fax: +1 (614) 798-1770

20010 NW Tanasbourne Dr.Hillsboro, Oregon USA 97124-7104

Toll Free: (800) 733-5511Direct: (503) 643-1681

About this Document

This document explains how to use the AIdirector network navigation tool to administer a network of devices, including how to add and edit regions, vendors, protocols, models, and individual network elements. This document also explains how to group users and network elements for security purposes.

AIdirector system administrators should have a working knowledge of devices on the network.

i

AIdirector Version 2.1x Configuration GuideAbout this Document: Document Conventions

Document ConventionsTable 1 describes the text conventions used in this document.

Table 1 Document Conventions

Convention Meaning

Screen Text, Menu Items,

System Prompts, Messages

and Reports

This style indicates Kentrox configuration screen text, menu items, system prompts, messages, and reports.

Static Command Text In a command statement, this style indicates text that should be entered exactly as shown at a command line.

Variable Command Text In a command statement, this style indicates user-specified text.

... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times.

[ ]

[ | ]

In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( | ) between them indicate a choice of optional parameters.

{ | } In a command statement, two or more parameters in braces with a vertical bar ( | ) between them indicate a choice of required parameters.

Menus and Menu Commands

This style indicates menu and menu commands. A vertical bar ( | ) separates the menus from the submenus or menu commands. The vertical bar also indicates the order in which you should click the menus, submenus, and menu commands.

Dialog Boxes, Tabs, Fields, Check Boxes, and Command Buttons

This style indicates dialog boxes, tabs, fields, check boxes, and command buttons.

Variable Field Text This style indicates variable information you type in a dialog box field.

KEYS Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+).

Labels This style designates physical components on Kentrox products such as jumpers, switches, and cable connectors.

ii

AIdirector Version 2.1x Configuration GuideAbout this Document: Document Conventions

Note:Note messages emphasize or supplement important points of the main text.

Important: Important messages provide information that is essential to the completion of a task.

Tip:Tip messages provide information that assists users in operating equipment more effectively.

Table 1 Document Conventions (Continued)

Convention Meaning

iii

AIdirector Version 2.1x Configuration GuideAbout this Document: Customer Assistance

Customer AssistanceKentrox offers technical support 24 hours a day, seven days a week.

Before you contact Kentrox for assistance, please have the following information available:

The version of hardware and software you are currently running

The error number and exact wording of any messages that appeared on your screen

What happened and what you were doing when the problem occurred

How you tried to solve the problem

Web Site SupportSupport is available 24 hours a day using our Web site at:

http://www.kentrox.com

Email SupportEmail support is available 24 hours a day. When you use email support, please be sure to include the details of your problem within the email.

To contact Technical Support, send email to:

[email protected]

Phone SupportPhone support is available. When you call Kentrox for support, please be sure you are at your computer and have the details of your problem available.

To contact Technical Support, call (866) 480-3571.

Product DocumentationTo order documentation, please contact your sales representative at (800) 247-9482 or +1 (614) 798-2000.

You can also access and view the most current versions of Kentrox product documentation on our Web site at:

http://www.kentrox.com

iv

Table of Contents

Chapter 1: Getting Started .....................................................................1-1AIdirector Overview ...................................................................................................... 1-2Using the Main Window ............................................................................................... 1-3Using the Element Dialog Box ..................................................................................... 1-4

Log Tab ............................................................................................................ 1-5Notes Tab ......................................................................................................... 1-6Element Groups Tab ........................................................................................ 1-7

Using the User Preferences Dialog Box ....................................................................... 1-8Using the Protocol Dialog Box ................................................................................... 1-10Using the Dependents Dialog Box ............................................................................. 1-11Managing Security ..................................................................................................... 1-12Identifying Shortcut Keys ........................................................................................... 1-13Identifying Menu Bar Items ........................................................................................ 1-14

Chapter 2: AIredirect ..............................................................................2-1AIredirect Overview ...................................................................................................... 2-2Creating AIredirect Profiles .......................................................................................... 2-3

Chapter 3: Regions ................................................................................3-1Regions Overview ........................................................................................................ 3-2Adding a Region ........................................................................................................... 3-3Editing a Region ........................................................................................................... 3-6Deleting a Region ......................................................................................................... 3-8Moving a Region .......................................................................................................... 3-9

Chapter 4: Vendors ................................................................................4-1Vendors Overview ........................................................................................................ 4-2Adding a Vendor .......................................................................................................... 4-3Editing a Vendor ........................................................................................................... 4-4Deleting a Vendor ........................................................................................................ 4-5

Chapter 5: Protocols ..............................................................................5-1Protocols Overview ...................................................................................................... 5-2Adding a Protocol ......................................................................................................... 5-3Editing a Protocol ......................................................................................................... 5-4

TOC-1

Table of Contents

Deleting a Protocol ....................................................................................................... 5-5

Chapter 6: Models ..................................................................................6-1Models Overview .......................................................................................................... 6-2Adding a Model ............................................................................................................ 6-3Editing a Model ............................................................................................................ 6-5Deleting a Model .......................................................................................................... 6-7

Chapter 7: Network Elements ................................................................7-1Network Element Overview .......................................................................................... 7-2Adding a Network Element ........................................................................................... 7-3Editing a Network Element ........................................................................................... 7-8Deleting a Network Element ....................................................................................... 7-10Moving a Network Element to a New Region ............................................................. 7-11Searching for Network Elements ................................................................................ 7-13

Chapter 8: Applications ..........................................................................8-1Applications Overview .................................................................................................. 8-2Adding an Application .................................................................................................. 8-3Editing an Application ................................................................................................... 8-5Deleting an Application ................................................................................................ 8-6IP Applications ............................................................................................................. 8-7Serial Applications ........................................................................................................ 8-8Launching an Application for a Network Element ........................................................ 8-9Auto-Detecting Applications ....................................................................................... 8-10

Chapter 9: Users and User Groups ........................................................9-1User Group Overview ................................................................................................... 9-2Creating a User Group ................................................................................................. 9-3Editing a User Group .................................................................................................... 9-6Deleting a User Group ................................................................................................. 9-7Creating a User ............................................................................................................ 9-8Editing a User ............................................................................................................. 9-10Deleting a User .......................................................................................................... 9-11Adding a User to a User Group .................................................................................. 9-12Removing a User from a User Group ......................................................................... 9-15Viewing Group Membership ....................................................................................... 9-18

Chapter 10: Element Groups ...............................................................10-1Element Group Overview ........................................................................................... 10-2

Fixed Element Groups .................................................................................... 10-2Dynamic Element Groups .............................................................................. 10-2

TOC-2

Table of Contents

Creating an Element Group ....................................................................................... 10-3Creating a Dynamic Element Group ............................................................... 10-3Creating a Dynamic Element Group from a Filter .......................................... 10-6Creating a Fixed Element Group .................................................................... 10-6

Editing an Element Group ........................................................................................ 10-10Editing a Fixed Element Group .................................................................... 10-10Editing a Dynamic Element Group ............................................................... 10-12

Deleting an Element Group ...................................................................................... 10-15Adding Network Elements to an Element Group ...................................................... 10-16

Adding Network Elements to a Dynamic Element Group ............................. 10-16Adding Network Elements to a Fixed Element Group .................................. 10-16

Removing Network Elements from an Element Group ............................................ 10-18Removing Network Elements from a Dynamic Element Group .................... 10-18Removing Network Elements from a Fixed Element Group ......................... 10-18

Adding an Element Group to a User Group ............................................................. 10-21Removing an Element Group from a User Group .................................................... 10-25

Chapter 11: Using Reports ...................................................................11-1Reports Overview ....................................................................................................... 11-2

User to User Group Report ............................................................................ 11-2User Group to User Report ............................................................................ 11-3User Group to Element Group Report ............................................................ 11-3Element Group to User Group Report ............................................................ 11-4Element Group to Element Report ................................................................. 11-4Element to Element Group Report ................................................................. 11-5

Viewing and Saving Reports ...................................................................................... 11-6

TOC-3

Table of Contents

TOC-4

1

Getting Started

Guide to this Section

AIdirector Overview

Using the Main Window

Using the Element Dialog Box

Using the User Preferences Dialog Box

Using the Protocol Dialog Box

Using the Dependents Dialog Box

Managing Security

Identifying Shortcut Keys

Identifying Menu Bar Items

1-1

AIdirector Version 2.1x Configuration GuideGetting Started: AIdirector Overview

AIdirector OverviewAIdirector is a remote network element database that provides the ability to navigate to any network element and launch applications that are compatible with each instance of a particular model. One of the common uses is finding a network element and launching a browser to connect to it.

AIdirector supports all IP devices and any non-IP device that can be connected to an Applied Innovation mediation device. The following list provides some examples:

AIbadger

AIremote

AIswitch

AIscout

AIdirector allows for add-on extensions such as EventDirector and PowerDirector that enhance the functionality of the base application. These extensions are available separately and are installed on top of an existing AIdirector server.

AIdirector is used by technicians to access network elements, and by administrators to populate the AIdirector database, configure network elements, and access default settings.

1-2

AIdirector Version 2.1x Configuration GuideGetting Started: Using the Main Window

Using the Main WindowThe AIdirector main window lets you navigate by region or subregion and also displays information about regions and subregions you select. Navigation results display as a detailed table with network elements, model names, and associated notes.

The Element Filter section of the main window is used for Searching for Network Elements.

Figure 1-1 AIdirector Main Window

1-3

AIdirector Version 2.1x Configuration GuideGetting Started: Using the Element Dialog Box

Using the Element Dialog BoxYou can open the Element dialog box by selecting a network element in the main window, then clicking File > Edit > Element. From the Element dialog box, you can view and edit details about each network element including:

Name

Model

Region

IP address

List of supported protocols

Log

Element groups

Notes

Tip: You can configure AIdirector to open the Element dialog box when you double-click a network element in the main window. To use this shortcut, choose File > User Preferences, click the AIdirector tab, then choose Edit element from the Preferred double click action drop-down list.

Figure 1-2 Element Dialog Box - Protocols Tab

1-4


The Element dialog box provides information about a network element. The Protocols tab lists the protocols supported by this network element. When an IP-capable network element is added to the database, this table will be pre-populated with the default ports indicated for its model. You can then edit the protocol port values for this individual element as required.

Note: If the Add and Fill buttons are unavailable, this means that all protocols available for this network element have been enabled. If the Add and Fill buttons are available, this indicates there are protocols available for the model that have not been enabled for this particular network element. Click Add to add protocols individually, or click Fill to add all available protocols.

For serial-connected network elements, the protocol entries will be entered through the AIdirector GUI. In most cases, these entries will consist of a single protocol entry for its serial port. For those elements the user must select the name of the access network element (usually an AI device) that is providing the IP-to-serial mediation for that protocol.

Log TabThe Log tab lists a summary of log entries pertaining to this network element. Each log entry contains up to 4096 characters of text, the date and time the entry was created, and the username of the user who created the entry. To view a log entry, select it from the list, then click View. To delete a log entry, select it from the list, then click Delete. To add a new log entry, click Add, then enter log text in the Add Log Entry dialog box.

Figure 1-3 Element Dialog Box - Log Tab

1-5


Notes TabThe Notes tab provides a location to record any notes that pertain to this network element, such as a service record for the network element or contact information for someone to notify in case of problems with the network element. The Notes section can contain any values up to 4096 characters.

Figure 1-4 Element Dialog Box - Notes Tab

1-6


Element Groups TabThe Element Groups tab lists the element groups to which this element belongs. Click Add to add this element to a fixed element group. Select a fixed element group and click Remove to remove this element from that element group.

Figure 1-5 Element Dialog Box - Element Groups Tab

1-7

AIdirector Version 2.1x Configuration GuideGetting Started: Using the User Preferences Dialog Box

Using the User Preferences Dialog BoxYou can open the User Preferences dialog box by choosing File > User Preferences.

By default, the User Preferences dialog box contains two tabs: AIdirector and Applications.

Note: More tabs may appear in the User Preferences dialog box depending on which AIdirector extensions are installed.

The AIdirector tab allows you to choose the action that will take place when you double-click a network element in the AIdirector main window. You can opt to open the Edit Element dialog box when an element is double-clicked, or you can opt to launch an application (such as Internet Explorer) to access the element.

Figure 1-6 User Preferences Dialog Box - AIdirector Tab

The Applications tab is used to configure applications installed on the PC. The location of installed applications can be auto-detected (for common applications) or configured manually.

Applications are associated with protocols. As network elements are added, the dialog box indicates which protocols (and by extension, which applications) they support.

1-8

AIdirector Version 2.1x Configuration GuideGetting Started: Using the User Preferences Dialog Box

Figure 1-7 User Preferences Dialog Box - Applications Tab

The application shown at the top of the list will be used by default when accessing network elements. If the application at the top of the list is incompatible with the network element you are accessing, AIdirector will use the second application in the list to access the element. If the second application also is incompatible, AIdirector will use the third application to access the element, and so forth.

You can assign priority to an application by selecting it on the Applications tab, then clicking the Up Arrow and Down Arrow buttons located at the bottom of the Applications tab to move the application to a higher or lower priority in the list.

Note: In the AIdirector Application menu, applications appear in order of their assigned priority.

1-9

AIdirector Version 2.1x Configuration GuideGetting Started: Using the Protocol Dialog Box

Using the Protocol Dialog BoxProtocol details for network elements can be edited through the Protocol dialog box, accessed through the Element dialog box by selecting a protocol and clicking Edit. In this dialog box, the IP port used for the protocol can be changed. If the element is a serial-connected device, the access network element can also be changed.

Figure 1-8 Edit Protocol Dialog Box

1-10

AIdirector Version 2.1x Configuration GuideGetting Started: Using the Dependents Dialog Box

Using the Dependents Dialog BoxThe Dependents dialog box displays a list of any serial devices that are connected to a specific mediation device, such as AIbadger. This dialog box can be accessed through the Element dialog box.

Use this dialog box to either open and edit a serial device or delete a serial device.

Figure 1-9 Dependents Dialog Box

1-11

AIdirector Version 2.1x Configuration GuideGetting Started: Managing Security

Managing SecuritySecurity is administered through the use of user groups and element groups. This provides a convenient method for assigning users access to certain network elements, but restricting access to other network elements.

The AIdirector administrator creates element groups, then assigns network elements membership in one or more element groups. The administrator also creates user groups with different permission levels, then assigns individual users membership in one or more user groups.

Here is an example to illustrate the use of user groups and element groups.

Consider a company that hires a contractor from Acme Corporation, which specializes in servicing Model X devices. The company wants this contractor to have complete access to all Model X devices in a given region, but no access to any other devices.

The AIdirector administrator creates element group ModelX containing Model X devices only. The administrator then creates user group AcmeTechs with manager permissions and assigns the contractor to this user group. Finally, the administrator assigns user group AcmeTechs to element group ModelX.

Now suppose the company wants the Acme contractor to be able to view the status of all devices in the region, but have administrative access to Model X devices only. The AIdirector administrator creates a second element group, AllDevices, containing all devices in the region. The administrator then creates user group AllTechs with status permissions and assigns the contractor to that user group as well. Finally, the administrator assigns user group AllTechs to element group AllDevices.

The contractor has status permissions on all devices in the region, based on membership in the user group AllTechs. The contractor also has manager permissions on Model X devices, based on membership in the user group AcmeTechs.

See Users and User Groups and Element Groups for detailed instructions on managing user groups and element groups.

1-12

AIdirector Version 2.1x Configuration GuideGetting Started: Identifying Shortcut Keys

Identifying Shortcut KeysThe following table provides a list of commonly used shortcut keys and the functions that they perform.

Note: This table does not list every shortcut key that is available.

Tip: To view shortcut keys on a particular page in the application, hold down the ALT key and view the page. An underline appears under a letter in the field name. Press the ALT key plus that letter to access that field.

Shortcut Key Function

ALT + F File Menu

ALT + A Application Menu

CTRL + N New Element

CTRL + Q Exit

F1 Help

ALT + H Help Menu

ALT + O OK

ALT + C Cancel

1-13

AIdirector Version 2.1x Configuration GuideGetting Started: Identifying Menu Bar Items

Identifying Menu Bar Items

Note: Additional menu items may appear depending on which AIdirector extensions have been installed.

The following table displays menus and submenus that are available from the AIdirector main window:

Menu Submenus

File NewEditMoveDeleteUser ManagementUser PreferencesSystem Preferences (with some extensions)Exit

View User Group MembershipReports

Application Any existing applications (for example, Internet Explorer)

Help AIdirector HelpAbout AIdirector

1-14

2

AIredirect


AIredirect Overview

Creating AIredirect Profiles

2-1

AIdirector Version 2.1x Configuration GuideAIredirect: AIredirect Overview

AIredirect OverviewOne of the applications with which AIdirector is associated is an enhanced AIredirect tool. AIredirect creates virtual COM ports for applications such as Procomm or HyperTerminal that require a serial interface. It is intended for network elements that are connected to the network through their serial interface to an AI device. With AIredirect, devices appear to be directly connected to the PC.

When the serial application terminates, AIredirect removes the virtual serial port and shuts down. AIredirect continues to have a GUI mode when invoked directly by the user.

AIredirect has the ability to detect and automatically remove a virtual serial device when it is no longer necessary.

Note: AIredirect version 2.0 is required for compatibility with AIdirector.

2-2

AIdirector Version 2.1x Configuration GuideAIredirect: Creating AIredirect Profiles

Creating AIredirect ProfilesAIredirect is used to create virtual COM ports that applications can use to access equipment.

To create an AIredirect profile (virtual COM port):

1. Open the AIredirect application.

2. From the menu bar, click Connections > New. The Create New AIredirect Connection page opens.

OR

From the toolbar, click the New button. The Create New AIredirect Connection page opens.

3. In the Profile Name field, enter a name for the new profile.

4. In the Virtual Serial Port field, enter the COM port that the serial application will be using (for example, COM1 or COM2).

5. Leave the Host Name or IP Address field blank.

6. In the Protocol section, select TCP Protocol.

7. Click OK. The new profile has been created.

Note: To use the new AIredirect profile, you need to create a new application from within the AIdirector client. From the New Application dialog box, you have the option to select an AIredirect profile.

See also:

Adding an Application

2-3

AIdirector Version 2.1x Configuration GuideAIredirect: Creating AIredirect Profiles

2-4

3

Regions


Regions Overview

Adding a Region

Editing a Region

Deleting a Region

Moving a Region

3-1

AIdirector Version 2.1x Configuration GuideRegions: Regions Overview

Regions OverviewThe database has network elements stored in regions. The regions can be nested into any geographic or logical grouping of network elements.

Once a region is selected, you have the option to:

Add a subregion to a selected region

Rename a region

Delete a region

Move (re-parent) a region

3-2

AIdirector Version 2.1x Configuration GuideRegions: Adding a Region

Adding a RegionTo add a region:

1. From the AIdirector main page, select the region that will be the parent of the new region, or select any region if the new region is to be inserted at the top level.

2. Select File > New > Region.

Figure 3-1 Selecting File > New > Region

3. The New Region dialog box opens with the Parent tab displayed. In the Region name field, enter a name for the new region. Valid values are up to 50 characters.

4. If the new region is to be a subregion under another region, click Under region and choose a region from the region tree. If the new region will not be a subregion of another region, click Top level.

Figure 3-2 New Region Dialog Box - Parent Tab

3-3


5. (optional) If you would like to store ID and/or location information for this site, click the Site Definition tab, select the Site option, then fill in the ID, Address, City, and State/Province fields.

Figure 3-3 New Region Dialog Box - Site Definition Tab

6. (optional) If you would like to record a log entry for this region, click the Log tab, then click Add. The Add Log Entry dialog box opens. Add log text in the text entry field, then click OK to save the log entry and return to the New Region dialog box.

Figure 3-4 New Region Dialog Box - Log Tab

3-4


7. (optional) If you would like to record notes for this region, click the Notes tab, then enter note text in the text entry field.

Figure 3-5 New Region Dialog Box - Notes Tab

8. Click OK. The new region is inserted.

Note: The AIdirector Administration Guide has information on using the Import utility to add multiple regions at one time.

Figure 3-6 New Region Appears in Region Tree

3-5

AIdirector Version 2.1x Configuration GuideRegions: Editing a Region

Editing a RegionTo edit a region:

1. From the AIdirector main page, select the region you want to edit.

2. Select File > Edit > Region. The Region dialog box opens.

3. (optional) In the Region name field, enter a new name for the region. Valid values are up to 50 characters.

4. (optional) If you would like to edit the ID and/or location information for this site, click the Site Definition tab, select the Site option, then edit the information in the ID, Address, City, and State/Province fields.

Figure 3-7 Region Dialog Box - Site Definition Tab

5. (optional) If you would like to record, view, or delete a log entry for this region, click the Log tab. You can then:

Add a log entry by clicking Add. The Add Log Entry dialog box opens. Add log text in the text entry field, then click OK to save the log entry and return to the New Region dialog box.

View a log entry by selecting the log entry in the list, then clicking View. The View Log Entry dialog box opens, displaying log text. Click Close to return to the New Region dialog box.

Delete a log entry by selecting the log entry in the list, then clicking Delete.

3-6

AIdirector Version 2.1x Configuration GuideRegions: Editing a Region

Figure 3-8 Region Dialog Box - Log Tab

6. (optional) If you would like to record or edit notes for this region, click the Notes tab, then enter note text in the text entry field.

Figure 3-9 New Region Dialog Box - Notes Tab

7. Click OK to close the Region dialog box and save your changes.

3-7

AIdirector Version 2.1x Configuration GuideRegions: Deleting a Region

Deleting a RegionDeleting a region requires confirmation. When a region is deleted, its children, including network elements and subregions, must also be deleted. When deleting a region, a confirmation dialog box appears that presents the name of the object selected for deletion and provides information about all other related objects that will also be deleted.

To delete a region:

1. From the AIdirector main page, select the region you want to delete.

2. Select File > Delete > Region. The Confirm Delete dialog box appears prompting you for confirmation of the deletion.

Note: The Confirm Delete dialog box provides information regarding any subregions that might exist.

Figure 3-10 Confirm Delete Dialog Box

3. Click Yes. The region has been deleted.

3-8

AIdirector Version 2.1x Configuration GuideRegions: Moving a Region

Moving a RegionTo move a region:

1. From the AIdirector main page, select the region that you wish to move.

Figure 3-11 Region Tree - Region Anaheim Selected

2. Select File > Move > Region. The Move Region dialog box opens.

3. From the Move Region dialog box, select either Top level or Under region.

4. If Under region is selected, choose the region that will become the parent of the region that you are moving.

Figure 3-12 Move Region Dialog Box

3-9

AIdirector Version 2.1x Configuration GuideRegions: Moving a Region

5. Click OK. The region is moved.

Figure 3-13 Region Tree - Region Anaheim Moved

Note: It is also possible to move regions by the “drag and drop” method (by clicking regions and dragging them to new locations). When you drop a region in a new location, a dialog box appears to confirm the new location. Click Yes to accept the new location.

3-10

4

Vendors


Vendors Overview

Adding a Vendor

Editing a Vendor

Deleting a Vendor

4-1

AIdirector Version 2.1x Configuration GuideVendors: Vendors Overview

Vendors OverviewThe database contains a list of vendors. Each vendor is the manufacturer of one or more models of network elements. The database stores a name for each vendor.

Once a vendor has been added to the database, you have the option to:

Rename a vendor

Delete a vendor

4-2

AIdirector Version 2.1x Configuration GuideVendors: Adding a Vendor

Adding a VendorTo add a vendor:

1. Select File > New > Vendor. The New Vendor dialog box opens.

Figure 4-1 Selecting File > New > Vendor

2. In the Vendor name field, enter a name for the new vendor. Valid values are up to 50 characters.

Figure 4-2 New Vendor Dialog Box

3. Click OK. The new vendor is added.

Note: The AIdirector Administration Guide has information on using the Import utility to add multiple vendors at one time.

4-3

AIdirector Version 2.1x Configuration GuideVendors: Editing a Vendor

Editing a VendorTo edit a vendor:

1. Select File > Edit > Vendor. The Edit Vendor dialog box opens.

Figure 4-3 Edit Vendor Dialog Box

2. Select a vendor to edit and click Edit.

3. The Vendor dialog box opens. From this dialog box, you can:

Edit the text in the Vendor name field

Edit and delete models associated with this vendor by clicking Dependents....

Figure 4-4 Vendor Dialog Box

4. Click OK. The new vendor information has been saved.

5. Click Close to close the Edit Vendor dialog box.

4-4

AIdirector Version 2.1x Configuration GuideVendors: Deleting a Vendor

Deleting a VendorTo delete a vendor:

1. Select File > Delete > Vendor. The Delete Vendor dialog box opens.

2. Select a vendor to delete and click the Delete button.

Figure 4-5 Delete Vendor Dialog Box

Note: A vendor cannot be deleted if any models associated with it are in the AIdirector database. You must delete all models associated with a vendor before you can delete the vendor. Click the Dependents... button in the Vendor dialog box to see which models are associated with the vendor.

Figure 4-6 Error - Deleting a Vendor

3. Click Close. The vendor has been deleted.

4-5

AIdirector Version 2.1x Configuration GuideVendors: Deleting a Vendor

4-6

5

Protocols


Protocols Overview

Adding a Protocol

Editing a Protocol

Deleting a Protocol

5-1

AIdirector Version 2.1x Configuration GuideProtocols: Protocols Overview

Protocols OverviewThe AIdirector database stores a list of protocols. A protocol indicates the type of communication between an application running on the client and an element in the network. IP-based protocols such as HTTP have default ports associated with them.

Non-IP protocols can be used by AIdirector when a mediation device (such as AIremote) is present in the network to convert a craft interface on a non-IP capable device into an IP connection.

Once a protocol has been added to the database, you have the option to:

Rename a protocol

Delete a protocol

Assign a new default port to a protocol

Associate models with a protocol

Disassociate models from a protocol

5-2

AIdirector Version 2.1x Configuration GuideProtocols: Adding a Protocol

Adding a ProtocolTo add a protocol:

1. Select File > New > Protocol. The New Protocol dialog box opens.

2. In the Protocol field, enter a name for the new protocol. Valid values are up to 50 characters.

3. If the protocol has a default port, select the Default port option and enter a port number.

Figure 5-1 New Protocol Dialog Box

4. Click OK. The new protocol is added.

Note: The AIdirector Administration Guide has information on using the Import utility to add multiple protocols at one time.

5-3

AIdirector Version 2.1x Configuration GuideProtocols: Editing a Protocol

Editing a ProtocolTo edit a protocol:

1. Select File > Edit > Protocol. The Edit Protocol dialog box opens.

Figure 5-2 Edit Protocol Dialog Box

2. Select a protocol to edit and click Edit.

3. The Protocol dialog box opens. From this dialog box, you can:

Edit the protocol name in the Protocol field

Edit and delete models associated with this protocol by clicking Dependents....

Figure 5-3 Protocol Dialog Box

4. Click OK. The new protocol information has been saved.

5-4

AIdirector Version 2.1x Configuration GuideProtocols: Deleting a Protocol

Deleting a ProtocolTo delete a protocol:

1. Select File > Delete > Protocol. The Delete Protocol dialog box opens.

2. Select a protocol to delete and click the Delete button.

Figure 5-4 Delete Protocol Dialog Box

Note: A protocol cannot be deleted if any models in the AIdirector database are using the protocol. You must remove the protocol from all models associated with it before you can delete the protocol. Click the Dependents... button in the Protocol dialog box to see which models are using the protocol.

Figure 5-5 Error - Deleting a Protocol

3. Click Yes. The protocol has been deleted.

5-5

AIdirector Version 2.1x Configuration GuideProtocols: Deleting a Protocol

5-6

6

Models


Models Overview

Adding a Model

Editing a Model

Deleting a Model

6-1

AIdirector Version 2.1x Configuration GuideModels: Models Overview

Models OverviewEach vendor in the database has a list of models associated with it. A model contains information relating to a specific type of device in the database. The database entry for a model indicates its vendor and whether a model can support connectivity by its own IP address. A vendor may manufacture many different models. The database also stores the list of possible protocols that may be available for a model.

Once a model has been added to the database, you have the option to:

Rename a model

Delete a model

Associate a model with a different vendor

Add or delete protocols for a model

6-2

AIdirector Version 2.1x Configuration GuideModels: Adding a Model

Adding a ModelTo add a model:

1. Select File > New > Model. The New Model dialog box opens.

Figure 6-1 New Model Dialog Box

2. In the Model name field, enter a name for the new model. Valid values are up to 50 characters.

3. From the Vendor drop-down list, select the appropriate vendor.

4. The IP capable option is selected by default. If the new model is not IP capable, deselect the IP capable option.

5. On the Protocols tab, click the Add button to add protocols for the new model. The Add Protocol dialog box opens.

Note: More tabs may appear in the New Model dialog box depending on which AIdirector extensions are installed.

6-3

AIdirector Version 2.1x Configuration GuideModels: Adding a Model

Figure 6-2 Add Protocol Dialog Box

6. Select a protocol from the Protocol drop-down list.

7. If you need to use a port number other than the default for this protocol, select the Override default port option and enter a port number.

8. Click OK. The protocol is added for the new model. If necessary, repeat steps 5 through 8 to add more protocols.

Figure 6-3 New Model Dialog Box

9. Click OK. The new model is added.

Note: The AIdirector Administration Guide has information on using the Import utility to add multiple models at one time.

6-4

AIdirector Version 2.1x Configuration GuideModels: Editing a Model

Editing a ModelTo edit a model:

1. Select File > Edit > Model. The Edit Model dialog box opens.

Figure 6-4 Edit Model Dialog Box

2. Select a model to edit and click Edit.

3. The Model dialog box opens. From this dialog box, you can:

Edit the text in the Model name field

Select a different vendor from the Vendor list to associate with this model

Select or deselect the IP capable option

Associate protocols with this model by clicking Add...

Edit a protocol associated with this model by selecting it from the list and clicking Edit...

Delete a protocol associated with this model by selecting it from the list and clicking Delete

6-5

AIdirector Version 2.1x Configuration GuideModels: Editing a Model

Figure 6-5 Model Dialog Box

4. Click OK. The new model information has been saved.

6-6

AIdirector Version 2.1x Configuration GuideModels: Deleting a Model

Deleting a ModelTo delete a model:

1. Select File > Delete > Model. The Delete Model dialog box opens.

Figure 6-6 Delete Model Dialog Box

2. Select a model to delete and click the Delete button.

Note: A model cannot be deleted if any network elements are associated with it in the database. You must delete all network elements associated with a model before you can delete the model. You can search by model in the main window to see which network elements of that model type are in the database. See Searching for Network Elements for more information.

Figure 6-7 Error - Deleting a Model

3. Click Close. The model has been deleted.

6-7

AIdirector Version 2.1x Configuration GuideModels: Deleting a Model

6-8

7

Network Elements


Network Element Overview

Adding a Network Element

Editing a Network Element

Deleting a Network Element

Moving a Network Element to a New Region

Searching for Network Elements

7-1

AIdirector Version 2.1x Configuration GuideNetwork Elements: Network Element Overview

Network Element OverviewA network element must have a model associated with it, but a network element in the database does not have to have an IP address. Network elements that are connected to the network via serial port to an AI device will not have their own IP addresses. Each network element links to its own Network Element dialog box, showing details for that element.

A network element has a name, is associated with a model, and has either IP or serial connectivity.

IP connected network elements have an IP address.

Serial connected network elements have an access network element, which must be in the AIdirector database. Each serial connected network element must be associated with an IP port on its assigned access network element.

Network elements are associated with protocols. The list of protocols for a network element determines which applications will be launched.

On IP connected network elements, listed protocols correspond to TCP ports on the device.

On serial connected network elements, listed protocols are mapped to ports on the access network elements.

7-2

AIdirector Version 2.1x Configuration GuideNetwork Elements: Adding a Network Element

Adding a Network ElementTo add a network element:

1. Select File > New > Element. The New Element dialog box opens.

Figure 7-1 New Element Dialog Box

2. In the Element name field, enter the name for the new element. Valid values are up to 50 characters.

3. From the Model drop-down list, select the appropriate model name.

4. In the Region field, verify that this is the region to which you want to add the network element, or click the Select button to open the Element Region dialog box and select a different region.

7-3


5. From the IP Address field:

6. The Protocols tab is pre-populated with the protocols supported by this network element and the default ports associated with these protocols. If necessary, you can:

Individually add any available protocol by clicking Add

Edit any protocol in the list by selecting that protocol and clicking Edit

Delete any protocol in the list by selecting that protocol and clicking Delete

Add all available protocols by clicking Fill

Note: If the Add and Fill buttons are unavailable (that is, “grayed out”), this means that all protocols available for this network element have been enabled.

If the network element that you are creating...

Then...

Is IP capable Enter the IP address.Note: If you enter an IP address, you now have the option to either use the default port values for the model’s protocols or you can edit/enter the IP port values for a subset of the available protocols for the model.

Is using a serial port Deselect the IP address checkbox.Note: For access, you must edit/enter the protocol for the serial port and select the access network element and port that connects to that interface.

7-4


Figure 7-2 New Element Dialog Box - Protocols Tab

7. (optional) If you would like to record a log entry for this element, click the Log tab, then click Add. The Add Log Entry dialog box opens. Add log text in the text entry field, then click OK to save the log entry and return to the New Element dialog box.

8. (optional) If you would like to record notes for this element, click the Notes tab, then enter note text in the text entry field.

9. On the Element Groups tab, click Add to select one or more element groups to which this network element will belong.

Note: See Element Groups for more information on adding network elements to element groups.

7-5


Figure 7-3 New Element Dialog Box - Element Groups Tab

10. Click OK. The network element has been added.

Figure 7-4 New Element Appears

7-6


Notes: The AIdirector Administration Guide has information on using the Import utility to add multiple network elements at one time.

In addition to the Protocols, Log, Notes and Element Groups tabs, other tabs may appear if you have extensions installed. See the documentation for those extensions for explanations of the data fields on those tabs.

It is impossible for a user to add a network element s/he will not have permission to access. For example, a user with manager permission cannot create a network element that only users with supervisor permission can access.

Figure 7-5 Error Message - Adding a Network Element

7-7

AIdirector Version 2.1x Configuration GuideNetwork Elements: Editing a Network Element

Editing a Network ElementTo edit a network element:

1. From the AIdirector main page, select the network element that you want to edit.

2. Select File > Edit > Element.

Tip: You can choose to enable a shortcut feature that allows you to open the Element dialog box by double-clicking a network element in the main window. To enable this shortcut, choose File > User Preferences, click the AIdirector tab, then select Edit element from the Preferred double-click action drop-down list.

Figure 7-6 Element Dialog Box

7-8

AIdirector Version 2.1x Configuration GuideNetwork Elements: Editing a Network Element

3. The Element dialog box opens. From this dialog box, you can:

Edit the text in the Element name field

Select a different model from the Model list to associate with this element

Move this element to a different region by clicking Select...

Select or deselect the IP capable option

Edit the IP address for this element

Edit or delete serial connected elements that access the network via this element by clicking Dependents...

Add, edit, or delete protocols associated with this element by using the Protocols tab

Add, view, or delete log entries for this element by using the Log tab

Add or edit notes for this element by using the Notes tab

Add this element to an element group or remove this element from an element group by using the Element Groups tab

Note: See section Adding a Network Element for descriptions of the tabs and fields in the Element dialog box.

4. Click OK to save your changes.

7-9

AIdirector Version 2.1x Configuration GuideNetwork Elements: Deleting a Network Element

Deleting a Network ElementTo delete a network element:

1. From the AIdirector main page, select the network element(s) that you want to delete.

2. Select File > Delete > Element. The Confirm Delete dialog box appears prompting you for confirmation of the deletion.

Note: To select more than one network element for deletion, hold down either the SHIFT or CTRL key while selecting multiple network elements.


3. Click Yes. The network element has been deleted.

Note: A network element cannot be deleted if it is being used as an access element for any serial connected elements. The serial elements can be viewed and deleted from the access element’s Dependents dialog box.

7-10

AIdirector Version 2.1x Configuration GuideNetwork Elements: Moving a Network Element to a New Region

Moving a Network Element to a New RegionTo move a network element to a new region:

1. From the AIdirector main page, select the network element(s) that you wish to move.

Note: To select more than one network element, hold down either the SHIFT or CTRL key while selecting multiple network elements.

2. Select File > Move > Element. The Move Elements dialog box opens.

Figure 7-8 Move Elements Dialog Box

3. From the Move Elements dialog box, select the new region.

4. Click OK. The network element has been moved.

OR

1. From the AIdirector main page, select the network element(s) that you wish to move.

2. Select File > Edit > Element. The Element dialog box opens.

7-11

AIdirector Version 2.1x Configuration GuideNetwork Elements: Moving a Network Element to a New Region

3. From the Region field, click Select. The Element Region dialog box opens.

Figure 7-9 Element Region Dialog Box

4. From the Element Region dialog box, select the new region.

5. Click OK. The network element has been moved.

7-12

AIdirector Version 2.1x Configuration GuideNetwork Elements: Searching for Network Elements

Searching for Network ElementsTo search for a network element record:

1. From the AIdirector main page, select the region that you want to search.

2. Enter one or more search criteria in the data fields located in the Element Filter section:

In the Element Name field, enter the name of the network element.

Notes: The Element Name field is not case-sensitive.

Searches can be performed with only a portion of the network element name. For example, you can use the first three letters/numbers of the name, the last three letters/numbers of the name, the middle three letters/numbers of the name or any other sequential combination.

In the IP address field, enter the IP address of the network element.

Note: Searches can be performed with a partial IP address. For example, entering 10.40.67 in the IP address field would return all network elements using IP addresses from 10.40.67.1 to 10.40.67.255.

From the Model drop-down list, select the model of the network element.

3. To include subregions in your search, select the Search subregions checkbox.

Figure 7-10 Searching for a Network Element

4. Click Find. The results of your search appear in the right-hand pane of the AIdirector main window.

7-13

AIdirector Version 2.1x Configuration GuideNetwork Elements: Searching for Network Elements

7-14

8

Applications


Applications Overview

Adding an Application

Editing an Application

Deleting an Application

IP Applications

Serial Applications

Launching an Application for a Network Element

Auto-Detecting Applications

8-1

AIdirector Version 2.1x Configuration GuideApplications: Applications Overview

Applications OverviewAIdirector launches applications to allow the client to access network elements. AIdirector automates application launching; however, connections are made directly between the client PC and the network element. The AIdirector server does not receive data transmissions between the client PC and the network element.

The AIdirector client can auto-detect whether certain known applications are installed on your PC. If any of these applications are detected, they will appear on the AIdirector Application menu so that they will be available for launch.

Figure 8-1 Application Menu

Examples of applications that can be detected by AIdirector include:

Internet Explorer

Firefox

Microsoft Telnet

Microsoft FTP

HyperTerminal

Procomm Plus

MG-SOFT Browser

CAIT

Ericsson OMT

NEC LCT

Note: AIdirector accepts the manual configuration of any application that accepts IP parameters. It also accepts any serial application compatible with AIredirect.

8-2

AIdirector Version 2.1x Configuration GuideApplications: Adding an Application

Adding an ApplicationTo add an application:

1. From the menu bar, choose File > User Preferences. The User Preferences dialog box opens.

Figure 8-2 User Preferences Dialog Box

2. On the Applications tab, click Add. The New Application dialog box opens.

3. In the Application data field, enter the name of the application.

4. From the Protocol drop-down list, select the appropriate protocol.

5. In the Target field, enter the application’s address or use the Browse button to locate the application. Add arguments after the application’s address as necessary.

Note: If %ipaddr% is present in the target field, it will be replaced with the IP address of the network element (or its access element) when the application is invoked. If %tcpport% is present in the field, it will be replaced with the port value for that protocol.

8-3

AIdirector Version 2.1x Configuration GuideApplications: Adding an Application

6. If the application expects a serial port to be present, select the Use AIredirect checkbox. Select an existing profile from the Profile name drop-down list. The profile's COM port is created before the application is launched. Select the Remove COM port option for situations in which the port should be removed.

Note: For most applications, the COM port should be removed when the application exits, but if you encounter errors running the multiple instances of the application simultaneously, try switching this setting to remove the port after it is closed. Some older applications explicitly forbid running multiple copies concurrently regardless of this setting.

Figure 8-3 New Application Dialog Box

7. Click OK. The new application is available for launch.

8. If necessary, assign the new application its proper priority by opening the User Preferences dialog box, selecting the Applications tab, selecting the new application, and clicking the Up Arrow or Down Arrow buttons. See Using the User Preferences Dialog Box for more information.

See also:

Creating AIredirect Profiles on page 2-3

8-4

AIdirector Version 2.1x Configuration GuideApplications: Editing an Application

Editing an ApplicationTo edit an application:


2. On the Applications tab, select the application that you want to edit.


3. Click Edit. The Application dialog box opens.

Figure 8-5 Application Dialog Box

4. Edit the information in the applicable fields.

5. Click OK to save your changes.

8-5

AIdirector Version 2.1x Configuration GuideApplications: Deleting an Application

Deleting an ApplicationTo delete an application:


2. On the Applications tab, select the application that you want to delete.


3. Click Delete. The Delete Application dialog box opens.

Figure 8-7 Delete Application Dialog Box

4. Click OK. The application has been deleted.

8-6

AIdirector Version 2.1x Configuration GuideApplications: IP Applications

IP ApplicationsThe following image depicts how AIdirector launches an IP application (for example, Telnet or a browser). The application communicates through the IP network to an IP-capable device or through an AI mediation device (for example, AIbadger) to a remote serial device.

Figure 8-8 Launching an IP Application

8-7

AIdirector Version 2.1x Configuration GuideApplications: Serial Applications

Serial ApplicationsThe following image depicts how AIdirector launches a serial application. The serial application communicates through AIredirect to the IP network or through a mediation device (for example, AIbadger) to a remote serial device.

Figure 8-9 Launching a Serial Application

Without AIredirect, the serial application would have to be physically connected to the serial device. You cannot connect to a remote serial device without this mediation software.

Figure 8-10 Connecting to a Serial Device

8-8

AIdirector Version 2.1x Configuration GuideApplications: Launching an Application for a Network Element

Launching an Application for a Network ElementTo launch an application:

1. From the AIdirector main page, select the region or subregion where the network element resides.

2. In the main window, select the network element that you want to access.

3. From the Application menu, select the application that you want to use to access the network element.

Note: Different applications can be associated with different models and there may be multiple applications associated with a particular model. If you want to launch an application that is disabled, verify in the Element dialog box that the selected network element supports the application’s protocol.

Tip: You can configure AIdirector to launch an application for a network element when you double-click that network element in the main window. To use this shortcut, choose File > User Preferences, then choose Launch application from the Preferred double click action drop-down list.


8-9

AIdirector Version 2.1x Configuration GuideApplications: Auto-Detecting Applications

Auto-Detecting ApplicationsThe AIdirector client can auto-detect whether certain known applications are installed on your PC. If any of these applications are detected, you will be presented with the option to add them to the AIdirector Application menu so that they will be available for launch.

When AIdirector is launched and no applications are configured, you will be presented with the option to detect applications. You also can auto-detect applications at any time by using the Detect option located in the Application dialog box.

To auto-detect applications:

1. From the menu bar, select File > User Preferences. The User Preferences dialog box opens.


8-10


2. On the Applications tab, click Detect. The Detected Applications dialog box opens, listing the applications AIdirector has detected on your PC.

Figure 8-13 Detected Applications Dialog Box

3. Click OK. The detected applications are available for launch from AIdirector.

8-11


8-12

9

Users and User Groups


User Group Overview

Creating a User Group

Editing a User Group

Deleting a User Group

Creating a User

Editing a User

Deleting a User

Adding a User to a User Group

Removing a User from a User Group

Viewing Group Membership

9-1

AIdirector Version 2.1x Configuration GuideUsers and User Groups: User Group Overview

User Group OverviewPermissions in AIdirector are assigned to user groups. Permissions are never assigned explicitly to individual users. Instead, users are granted permissions implicitly based on their membership in user groups. A user must belong to at least one user group, but may belong to many user groups. In turn, user groups are assigned access to one or more element groups.

Each user group is assigned a permission level, which applies to all users in the user group. The following table describes the four available permission levels.

Table 9-1 User Group Permission Summary

Permission Description

status This permission allows users to view the status of network elements in the element group(s) that have been assigned to this user group.

manager This permission allows users status permission, plus the ability to launch applications, create new network elements, and edit existing network elements within assigned element group(s).

supervisor This permission allows users complete administrative control within assigned element group(s).

administrator This permission allows users complete administrative control across the AIdirector network. There is no accessibility restriction based on assigned element groups.

9-2

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Creating a User Group

Creating a User GroupTo create a user group:

1. From the AIdirector main page, select File > User Management. The User and Group Administration dialog box opens.

Figure 9-1 User and Group Administration Dialog Box

2. On the Groups tab, click New. The New User Group dialog box opens.

Figure 9-2 New User Group Dialog Box (Fields Blank)

9-3


3. In the Group ID field, enter an identifying value for the user group.

Note: The Group ID field usually contains a machine-friendly name, while the Group Name field usually contains a human-friendly name for the same group. For example, a user group might have the group ID laxmgrs and the group name Los Angeles managers.

4. From the Permission level list, select a permission level for this user group.

Note: See Table 9-1 for descriptions of available permission levels.

5. In the Group name field, enter a name for the user group.

6. On the Users tab, click Add. The Add Users dialog box opens.

Figure 9-3 Add Users Dialog Box

7. Select users to add to the new user group, then click OK. The Add Users dialog box closes and the selected users appear on the Users tab in the New User Group dialog box.

8. On the Element Groups tab, click Add. The Add Element Group dialog box opens.

9-4


Figure 9-4 Add Element Group Dialog Box

9. Select element groups to add to the new user group, then click OK. The Add Element Group dialog box closes and the selected element groups appear on the Element Groups tab in the New User Group dialog box.

Note: See section Creating an Element Group for information on creating element groups.

Figure 9-5 New User Group Dialog Box (Fields Populated)

10. Click OK to close the New User Group dialog box. The new user group appears in the list.

11. Click Close to close the User and Group Administration dialog box.

9-5

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Editing a User Group

Editing a User GroupTo edit a user group:


2. On the Groups tab, select a user group, then click Edit. The User Group dialog box opens.

Figure 9-6 User Group Dialog Box

3. (optional) In the Group ID field, enter a new identifying value for this user group.

4. (optional) In the Group Name field, enter a new name for this user group.

5. (optional) From the Permissions list, select a new permissions level for this user group.

Notes: From the Users tab, you can add or remove users from this user group. See sections Adding a User to a User Group and Removing a User from a User Group for more information.

From the Element Groups tab, you can add or remove element groups from this user group. See sections Adding an Element Group to a User Group and Removing an Element Group from a User Group for more information.

6. Click OK to close the User Group dialog box.


9-6

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Deleting a User Group

Deleting a User GroupTo delete a user group:


2. On the Groups tab, select a user group, then click Delete. The Confirm Delete dialog box opens.


3. Click Yes. The user group no longer appears in the list on the Groups tab.


9-7

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Creating a User

Creating a UserTo create a user:


2. On the Users tab, click New. The New User dialog box opens.

Figure 9-8 New User Dialog Box - Fields Blank

3. In the User ID field, enter an identifying value for this user.

Note: The value you enter in the User ID field should correspond to this user’s ID in the user authentication database on the server. See the AIdirector Administration Guide for more information.

4. In the User Name field, enter a name for this user.

5. If you do not want to add this user to a user group at this time, skip to step 7. Otherwise, click Add on the User Groups tab. The Add Groups dialog box opens.

9-8

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Creating a User

Figure 9-9 Add Groups Dialog Box

6. Select a group from the list, then click OK. The user group appears on the User Groups tab in the New User dialog box.

Figure 9-10 New User Dialog Box - Fields Populated

7. Click OK to close the New User dialog box.


9-9

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Editing a User

Editing a UserTo edit a user:


2. On the Users tab, select a user, then click Edit. The User dialog box opens.

Figure 9-11 User Dialog Box

3. (optional) In the User ID field, enter a new identifying value for this user.

4. (optional) In the User Name field, enter a new name for this user.

5. On the User Groups tab, you can add this user to a user group, remove this user from a user group, or edit a user group.

Note: See sections Adding a User to a User Group, Removing a User from a User Group, and Editing a User Group for more information.

6. Click OK to close the User dialog box.


9-10

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Deleting a User

Deleting a UserTo delete a user:


2. On the Users tab, select a user, then click Delete. The Confirm Delete dialog box opens.


3. Click Yes. The user no longer appears in the list on the Users tab.


9-11

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Adding a User to a User Group

Adding a User to a User GroupTo add a user to a user group:



Figure 9-13 User Group Dialog Box

3. On the Users tab, click Add. The Add Users dialog box opens.

Figure 9-14 Add Users Dialog Box

9-12


4. Select a user from the list, then click OK. The user appears on the Users tab in the User Group dialog box.



OR



Figure 9-15 User Dialog Box

9-13


3. On the User Groups tab, click Add. The Add Groups dialog box opens.

Figure 9-16 Add Groups Dialog Box

4. Select a user group from the list, then click OK. The user group appears on the User Groups tab in the User dialog box.



9-14

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Removing a User from a User Group

Removing a User from a User GroupTo remove a user from a user group:


Figure 9-17 User and Group Administration Dialog Box (Groups Tab)


Figure 9-18 User Group Dialog Box (Users Tab)

9-15


3. On the Users tab, select a user from the list, then click Remove. The user no longer appears in the list.



OR


Figure 9-19 User and Group Administration Dialog Box (Users Tab)


Figure 9-20 User Dialog Box (User Groups Tab)

9-16


3. On the User Groups tab, select a user group from the list, then click Remove. The user group no longer appears in the list.



9-17

AIdirector Version 2.1x Configuration GuideUsers and User Groups: Viewing Group Membership

Viewing Group MembershipYou can quickly see which user groups you belong to by clicking View > User Group Membership....

Figure 9-21 Selecting View > User Group Membership

The User Group Membership dialog box opens. This dialog box lists the group ID, group name, and permission level of each user group to which you belong. To remove yourself from a user group, deselect its checkbox in the Include? column, then click OK.

Figure 9-22 User Group Membership Dialog Box

9-18

10

Element Groups


Element Group Overview

Creating an Element Group

Editing an Element Group

Deleting an Element Group

Adding Network Elements to an Element Group

Removing Network Elements from an Element Group

Adding an Element Group to a User Group

Removing an Element Group from a User Group

10-1

AIdirector Version 2.1x Configuration GuideElement Groups: Element Group Overview

Element Group OverviewAIdirector administrators group network elements together in order to manage user access. User groups are never granted access directly to individual network elements. Instead, user groups are granted access to element groups, which contain individual network elements.

There are two types of element groups: fixed element groups and dynamic element groups. The difference lies in the way individual elements are added to the element group.

Fixed Element GroupsA fixed element group contains a finite number of network elements. Each network element is added manually by the AIdirector administrator, or by a user that belongs to a user group with supervisor or higher permissions. A fixed element group can grow only if network elements are added manually to the element group, and can shrink only if network elements are manually removed from the group or deleted from the AIdirector database.

Dynamic Element GroupsA dynamic element group contains a variable number of network elements. An AIdirector administrator (or user that belongs to a user group with supervisor permissions) defines a dynamic element group by specifying a set of search criteria. For example, a dynamic element group might contain all network elements with names containing NYC, or all network elements with IP addresses containing 10.40.

Any new network element whose properties meet the search criteria is automatically added to the dynamic element group. If a network element’s properties no longer meet the search criteria (for example, a new element name or IP address is assigned to the element, or the element is moved to a new region), it is automatically removed from the dynamic element group.

10-2

AIdirector Version 2.1x Configuration GuideElement Groups: Creating an Element Group

Creating an Element Group

Creating a Dynamic Element GroupTo create a dynamic element group:

1. From the AIdirector main page, select File > New > Element Group > Dynamic Element Group. The New Dynamic Element Group dialog box opens.

Figure 10-1 New Dynamic Element Group Dialog Box

2. In the Group name field, enter a name for the new element group. Valid values are up to 50 characters.

3. (optional) On the Filter tab, establish Basic Filter Options. These are search criteria to determine which network elements will belong to this dynamic element group:

In the Element name field, enter a full or partial network element name.

In the IP address field, enter a full or partial IP address.

Select a model from the Model list.

10-3


Note: If you do not want to filter for a particular search criterion, leave that field blank.

4. (optional) On the Filter tab, establish Region Options:

The dynamic element group will include network elements from the region shown in the Region: field. If you want to select a different region, click Select, then choose a region from the Dynamic Element Group Region dialog box and click OK. The Dynamic Element Group Region dialog box closes and the new region appears in the Region: field.

If you want the dynamic element group to include network elements from subregions under the selected region, select the Search subregions option.

5. (optional) On the Filter tab, establish Attribute Options:

On the Region Attributes tab, click Add. An Add Attribute dialog box opens, containing a list of available attributes.

Figure 10-2 First Add Attribute Dialog Box

Click an attribute, then click OK. A second Add Attribute dialog box opens. Enter a value for the attribute you have chosen, then click OK.

Figure 10-3 Second Add Attribute Dialog Box

The attribute and value you have chosen appear in the list.

10-4


If you have extensions installed that support element attributes, you can filter for element attributes by clicking Add on the Element Attributes tab. An Add Attribute dialog box opens, containing a list of available attributes. Click an attribute, then click OK. A second Add Attribute dialog box opens. Enter a value for the attribute you have chosen, then click OK. The attribute and value you have chosen appear in the list.

Figure 10-4 New Dynamic Element Group Dialog Box (Filter Tab)

6. (optional) If you want to apply the Filter tab options you have chosen to the Element Filter in the main AIdirector window, click Apply As Filter.

10-5


7. On the User Groups tab, choose user groups that will have access to the dynamic element group:

Click Add. The Add User Groups dialog box opens.

Select a user group from the list, then click OK. The Add User Groups dialog box closes and the user group appears in the User Groups tab.

Figure 10-5 New Dynamic Element Group Dialog Box (User Groups Tab)

8. Click OK. The dynamic element group has been created.

Creating a Dynamic Element Group from a FilterTo create a dynamic element group from a filter:

1. From the AIdirector main page, select File > New > Element Group > Dynamic Element Group From Filter. The New Dynamic Element Group dialog box opens.

2. On the Filter tab, the Basic Filter Options, Region Options, and Attribute Options fields are populated with values from the Element Filter fields in the main AIdirector window. Otherwise, the procedure is identical to Creating a Dynamic Element Group.

Creating a Fixed Element GroupTo create a fixed element group:

1. Select one or more network elements in the AIdirector main window.

10-6


2. Right-click the selected elements and choose Element Group > Save as fixed element group.

Figure 10-6 Element Group Context Menu

3. The New Fixed Element Group dialog box opens. In the Group name field, enter the name for the new element group. Valid values are up to 50 characters.

4. On the Elements tab, verify that the selected elements appear.

Tip: If you select an element and click Edit, the Element dialog box opens allowing you to edit properties for this element.

10-7


Figure 10-7 New Fixed Element Group Dialog Box (Elements Tab)

5. On the User Groups tab, choose user groups that will have access to the fixed element group:



Figure 10-8 Add User Groups Dialog Box

10-8


6. Click OK. The fixed element group has been created.

OR

1. From the AIdirector main page, select File > New > Element Group > Fixed Element Group. The New Fixed Element Group dialog box opens.

2. In the Group name field, enter a name for the new element group. Valid values are up to 50 characters.

3. Select network elements that will belong to this fixed element group by dragging them from the main AIdirector window to the Elements tab.

4. On the User Groups tab, choose user groups that will have access to the fixed element group:



Figure 10-9 New Fixed Element Group Dialog Box (User Groups Tab)

5. Click OK. The fixed element group has been created.

10-9

AIdirector Version 2.1x Configuration GuideElement Groups: Editing an Element Group

Editing an Element Group

Editing a Fixed Element GroupTo edit a fixed element group:

1. From the AIdirector main page, select File > Edit > Element Group. The Edit Element Group dialog box opens.

Figure 10-10 Edit Element Group Dialog Box

2. Select an element group from the list, then click Edit. The Fixed Element Group dialog box opens.

3. (optional) In the Group Name field, enter a new name for the element group.

10-10


4. (optional) On the Elements tab, you can:

Add network elements by dragging them from the main AIdirector window to the Elements tab

Edit a network element by selecting it from the list, then clicking Edit

Remove a network element from the fixed element group by selecting it from the list, then clicking Remove

Figure 10-11 Fixed Element Group Dialog Box (Elements Tab)

10-11


5. (optional) On the User Groups tab, you can:

Add a user group by clicking Add, then selecting a user group from the Add User Groups dialog box

Edit a user group by selecting it from the list, then clicking Edit

Remove a user group from the fixed element group by selecting it from the list, then clicking Remove

Figure 10-12 Fixed Element Group Dialog Box (User Groups Tab)

6. Click OK to close the Fixed Element Group dialog box.

7. Click Close to close the Edit Element Group dialog box.

Editing a Dynamic Element GroupTo edit a dynamic element group:


2. Select an element group from the list, then click Edit. The Dynamic Element Group dialog box opens.

3. (optional) In the Group Name field, enter a new name for the element group.

10-12


4. (optional) On the Filter tab, you can:

Adjust Basic Filter Options by altering the Element name, IP address, and Model values

Adjust Region Options by clicking Select and choosing a different region from the Dynamic Element Group Region dialog box, or by selecting or deselecting the Search subregions option

Adjust Attribute Options by using the Add, Edit and Delete buttons on the Region Elements and Element Attributes tabs

Apply the values on the Filter tab to the Element Filter in the main AIdirector window by clicking Apply As Filter

Figure 10-13 Dynamic Element Group Dialog Box (Filter Tab)

10-13


5. (optional) On the User Groups tab, you can:

Add a user group by clicking Add, then selecting a user group from the Add User Groups dialog box

Edit a user group by selecting it from the list, then clicking Edit

Remove a user group from the dynamic element group by selecting it from the list, then clicking Remove

Figure 10-14 Dynamic Element Group Dialog Box (User Groups Tab)

6. Click OK to close the Dynamic Element Group dialog box.


10-14

AIdirector Version 2.1x Configuration GuideElement Groups: Deleting an Element Group

Deleting an Element GroupTo delete an element group:

1. From the AIdirector main page, select File > Delete > Element Group. The Delete Element Group dialog box opens.

Figure 10-15 Delete Element Group Dialog Box

2. Select an element group from the list, then click Delete. The element group no longer appears in the list.

3. Click Close to close the Delete Element Group dialog box.

10-15

AIdirector Version 2.1x Configuration GuideElement Groups: Adding Network Elements to an Element Group

Adding Network Elements to an Element Group

Adding Network Elements to a Dynamic Element GroupNetwork elements cannot be added manually to a dynamic element group. If you want to change the members of a dynamic element group, you must change Basic Filter Options or Region Options as described in the section Editing a Dynamic Element Group.

Adding Network Elements to a Fixed Element GroupTo add a network element to a fixed element group:

1. In the main AIdirector window, select a network element, then select File > Edit > Element. The Element dialog box opens.

Figure 10-16 Element Dialog Box (Element Groups Tab)

10-16

AIdirector Version 2.1x Configuration GuideElement Groups: Adding Network Elements to an Element Group

2. On the Element Groups tab, click Add. The Add Fixed Element Groups dialog box opens.

Figure 10-17 Add Fixed Element Groups Dialog Box

3. Select an element group from the list, then click OK. The Add Fixed Element Groups dialog box closes and the element group appears in the list on the Element Groups tab.

4. Click OK to close the Element dialog box.

OR

1. In the main AIdirector window, right-click a network element, then select Element Group > Add to fixed element group from the context menu. The Add to Fixed Element Group dialog box opens.

Figure 10-18 Add to Fixed Element Group Dialog Box

2. Select an element group from the Fixed element group list.

3. Click OK to close the Add to Fixed Element Group dialog box.

10-17

AIdirector Version 2.1x Configuration GuideElement Groups: Removing Network Elements from an Element Group

Removing Network Elements from an Element Group

Removing Network Elements from a Dynamic Element GroupNetwork elements cannot be removed manually from a dynamic element group. If you want to change the members of a dynamic element group, you must change Basic Filter Options or Region Options as described in the section Editing a Dynamic Element Group.

Removing Network Elements from a Fixed Element GroupTo remove a network element from a fixed element group:

1. In the main AIdirector window, select File > Edit > Element Group. The Edit Element Group dialog box opens.

Figure 10-19 Edit Element Group Dialog Box

2. Select an element group, then click Edit. The Fixed Element Group dialog box opens.

10-18


Figure 10-20 Fixed Element Group Dialog Box (Elements Tab)

3. On the Elements tab, select an element, then click Remove. The element no longer appears in the list.

4. Click OK to close the Fixed Element Group dialog box.


10-19


OR

1. In the main AIdirector window, select a network element, then select File > Edit > Element. The Element dialog box opens.

Figure 10-21 Element Dialog Box (Element Groups Tab)

2. On the Element Groups tab, select an element group, then click Remove. The Confirm Delete dialog box opens.


3. Click Yes to close the Confirm Delete dialog box. The element group no longer appears in the list on the Element Groups tab.

4. Click OK to close the Element dialog box.

10-20

AIdirector Version 2.1x Configuration GuideElement Groups: Adding an Element Group to a User Group

Adding an Element Group to a User GroupTo add an element group to a user group:


2. Select an element group from the list, then click Edit. The Element Group dialog box opens.

Figure 10-23 Element Group Dialog Box (User Groups Tab)

10-21


3. On the User Groups tab, click Add. The Add User Groups dialog box opens.

Figure 10-24 Add User Groups Dialog Box

4. Select a user group from the list, then click OK. The user group appears on the list in the Element Group dialog box.

5. Click OK to close the Element Group dialog box.


10-22


OR


Figure 10-25 User and Group Administration Dialog Box (Groups Tab)


Figure 10-26 User Group Dialog Box (Element Groups Tab)

10-23


3. On the Element Groups tab, click Add. The Add Element Group dialog box opens.

Figure 10-27 Add Element Group Dialog Box

4. Select an element group from the list, then click OK. The element group appears on the list in the User Group dialog box.



10-24

AIdirector Version 2.1x Configuration GuideElement Groups: Removing an Element Group from a User Group

Removing an Element Group from a User GroupTo remove an element group from a user group:


2. Select an element group from the list, then click Edit. The Element Group dialog box opens.

Figure 10-28 Element Group Dialog Box (User Groups Tab)

3. On the User Groups tab, select a user group from the list, then click Remove. The user group no longer appears in the list.

4. Click OK to close the Element Group dialog box.


OR


10-25

AIdirector Version 2.1x Configuration GuideElement Groups: Removing an Element Group from a User Group


Figure 10-29 User Group Dialog Box (Element Groups Tab)

3. On the Element Groups tab, select an element group, then click Remove. The element group no longer appears in the list.



10-26

11

Using Reports


Reports Overview

Viewing and Saving Reports

11-1

AIdirector Version 2.1x Configuration GuideUsing Reports: Reports Overview

Reports OverviewTracking the relationships among users, user groups, network elements, and element groups can be challenging. To simplify this task, AIdirector includes six reports to track group relationships:

User to User Group

User Group to User

User Group to Element Group

Element Group to User Group

Element Group to Element

Element to Element Group

User to User Group ReportThis report is useful if you want to see which user group(s) a given user belongs to.

Figure 11-1 User to User Group Report

11-2


User Group to User ReportThis report is helpful if you want to see which users have membership in a given user group.

Figure 11-2 User Group to User Report

User Group to Element Group ReportThis report is helpful if you want to see which element groups a given user group has access to.

Figure 11-3 User Group to Element Group Report

11-3


Element Group to User Group ReportThis report is helpful if you want to see which user groups have access to a given element group.

Figure 11-4 Element Group to User Group Report

Element Group to Element ReportThis report is helpful if you want to see which network elements are members of a given element group.

Figure 11-5 Element Group to Element Report

11-4


Element to Element Group ReportThis report is helpful if you want to see which element groups a given network element belongs to.

Figure 11-6 Element to Element Group Report

11-5

AIdirector Version 2.1x Configuration GuideUsing Reports: Viewing and Saving Reports

Viewing and Saving ReportsTo view a report:

1. Click View > Reports, then choose a report from the Reports submenu.

Figure 11-7 View > Reports submenu

The selected report opens.

Figure 11-8 User Group to Element Group Report

11-6


2. (optional) To save this report as an .html file, click File > Save.

3. (optional) To find text within a report, click Edit > Find. The Input dialog box opens. Enter search terms in the Find field, then click OK.

Figure 11-9 Searching Within a Report

11-7


11-8

Copyrights and License

StatementsCopyright © 1983-2008 by Kentrox, Inc.The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication.

This product includes software copyrighted by the GNU General Public License and/or the GNU Lesser General Public License. The source for the GPL portions of the software is available by sending an email request to [email protected].

TRADEMARKS:Applied Innovation, Applied Innovation Inc., the AI logo, and other names are intellectual property of Applied Innovation Inc.

AIdirectorCopyright © 1999_2008 Applied Innovation Inc.Copyright © 2004 nexB Inc.Copyright © 2003_2005 Greg Luck

OpenNMSOpenNMS(R) is Copyright (C) 2002-2008 The OpenNMS Group, Inc.OpenNMS(R) is a registered trademark of the OpenNMS Group, Inc.Copyright (C) 1999-2001 Oculan Corp.Copyright (C) 2008 Applied Innovation Inc.OpenNMS is released under the terms of the GNU General PublicLicense as published by the Free Software Foundation;For more information contact:OpenNMS Licensing - [email protected]://www.opennms.org/http://www.opennms.com/

Copyrights-1

Copyrights and License Statements

Copyrights-2

Documents

AIdirector Version 2.1x Configuration Guide - Westell, Incsupport.westell.com/.../Director-v2-1x-Configuration-Guide-(1).pdf · Configuration Guide Version 2.1x ... Commands This