Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

1 Using the Configuration GUI

• Overview of the Configuration GUI
• Running the Configuration GUI
• Components Configured by the Configuration GUI
• Managing Hosts with the Configuration GUI
• Enabling and Disabling Components
• Modifying Configuration Parameters
• Refreshing the Configuration Parameters
• Managing the Configuration GUI
• About Configuration Files
• Saving a Configuration
• Loading a Configuration
• Loading a Configuration onto Another Host
• Files Managed Through the Configuration GUI
  • About the warnInOfflineMaintenanceMode Parameter
  • Encryption of Configuration GUI-managed Files
  • Configuration GUI Logging

2 Post-installation Administration Tasks

• Verifying Network Processor Assignment and Cartridge Installation
  • Verifying the Network Processor is Assigned as a Proxy Agent
  • Testing Cartridge Installation
    • Viewing the Cartridge in the GUI
    • Enabling Layer 2 Martini Support Through the Cisco IOS Cartridge
    • Testing Connectivity to a Device
• Confirming Router Configurations
  • All Devices
  • Cisco
  • Juniper
• Launching the SSH Client
  • Prerequisites
  • Procedure
• About Configuration Policies
  • Loading Configuration Policies
  • Adding a Configuration Policy as a New Policy Type
  • Exporting a Policy File from a New or Customized Configuration Policy
• Importing and Linking Controller Scripts
• Discovering Devices Using AutoDiscovery.cfg
• Additional Setup Tasks to Be Run Prior to Initial Startup

3 Starting and Stopping IP Service Activator

• Starting IP Service Activator Components
  • Starting the Naming Service
  • Starting the Component Manager
    • IP Service Activator Fast Start Mode
  • Starting the Windows-based User Interface
• Stopping IP Service Activator Components
  • Stopping the Windows-based User Interface
  • Stopping the Component Manager
  • Stopping the Naming Service

4 Setting Up Users and Menus

• About Users and Security
  • User Groups
  • Users
  • Passwords
  • Permissions
    • Permission Levels
    • Link Permission
    • Link (Reference Only) Permission
    • Execute Permission
    • Folder Permissions
    • Impact of Permissions in the GUI View
    • Inheritance of Permissions
• Changing the Default User
• Creating Rules for Passwords
• Setting Up User Groups and Users
• Setting Up User Groups
  • Setting Up Read Write Group Permissions
  • Creating Users
    • Resetting a user password
  • Disabling or Re-enabling User Access
  • Re-enabling Users
  • Viewing User Group and User Information
  • Allowing a User Group to Access Configuration Template Module
• Owning and Setting Permissions on an Object
• Running the User Interface in Confirmed Commit Mode
• Context Menu Extension Plugin
  • Setting up the Context Menu Extension Plugin
  • Creating Context Menu Items in the GUI
  • Example ExplorerScripts.xml File
• The Module Authorization GUI
  • Accessing the Module Authorization GUI
  • Setting Permissions with the Module Authorization GUI

5 Backing Up and Restoring Data

• Introduction
• IP Service Activator Installation Directories
• Data to be Backed Up
  • Critical Data
  • Non-critical Data
• Backing Up and Restoring Data on Windows
  • Full Restore
  • Replacing the user interface
  • Backing Up and Restoring Windows Registry Settings
• Backup and Restore on Solaris/Linux
  • Backup Procedures on Solaris/Linux
    • Full Backup
  • Replacing One or More Components

6 Monitoring and Managing IP Service Activator

• Setting the Component Manager Startup Delay Time
• Setting the Component Manager Shutdown Timeout Period
• IP Service Activator Process Names on Solaris/Linux
  • The Naming Service
  • The Component Manager
  • The User Interface
• Managing Validation on Policy Server Initialization
• Managing components
  • Discovering New System Components
  • Setting the Proxy Agent Timeout Value
  • To Restart a Halted Component Manager
• Viewing and Understanding Error Messages
• Getting More Information About Error Messages
• Suppressing Error Messages
• Logging in IP Service Activator
  • Checking the System Logs
  • System Message Log
  • Device Configuration Log
  • Checking the Device Driver Logs
• Configuration GUI Log Files
  • Managing the Size of System Log Files
  • Viewing Log Files
