A Generic framework for deploying EMS provisioning services

• US 20060080424A1
• Filed: 06/10/2004
• Published: 04/13/2006
• Est. Priority Date: 06/10/2004
• Status: Active Grant

• Current Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Original Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Inventors: Ward, David D., Sun, Jiong, Ramamoorthy, Sai V., Gopal, Niraj, Raju, Satyanarayana, Yerneni, Prasad
• Granted Patent: US 7,660,882 B2
• Time in Patent Office: Days
• US Class Current: 709/223
• CPC Class Codes: H04L 41/0806 for initial configuration or provisioning, e.g. plug-and-play
• CPC Class Codes: H04L 41/0843 based on generic templates
• CPC Class Codes: H04L 41/5054 Automatic deployment of services triggered by the service manager, e.g. service implementation by automatic configuration of network components

Abstract

A method and apparatus for deploying EMS provisioning services is provided. A communication to administer a particular service on a network element is transmitted from an EMS client to an EMS server. The communication contains service data that describes a particular service to be administered on the network element. The EMS server constructs an instance of a generic record that stores the service data. The EMS server selects a service module to process the instance based on which service is associated with the service data stored in the instance. The instance is processed to produce result data that describes the result of processing the service data at the network element. The EMS server stores the result data in a persistent store. This generic framework enables communications between EMS clients and the EMS server involving different services to be processed similarly. New services are added without modification to the generic framework.

Claims

1. A machine-implemented method, comprising:

receiving, at a network element management system (“

EMS”

) server from an EMS client, a communication to administer a particular service on a network element, wherein the communication contains service data that describes the particular service to be administered on the network element, and wherein the particular service is one of a set of services;

creating and storing an instance of a generic record that comprises the service data;

determining a selected service module from a set of service modules to process the instance based on which service is associated with the service data stored in the instance, and wherein the selected service module is configured to process instances of the generic record storing service data associated with the particular service; and

processing the instance at the selected service module to produce result data that describes the result of processing the service data at the network element.

2. The method of claim 1, further comprising:

storing the result data in a persistent store.

3. The method of claim 1, further comprising:

performing generic processing on the instance, wherein the same generic processing is performed on any instance of the generic record regardless of which service is associated with service data stored by the instance.

4. The method of claim 3, wherein performing generic processing comprises:

logging information about the instance to a persistent store.

5. The method of claim 3, wherein performing generic processing comprises:

performing one or more security checks on the instance.

6. The method of claim 3, wherein performing generic processing comprises:

performing error handling on any errors associated with the instance.

7. The method of claim 3, wherein performing generic processing comprises:

logging information about the instance to a persistent store;

performing one or more security checks on the instance; and

performing error handling on any errors associated with the instance.

8. The method of claim 1, wherein the EMS client is one of a set of EMS clients, and wherein each EMS client in the set of EMS clients administers a different service in the set of services on the network element.

9. The method of claim 1, wherein creating and storing the instance of the generic record further comprises:

determining an object type of the service data; and

constructing the instance to include one or more specific methods based upon the object type.

10. The method of claim 1, wherein creating and storing the instance of the generic record further comprises:

performing a validation check on the service data to ensure that the service data confirms to a set of validation rules.

11. The method of claim 1, wherein the instance is a first instance, and wherein the processing step further comprises:

creating an outbound XML document containing the service data stored within the first instance;

transmitting the outbound XML document to the network element;

receiving a responsive XML document from the network element, wherein the responsive XML document contains the result data; and

at the EMS server, constructing a second instance containing the result data.

12. The method of claim 11, wherein storing the result data in a database comprises:

processing the second instance to retrieve the result data from the second instance.

13. The method of claim 1, wherein storing comprises:

consulting a set of information that maps fields of the generic record to specific tables in the database; and

determining how to store the result data based upon the set of information.

14. The method of claim 1, further comprising:

configuring the EMS server to support a new service in the set of services by performing;

adding a new service module to the EMS that processes instances of the generic record containing service data associated with the new service;

updating a database to accommodate data associated with the new service;

