Benutzerhandbuch für Cisco Cisco Configuration Engine 3.5

Cisco

Merkblatt (English)Entwickleranleitung (English) (English) (English) (English)

Merkblatt

Inhaltsverzeichnis

Größe:

1,12 MB
Seiten:

37
Language:

English

Handbuch öffnen

Entwickleranleitung

Inhaltsverzeichnis

Cisco Configuration Engine Software Development Kit API Reference and Programmer Guide 3.5
1
Contents
3
About This Guide
17
- Objective
  17
- Who Should Use This Book
  17
- Related Documentation
  18
- Conventions
  18
- Cisco Developer Support Program
  18
Product Overview
21
Event Service and IMGW
25
- Event Service Overview
  25
  - Event Services Structure
    27
  - Event Service Features
    27
- Intelligent Modular Gateway
  28
  - Event Bus Interface
    30
  - Device Interface
    30
- Event Bus Interface
  30
- IMGW Device Information Database
  33
  - Data Structures
    33
  - Examples
    34
    - Supported Device Types
      34
    - Hopinfo Examples
      35
  - Depreciated IMGW API
    37
  - Simulated Agents
    37
- End User Interface
  39
Configuration Service
41
- Configuration Service Overview
  41
- Template File Manager
  42
  - Usage
    42
  - Configuration Engine File Management DTD
    42
    - Template File XML Response Messages
      44
    - Limitations
      47
    - Error Codes
      47
  - Examples
    48
    - Client Examples
      48
    - XML Request Examples
      51
    - XML Response Example
      53
- Template Features
  53
  - Dynamic Template and Object
    54
    - Preparation
      54
    - URL to Connect to Configuration Engine
      55
    - Example
      55
      - Error Handling
        55
  - Restrictions
    56
Namespace Mapping Service
57
- Namespace Mapper
  57
- Object Model
  61
  - GroupItem
    62
  - Device
    62
  - Group
    62
  - Application Namespace
    62
  - Event
    63
  - Schema Description
    63
    - Device
      63
    - Group
      63
    - Application Namespace
      64
    - Event Object
      64
- Mapping Algorithm
  66
  - Subscriber Logic
    66
  - Publisher Logic
    67
  - Default Namespace config
    67
  - Administration and Setup
    67
  - NSM API Usage
    68
- NSM SDK Contents
  70
  - Constants
    70
  - Supported CPP Compilers
    71
    - Solaris
      71
    - Solaris C++
      71
  - Java
    71
- NSM Client API Reference
  71
  - class NSMClient
    71
    - Public Functions
      72
      - NSMClient()
        72
      - create()
        72
      - attach()
        72
      - detach()
        72
      - resolve()
        73
      - resolve()
        73
      - resolve()
        74
  - class NSMResolveRequest
    75
    - Public Functions
      75
      - NSMResolveRequest()
        75
      - NSMResolveRequest()
        75
      - get_dev_id()
        75
      - get_event()
        76
      - get_action()
        76
      - get_element()
        76
      - set_dev_id()
        76
      - set_event()
        77
      - set_action()
        77
      - set_element()
        77
  - class NSMResult
    77
    - Public Functions
      78
      - NSMResult()
        78
      - get_num_items()
        78
  - class NSMResultIterator
    78
    - Public Functions
      78
      - NSMResultIterator()
        78
      - advance()
        78
      - value()
        79
      - isEnd()
        79
Web Services: Admin, Config, Image, Exec, NSM
81
- Web Services Model
  81
- Depreciated Image Web Service
  100
  - End User Interface
    101
    - Exception Handling
      101
  - Operational Methods
    102
    - getImageInventoryReport
      102
    - submitJob
      102
    - evaluateJob
      103
    - listJobIds
      104
    - getJobStatus
      104
    - getJobDetailStatus
      105
    - stopJob
      105
    - restartJob
      105
    - cancelJob
      106
  - Administrative Methods
    106
    - deleteDevice
      106
    - deleteGroup
      107
    - deleteImage
      107
    - Import Template
      107
    - Export Template
      108
    - bulkUpload
      109
  - Types
    109
  - Notes
    110
  - Example Scenarios
    110
    - Background
      111
      - Data Management
        111
      - Objects
        111
    - Scenario One
      111
      - Objective
        111
      - Assumptions
        111
      - Preconditions
        111
      - Steps
        111
      - Notes
        113
    - Scenario Two
      113
      - Objective
        113
      - Assumptions
        113
      - Preconditions
        113
      - Steps
        114
    - Sample Bulkupload Files
      114
  - Image Web Service WSDL
    117
