Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• IP Service Activator Configuration Policy Online Documentation

1 Introduction to the OSS Integration Manager

• What You Can Do with the OIM
  • Browsing the Managed Network
  • Provisioning Services
  • Event Reporting
  • Security Considerations
  • Multiple Client OIM Access
  • Support for Load Balancing in Layer 3 VPNs
  • Support for 4-byte Autonomous System Number (ASN)
• Installing the OIM
• Running the OIM
  • Running the Integration Manager
  • Running the Command-line Interface
    • Running OIM on Solaris
  • Maximum CORBA Message Size
• Using the OIM
  • The Command Set
  • The External Object Model
• Connecting an OIM Client to the Naming Service

2 Web Services

• About Web Services
• About Web Services and OIM
• Design Studio for IP Service Activator
  • About Activation Tasks
• Configuring Web Services
• Security
• OSM Data Providers
• Finding and Retrieving Data
  • Finding Objects
  • Retrieving Objects
  • Retrieving Other Data
• Web Service Operations

3 The Command Language

• Command Grammar
  • Object Path
  • Attributes
  • Data Types
  • Case Sensitivity
• Overview of the Commands
• Transactions
• Error Reporting
• The Access Control Module
  • The Login Command
  • The ChangePassword Command
  • The Logout Command
  • The getAccess Command
• The Transaction Module
  • The Abort Command
  • The Commit Command
  • The Events Command
  • The Exporttransaction Command
    • Concretes Affected by the Exporttransaction Command
    • Enhancement of Exporttransaction Command and the Cat Command
    • Exporttransaction Command Examples
  • The ListTrans Command
  • The Merge Command
  • The Rollback Command
  • The Schedule command
• The Declarative Module
  • The PreserveMissingInterfaces Command
  • The ApplyRoleAssignmentRules Command
  • The Copy Command
  • The Create Command
  • The Delete Command
  • The Link Command
  • The Unlink Command
  • The Modify Command
  • The Subscribe/Unsubscribe Commands
  • The Use Command
  • The Unuse Command
• The Management Module
  • The Discover Command
  • The Manage Command
  • The Unmanage Command
  • The ResetCapability command
• The Navigation Module
  • The Find Command
  • The FindParameters command
    • FindParameters Command Errors
  • The GetAttributes command
  • The GetChildren command
  • The GetID command
  • The GetName Command
  • The GetParameters Command
  • The GetParents command
  • The GetPath command
  • The SetPath Command
  • The GetTargets command
  • The XmlExport command
    • XML Standard Encoding
    • xmlExport Compression
• The Utility Module
  • The Alias command
  • The File Command

4 The External Object Model

• General Concepts
  • Purpose of the External Object Model
  • Overall Structure
• Object Notation
  • Access Types
  • Data Types
  • Key to Object Diagrams
  • Linking by Attribute
• Object Inheritance and Abstract Objects
  • Object Reference
  • Object Inheritance
• Summary of Objects
  • Policy Model Objects
  • Topology Model Objects
  • System Model Objects
• The Policy Model
  • Policy Object
  • ParameterSet Object
    • MeasurementParameterSet
    • CollectorParameterSet
    • ParameterSetInstance
  • Domain Object
    • InterfacePolicyRegistration
  • Customer Object
    • SiteFolder
  • CustomerFolder Object
  • Account Object
  • VPN Object
  • PtToPtL2Martini Object
  • TLS Object
  • SAATemplate Object
  • SAAOperation Object
  • RtNumber Object
    • RtNumber for Sites and VPNs
    • RtNumber for Virtual CEs
  • Site objects
    • SiteHub Object
  • SiteL2 Object
  • StaticRoute object
  • Traffic Type Objects
    • Traffic Object (Abstract)
    • TrafficGroupObject
    • TrafficCompound Object
    • TrafficMime Object
    • TrafficUrlObject
    • TrafficPort Object
    • TrafficApplication Object
    • TrafficSubApplication Object
    • TrafficPacketMarking Object
    • TrafficDomainName Object
    • TrafficVlan Object
    • TrafficInputInterface Object
  • Rule Objects
    • Rule Object (Abstract)
    • RuleAccess Object
    • RuleClassification Object
    • RuleGeneric Object
    • Policy Type Object
    • Policy Type Folder Object
    • RulePolicing Object
  • Period Object
  • Classification Objects
    • ClassificationBase Object (Abstract)
    • ClassificationGroup Object
    • ClassificationOrder
    • Classification Object
    • ClassificationFolder Object
  • PHBGroup Objects
    • PHBGroup Object
  • PHBGroupFolder Object
    • PHBGroupInstance Object
    • PHB Object
    • PHBAtm Object
    • PHBFrts Object
    • PHBWred Object
  • PHBGroupMqc Objects
    • PHBGroupMqc Object
    • PHBMqc Object
  • PHBPolicingAction Object
  • Cos Object
  • COSFolder Object
  • Service Group Object
  • DriverScript Object
  • DriverscriptFolder Object
  • Role Objects
    • Role Object (Abstract)
    • RoleFolder Object
    • RoleDevice Object
    • RoleInterface Object
  • PacketMarking Object
  • ConcreteObject Object
