Skip Headers
Oracle® Communications IP Service Activator User's Guide
Release 7.2

E35290-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

2 The IP Service Activator Client

This chapter introduces elements of Oracle Communications IP Service Activator client and describes how to navigate the system and customize the interface. It covers the following areas:

Introduction

The client provides a representation of the service that is managed by IP Service Activator. The client acts as a front end to the policy server, the core component of IP Service Activator.Working within the client, you can discover the devices to be managed, map the topology of the network and construct the policy to be applied. The information you enter in the client is saved to a database via the policy server.IP Service Activator models the network and the policy you apply to it using an object model, where every element is an object with its own properties and capabilities. Every object type has an icon associated with it. Where the state of an object may change, color is used to represent the state of the object. See "Status Context View" for more information.The system provides a policy view for objects that can have a policy applied to them, where object icons are displayed in shades of gray that reflect their policy role.You can have several windows onto the system open simultaneously, with each one offering the same or a different view of the system. These windows are known as domain management windows.Each window is divided into several panes. Each pane displays a different type of information. You can choose whether to hide or show selected panes.There may be several client components running at any one time, with each user entering new configuration details. As a user makes changes in the client, the changes are queued locally, and are not reflected in remote clients. When a user commits a transaction, the policy server co-ordinates the information between clients, ensuring that all users' views of the system are consistent.

Running IP Service Activator for the First Time

When you run IP Service Activator for the first time after installation, there are no domains defined and only default system information is displayed on the System tab.

The first time the client opens, the system prompts you to change the administrator password, which has a default value of admin. Changing the password is a mandatory step.

The main IP Service Activator screen is referred to as the Global Setup window and is always displayed when you run IP Service Activator. See "The Global Setup Window" for more information.

User Access Levels and the Client

The appearance of the client is affected by your security level. You may be able to see all or only parts of the system. For example, you may be unable to see the System tab or some menu items. Similarly you may be able to see some objects, but unable to modify their values. For example, you may be able to see a list of user-defined roles but unable to modify them or add new roles to the list.

This guide, and the online Help system, assume you can view and modify all parts of the system. This access level is available to users with Super User access. If you have a lower access level you may be unable to access some parts of IP Service Activator described in this guide.

Note that the Policy tab is not displayed to the user and options for creating rules and PHB groups are missing from the device's context menu. The user is therefore unable to view or create policies.

Note also that you cannot see faults associated with object types to which you do not have access. In this example, the warnings that relate to a PHB group with no roles associated with it cannot be seen in the second illustration.

IP Service Activator Windows

Within the IP Service Activator client you can open multiple windows and arrange them as needed to support whatever you are currently working on. For example, you can display windows side by side to compare information between two domains, or drag and drop objects between windows on the same or different domains.

Information is displayed in the following window types:

  • Domain management windows display information about a particular policy domain. This window type is your workspace area for managing the domain.

  • The Global Setup window displays global information and allows you to create and manage multiple domains.

The information that is displayed in each window type and the actions you can perform depend on your access level. For example, in the Global Setup window you may be able to view existing domains but unable to create new domains. See "User Access Levels and the Client" for more information.To open a new domain management window:

  1. In a domain management window, either:

    • From the Window menu, select New Window.

      A new domain management window opens. The window's Hierarchy pane shows the complete object model for the domain.

    or:

    • With an object selected in the Hierarchy pane, from the View menu, select Open.

      A new domain management window opens. The window's Hierarchy pane shows only those objects that exist below the object you selected in the Hierarchy pane.

You can also create a new window by double-clicking on a domain on the Domains tab in a Global Setup window.

The Domain Management Windows

Domain management windows provide a workspace for configuring a policy domain. You work in a domain management window to:

  • Discover the network you intend to manage

  • Create and view topology maps of the network

  • Set up the policies and services you want to implement

  • Create transactions and send configuration details to the devices you are managing

If you are using the Network Processor, you must have all the devices present in the client in order to create capabilities, options, and the MIPSA registry. For information about using the Network Processor, see IP Service Activator Cisco IOS Cartridge Guide.

The following shows a domain management window with the topology map displayed:

When you run IP Service Activator for the first time, there are no domains created and you cannot display a domain management window. See "Setting Up Domains" for information about creating a domain.

Panes in the Domain Management Window

The domain management window is divided into sections.

See "Hiding and Showing Windows and Window Elements" for information about hiding and showing panes in the domain management window.

Hierarchy Pane and Tabs

The Hierarchy pane displays the IP Service Activator object model as a hierarchical tree structure, showing the major container (parent/child) relationships between the objects. Associated objects are arranged into tabbed groups. You can access all of the objects within the domain by selecting tabs and browsing through the hierarchy.

Branches of the tree can be expanded or collapsed by clicking the ’+' or ’-' symbols in the tree.

By default, the hierarchy tree appears at the top left of each explorer window, but it can be moved, deleted, or resized using the normal window controls.

Tabs allow you to view different groupings of data. By default, the tabs appear at the left of the Hierarchy pane. You can change their position by clicking in the title bar of the hierarchy tree.

See "Tabs in the Domain Management Window" for more information about the hierarchy tree tabs. See "How IP Service Activator Models the System" for information about the IP Service Activator object model.

Details Pane