if the new service requires that instances of the generic record that contain service data associated with the new service comprise one or more special methods, then adding a constructor that creates instances of the generic record with the one or more special methods; and

updating a set of information that maps fields of the generic record to specific tables in the database to reflect where result data for the new service is stored in the database.

15. The method of claim 1, further comprising:

configuring the EMS server to support a new service by adding the new service to a list of supported services by the EMS server.

16. The method of claim 1, wherein the network element is one of one or more network elements, and further comprising:

prior to receiving the communication, the EMS server using a list of supported services to determine which services in the set of services are supported by the EMS server, wherein the list of supported services also describes which network elements in the set of one or more network elements are associated with each of the set of services;

transmitting, from the EMS server to each of the one or more network elements, a request for configuration information of the recipient of the request;

receiving, from at least one of the one or more network elements, configuration information that describes the current operational configuration of the network element which sent the configuration information; and

storing the received configuration information in the database.

17. The method of claim 1, further comprising:

defining a customizable method to process an instance storing service data associated with a specific service in the set of services.

18. The method of claim 17, further comprising:

determining if the instance stores service data associated with the specific service; and

executing the customizable method on the instance only upon determining that the instance stores service data associated with the specific service.

19. A method for provisioning a service to a network element, comprising:

deploying the service on the network element using an EMS server,

wherein the EMS server comprises a generic framework which stores service data received from an EMS client in an instance of a generic record, wherein the generic framework comprises a generic engine and a set of service modules,

wherein the EMS server using the generic engine to process the instance regardless of which service is associated with the service data, wherein the generic engine logs information about the instance, and

wherein the EMS server selects a particular service module from the set of service modules to process the instance based on which service is associated with the service data stored in the instance.

20. A machine-readable medium carrying one or more sequences of instructions, wherein execution of the one or more sequences of instructions by one or more processors causes the one or more processors to perform the steps of:

receiving, at a network element management system (“

EMS”

) server from an EMS client, a communication to administer a particular service on a network element, wherein the communication contains service data that describes the particular service to be administered on the network element, and wherein the particular service is one of a set of services;

creating and storing an instance of a generic record that comprises the service data;

determining a selected service module from a set of service modules to process the instance based on which service is associated with the service data stored in the instance, and wherein the selected service module is configured to process instances of the generic record storing service data associated with the particular service; and

processing the instance at the selected service module to produce result data that describes the result of processing the service data at the network element.

21. The machine-readable medium of claim 20, wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the step of:

storing the result data in a persistent store.

22. The machine-readable medium of claim 20, wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the step of:

performing generic processing on the instance, wherein the same generic processing is performed on any instance of the generic record regardless of which service is associated with service data stored by the instance.

23. The machine-readable medium of claim 22, wherein performing generic processing comprises:

logging information about the instance to a persistent store.

24. The machine-readable medium of claim 22, wherein performing generic processing comprises:

performing one or more security checks on the instance.

25. The machine-readable medium of claim 22, wherein performing generic processing comprises:

performing error handling on any errors associated with the instance.

26. The machine-readable medium of claim 22, wherein performing generic processing comprises:

logging information about the instance to a persistent store;

performing one or more security checks on the instance; and

performing error handling on any errors associated with the instance.

27. The machine-readable medium of claim 20, wherein the EMS client is one of a set of EMS clients, and wherein each EMS client in the set of EMS clients administers a different service in the set of services on the network element.

28. The machine-readable medium of claim 20, wherein creating and storing the instance of the generic record further comprises:

determining an object type of the service data; and

constructing the instance to include one or more specific methods based upon the object type.

29. The machine-readable medium of claim 20, wherein creating and storing the instance of the generic record further comprises:

performing a validation check on the service data to ensure that the service data confirms to a set of validation rules.

30. The machine-readable medium of claim 20, wherein the instance is a first instance, and wherein the processing step further comprises:

creating an outbound XML document containing the service data stored within the first instance;

transmitting the outbound XML document to the network element;

