Description of the Provisioning Library. More...

Description of the Provisioning Library.

Description of Prov MSO.

Any physical, logical resource(s) in a system that needs to be configured from north bound interface(SNMP,CLI) has to be modeled as Prov MSO in COR. Prov MSO can have one or more instances and has a corresponding associated OI. An OI is a component/process which implements given Prov MSO.

Modeling Prov MSO and associating with corresponding OI

IDE provides a way to model Prov MSO and also to associate given Prov MSO(s) to given OI(s). IDE provides a way to associate all the Prov MSO instances to given OI(s) or associate set of Prov MSO instances to given OI(s). Those associations are captured in <nodeInstanceName>_rt.xml file. This files can be found in $ASP_CONFIG folder.

Prov MSO attribute characteristics

Each MO attribute has the following characteristics:

Type associated with attribute values:
Prov MSO supporting signed/unsigned char, signed/unsigned short, signed/unsigned int, signed/unsigned int64.
Default value
Qualifier
Sub Qualifiers

The qualifiers supported are:
Every attribute must be qualified as a CONFIG, RUNTIME or KEY attribute - the qualifiers are mutually exclusive.

Configuration attribute

A configuration attribute is always persisted and cached. The following sub- qualifiers (either singly or in any combination) can be associated with a configuration attribute:

The INITIALIZED sub-qualifier indicates that a value must be specified for this attribute when the object is created. This sub qualifier may not be set in the definition of a configuration attribute, which includes a default value for the attribute.
The WRITABLE sub-qualifier indicates that the attribute can be modified at run time.
The MULTI-VALUED sub-qualifier indicates that the attribute can take on multiple values.

Run-time attribute

A runtime attribute is not persisted or cached by default. Runtime attributes are not allowed to take on the writable or initialized sub-qualifiers. The following sub-qualifiers (either singly or in any combination) can be associated with a runtime attribute:

The PERSISTENT sub-qualifier for runtime attributes indicates that the attribute must be stored in a persistent manner by the COR Service.
The CACHED sub-qualifier for runtime attribute indicates that the attribute must be cached by the COR service
The MULTI-VALUED sub-qualifier indicates that the attribute can take on multiple values.

Runtime attributes are used for data provided by Object Implementers. They are 'read only' from North bound interface.

A runtime attribute that is cached will be updated by the Object Implementer whenever the value has changed.
A read request on such a runtime attribute will be honored from the cache.
On the other hand, a read request on a runtime attribute that is not cached will trigger a synchronous request to the Object Implementer who is expected to return with the value of the attribute.

Managing life cycle of Prov MSO: Prov MSO objects can be created when its corresponding OI comes up. During modeling through IDE, there is an option to specify whether the Prov MSO should be created or not when Provisioning library is initialized.

Provisioning Library provides two APIs to create/delete Prov MSO at run time.

Create Prov MSO at run time clProvObjectCreate().
Delete Prov MSO at run time clProvObjectDelete().

Prov MSO change notification

Any change in Prov MSO will be notified using following call back functions.

cl<OIName><MSOName>ProvConstructor()
cl<OIName><MSOName>ProvDestructor()
cl<OIName><MSOName>ProvValidate()
cl<OIName><MSOName>ProvUpdate()
cl<OIName><MSOName>ProvRollback()

The above functions are generated by IDE. Those functions can be found in $ASP_MODEL/$ASP_MODEL_NAME/app/<OIName>/cl<OIName><MSOName>.c file. User can fill in their bussiness logic inside those functions.

cl<OIName><MSOName>ProvConstructor() callback function is called when Prov MSO is created. cl<OIName><MSOName>ProvDestructor() callback function is called when given Prov MSO is deleted.

Any change in configuration attributes are informed to OI by using two phase transaction. cl<OIName><MSOName>ProvValidate function will be called first. In this function can have a logic to validate the value of the changed configuration attribute. This function return success or failure based on its logic. In case if it returns non-success value, Provisioning Library will call cl<OIName><MSOName>ProvRollback function. In this function can have a logic to release any resource which are allocalted in cl<OIName><MSOName>ProvValidate function. In case of success of cl<OIName><MSOName>ProvValidate function, cl<OIName><MSOName>ProvUpdate function will called.

Pre-Provisioning

Provisioning Library provides a way to pre-configure Prov MSO even before OI is running. When Provisioning Library is being initialized, it finds out the Prov MSOs managed by the OI to which it is linked. If the Prov MSOs are already created then it pulls the information from COR and informs the OI. This activity happens when clProvInitialize function is called which is called just before calling OI clAppInitalize function.