The Details pane displays information about the object that you have selected in the Hierarchy pane, and the network topology around that object. Three types of views are available:

  • Report view displays the contents in the form of a list of objects, together with additional columns of attributes

  • Compact List view displays the contents as a list of objects

  • Map view displays the network topology in graphical form. You can only select the map view when a network or VPN object is selected

Information is displayed in a map, list or report view, depending on the selected object's type. You can double-click on an object in the details pane to drill down to a lower level. If there are no child objects, the Properties dialog box for the selected object is displayed.For example:

  • If you have selected a network object, its details can be viewed as a topology map, a list of the devices within that network or a report list showing details of each device's state, role, IP address, and so on.

  • If you have selected a VPN object, the sites within the VPN can be viewed in map, list, or report form.

  • If you have selected a device, the interfaces available on the device can be displayed in list or report form.

You can also display information about the configuration that applies to an object in the Details pane or the content of any of the system's log files. For more information, see IP Service Activator QoS User's Guide and IP Service Activator VPN User's Guide. For information about IP Service Activator log files, see IP Service Activator System Administrator's Guide.

See "Printing" for information about printing the content of the Details pane.

Ancestry Pane

The Ancestry pane displays the object model as a reverse tree, with the object that you have currently selected in the Hierarchy pane shown at the top level and its parent objects beneath it. This reverse hierarchy is useful for tracing all the links between an object and its parent objects. Note that where links are created, an object can have several parents.

The ancestry tree is not a navigation tool, that is, selecting items in the tree does not affect the information that is displayed in the Details pane. See "How IP Service Activator Models the System" for more information about the object model.

Current Faults Pane

The Current Faults pane displays information, warning, and error messages reported by the system, as shown in Figure 2-1. Most messages result from network discovery or data validation.

Figure 2-1 The Current Faults Pane

Description of Figure 2-1 follows
Description of "Figure 2-1 The Current Faults Pane"

The severity, code number, date and time of occurrence, and error description appear. Each message type is color-coded for reference.

In most cases, after a fault is fixed, its corresponding message is automatically removed. If the fault is not automatically removed, you must delete the fault manually, which triggers IP Service Activator to push the data from the Policy Server to the corresponding driver.

To display more information about a particular message, select it and press F1 or choose Help from the context menu.

By default the pane appears at the bottom of the main window, but you can detach it and move it to a different position on your desktop. Click the frame surrounding the window and drag it to a new position.

When you restart the IP Service Activator client, it opens in the domain view.

Current Faults Message Content

Messages in the Current Faults pane are categorized according to their degree of criticality. Table 2-1 describes fault categories and what those faults mean.

Table 2-1 Current Faults Message Content

Category Fault Type

Messages on a red background

Indicate critical faults requiring intervention, such as failure of an IP Service Activator system component or a serious problem with a device.

Messages on an orange background

Indicate errors, i.e. serious faults in the policy system, but not in a system component.

Messages on a yellow background

Indicate warnings, such as validation errors.

Messages on a blue background

Indicate notices. Some user action is required.

Messages on a cyan background

Indicate information only; no user action required.


For each message, the following information appears:

  • Name: Name of the object in which the fault occurred. Note that the icon of the object also appears.

  • Severity: Critical, Error, Warning, Notice, or Information, as described in Table 2-1.

  • Code: Code number of the message. Numbers prefixed with 100 indicate those generated from Service Activator components. Any other prefixes indicates a message originating from a component not supplied by Service Activator, for example, device drivers produced by a third party. For more information about these messages, please contact your software supplier.

  • Date & Time: Date and time that the error occurred.

  • Description: Text of the message.

For a list of messages that can occur, and suggestions about how to fix the underlying problem, see IP Service Activator online Help.

To display information about a particular message, select the message in the Current Faults pane and press F1 or choose Help from the context menu.

By default the Current Faults pane appears at the bottom of the main window. However, it is dockable at the top, bottom, left, or right of the main application window. Click the frame surrounding the window and drag it to the new position. Alternatively, if you drag it outside the main application window, it becomes a separate, floating window.

A fault message appears in the Current Faults pane only while the fault exists; after it is fixed the message is deleted. However all reported faults except validation messages appear in the System Messages report.

You can choose whether or not to display the Current Faults pane. Choose Current Faults Pane from the View menu.

You can double-click a message, or choose Properties from the context menu, to display the property pages for the object on which the fault is reported.

Each fault represents an object and you can drag and drop it in the same way as the object itself. For example, you can link objects by dragging them to an appropriate place on the object model, and if you drag a fault on to the map, the object to which it is related will appear on the map.

Choose Delete from the context menu to manually clear the fault. Note that if the problem is not fixed, the fault will re-occur.

Statistics Summary Pane

The Statistics Summary pane summarizes status information for PHB groups, policy rules, CCCs, VPNs, Layer 2 Martini VPNs, and driver scripts. The System Statistics pane can be docked to the top or bottom of the window.Object statuses include:

  • Inactive: the object is created but has not been propagated to the proxy agents

  • Disabled: the object is disabled

  • Active: the object is propagated to the proxy agents

  • Conflict: the object conflicts with an existing object or has failed validation

  • Rejected: one or more of the objects failed to install

  • Mismatched: the object is missing an installed command from its current configuration

  • Installed: an object that is installed on the designated device

  • Script Failed: the proxy agent experienced a failure trying to install the driver script and it has therefore been discarded (driver scripts only)

  • Totals: the number of objects in each state