receiving a responsive XML document from the network element, wherein the responsive XML document contains the result data; and

at the EMS server, constructing a second instance containing the result data.

31. The machine-readable medium of claim 30, wherein storing the result data in a database comprises:

processing the second instance to retrieve the result data from the second instance.

32. The machine-readable medium of claim 20, wherein storing comprises:

consulting a set of information that maps fields of the generic record to specific tables in the database; and

determining how to store the result data based upon the set of information.

33. The machine-readable medium of claim 20, further comprising:

configuring the EMS server to support a new service in the set of services by performing;

adding a new service module to the EMS that processes instances of the generic record containing service data associated with the new service;

updating a database to accommodate data associated with the new service;

if the new service requires that instances of the generic record that contain service data associated with the new service comprise one or more special methods, then adding a constructor that creates instances of the generic record with the one or more special methods; and

updating a set of information that maps fields of the generic record to specific tables in the database to reflect where result data for the new service is stored in the database.

34. The machine-readable medium of claim 20, wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the step of:

configuring the EMS server to support a new service by adding the new service to a list of supported services by the EMS server.

35. The machine-readable medium of claim 20, wherein the network element is one of one or more network elements, and wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the steps of:

prior to receiving the communication, the EMS server using a list of supported services to determine which services in the set of services are supported by the EMS server, wherein the list of supported services also describes which network elements in the set of one or more network elements are associated with each of the set of services;

transmitting, from the EMS server to each of the one or more network elements, a request for configuration information of the recipient of the request;

living, from at least one of the one or more network elements, configuration information that describes the current operational configuration of the network element which sent the configuration information; and

storing the received configuration information in the database.

36. The machine-readable medium of claim 20, wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the step of:

defining a customizable method to process an instance storing service data associated with a specific service in the set of services.

37. The machine-readable medium of claim 36, wherein execution of the one or more sequences of instructions by the one or more processors further causes the one or more processors to perform the steps of:

determining if the instance stores service data associated with the specific service; and

executing the customizable method on the instance only upon determining that the instance stores service data associated with the specific service.

38. A machine-readable medium carrying one or more sequences of instructions for provisioning a service to a network element, wherein execution of the one or more sequences of instructions by one or more processors causes the one or more processors to perform the step of:

deploying the service on the network element using an EMS server,

wherein the EMS server comprises a generic framework which stores service data received from an EMS client in an instance of a generic record, wherein the generic framework comprises a generic engine and a set of service modules,

wherein the EMS server using the generic engine to process the instance regardless of which service is associated with the service data, wherein the generic engine logs information about the instance, and

wherein the EMS server selects a particular service module from the set of service modules to process the instance based on which service is associated with the service data stored in the instance.

39. An apparatus, comprising:

means for receiving, at a network element management system (“

EMS”

) server from an EMS client, a communication to administer a particular service on a network element, wherein the communication contains service data that describes the particular service to be administered on the network element, and wherein the particular service is one of a set of services;

means for creating and storing an instance of a generic record that comprises the service data;

means for determining a selected service module from a set of service modules to process the instance based on which service is associated with the service data stored in the instance, and wherein the selected service module is configured to process instances of the generic record storing service data associated with the particular service; and

means for processing the instance at the selected service module to produce result data that describes the result of processing the service data at the network element.

40. The apparatus of claim 39, further comprising:

means for storing the result data in a persistent store.

41. The apparatus of claim 39, further comprising:

means for performing generic processing on the instance, wherein the same generic processing is performed on any instance of the generic record regardless of which service is associated with service data stored by the instance.

42. The apparatus of claim 41, wherein the means for performing generic processing comprises:

means for logging information about the instance to a persistent store.

43. The apparatus of claim 41, wherein the means for performing generic processing comprises:

means for performing one or more security checks on the instance.

44. The apparatus of claim 41, wherein the means for performing generic processing comprises:

means for performing error handling on any errors associated with the instance.

45. The apparatus of claim 41, wherein the means for performing generic processing comprises:

means for logging information about the instance to a persistent store;