- Spreadsheet Bulk Upload
  133
Namespace Administration, Group Administration, and Notification APIs
135
- Namespace Administration API
  135
  - Class NamespaceAdminFactory
    135
    - Constructor
      136
    - Create
      136
    - Delete
      136
  - Class NamespaceAdmin
    137
    - Add Namespace
      137
    - Namespace Deletion
      137
    - Clone Namespace
      138
    - List All Namespaces
      139
    - List Selected Namespaces
      140
    - Add Subject in Namespace
      140
    - Delete Subject in Namespace
      141
    - List All Subjects in Namespace
      142
    - List Selected Subjects in a Namespace
      142
    - Add Mapping for Given Subject Into Namespace
      143
    - Deleting Mapping from Namespace
      144
    - List Subject Mapping
      145
    - Get Mapping Resolution Mode
      146
    - Set Notification
      147
- Group Administration API
  148
  - Grouping rules
    148
  - Class GroupAdminFactory
    149
    - Constructor
      149
    - create
      150
    - Delete
      150
  - GroupMember
    151
  - Class GroupAdmin - Group Administration API
    151
    - Add Members
      151
    - Delete Members
      153
    - Delete All Members
      154
    - Move Members
      155
    - List Members
      157
    - List Groups
      158
    - Clone Members
      159
    - Clone All Members
      161
    - Clone Groups
      162
    - Rename Group
      162
    - isMember
      164
    - List Parents
      164
    - Set Notification
      165
  - Partial-complete Operation Upon Failure
    166
- Notification API
  167
  - Class GroupChangeNotification
    167
    - GroupChangeNotification
      167
    - startNotification
      167
    - stopNotification
      168
  - Class NamespaceChangeNotification
    168
    - NamespaceChangeNotification
      168
    - startNotification
      168
    - stopNotification
      169
  - Class NotificationHandler
    169
  - Class DataChangeInfo
    170
  - Class GroupChangeInfo
    170
  - Class NamespaceChangeInfo
    173
- Dynamic Grouping of Devices
  173
- Synchronization Between Publishers and Subscribers
  174
- NSM Clients in Cisco Configuration Engine
  174
  - Event Gateway
    174
  - Intelligent Modular Gateway
    174
  - Configuration Server
    174
- NSM Support for Hierarchical Groups
  175
  - Model Change
    175
    - Advantages
      175
    - Disadvantage
      175
  - Schema Changes
    175
- Mapping Scenarios
  176
  - Example
    176
  - Terminology
    176
  - NSM Mapping Rules
    177
  - Mapping Scenarios
    177
    - Algorithmic Mode
      177
    - Non-algorithmic Mode
      179
- C++ Error Codes
  180
  - ErrorInfo
    183
  - MemberElementInfo
    184
  - ReturnObject
    184
- Namespace Administration API Reference
  185
  - C++ Version
    185
  - Java Version
    187
  - Properties Supported
    190
- Group Administration API Reference
  191
  - C++ Version
    191
  - Java Version
    192
  - Properties Supported
    195
- Notification API Reference
  196
  - C++ Version
    196
  - Java Version
    198
Device Administration Interface API
201
- Setup
  201
  - Solaris Java Environment
    201
  - Solaris C++ environment
    201
- Software Architecture
  202
- Sequence of Operations
  202
  - Remote Implementation
    202