Status Bar

The Status Bar displays information about the state of IP Service Activator when you discover devices, propagate configuration data, or retrieve device capabilities, as shown in Figure 2-2.

Figure 2-2 Status Bar

the Status Bar

Palette

The Palette, as shown in Figure 2-3, appears when a network map is displayed in Service Activator. In context-sensitive mode, it displays objects relevant to the current selection. For example, if a device is selected, the Palette lists the device's interfaces. If context-sensitivity is turned off, the Palette displays all objects that are not currently displayed on the map. You can display objects on the network map by dragging them from the Palette into the map area, and remove objects from the display by dragging them from the map onto the Palette.

Figure 2-3 The Palette

The Palette

See "Recalculating a Map Layout" for more information about maps.

Tabs in the Domain Management Window

Within the Domain management window, sets of related objects are grouped and displayed on separate tabs. The tabs are part of the Hierarchy pane. If the Hierarchy pane is not displayed, the tabs are not visible. On each tab, objects are grouped into folders and, in the case of the Topology tab, networks.

You can change the position of the Hierarchy pane's tabs. See "Changing the Hierarchy Pane's Tab Position and Style" for more information.

Objects are grouped under the following tabs:

  • Topology: network elements, including networks, devices, and interfaces. Work on this tab to discover the network, view and create maps of the network to be managed and assign services and policies to the network elements.

  • Policy: Class of Service (CoS) and policy building blocks. Work on this tab to create roles, define the levels of service that can be applied to traffic and set up standard and MQC PHB groups, and to define elements such as IP protocols and traffic types. For information about the elements that you can define, see IP Service Activator QoS User's Guide.

    Note:

    You can create some basic rule component data by loading policy configuration files. See "Loading Policy Configuration Data" for more information.
  • Service: information relating to VPN services. Work on this tab to create and maintain customers, VPNs and sites, TLSs and layer 2 sites, VRF-lite sites, and point-to-point connections.

  • Accounts: group, subnet, host and user accounts. Work on this tab to create the accounts that act as source or destination points to which rules can be applied.

  • System: details of the current global parameters and system components. Work on this tab to view information about IP Service Activator system components and their host machines, add and edit user details, access the system's log files, view information about pending, scheduled and committed transactions, define external systems and create SAA templates.

    The System tab includes the following folders:

    • Event Subscriptions

    • External Systems

    • SAA Templates

    • System Hosts - shows the physical relationship between the system components - each of the hosts and the components that have been installed on them. All the host systems on which components are running are listed. These are located and defined by the system and should not be modified.

      Each system host object contains the objects which represent the components that are running on that particular system such as policy server, proxy agent, or system logger.

    • System Logs - lists the logs maintained by the system such as Audit Trail, Device Configuration Log, Event Log and System Messages Log.

    • System User Groups - includes all the users that have been set up in the system. When the system is first installed, one default Super User is created. Additional users should be set up and granted suitable access rights by the system administrator.

    • Transactions

    • SNMP Profiles

    • Policy Server - this object shows the logical relationship between the system components and devices, i.e. the hierarchy of proxy agents, device drivers and the actual devices they control. The policy server object lists the proxy agents that it controls.

  • Custom: driver scripts that currently exist in IP Service Activator. Work on this tab to import, run and create driver scripts.

The Global Setup Window

The Global Setup window lists the policy domains that are managed by the system and displays general information about each one. The window has three tabs:

  • Domains: lists the domains that have been created and displays summary information for each one.

  • System: this tab is identical to that displayed in the domain management window.

  • Custom: The custom tab lists the driver scripts that currently exist in the system. Work on this tab to create or import new driver scripts or to view details of existing scripts. The tab includes the Driver scripts folder which holds all driver scripts existing in the system. The custom tab is identical to that displayed in the domain management window.

How IP Service Activator Models the System

IP Service Activator regards anything that it can manipulate as an object. An object may be a representation of a physical element, such as a device or an interface, or a logical element, such as an account or a rule. Information about the objects that exist in the system is held in the database.

Every object has a set of attributes associated with it that define, at the minimum, the name of the object or more complex characteristics, such as detailed information about queuing mechanisms. The number and type of attributes vary between different types of object. For example, a device object has attributes that include its name and IP address, its role, and the interfaces available on the device. A packet marking object, by contrast, has only two attributes associated with it that define its name and the marking associated with it. The combined attributes of an object are referred to as object properties. You can edit an object's properties in its dialog box. To open the properties dialog box for an object, right click on the object and select Properties.

Information about objects, the relationships that can exist between them and the actions you can perform on them, together make up the object model. The IP Service Activator object model represents three main areas:

  • The underlying network topology

  • The policies and services applied to the network

  • The IP Service Activator system configuration itself

You can view the objects that are currently defined in the system in the domain management window. You can also view information about system and domain-related objects in the Global Setup window. See "Tabs in the Domain Management Window" for more information.

You can view information about the relationships that exist between the objects in IP Service Activator using the Hierarchy and Ancestry panes:

  • The Hierarchy pane shows an object's relationship to objects that exist at a lower level in the object model. You can use the hierarchy tree to drill down through the hierarchy.

  • The Ancestry pane shows how an object is related to objects that exist at a higher level in the object model.