means for performing one or more security checks on the instance; and

means for performing error handling on any errors associated with the instance.

46. The apparatus of claim 39, wherein the EMS client is one of a set of EMS clients, and wherein each EMS client in the set of EMS clients administers a different service in the set of services on the network element.

47. The apparatus of claim 39, wherein the means for creating and storing the instance of the generic record further comprises:

means for determining an object type of the service data; and

means for constructing the instance to include one or more specific methods based upon the object type.

48. The apparatus of claim 39, wherein the means for creating and storing the instance of the generic record further comprises:

means for performing a validation check on the service data to ensure that the service data confirms to a set of validation rules.

49. The apparatus of claim 39, wherein the instance is a first instance, and wherein the means for processing further comprises:

means for creating an outbound XML document containing the service data stored within the first instance;

means for transmitting the outbound XML document to the network element;

means for receiving a responsive XML document from the network element, wherein the responsive XML document contains the result data; and

means for constructing, at the EMS server, a second instance containing the result data.

50. The apparatus of claim 49, wherein the means for storing the result data in a database comprises:

means for processing the second instance to retrieve the result data from the second instance.

51. The apparatus of claim 39, wherein the means for storing comprises:

means for consulting a set of information that maps fields of the generic record to specific tables in the database; and

means for determining how to store the result data based upon the set of information.

52. The apparatus of claim 39, further comprising:

means for configuring the EMS server to support a new service in the set of services by performing;

adding a new service module to the EMS that processes instances of the generic record containing service data associated with the new service;

updating a database to accommodate data associated with the new service;

if the new service requires that instances of the generic record that contain service data associated with the new service comprise one or more special methods, then adding a constructor that creates instances of the generic record with the one or more special methods; and

updating a set of information that maps fields of the generic record to specific tables in the database to reflect where result data for the new service is stored in the database.

53. The apparatus of claim 39, further comprising:

means for configuring the EMS server to support a new service by adding the new service to a list of supported services by the EMS server.

54. The apparatus of claim 39, wherein the network element is one of one or more network elements, and further comprising:

means for, prior to receiving the communication, using a list of supported services to determine which services in the set of services are supported by the EMS server, wherein the list of supported services also describes which network elements in the set of one or more network elements are associated with each of the set of services;

means for transmitting, from the EMS server to each of the one or more network elements, a request for configuration information of the recipient of the request;

means for receiving, from at least one of the one or more network elements, configuration information that describes the current operational configuration of the network element which sent the configuration information; and

means for storing the received configuration information in the database.

55. The apparatus of claim 39, further comprising:

means for defining a customizable method to process an instance storing service data associated with a specific service in the set of services.

56. The apparatus of claim 55, further comprising:

means for determining if the instance stores service data associated with the specific service; and

means for executing the customizable method on the instance only upon determining that the instance stores service data associated with the specific service.

57. An apparatus for provisioning a service to a network element, comprising:

means for deploying the service on the network element using an EMS server,

wherein the EMS server comprises a generic framework which stores service data received from an EMS client in an instance of a generic record, and wherein the generic framework comprises a generic engine and a set of service modules;

means for processing the instance regardless of which service is associated with the service data;

means for logging information about the instance, and

means for selecting a particular service module from the set of service modules to process the instance based on which service is associated with the service data stored in the instance.

58. An apparatus comprising a memory storing instructions which, when executed by one or more processors, cause the one or more processors to perform the steps of:

receiving, at a network element management system (“

EMS”

) server from an EMS client, a communication to administer a particular service on a network element, wherein the communication contains service data that describes the particular service to be administered on the network element, and wherein the particular service is one of a set of services;

creating and storing an instance of a generic record that comprises the service data;

determining a selected service module from a set of service modules to process the instance based on which service is associated with the service data stored in the instance, and wherein the selected service module is configured to process instances of the generic record storing service data associated with the particular service; and

processing the instance at the selected service module to produce result data that describes the result of processing the service data at the network element.

59. The apparatus of claim 58, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the step of:

storing the result data in a persistent store.