• Network Processor Logging
  • Network Processor Log Files
  • Setting Up Logging
  • Checking Network Processor Logs
  • Checking the Network Processor Cartridge Log
  • Logging Levels
  • Changing the Logging Level Filter
  • Managing Log File Rollover
    • Using the dailyFileAppender
  • Log Output
  • Logging Properties
  • LogReader
    • Configuring the LogReader Component
    • Configuring the Scope of the LogReader
    • Database Schema for LogReader
  • Network Processor Database-related Log Files
  • Setting the Archive Limit for Transactions
• Audit Trail
• Policy Server Performance Tuning
  • Device Role Check Option
  • Specifying a Queue Size High Water Mark
  • Writing Queue Information to the Policy Server Log File
• About Transaction Status Monitoring
  • Viewing Provisioning Statuses
  • Configuring Transaction Status Monitoring
    • Configuring Transaction Status Monitoring Using Command Line
    • Configuring Transaction Status Monitoring After IP Service Activator is Running
• Viewing the Status of a Device or Interface
• Viewing the Current Status of IP Service Activator
  • Permitting GUI Access to the Network Processor
  • Transaction Troubleshooting
• Auditing
  • Viewing the Configuration on a Device
  • Running a Device Audit
    • Device Audit Report Examples
  • Running a Per-service Audit
  • Audit File Color Coding
  • Audit Synonyms
    • Loading Audit Synonyms
    • Sample Synonyms File
    • Understanding How Synonyms Work
    • Creating a Custom Synonyms File
    • Synonym Tools
• About Audit Templates
  • Understanding audit template elements
  • Audit Template Command Attributes
  • kind=<string>
  • Effect of Kind Attribute on Audit Report
  • configVersion=<boolean>
  • ordered=<string>
  • autoIndentUntil=<string>
  • reportManualConfig=<boolean>
  • brokenIndentRulesOffset=<int>

7 Monitoring and Managing the Network Processor

• Network Processor
  • Network Processor/Cartridge Components
  • Network Processor Operation
  • Implementing New Services Through the Network Processor
  • Tolerance for Manual Configuration on Devices
    • Adding a New Success Pattern
• Configuring the Network Processor
  • Configuring Performance Characteristics of the Network Processor
    • Setting the Network Processor Cache Size
    • Configuring the Number of Simultaneous Device Transactions for Network Processor
  • Configuring Queue Priority at Network Processor Startup
  • Creating or Editing a Cartridge Registry File
    • Producing a Device Configuration Change Log
    • Applying Cartridge Registry Changes
  • Registering Cartridges with Registry.xml
    • Cisco sample
  • Customization File Entries
  • Using Activation Retry
    • Connection Retry
    • Command retry
  • Configuring Time Delays for the Network Processor
  • Configuring Memory Limits for Network Processor Cache
  • Configuring Prefix List Ranges for Cisco Devices
  • Deleting Address Family Unicast Commands from Cisco Devices
  • Setting the ”alias ip-vrf” Command for Cisco VPNs
  • Setting the ”alias exec” Command
  • Adding the ”unmanaged RIP redistribution” Command for Juniper VPNs
  • Configuring the Network Processor to Accept Exact Names on a Huawei Device
• Command Delivery Modes
  • Overview of Command Delivery Mode at the Network Processor Level
    • Command Delivery Mode Behavior at the Network Processor Level
    • New Notifications for Network Processor
    • Differences Between Network Processor and Device Driver Behavior
  • Setting Command Delivery Mode Using the CLUI
    • Audit Trail - Indication of Operational Mode
  • Switching Between Offline Test Mode and Online Mode
    • Method 1
    • Method 2
  • Logging with the Network Processor
  • Network Processor Database-related Log Files
• Synchronization and Recovery Strategies and Tasks
  • Causes of Configuration Mismatches
  • Configuration Mismatch Recovery Scenarios
    • Device Configuration Is Older than the Last Device State
    • Device Configuration Is Newer than the Last Device State
    • Device and Last Device State Timestamps Match but Audit Detects Differences
  • Configuration Mismatch Recovery Procedure
  • Setting the Severity of the Loss of Synchronization Fault
  • Dropping Database Tables/User
  • Moving a Device to Another Network Processor