You can view the properties that are associated with an object by selecting Properties from the object's context menu or from the View menu. See "Viewing and Editing Object Properties" for more information.

Modeling the Network, Services, and Policies

As you work in the client, you model the network and the policies or services to be applied to it by:

  • Creating objects such as VPNs, classes of service, and sites.

  • Defining each object's properties or attributes, such as the connectivity type of a VPN or the name of a site.

  • Creating relationships between objects. Objects exist within a hierarchy of parent/child relationships, with the policy, system, or domain objects existing at the highest level. Every new object created is a child of an existing object. You can also make parent/child relationships between some objects by linking them. See "Linking Objects" for more information about linking objects.

IP Service Activator maintains a central version of the object model called the common object model, which is updated when you commit or save a transaction from a remote client. For more information, see IP Service Activator Concepts.

Inheritance Between Objects

There is a hierarchy of inheritance between objects, where objects at a lower level in the hierarchy inherit parameters that are applied to objects at a higher level.

Note that devices and interfaces must be tagged with the appropriate roles for policy or parameters to be inherited. The IP Service Activator inheritance model is described in IP Service Activator QoS User's Guide.

Working with Objects

You do many of the tasks that are associated with objects using object context menus. The options on each object's menu depend on the object type.

Note:

Folders also have context menus associated with them and some object types are created from these menus. See "Creating New Objects" for more information.

To view an object's context menu:

  1. Select the object and right-click.

You can not edit information directly within the explorer windows. Each object has a Properties dialog box, which allows you to view details and modify them where necessary. Most Properties dialog boxes contain multiple property pages, selectable from the tree display on the left side of the dialog box. Each property page contains controls for various types of attributes for the object.

The Properties dialog box also appears when you double-click any object in the Details or Hierarchy pane that has no child objects.

Properties dialog boxes are modeless windows; you can leave them open while you select other objects from the client. As different objects are selected, the Properties dialog box changes to display the details of the newly selected object. Note that if you make any edits, the window becomes modal, which means you must apply the changes (or cancel them) before you can select another object.

You can modify the properties of multiple classification rules, policing rules, and access rules. For other multiple selections, properties cannot be displayed.

Selecting Objects

Select an object by clicking it. The icon of a selected object appears shaded.

The Details pane only displays object details if you double-click an object.

You can also select multiple objects by:

  • Selecting objects one by one by pressing Control and clicking each object.

  • Where objects are listed in the Details pane and the Palette, you can select a range of objects by pressing Shift and clicking the first and last items in the range.

Note that you can use the multi-select technique to:

  • Create a new map or network view that includes the selected network objects. See "Creating Subsidiary Networks and Maps" for more information.

  • Select a number of network objects (devices, sites, segments, and so on) and include them in a subsidiary network.

  • Set the properties for a number of classification, policing, or access rules. For more information, see IP Service Activator QoS User's Guide.

  • Edit the common properties of a number of classification rules, policing rules, and access rules.

  • Copy and paste multiple rules.

  • Delete multiple objects.

Creating New Objects

You create new objects (where it is permitted) through an existing object's context menu or the context menu associated with a folder.

An object's context menu provides options to create new objects of a type that the object model allows for that object.

In addition, you can generally add new objects from a folder's context menu. For example, you can add new device types using the Device Type folder's context menu. The exceptions to this rule are the Devices and Segments folders on the Topology tab and the System Hosts folder on the System tab.

Any new object is linked as a child of the object from which it was created. It may also be automatically linked to other objects. For example, if you create a new user in a user group, the user is a child of the user group object and also the system object.

You can view an object's parentage in the Ancestry pane.

To set up the objects representing your network topology (devices, segments, interfaces, and so on), use the device discovery process, which discovers details of the network, represents it graphically, and updates the object model.

To create an object:

  1. Select the relevant folder or object in the Hierarchy, Ancestry, or Details pane and select an Add command from the context menu.

    For example, to create a new classification, select the Classifications folder on the Policy tab, and then select Add Classification from the context menu.

    IP Service Activator opens the Properties dialog box for that object.

  2. Enter the details in the dialog box.

    If you need help to complete a particular property page, press F1 or click the Help button on the dialog box.

Viewing and Editing Object Properties

You view and edit the attributes or properties that are associated with an object in the object's property dialog box. Depending on the object's type, the dialog box may contain any number of property pages, which are accessed by clicking the appropriate entry in the navigation tree on the left side of the dialog box.

Properties dialog boxes are modeless windows, which means that you can leave them open while you select other objects from the client. As you select objects, the Properties dialog box changes to display the selected object's details. However, if you edit any of the details displayed in the dialog, the window becomes modal and you must apply the changes before you can select another object. You can only have one Properties dialog box open at a time.

Every Properties dialog box includes the following command buttons:

  • OK: Validates the input, applies changes that have been made, and closes the dialog box.

  • Cancel: Closes the dialog box without applying the changes. This button is displayed only after changes are made in the dialog box but have not yet been saved by clicking Apply.

  • Close: Closes the dialog box. This button is displayed only if changes made in the dialog box have been saved by clicking Apply.

  • Apply: Validates the input, applies changes that have been made but leaves the dialog box open. This button is grayed out initially and becomes active only when changes are made.

  • Help: Displays help relevant to the selected property page.

Some property pages include an edit toolbar, shown in Figure 2-4.

