cc/td/doc/product/rtrmgmt/bacbba/bacbba25
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

ServiceProvisioning.idl
Interface List
Module ServiceProvisioning
Interface ProvisionMgr

ServiceProvisioning.idl


Interface List

The file ServiceProvisioning.idl contains the following interface:

ServiceProvisioning::ProvisionMgr

Module ServiceProvisioning

The ServiceProvisioning module encapsulates the interface ProvisionMgr and related data structures needed for a service request.

Data Structures and Types

FeatureData Structure

A FeatureData object encapsulates information on a service feature.

Usage
struct FeatureData
{
string feature_name;
string operation_type;
NVPairSeq feature_parameters;
NEInfoSeq network_elements;
};
Members

feature_name—name of service feature.

operation_type—the operation to be performed for this service feature (for example ADD, DELETE). If empty string then the default operation type of service request is the operation type for this service feature. Refer to description of default_operation_type of ServiceRequest struct for details. This field is used to retrieve the associated template and template data for this service feature.

feature_parameters—a list of name-value pairs which specifies any configuration parameters for this service feature.

network_elements—list of network elements that this service feature will be "performed" on (i.e. adding, deleting).

FeatureDataSeq User Defined Type

The FeatureDataSeq type defines the list of FeatureData objects.

Usage
typedef sequence<FeatureData> FeatureDataSeq

NEInfo Structure

An NEInfo object encapsulates information on a network element to be passed into a service request.

Usage
struct NEInfo
{
string id;
string tag;
string model;
string type;
string subtype;
NVPairSeq config_param;
};
Members

id—fully distinguished name of the device.

tag—any string that can be understood by specific application of SPM.

model—the model of the device (for example 2421/3660/827).

type—the device type (for example CPE/ROUTER).

subtype—the device subtype (for example DSL).

config_param—a name-value pair list that specifies any configuration parameters that are specific to this device.

NEInfoSeq User Defined Type

The NEInfoSeq type defines the list of NEInfo objects.

Usage
typedef sequence<NEInfo> NEInfoSeq

NVPairSeq User Defined Type

The NVPairSeq type re-defines the NVPairSeq type defined in the module CommonDefinition for convenience.

Usage
typedef CommonDefinition::NVPairSeq NVPairSeq

ResultInfo User Defined Type

The ResultInfo type re-defines the ResultInfo type defined in the module CommonDefinition for convenience.

Usage
typedef CommonDefinition::ResultInfo ResultInfo

SecurityToken User Defined Type

The SecurityToken type re-defines the SecurityToken type defined in the module CommonDefinition for convenience.

Usage
typedef SecurityService::SecurityToken SecurityToken

ServiceRequest Structure

The ServiceRequest data structure.

Usage
struct ServiceRequest
{
string service_category_id;
string request_reference_id;
string description;
string operator_id;
string technology_type;
string default_operation_type;
string customer_id;
NVPairSeq service_parameters;
FeatureDataSeq service_feature_list;
};
Members

service_category_id—identifies the service profile to be used.

request_reference_id—identifier to reference a related request,for example, to reference a request ID of a previous "Add Service" request (for the "Delete Service" operation). This reference id need not be unique. This is for the purpose of easy identification of a service request from the user's perspective. The system just uses this for logging purpose only.

description—text description of the request.

operator_id—operator ID, for logging purpose.

technology_type—the technolgy type of the solution network this request applies to, for example VoIP network, ContentSwitch network, MobileWireless network.

default_operation_type—The default operation type is the operation type for a service feature unless the service feature (see FeatureData struct) explicitly defines its own operation type (for example ADD, MODIFY, DELETE service, or empty).

customer_id—customer ID, identifies the customer for this provision request.

service_parameters—global parameters associated with the service request.

@param service_feature_list--list of service features to be provisioned. If the same feature_name and operation_type is repeated in the sequence the parameters for the later combination overwrites the one from previous combination.

Description

ServiceRequest: data related to provisioning a service in the network, including service category and its associated features to be provisioned, the applicable network domain (for example, Content Switch network, voice over IP network, mobile wireless), and global parameters for all the features defined in the service category

Interface ProvisionMgr

Interface ProvisionMgr provides the operation for service provisioning.

Operations

process_provision_request()

The process_service_request method is responsible for processing the service request.

Usage
ResultInfo process_provision_request(
in SecurityToken security_token,
in ServiceRequest prov_request,
out long request_id);
Parameters

security_token—Security token for authentication and authorization purpose.

prov_request—Service Request informations.

request_id—Service request id returned by the server

Returns

ResultInfo—returns the result of the process request.

Raises

No exception is raised by this operation.

Description

Upon successful, this method returns a ResultInfo object with major_code = 0 (SPM Module), minor_code = 0 (Success) and msg_text contains return data if any. If failure, the returned ResultInfo object has major_code and minor code and msg_text indicating the module from which the error was raised.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Wed May 21 08:17:49 PDT 2003
All contents are Copyright © 1992--2003 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.