• Cartridge capabilities management
  • Capabilities and the Registry
  • Capabilities File Structure
  • Device Capabilities
  • Interface Capabilities
  • SAP Capabilities
  • Inbound and Outbound Capabilities
  • Capabilities and Options
  • Default Capabilities Generation
  • Initial Capabilities Configuration
  • Modifying and Creating Capabilities Files
  • Enabling, Disabling, or Modifying a Capabilities Definition
  • Adding a New Interface Type to an Interface Capabilities Definition
  • Modifying Capabilities for a Specific Vendor Device Type or OS Version
  • Capabilities Dialogue Messages
  • Re-initializing Capabilities for a Device or Interface
  • Assigning unsupported capabilities to a device or cartridge
  • Capabilities reference
    • Device capabilities
    • Interface capabilities
  • Capabilities classifications
  • Capability value pairs

8 Managing the IP Service Activator Database

• Checking the Integrity of a Database
  • Running the Database Integrity Checker (UNIX Version)
  • Running the Database Integrity Checker (Windows Version)
    • Database Integrity Checker Parameters
  • Report Information
  • Diagnostic Information
• Datascript Cleanup
  • Running the Datascript Cleanup Utility
• Database Administration for the Network Processor
  • Device Model and Service Model Persistency
  • npAdmin Tools
  • Network Processor Database-related Files
    • Network Processor Database-related Configuration Files

9 Troubleshooting IP Service Activator

• Running Troubleshooting Scripts
• Communication Errors with the Database
• Component Errors
  • Component Will Not Restart
  • GUI Cannot Connect to Server
  • GUI Hangs When Running Multiple Interfaces on Same Machine
  • Client Cannot Connect to Server
  • Component Manager Fails on Start-up
  • Component Does Not Restart
  • Investigating a User Interface Error on Windows
  • Insufficient privilege to stop the component manager or naming service
• Transactions
  • Cannot Save or Commit a Transaction
  • Reviewing Transactions
  • Exporting Transactions
• Log Files
  • Generating debug log files for non-Java based IP Service Activator components
  • Collating Log Files
    • Enabling Debug Log Files for a Windows GUI
    • Generating Debug Log Files for Java-based IP Service Activator Components
  • Checking and Deleting Core Files
  • Managing Swap File Size
• Discovering Manually Created Subinterfaces on Juniper M-series Devices
• Troubleshooting the Network Processor
  • Viewing Debug Logs
  • Network Processor Cannot Find a Cartridge
  • Turning Off the Offline Maintenance Mode Warning
    • Command line and ComponentParameters for Network Processor
  • Setting Severity of Fault ”Re-issue commands operation failed”
  • Recovering from Rollback Failure
  • Network Processor Does Not Start
    • CORBA handshake delay time
    • Cartridge handshake delay time
    • Credentials expiry
    • VMSize
  • If Concrete Rules Are Not Created for Abstract Rules
  • Running Troubleshooting Scripts
    • Example: Using the IPSAPS script to verify which components are running
• Effects of Component Failures
• Component Distribution and Communication
• Software Failure
  • Naming Service
  • Component Manager
  • System Logger
  • Policy Server
  • Proxy Agent
  • Device Driver
    • Juniper M-series Device Driver
  • Network Processor
  • Log Reader
  • User Interface
  • Event Handler
  • OSS Integration Manager (OIM)
  • CTM Server Component
  • Discovery Module Server Components
  • Tacc Module Server Component
• Hardware Failure
  • About the Component Manager and the Restart of Managed Components
  • Proxy Agent and Device Driver Host
  • Policy Server Host
  • User Interface Host
  • OIM Host
  • Event Handler Host
  • Measurement Component Host

10 Improving IP Service Activator Performance

• Performance Considerations
  • Running Troubleshooting Scripts
• Tuning Techniques
  • Deploying on Solaris
  • Re-ordering IP Service Activator Component Initiation
  • Reducing the Number of Stored Transactions
  • Setting DeviceStatusDelay
  • Reducing the Impact of Discovery Actions on the IP Service Activator GUI
  • Apply Policies at the Highest Granularity Possible
  • Reducing the Component Manager Shutdown Timeout
  • Increasing the ORB TCP Timeout Threshold
    • Avoiding Errors When Disabling and Re-enabling CTM
• Tuning the Network Processor
  • Setting optimizeFirstCommit
  • Increasing the Allocated Memory of the Network Processor
  • Increasing the CORBA Message Size for the Network Processor
  • Limiting the Growth of Caches Within the Network Processor Buffer
  • Increasing the Processor Thread Limit of the Network Processor