- End User Interface
  203
  - Status of Operations
    203
  - Thread Safety
    204
  - Class Transport
    204
    - Get Transport Type
      204
    - Get Transport Identifier
      204
  - Class CNSAgentTransport
    204
    - Constructor
      204
  - Class AgentProxyTransport
    205
    - Constructor
      205
    - Set Gateway ID
      205
    - Get Gateway ID
      205
    - Set Hop Info
      206
    - Get Hop Info
      206
  - Class HopInfo
    206
    - Constructor
      206
    - Set Hop Type
      207
    - Set IP Address
      207
    - Set Port
      207
    - Set Username
      207
    - Set Password
      208
    - Get Hop Type
      208
    - Get IP Address
      208
    - Get Port
      208
    - Get Username
      208
    - Get Password
      209
  - Class AgentProxyConfiguration
    209
    - Add Error Pattern
      209
    - Delete Error Pattern
      209
    - Get Error Pattern
      210
    - Add Ignore Pattern
      210
    - Delete Ignore Pattern
      210
    - Get Ignore Pattern
      210
  - Class DeviceServiceAttribute
    211
    - Get Service Type
      211
    - Register Service
      211
    - Unregister Service
      211
    - Set Service Transport
      212
    - Get Service Transport
      212
    - Set Device Identifier
      212
    - Get Device Identifier
      213
    - Set Device Password
      213
    - Get Device Password
      213
  - Class ConfigurationAttributes
    214
    - Set Template
      214
    - Add Template
      214
    - Get Template
      214
    - Delete Template
      215
  - Class CNSDevice
    215
    - Constructor
      215
    - Get Device Type
      215
    - Get Device Identifier
      216
    - Get Device Name
      216
  - Class PIXDevice
    216
    - Constructor
      216
    - Set Password
      216
    - Get Password
      216
  - Class LineCardDevice
    217
    - Constructor
      217
  - Class DeviceAdminFactory
    217
  - Class CNSDeviceManager
    220
    - CreateDevice
      220
    - CreateDevice
      220
    - CreateDevice
      220
    - CreateDevice
      221
    - Rename Device
      221
    - Get Device Type
      221
    - Set Event ID
      222
    - Get Event ID
      222
    - Set Device Attributes
      222
    - Get Device Attribute
      223
    - Delete Device Attribute
      223
    - Delete Device Object
      223
    - List Device Objects
      224
    - List Device Objects Based on Condition
      224
    - List All Device Attribute Names
      225
    - Get All Registered Services
      225
  - Class LineCardManager
    226
    - Associate Subdevice
      226
    - Disassociate Subdevice
      226
    - List Subdevices
      226
    - Get Line Card Type
      227
    - Get Parent Device
      227
  - Class ResultAttribute
    227
    - Get Attribute Name
      227
    - Get Attribute Values
      228
  - Class ResultObject
    228
    - Get Attributes
      228
    - Get Name
      228
  - Class ResultSetIterator
    229
    - Get Next Object
      229
    - Get Next n Objects
      229
- Configuration and Restrictions
  229
- Security
  230
- C++ Version of Device Interface API
  230
  - API Definition
    230
  - Return Codes
    238
- Java Version of Device Interface API
  239
  - API Signature
    239
  - Exceptions
    245
Creating Provisioning Solution
247
- Creating Provisioning Solutions
  247
DTDs for Cisco IOS Devices
257
- Event Gateway Communications
  257
IMGW API Reference
283
- IMGWDevice API
  283
  - package com.cisco.cns.imgw
    283
  - public class IMGWDevice
    283
    - Public Data Structures and Types
      283
      - static final int IMAGE_AGENT
        283
      - static final int CONFIG_AGENT
        283
    - Public Methods
      283
      - setDebug()
        283
      - IMGWDevice()
        284
      - addErrorPattern()
        284
      - deleteErrorPattern()
        284
      - getErrorPattern()
        285
      - addIgnorePattern()
        285
      - deleteIgnorePattern()
        285
      - getIgnorePattern()
        286
      - listAllDevices()
        286
      - listAllDevices()
        286
      - listAllDevices()
        287
      - listAllDevices()
        287
      - createDevice()
        288
      - createDevice()
        288
      - getDeviceType()
        289
      - addDeviceHop()
        289
      - getDeviceHop()
        289
      - deleteDevice()
        290
      - modifyDeviceHop()
        290
      - modifyDeviceHop()
        291
      - getGatewayId()
        291
      - getSimulatedAgents()
        292
- HopInfo API
  293
  - package com.cisco.cns.imgw
    293
  - public class HopInfo
    293
    - Public Methods
      293
      - HopInfo()
        293
      - HopInfo()
        293
      - setHopType()
        293
      - setIPAddr()
        294
      - setPort()
        294
      - setUserName()
        294
      - setPassword()
        294
      - getHopType()
        295
      - getIPAddr()
        295
      - getPort()
        295
      - getUserName()
        295
      - getPassword()
        296
- Exceptions
  296
Code Samples
301
- Using the Event API and the Namespace Mapper API
  301
  - C++
    301
  - Makefiles
    315
  - Java
    316
  - Common Files
    328
  - IMGW API Test Code
    328
    - testDriver.Java
      328
Sample Schema
331
- Parameter Descriptions
  331
IMGW Error Codes & Sample Source
333
- IMGW Error Code Messages
  333
- Code Sample for IMGW Device Information API
  335
Index
339

Entwickleranleitung

Größe:

7,01 MB
Seiten:

344
Language:

English

Handbuch öffnen

Größe:

202 KB
Seiten:

10
Language:

English

Handbuch öffnen

Größe:

209 KB
Seiten:

10
Language:

English

Handbuch öffnen

Größe:

208 KB
Seiten:

10
Language:

English

Handbuch öffnen