Figure 2-4 The Edit Toolbar

The Edit Toolbar, buttons described below.

From left to right, the edit toolbar buttons include:

  • Set: applies a change to the selected entry.

  • Add: adds a new entry.

  • Delete: removes the selected entry.

  • Up: moves the selected entry up one position.

  • Down: moves the selected entry down one position.

To display an object's properties, on the View menu, select Properties.

If the object has no children, you can also double-click the object in the Hierarchy or Details pane to open the Properties dialog box.

Resizing an Object's Properties Dialog Box

You can resize the Properties dialog box for an object by clicking and dragging the resize handle in the lower right-hand corner of the dialog box. This is useful if a dialog box contains information that is not immediately viewable.

Changes to the default dialog box size persist, that is, IP Service Activator retains your preference.

Data Validation in a Properties Dialog Box

Data input is validated when you click OK or Apply, or when you select a different property page.

Additional validation is performed on the entire database whenever you save or commit a transaction or when you run the Validate command from the Tools menu.

Viewing an Object's Configuration

Objects, such as networks, customers, VPNs, sites, and so on, are referred to as ’policy targets.'

These objects can have policy types applied. For information about policy types, see IP Service Activator QoS User's Guide or IP Service Activator VPN User's Guide.

The policy elements associated with an object can be listed in the Details pane by double-clicking on the object and selecting the relevant tab.

Tabbed options at the bottom of the pane allow you to select the policy details you want to view.

To view the configuration associated with an object, double-click the object in the Hierarchy, Ancestry, or Details pane.

Depending on the object type, the configuration policies and services that are associated with the object are listed in the Details pane. You can view different elements by selecting from the tabs at the bottom of the Details pane.

Linking Objects

You set up associations between objects by linking them.

IP Service Activator shows the link between two objects as a link object, which appears in the Hierarchy pane as a copy of the object you have linked.

Examples of valid links include:

  • Linking a device to the proxy agent that manages it.

  • Linking a device to a site.

  • Creating and modifying a structure of accounts, by linking accounts to account groups.

  • Creating and modifying a structure of traffic types, by linking traffic types to traffic type groups.

  • Linking sites to a VPN object to create a VPN.

Unlike a standard object, a link object's context menu includes an Unlink option.

This section describes how to link objects using the drag and drop and copy and paste link techniques. You can drag and drop objects to create links between them working in the Hierarchy and Details panes, or by opening new domain management windows and dragging between windows.

The copy and paste link technique uses options from the Edit menu. This involves copying the object and selecting the Paste Link option over the object to which you want to link the first object.

You cannot link all object types; valid links are dictated by IP Service Activator's object model. If you are using drag and drop linking, an invalid link is shown by the mouse pointer, which changes over an invalid link target. If you are using Copy and Paste Link, the Edit menu's Paste Link option is not enabled.

Note that there are other indirect methods of linking objects. You can create links between objects when you select options on an object's property page. For example, when you select a class of service on a PHB group's property page, you effectively create a link between the PHB group and the class of service. IP Service Activator also creates some links automatically; for example, when you drag discovered devices on to a topology map.

If you have created a link between object A and object B, object A cannot be deleted. You first have to delete all instances of the link object.

Link objects look just like real objects in the Hierarchy pane. To check if an object is the real object or a link, check the context menu. If there is an Unlink option, the object is a link.

To tell if an object has any links to it, check the context menu. If the Delete option is grayed out, the object has links. You can then look in the Ancestry pane to see what parent objects exist - the object will have more than one parent.

To create a link using drag and drop:

  1. Organize the display so that the objects to be linked are both visible.

    You can simultaneously display objects in the Hierarchy and Details panes or by opening and arranging two domain management windows.

  2. Drag the source object and drop it on the destination object. The mouse pointer changes as you drag the item:

    • The pointer appears with a small arrow beneath it when you are over a valid destination to which the object can be linked.

    • The pointer appears as a circle with a bar through it when you are over an invalid destination to which the object cannot be linked.

    A new link object appears in the new position in the hierarchy tree.

To create a link using the Copy and Paste Link commands:

  1. Select the source object and select Copy from the Edit menu, or click the Copy toolbar button.

  2. Select the object to which you want to link the copied object and select Paste Link from the Edit menu.

    If the destination is not valid, the Paste Link option is not available.

    When a link is successfully created, a new link object appears in the new position in the hierarchy.

Unlinking Objects: Deleting Links

An object may be linked to other objects at multiple points in the IP Service Activator object model. Where an object is linked to another object, IP Service Activator displays the linked object as a child of the object to which it is linked. Therefore, an object may appear in multiple locations within the IP Service Activator client, as with the Site Nimes in Figure 2-5.

Figure 2-5 Objects Linked at Multiple Points in the Hierarchy Pane

Hierarchy pane, shows Nimes as child of a customer and VPN.

You can remove links between objects, for example if you have linked two objects by mistake or if you are making changes to the data.

Note:

If an object has been linked to one or more parent objects, you must remove those links before you can delete the object. For example, if you have created a host account named ’zeus' and linked it to an account group, you cannot delete the zeus account until you have removed its link to the account group.

Note:

If the Unlink option does not appear in the object's context menu, the object is a real object rather than a link object.

To check whether an object is a child of a parent object:

  • Right-click the object to display the object's context menu.

    If the Unlink option is listed, the object is linked.

