Manuali utente per Cisco Cisco Configuration Engine 3.0

Cisco

(English)Dépliant (English)Guida Dello Sviluppatore (English)

Dépliant

Sommario

Dimensioni:

1,12 MB
Pagine:

37
Language:

English

Apri il manuale

Guida Dello Sviluppatore

Sommario

Cisco Configuration Engine Software Development Kit API Reference and Programmer Guide
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
  32
  - 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
    - bulkUpload
      107
  - Types
    108
  - Notes
    109
  - Example Scenarios
    109
    - Background
      109
      - Data Management
        109
      - Objects
        109
    - Scenario One
      110
      - Objective
        110
      - Assumptions
        110
      - Preconditions
        110
      - Steps
        110
      - Notes
        111
    - Scenario Two
      112
      - Objective
        112
      - Assumptions
        112
      - Preconditions
        112
      - Steps
        112
    - Sample Bulkupload Files
      113
  - Image Web Service WSDL
    115
- Spreadsheet Bulk Upload
  131
Namespace Administration, Group Administration, and Notification APIs
133
- Namespace Administration API
  133
  - Class NamespaceAdminFactory
    133
    - Constructor
      134
    - Create
      134
    - Delete
      134
  - Class NamespaceAdmin
    135
    - Add Namespace
      135
    - Namespace Deletion
      135
    - Clone Namespace
      136
    - List All Namespaces
      137
    - List Selected Namespaces
      138
    - Add Subject in Namespace
      138
    - Delete Subject in Namespace
      139
    - List All Subjects in Namespace
      140
    - List Selected Subjects in a Namespace
      140
    - Add Mapping for Given Subject Into Namespace
      141
    - Deleting Mapping from Namespace
      142
    - List Subject Mapping
      143
    - Get Mapping Resolution Mode
      144
    - Set Notification
      145
- Group Administration API
  146
  - Grouping rules
    146
  - Class GroupAdminFactory
    147
    - Constructor
      147
    - create
      148
    - Delete
      148
  - GroupMember
    149
  - Class GroupAdmin - Group Administration API
    149
    - Add Members
      149
    - Delete Members
      151
    - Delete All Members
      152
    - Move Members
      153
    - List Members
      155
    - List Groups
      156
    - Clone Members
      157
    - Clone All Members
      159
    - Clone Groups
      160
    - Rename Group
      160
    - isMember
      162
    - List Parents
      162
    - Set Notification
      163
  - Partial-complete Operation Upon Failure
    164
- Notification API
  165
  - Class GroupChangeNotification
    165
    - GroupChangeNotification
      165
    - startNotification
      165
    - stopNotification
      166
  - Class NamespaceChangeNotification
    166
    - NamespaceChangeNotification
      166
    - startNotification
      166
    - stopNotification
      167
  - Class NotificationHandler
    167
  - Class DataChangeInfo
    168
  - Class GroupChangeInfo
    168
  - Class NamespaceChangeInfo
    171
- Dynamic Grouping of Devices
  171
- Synchronization Between Publishers and Subscribers
  172
- NSM Clients in Cisco Configuration Engine
  172
  - Event Gateway
    172
  - Intelligent Modular Gateway
    172
  - Configuration Server
    172
- NSM Support for Hierarchical Groups
  173
  - Model Change
    173
    - Advantages
      173
    - Disadvantage
      173
  - Schema Changes
    173
- Mapping Scenarios
  174
  - Example
    174
  - Terminology
    174
  - NSM Mapping Rules
    175
  - Mapping Scenarios
    175
    - Algorithmic Mode
      175
    - Non-algorithmic Mode
      177
- C++ Error Codes
  178
  - ErrorInfo
    181
  - MemberElementInfo
    182
  - ReturnObject
    182
- Namespace Administration API Reference
  183
  - C++ Version
    183
  - Java Version
    185
  - Properties Supported
    188
- Group Administration API Reference
  189
  - C++ Version
    189
  - Java Version
    190
  - Properties Supported
    193
- Notification API Reference
  194
  - C++ Version
    194
  - Java Version
    196
Device Administration Interface API
199
- Setup
  199
  - Solaris Java Environment
    199
  - Solaris C++ environment
    199
- Software Architecture
  200
- Sequence of Operations
  200
  - Remote Implementation
    200
