Cisco Cisco Prime Network Services Controller 3.0 Developer's Guide
Page 9
OL-28369-01
The API model is recursively driven and provides major functionality for application development. For example,
changes can be made on a single object, an object subtree, or the entire object tree. Changes can be made to a
single attribute on an object or applied to the entire Prime Network Services Controller structure with a single API
call.
changes can be made on a single object, an object subtree, or the entire object tree. Changes can be made to a
single attribute on an object or applied to the entire Prime Network Services Controller structure with a single API
call.
The API operates in forgiving mode. Missing attributes are substituted with default values (if applicable) that are
maintained in the DME. If multiple managed objects (such as policies) are being configured, and any of the
managed objects cannot be configured, the API stops the operation, returns the configuration to its prior state, and
then stops the API process with a fault notification.
maintained in the DME. If multiple managed objects (such as policies) are being configured, and any of the
managed objects cannot be configured, the API stops the operation, returns the configuration to its prior state, and
then stops the API process with a fault notification.
The API leverages an asynchronous operations model to improve scalability and performance. Processes that
require time to complete are nonblocking or asynchronous. This means that faster API processes are not blocked
or delayed by those that require more time. A process receives a success message upon a valid request and a
completion message when the task is finished.
require time to complete are nonblocking or asynchronous. This means that faster API processes are not blocked
or delayed by those that require more time. A process receives a success message upon a valid request and a
completion message when the task is finished.
Full event subscription is supported. Prime Network Services Controller sends notifications to all subscribers for the
events that occur (such as changes to managed objects), and indicates the type of state change.
events that occur (such as changes to managed objects), and indicates the type of state change.
Future updates to the managed object data model will conform to the existing object model to ensure backward
compatibility. If existing properties are changed during a product upgrade, it will be handled during the database
load after the upgrade. New properties will be assigned default values.
compatibility. If existing properties are changed during a product upgrade, it will be handled during the database
load after the upgrade. New properties will be assigned default values.
Prime Network Services Controller uses a model-driven architecture, where changes are first applied to logical
constructs in the form of managed objects. The managed objects then apply the changes to the endpoints to
achieve the required state (that is, configuration) of the endpoint.
constructs in the form of managed objects. The managed objects then apply the changes to the endpoints to
achieve the required state (that is, configuration) of the endpoint.
Operation of the API is transactional and terminates on a single data model. Prime Network Services Controller is
responsible for all endpoint (ASA 1000V, VSG, and VSM) communication (such as state updates). API users
cannot communicate directly with endpoints, which relieve the users from administering isolated, individual
component configurations.
responsible for all endpoint (ASA 1000V, VSG, and VSM) communication (such as state updates). API users
cannot communicate directly with endpoints, which relieve the users from administering isolated, individual
component configurations.
The Prime Network Services Controller API model includes the following programmatic entities:
●
Classes
—Objects and their properties and states in the management information tree.
●
Methods
—Actions that the API performs on one or more objects.
●
Types
—Collections or ranges of allowed values for object properties. A typical request comes into a service
component’s DME and is placed in the transactor queue in first-in, first-out (FIFO) order. The transactor
gets the request from the queue, interprets the request, and performs an authorization check. When the
request is confirmed, the transactor updates the management information tree. This process is done in a
single transaction.
gets the request from the queue, interprets the request, and performs an authorization check. When the
request is confirmed, the transactor updates the management information tree. This process is done in a
single transaction.
Prime Network Services Controller Data Model Schema
The data model HTML documents and schemas for all Prime Network Services Controller service providers are
packaged with the Prime Network Services Controller server and can be accessed from either of the following
URLs:
packaged with the Prime Network Services Controller server and can be accessed from either of the following
URLs:
●
https://Prime Network Services Controller-ip-address/doc, which includes:
- core
- policy-mgr
- resource-mgr
- service-reg
●
https://Prime Network Services Controller-ip-address/schema, which includes:
- core.in.xsd
—Management controller configuration APIs and data model.
- core.out.xsd
—Management controller query APIs and data model.
- policy-mgr.in.xsd
—Policy manager configuration APIs and data model.
- policy-mgr.out.xsd
—Policy manager query APIs and data model.
- resource-mgr.in.xsd
—Resource manager configuration APIs and data model.
- resource-mgr.out.xsd
—Resource manager query APIs and data model.
- service-reg.in.xsd
—Service registry configuration APIs and data model.
- service-reg.out.xsd
—Service registry query APIs and data model.