To unlink an object:

  1. In a domain management window's Hierarchy pane, locate the parent object and select the link object listed below it.

    For example, to delete the link between a proxy agent and a device, locate the proxy agent in the hierarchy tree and select the device link object, listed beneath the proxy agent.

  2. From the Edit menu, select Unlink to unlink the object.

    The link is deleted and the link object is deleted from the hierarchy.

Note:

You can also drag the object onto a new object, which removes the existing link and links the object to a new parent.

Deleting Objects

You can delete objects from the object model, for example a router that does not physically exist in your network, or a rule component that is no longer used.

Note that you cannot delete system-defined (top-level) folders. These provide a means of grouping objects but are not objects themselves. See "Organizing Objects into User-defined Folders" to delete a user-defined folder.

Note:

Take care when deleting objects. IP Service Activator does not always display a confirmation message prior to deletion. If you delete something by mistake you can use the Edit menu's Undo command to restore it provided that you have not saved the current transaction since the object was deleted. You may also be able to rollback the transaction that performed the deletion.

For more information about undoing commands during a transaction or about rolling back a transaction, see IP Service Activator Concepts.

You cannot delete any object currently in use, for example, a Date and Time template that is assigned to a policy rule.

If you have dragged one object on to another, creating a link, the first object cannot be deleted until all links are deleted.

Remember that if you delete an object (such as a device or interface) from the map, you are actually deleting the object from the database.

To delete an object, select the object in the Hierarchy, Ancestry or Details pane, and, from the Edit menu, select Delete.

The object is deleted from the object hierarchy.

Organizing Objects into User-defined Folders

Most types of objects can be organized into user-defined folders.

  • Customers: customer folders are created under Customer objects in the Service tab

  • Sites: customer sites are created under Site objects in the Service tab

  • Driver Scripts: driver script folders are created under the Driver Scripts folder in the Custom tab

  • PHB Groups: PHBs and MQC PHBs can be organized into folders and sub-folders under the PHB Groups folder in the Policy tab.

  • Classifications: classifications and classification groups can be organized into folders and sub-folders under the Classifications folder in the Policy tab.

  • Classes of service: CoS can be organized into folders and sub-folders under the Classes of Service folder in the Policy tab.

  • Roles: roles can be organized into folders and sub-folders under the Roles folder in the Policy tab.

  • Traffic Groups: effectively folders organized under the Traffic Types folder in the Policy tab.

User-defined folders can contain sub-folders. Drag and drop operations can be used to move folders or their contents. You can also define folder permissions to restrict access to a subset of users for these folders.

To create a user-defined folder:

  1. Select the correct tab, depending upon the user.

    • For customers, select the Service tab on a Domain detail window or Network detail window.

    • For sites, select the Service tab on a Domain detail window.

    • For driver scripts, select the Custom tab on a Domain detail window, Network detail window, or Global View window.

    • For PHB groups, classifications, classes of service, roles, and traffic groups, select the Policy tab on a Domain detail window.

  2. Right-click on the parent object for the new folder. This can be the main system-supplied container folder (such as Customers, Driver Scripts or PHB Groups) or an existing user-defined folder.

  3. From the context menu, select Add Folder. (For Traffic Types, select Add Traffic Group.)

    One of the following Folder dialog boxes opens, as appropriate:

    • Customer Folder

    • Site Folder

    • Driver Script Folder

    • PHB Group Folder

    • Classification Folder

    • Classes of Service Folder

    • Roles Folder

    • Traffic Group

  4. Enter an identifying Name for the folder and, optionally, accompanying Remarks.

  5. If you wish to restrict access to the folder, select its Ownership property page and specify permissions.

  6. Click OK and commit the transaction.

To add an object to a user-defined folders:

  1. Drag the object to the target folder. Objects can be included in only one folder.

To move an object out of a user-defined folder:

  1. Drag the object to the new folder, or to the root folder for the objects.

To move a user-defined folder:

  1. Click the folder and drag it to its new parent. The parent can be the root folder for the objects or another user-defined folder of the same object type. Contents (objects and subfolders) of the folder move with the folder.

To delete a user-defined folder:

  1. Click the folder and, from the Edit menu, click Delete. When a user-defined folder is deleted, all of its contents (objects and subfolders) are deleted with it.

To rename a user-defined folder:

  1. Right-click the folder and select Properties from the context menu.

  2. Enter the new name for the folder in the Name field, and click OK.

  3. Commit the transaction.

Navigation

IP Service Activator offers a range of techniques for navigating the client.

  • View different object groups by selecting tabs in the domain management window.

  • Navigate the hierarchy tree by expanding and contracting objects in the Hierarchy or Ancestry panes.

  • Single-click on objects in the hierarchy tree to browse the hierarchy while keeping the view in the details pane static.

  • View more information about an object in the Details pane by double-clicking on the object in the Hierarchy pane.

  • Create different views of the policy domain simultaneously by opening and arranging new windows. See "IP Service Activator Windows" for more information about working with windows.

  • To open a duplicate of the current explorer window, choose New Window from the Windows menu.

  • To open a new explorer window which has the currently selected object at the top of the hierarchy, choose Open from the View menu or from the context menu. The selected object becomes the title of the new window.

About the Toolbar