60. The apparatus of claim 58, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the step of:

performing generic processing on the instance, wherein the same generic processing is performed on any instance of the generic record regardless of which service is associated with service data stored by the instance.

61. The apparatus of claim 60, wherein performing generic processing comprises:

logging information about the instance to a persistent store.

62. The apparatus of claim 60, wherein performing generic processing comprises:

performing one or more security checks on the instance.

63. The apparatus of claim 60, wherein performing generic processing comprises:

performing error handling on any errors associated with the instance.

64. The apparatus of claim 60, wherein performing generic processing comprises:

logging information about the instance to a persistent store;

performing one or more security checks on the instance; and

performing error handling on any errors associated with the instance.

65. The apparatus of claim 58, wherein the EMS client is one of a set of EMS clients, and wherein each EMS client in the set of EMS clients administers a different service in the set of services on the network element.

66. The apparatus of claim 58, wherein creating and storing the instance of the generic record further comprises:

determining an object type of the service data; and

constructing the instance to include one or more specific methods based upon the object type.

67. The apparatus of claim 58, wherein creating and storing the instance of the generic record further comprises:

performing a validation check on the service data to ensure that the service data confirms to a set of validation rules.

68. The apparatus of claim 58, wherein the instance is a first instance, and wherein the processing step further comprises:

creating an outbound XML document containing the service data stored within the first instance;

transmitting the outbound XML document to the network element;

receiving a responsive XML document from the network element, wherein the responsive XML document contains the result data; and

at the EMS server, constructing a second instance containing the result data.

69. The apparatus of claim 59, wherein storing the result data in a database comprises:

processing the second instance to retrieve the result data from the second instance.

70. The apparatus of claim 58, wherein storing comprises:

consulting a set of information that maps fields of the generic record to specific tables in the database; and

determining how to store the result data based upon the set of information.

71. The apparatus of claim 58, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the step of:

configuring the EMS server to support a new service in the set of services by performing;

adding a new service module to the EMS that processes instances of the generic record containing service data associated with the new service;

updating a database to accommodate data associated with the new service;

if the new service requires that instances of the generic record that contain service data associated with the new service comprise one or more special methods, then adding a constructor that creates instances of the generic record with the one or more special methods; and

updating a set of information that maps fields of the generic record to specific tables in the database to reflect where result data for the new service is stored in the database.

72. The apparatus of claim 58, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the step of:

configuring the EMS server to support a new service by adding the new service to a list of supported services by the EMS server.

73. The apparatus of claim 58, wherein the network element is one of one or more network elements, and wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the steps of:

prior to receiving the communication, the EMS server using a list of supported services to determine which services in the set of services are supported by the EMS server, wherein the list of supported services also describes which network elements in the set of one or more network elements are associated with each of the set of services;

transmitting, from the EMS server to each of the one or more network elements, a request for configuration information of the recipient of the request;

receiving, from at least one of the one or more network elements, configuration information that describes the current operational configuration of the network element which sent the configuration information; and

storing the received configuration information in the database.

74. The apparatus of claim 58, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the step of:

defining a customizable method to process an instance storing service data associated with a specific service in the set of services.

75. The apparatus of claim 74, wherein the memory further comprises one or more additional instructions which, when executed by the one or more processors, cause the one or more processors to perform the steps of:

determining if the instance stores service data associated with the specific service; and

executing the customizable method on the instance only upon determining that the instance stores service data associated with the specific service.

76. An apparatus for provisioning a service to a network element comprising a memory storing instructions which, when executed by one or more processors, cause the one or more processors to perform the step of:

deploying the service on the network element using an EMS server,

wherein the EMS server comprises a generic framework which stores service data received from an EMS client in an instance of a generic record, wherein the generic framework comprises a generic engine and a set of service modules,

wherein the EMS server using the generic engine to process the instance regardless of which service is associated with the service data, wherein the generic engine logs information about the instance, and

wherein the EMS server selects a particular service module from the set of service modules to process the instance based on which service is associated with the service data stored in the instance.