• The Topology Model
  • Topology Object
  • Network Object
  • Device Object
    • DeviceCapabilities Object
  • DeviceType Object
  • InterfaceCapabilities Object
  • VCCapabilities Object
  • Interface Object
  • Port Object
  • EigrpRedistribution Object
  • OspfSummaryAddress Object
  • BgpAggregateAddress
  • BgpNetwork
  • EbgpNeighbour Object
  • SAP Object
    • Creation and Deletion
    • Linking and Unlinking
    • To Create an Interface-less VRF
  • SubInterface Object
  • CreationMarkerSubInt Object
  • CreationMarkerVcFr Object
  • SubLayer Object
  • VlanInterface Object
  • VcEndpoint Objects
    • VcEndpoint Object (Abstract)
    • VcEndpointFr Object
    • VcEndpointAtm Object
  • EthernetVlan Object
  • Segment Object
• The System Model
  • System Object
  • Options Object
  • TransactionEntry Object
  • Component Object
  • EventSubscription Object
  • EventCollector object
  • EventFilter Objects
    • EventFilter Object (Abstract)
    • EventFilterAttributeChange object
    • EventFilterFaultMask Object
  • ExternalSystem Object
  • Fault Object
  • SnmpProfile object
  • SystemUserGroup Objects
    • SystemUserGroup Object
    • SystemUser Object

5 Examples of Using OIM

• Explanation of the examples
• Browsing the Topology
  • Pre-requisites
  • Command syntax
  • Object Hierarchy
  • Example
• Finding Objects
  • Pre-requisites
  • Command Syntax
  • Examples
• Discovering Devices
  • Pre-requisites
  • Command Syntax
    • Discovering a Single Device
    • Discovering a Single Device Using an SNMP Profile
    • Discovering a Subnet
    • Fetching Capabilities
    • Rediscovering a Device
    • Stopping Discovery
  • Example
• Creating Device and Interface Objects for Pre-Provisioning
  • Pre-requisites
  • Command Syntax
  • Example
• Creating and Assigning Roles to Devices and Interfaces
  • Pre-requisites
  • Command Syntax
    • Creating a New Role
    • Assigning a Role to a Device, Interface, or SubInterface
  • Example
• Creating a Site
  • Pre-requisites
  • Command Syntax
    • Create Customer Object
    • Create Site Object
    • Link PE Access Interface to Site
    • Link CE Router to Management Site
    • Manage the CE Router
    • Setting Up PE-CE Routing Parameters
  • Example
• Creating a Management VPN
  • Pre-requisites
  • Command Syntax
    • Creating the VPN Object
    • Link the Management Site to the VPN, and Make it a Hub Site
    • Link Customer Sites to the VPN
  • Example
• Creating a Customer VPN
  • Pre-requisites
  • Command Syntax
    • Create the VPN Object
    • Link the Customer Site to the VPN
    • Set Hub Sites
    • Link Customer Sites to the Management VPN
  • Example
  • OIM Commands
• Creating and Applying Rules
  • Pre-requisites
  • Command Syntax
    • Creating the Rule
    • Assigning Roles to the Rule
    • Rule Attributes: Inbound/Outbound
    • Rule Attributes: Date and Time Period
    • Rule Attributes: Classification
    • Classification Rule
    • Creating and Linking a Packet Marking to a Traffic Type
    • Access Rule
    • Policing Rule
  • Example
    • Classification Rule
    • Access Rule
• Creating and Applying PHB Groups
  • Pre-requisites
  • Creating a Standard PHB Group
    • Deleting the Default Class of Service and Linking to an Existing Class of Service
    • Creating Additional PHB Children
  • Creating an MQC PHB Group
    • Deleting the Default Class of Service and Linking to an Existing Class of Service
    • Creating Additional PHBMqc Children
    • Implementing Single or Two-rate Policing with a PHBMqc Object
    • Configuring WFQ Using WRED as the Drop Strategy
    • Nesting MQC PHB Groups
• Creating an Event Subscription
  • Pre-requisites
  • Command Syntax
    • Creating the Event Subscription
    • Creating the Event Collector
    • Event Filters
  • Example
    • EventSubscription
    • EventCollector
• Applying Parameter Sets
  • Pre-requisites
  • Command Syntax
  • Example
• Provisioning SAA
  • Creating an SAA Template
  • Creating an SAA Operation
  • Applying an SAA Template to a VPN
• Determining when Transactions Have Been Completed
  • Transaction Attributes
  • Example
• Determining When Transactions Have Been Completed Using Concrete Objects Status
  • Finding Relevant Concrete Objects
  • Checking Concrete Object Status
  • Example
  • Managing System Users
  • Viewing All Users and User Groups
  • Adding a User
  • Modifying a User
  • Deleting a User
• Configuration Thresholding Feature: Modifying the Regular Expression
  • Cisco Regular Expression
  • Huawei Regular Expression
  • Juniper Regular Expression
  • Limitation
  • General Rrocedure for Changing the Regular Expression
  • Specific Examples
• Applying Configuration Policies Using the OIM
  • Creating a Configuration Policy Using Existing PolicyTypes
  • Creating User-defined PolicyTypes
    • Using the HTML and XSD Schema Content
    • Using the User-defined .policy File

6 Error Handling

• Exceptions
  • CommandSyntaxException
  • CommandExecutionError
  • OimSystemException
  • LoginException

A Command Grammar

• Basic Grammar for Commands

B Command Correlation

• Command Correlation Table

C Sample IP Service Activator Transaction Publisher Class

• Types of JMS Events
  • TransactionCreation
  • AttributeChange
• Sample OJDL file
• Coding examples
  • Implementation of the java.lang.Runnable Interface
  • EOMSession Management
  • Handling of Create Events
  • Handling of Modify Events
  • Customizing the Format of the JMS Message
  • Publishing the Outgoing Message
  • Initializing the JMS Entities