Figure 2-6 shows the toolbar at the top of the main window that includes icons that allow you to access the most frequently used commands.

Figure 2-6 The Toolbar

The Toolbar, icons described in table below.

Table 2-2 describes the function of each toolbar icon as they appear, from left to right.

Table 2-2 Toolbar Icons

Icon Description

Validate

Checks all the data in the object model and reports any errors in the Current Faults Pane.

Save

Saves the current transaction to the database. The changes held in the transaction are not applied until the transaction is merged with the local object model and then committed.

Commit

Saves the current transaction to the database and propagates any associated device configuration to the network.

Schedule

Displays the Transaction Properties dialog box, allowing you to store the current transaction for implementing at a set date and time.

Abort

Aborts the current transaction, discarding all changes.

Copy

Places a copy of the selected object on the Windows clipboard. This has the same effect as the Copy command in the Edit menu.

To copy text from property pages or dialog boxes, use the Copy command from the context menu.

Paste

Pastes the object in the clipboard to the selected point. Can be used to copy rules.

To paste text from property pages or dialog boxes, use the Copy command from the context menu.

Undo

Reverses the previous action. You can click on this button more than once to reverse actions within the current transaction.

Redo

Performs an action again, if you have selected Undo and you then decide you didn't want to undo the action. You can click on this button more than once in order to reverse Undo operations within the current transaction.

Delete

Deletes the currently selected object.

Unlink

Removes the link between the currently selected object in the object model and its parent.

Properties

Displays the Properties dialog box for the selected item, allowing you to view or edit the information.

Opens a new explorer window, with the currently selected item as the topmost item in the hierarchy

Synchronize panes

Synchronizes the display in the Hierarchy pane with the Details pane. The parent of the item selected in the Details pane is highlighted in the Hierarchy pane.

Back

Returns to the previous display from a previously-navigated browse sequence.

Forward

Returns to the next display in a previously-navigated browse sequence

Configuration

Displays details of the configuration that applies to the currently selected object, including rules, PHB groups, VPNs, and driver scripts.

Report view

Displays the contents of the Details pane in the form of a list of objects, together with additional information about the object.

Compact list view

Displays the contents of the Details pane in the form of a list of objects.

Map view

Displays the network map in the Details pane.

Status context

The map display uses different colors to show the status of devices and interfaces.

Policy context

The map display uses different colors to show the status of devices and interfaces.

Print

Displays a standard Windows print dialog box, allowing the selected network map to be printed. This is only available when the map is displayed.

Help

Displays the contents page of the on-line help.


Synchronizing Panes

When you double-click on an object in the Hierarchy pane, the Details pane synchronizes automatically and the selected object's details are displayed in the Details pane. However, you can also click on objects to browse the hierarchy tree but leave the view in the Details pane static.

The Synchronize Panes feature enables you to resynchronize the view shown in the Hierarchy pane with the Details pane. It returns you to the tab whose details are shown in the Details pane, with the tab in the same state as last viewed.

To synchronize the Hierarchy pane with the Details pane:

  • Click the Synchronize Panes icon on the toolbar.

IP Service Activator synchronizes the Hierarchy pane with the Details pane.

Note:

Synchronization only occurs if you have navigated objects in the Hierarchy pane using the single-click technique.

Using the Navigation Icons

Whenever you open a new window and browse through the object model, IP Service Activator keeps a record of the object views you have visited. You can move through the recorded browse sequence using the Up, Back, and Forward icons.

The Up icon is only enabled when you drill down through a map on the Topology tab. When selected, it takes you up one level in the topology hierarchy and displays details of the selected object's parent. However, if you have a segment selected, the Up icon is not enabled. This is because a segment may have a number of connected interfaces and therefore has multiple parents.To navigate a recorded browse sequence:

  • Use the Back and Forward icons to step backwards and forwards through the browse sequence.

  • Use the Up icon to return to a previous map view after you have drilled down a level.

Changing Views

The Details pane can display details of selected objects in several formats. You can switch between views using toolbar icons:

  • Report View: displays the contents of the Details pane in the form of a list of objects, together with additional information about the object's properties. You can sort on any column by clicking on its title.

  • Compact List View: displays the contents of the Details pane in the form of a multi-column list of objects.

  • Map View: displays the network topology map or the VPN map in the Details pane. This button is only available when you have selected an object that has an associated map, that is, a network object or a VPN object.

  • Status Context: displays the map view showing the status of all network elements.

  • Policy Context: displays the map view showing the policy role of all network elements.

You can also change the type of information that is displayed on the topology map, viewing information about the status of the map's devices or the policy implemented at each device. See "How Objects are Represented" for more information.

Changing the Appearance of the Client

IP Service Activator gives you flexibility over the appearance of the client. You can hide and show window panes, arrange panes or move elements around the window. The only window element that you cannot hide is the Details pane.

Hiding and Showing Windows and Window Elements

You can hide and show windows and window elements by selecting options from the View menu. You can hide or show the following elements:

  • Toolbar

  • Status bar

  • Hierarchy tree pane

  • Ancestry tree pane

  • Map palette

  • Global Setup window

  • Current faults pane

  • Statistics summary pane

  • System statistics window

To hide or show a window element, from the View menu, select the element that you want to hide or show. An element is displayed if its name is checked.

Changing the Size and Position of a Pane