- End User Interface
  201
  - Status of Operations
    201
  - Thread Safety
    202
  - Class Transport
    202
    - Get Transport Type
      202
    - Get Transport Identifier
      202
  - Class CNSAgentTransport
    202
    - Constructor
      202
  - Class AgentProxyTransport
    203
    - Constructor
      203
    - Set Gateway ID
      203
    - Get Gateway ID
      203
    - Set Hop Info
      204
    - Get Hop Info
      204
  - Class HopInfo
    204
    - Constructor
      204
    - Set Hop Type
      205
    - Set IP Address
      205
    - Set Port
      205
    - Set Username
      205
    - Set Password
      206
    - Get Hop Type
      206
    - Get IP Address
      206
    - Get Port
      206
    - Get Username
      206
    - Get Password
      207
  - Class AgentProxyConfiguration
    207
    - Add Error Pattern
      207
    - Delete Error Pattern
      207
    - Get Error Pattern
      208
    - Add Ignore Pattern
      208
    - Delete Ignore Pattern
      208
    - Get Ignore Pattern
      208
  - Class DeviceServiceAttribute
    209
    - Get Service Type
      209
    - Register Service
      209
    - Unregister Service
      209
    - Set Service Transport
      210
    - Get Service Transport
      210
    - Set Device Identifier
      210
    - Get Device Identifier
      211
    - Set Device Password
      211
    - Get Device Password
      211
  - Class ConfigurationAttributes
    212
    - Set Template
      212
    - Add Template
      212
    - Get Template
      212
    - Delete Template
      213
  - Class CNSDevice
    213
    - Constructor
      213
    - Get Device Type
      213
    - Get Device Identifier
      214
    - Get Device Name
      214
  - Class PIXDevice
    214
    - Constructor
      214
    - Set Password
      214
    - Get Password
      214
  - Class LineCardDevice
    215
    - Constructor
      215
  - Class DeviceAdminFactory
    215
  - Class CNSDeviceManager
    218
    - CreateDevice
      218
    - CreateDevice
      218
    - CreateDevice
      218
    - CreateDevice
      219
    - Rename Device
      219
    - Get Device Type
      219
    - Set Event ID
      220
    - Get Event ID
      220
    - Set Device Attributes
      220
    - Get Device Attribute
      221
    - Delete Device Attribute
      221
    - Delete Device Object
      221
    - List Device Objects
      222
    - List Device Objects Based on Condition
      222
    - List All Device Attribute Names
      223
    - Get All Registered Services
      223
  - Class LineCardManager
    224
    - Associate Subdevice
      224
    - Disassociate Subdevice
      224
    - List Subdevices
      224
    - Get Line Card Type
      225
    - Get Parent Device
      225
  - Class ResultAttribute
    225
    - Get Attribute Name
      225
    - Get Attribute Values
      226
  - Class ResultObject
    226
    - Get Attributes
      226
    - Get Name
      226
  - Class ResultSetIterator
    227
    - Get Next Object
      227
    - Get Next n Objects
      227
- Configuration and Restrictions
  227
- Security
  228
- C++ Version of Device Interface API
  228
  - API Definition
    228
  - Return Codes
    236
- Java Version of Device Interface API
  237
  - API Signature
    237
  - Exceptions
    243
DTDs for Cisco IOS Devices
245
- Event Gateway Communications
  245
Creating Provisioning Solution
271
- Creating Provisioning Solutions
  271
IMGW API Reference
281
- IMGWDevice API
  281
  - package com.cisco.cns.imgw
    281
  - public class IMGWDevice
    281
    - Public Data Structures and Types
      281
      - static final int IMAGE_AGENT
        281
      - static final int CONFIG_AGENT
        281
    - Public Methods
      281
      - setDebug()
        281
      - IMGWDevice()
        282
      - addErrorPattern()
        282
      - deleteErrorPattern()
        282
      - getErrorPattern()
        283
      - addIgnorePattern()
        283
      - deleteIgnorePattern()
        283
      - getIgnorePattern()
        284
      - listAllDevices()
        284
      - listAllDevices()
        284
      - listAllDevices()
        285
      - listAllDevices()
        285
      - createDevice()
        286
      - createDevice()
        286
      - getDeviceType()
        287
      - addDeviceHop()
        287
      - getDeviceHop()
        287
      - deleteDevice()
        288
      - modifyDeviceHop()
        288
      - modifyDeviceHop()
        289
      - getGatewayId()
        289
      - getSimulatedAgents()
        290
- HopInfo API
  291
  - package com.cisco.cns.imgw
    291
  - public class HopInfo
    291
    - Public Methods
      291
      - HopInfo()
        291
      - HopInfo()
        291
      - setHopType()
        291
      - setIPAddr()
        292
      - setPort()
        292
      - setUserName()
        292
      - setPassword()
        292
      - getHopType()
        293
      - getIPAddr()
        293
      - getPort()
        293
      - getUserName()
        293
      - getPassword()
        294
- Exceptions
  294
Code Samples
299
- Using the Event API and the Namespace Mapper API
  299
  - C++
    299
  - Makefiles
    313
  - Java
    314
  - Common Files
    326
  - IMGW API Test Code
    326
    - testDriver.Java
      326
Sample Schema
329
- Parameter Descriptions
  329
IMGW Error Codes & Sample Source
331
- IMGW Error Code Messages
  331
- Code Sample for IMGW Device Information API
  333

Guida Dello Sviluppatore

Dimensioni:

6,91 MB
Pagine:

342
Language:

English

Apri il manuale

Dimensioni:

152 KB
Pagine:

8
Language:

English

Apri il manuale