You can change the size of any of the displayed panes and, for selected panes, drag them to a new position.

To change the relative size of panes:

  • Click on and drag the vertical and horizontal bars separating the relevant panes.

To move and dock a pane, do one of the following:

  • On the Hierarchy, Ancestry or Palette pane, click on the pane's title bar and drag it to a new position.

  • On the Current Faults pane, click on the pane's docking bar and drag the pane to a new position.

Depending on the pane's new location, IP Service Activator may change the pane's orientation and size.

If you drag the pane outside the domain management window, it becomes a separate, floating window. To return the pane to the window, position the pane over the window's edge.

Changing the Hierarchy Pane's Tab Position and Style

You can customize the appearance of the Hierarchy pane's tabs by selecting their location on the pane. If tabs are displayed at the top or bottom of the pane, you can also specify whether they appear in a single line or multiple lines. The default is multiple lines.

To change tab position and style:

  1. Right-click on the Hierarchy pane's title bar and select Display Tabs to display the pane's context menu.

  2. Select Top, Bottom, Left, or Right.

    The tabs move to the position you selected.

  3. Right-click on the Hierarchy pane's title bar and select Multilined.

    The Multilined option is only displayed if tabs are displayed at the top or the bottom of the pane.

    The tab style changes depending on whether the Multilined option is selected or deselected.

Searching IP Service Activator

IP Service Activator provides the following options for searching:

  • Search for objects based on a text string

    The text string may be in the form of a regular expression. You can choose whether to expand or restrict the search to policy objects, including inherited policy objects. You can also restrict the search by object type, state and/or role.

  • Search for concrete configuration objects

    This search locates concrete rules, PHB groups, driver scripts, VPNs, and CCCs. You can restrict the search by state.

Conducting a Text-based Search

A text-based search is based on a string that may include a regular expression. The search operates from a user-selectable point in the hierarchy. IP Service Activator attempts to match the search string against all attributes of an object. This means, for example, that you can search for a device by name, role or IP address, or a rule by its name, status or associated traffic type.

The search text may include any alphanumeric or punctuation characters up to a maximum of 64 characters.

By default, IP Service Activator attempts to match the search text at any point in a text string. For example, the search text ’165' will be matched against 168.165.0.4. Alternatively, you can specify that the search text is matched against whole words only. You can specify whether the search is case sensitive.

IP Service Activator remembers previous search start points and displays them in a pull-down list in the Find dialog box. This list is cleared if the client is stopped and restarted.

Note the following:

  • IP Service Activator searches the contents of the Object Model. Note that the System Logs are not held in the Object Model, and you therefore cannot search their content from the client.

  • You can search within a single domain only.

Note:

For complete dialog box and property page descriptions, see IP Service Activator online Help.

To conduct a text-based search:

  1. From the Tools menu, select Find.

    The Find dialog box opens.

  2. In the Find What field, specify the search string.

  3. Optionally, select options including Search From, Match Whole Word Only, Match Case, Regular Expression, Match Configuration, Match Configuration Only, and Match Inherited Configuration.

  4. If you want to restrict the search by object type, state or role, select the Advanced tab and select from options, including Match Object Type, Match Object State, and Match Object Role.

  5. Click Find.

    IP Service Activator searches for the specified search criteria. As matches are found, the search results are added to the list in the lower half of the Find dialog box.

Note:

Depending on the amount of information held by IP Service Activator, a search may take some time to complete. You can stop the search by clicking the Cancel button that is displayed while the search is in progress.

When the search is complete the results are shown in the lower half of the Find dialog box.

By default, found objects are sorted by object name. You can:

  • Change the sort order criteria by single-clicking on a column title.

  • Display a found object in the Hierarchy pane by double-clicking on it. IP Service Activator highlights the object in the Hierarchy pane and, where relevant, lists children of the found object in the Details pane.

  • Open a new window on a found object by selecting Open from the object's context menu.

  • View an object's properties by selecting Properties from the object's context menu.

For information about searching for concrete objects, see IP Service Activator Concepts.

Searching Committed Transactions

IP Service Activator supports the ability to search through committed transactions. See "Searching Committed Transactions" for details.

Printing

You can print the contents of the Details pane to produce, for example, a printout of the system log file or topology map. Each page has a ruled border with information about the page content printed round the border edge. Details of the page layout, including margin size, can be specified and the printed layout previewed.

Note:

When printing a topology map that occupies multiple pages, there is some overlap between pages.

For information about printing reports, see IP Service Activator Network and SLA Monitoring Guide.

To print the Details pane:

  1. From the File menu, select Print.

    The Print dialog box opens.

  2. Adjust the print settings if required.

  3. Click OK.

To define the print page setup:

  1. From the File menu, select Page Setup.

    The Page Setup dialog box opens.

  2. Select the Paper, Orientation, and Margins that you want.

  3. If you want to select a printer, click the Printer button, select the printer, and click OK to confirm the printer selection.

  4. Click OK.

To display a print preview of the Details pane:

  1. From the File menu, select Print Preview.

    IP Service Activator displays a preview of the pane printout. You can move between pages using the Next Page and Prev Page buttons. You can view the image in more or less detail using the Zoom In and Zoom Out buttons.

  2. If you want to print the previewed image, click Print to display the Print dialog box and OK to confirm the print request.

  3. If you want to close the previewed image, click Close.