Method and apparatus for provisioning network devices using instructions in extensible markup language

• US 7,054,924 B1
• Filed: 09/29/2000
• Issued: 05/30/2006
• Est. Priority Date: 09/29/2000
• Status: Active Grant

• Current Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Original Assignee: Cisco Technology, Inc. (Cisco Systems, Inc.)
• Inventors: Harvey, Andrew, Mohammad, Ikramullah, Kao, Tohru, Pereira, Leo
• Primary Examiner(s): Dharia, Rupal
• Assistant Examiner(s): Nguyen, Quang N.
• Application Number:
  US09/675,921
• Time in Patent Office: 2,069 Days
• Field of Search: 709220-222, 709226-229, 709202-203, 709223-224, 709/206, 370/519, 707/10
• US Class Current: 709/220
• CPC Class Codes: H04L 67/025 for remote control or remote monitoring of applications
• CPC Class Codes: H04L 67/125 involving control of end-device applications over a network
• CPC Class Codes: H04L 67/303 Terminal profiles

Abstract

A method is disclosed for carrying out network device provisioning and configuration, and communication of other information to a network device, automatically and in an assured manner. A configuration service receives a request from a network device to provide configuration information. The configuration service retrieves a template representing the configuration from a storage location, e.g., a directory service. The configuration service also retrieves one or more parameter values specific to the device. Device-specific values are instantiated for the generic parameters in the template, based on the retrieved values. The resulting configuration is stored in XML format using XML tags to delimit configuration commands, tested for well-formed-ness, and syntax checked. A reliable transport protocol carries the configuration information to the device. At the device, a configuration agent syntax checks the embedded configuration information, and then applies the configuration information to the device. As a result, automatic network provisioning may be accomplished remotely, without requiring a skilled technician to visit customer premises to carry out configuration. The process may be integrated with an event service to enable multiple devices to concurrently receive re-configuration without special synchronization logic.

Claims

1. A method of automatically configuring a network device, the method comprising the computer-implemented steps of:

receiving a request from the network device to provide configuration information;

retrieving a template describing a device configuration, wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may receive values specific to a particular device;

wherein each symbolic reference identifies an operation and a list of parameters for that operation;

retrieving from a repository of the plurality of values, based on the symbolic references, one or more values of parameters specific to the network device; and

creating and storing a device-specific instance of the configuration information based on the template and the values of parameters specific to said network device;

said configuration information conforming to an Extensible Markup Language Document Type Definition (XML DTD) and comprising one or more XML tags that delimit a beginning and an ending of the configuration information.

2. A method as recited in claim 1, further comprising the steps of:

testing the device-specific instance of configuration information to determine whether it is well-formed with respect to the XML DTD;

providing the device-specific instance of configuration information to the network device.

3. A method as recited in claim 1, further comprising the steps of:

testing the device-specific instance of configuration information to determine whether it is well-formed with respect to the XML DTD;

providing the device-specific instance of configuration information to the network device over a reliable transport protocol, wherein the network device ensures that all of the configuration information is received by checking the one or more XML tags that delimit a beginning and an ending of configuration information.

4. A method as recited in claim 2, further comprising the step of:

at the network device,

syntax checking only configuration commands of the device-specific instance of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device;

applying the device-specific instance of configuration information to the network device.

5. A method as recited in claim 2, further comprising the step of:

at the network device,

syntax checking only configuration commands of the device-specific instance of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device;

applying the device-specific instance of configuration information to the network device;

when a syntax error is detected during the syntax checking step, publishing an event that reports the syntax error using an event service.

6. A method as recited in claim 1, further comprising the steps of:

providing the device-specific instance of configuration information to a plurality of network devices;

at one of the network devices, syntax checking only configuration commands of the device-specific instance of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device;

upon successful syntax checking, generating an event to an event service to which the plurality of network devices subscribe, wherein the event announces that the configuration commands conform to correct syntax;

in response to receiving the event, applying the device-specific instance of configuration information to the network devices concurrently.

7. A method as recited in claim 1, further comprising the steps of:

providing the device-specific instance of configuration information to a plurality of network devices;

upon successfully receiving the device-specific instance of configuration information at one of the network devices, generating an event to an event service to which the plurality of network devices subscribe;

in response to receiving the event, applying the device-specific instance of configuration information to the network devices concurrently.

8. A method as recited in claim 1, further comprising the steps of:

applying the device-specific instance of configuration information to the network device;

receiving a user request to cancel application of the configuration information;

restoring the network device to its state prior to application of the device-specific instance of configuration information.

9. A method as recited in claim 1, wherein the step of receiving a request from the network device to provide configuration information comprises the step of receiving an HTTP request that identifies a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

10. A method as recited in claim 1, wherein the step of receiving a request from the network device to provide configuration information comprises the step of receiving an HTTP request that identifies an Active Server Page of a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

11. A method as recited in claim 1, wherein the step of receiving a request from the network device to provide configuration information comprises the step of receiving an HTTP request that identifies a Java®

Servlet of a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

12. A method as recited in claim 1, wherein the step of receiving one or more values of parameters specific to the network device comprises the step of retrieving a container object associated with the network device from a directory in a directory service and obtaining the values of parameters from directory objects contained within the container object.

13. A method as recited in claim 1, wherein the step of retrieving a template comprises the steps of:

retrieving a reference to a template describing the configuration information from a directory service;

retrieving the template from a configuration server based on the retrieved reference, wherein the template comprises symbolic reference to one or more parameters that may receive values specific to a particular device, and wherein the step of receiving one or more values of parameters specific to the network device comprises the step of retrieving a container object associated with the network device from a directory in a directory service and obtaining the values of parameters from directory objects contained within the container object.

14. A method as recited in claim 5, wherein the step of syntax checking additionally comprises parsing one or more configuration commands from the device-specific instance of configuration information using a parser of an operating system that is executed by the network device.

15. The method as recited in claim 1, further comprising the steps of:

determining that a partial configuration should be sent to one or more network devices;

based on the template and the one or more values of parameters specific to the network device, creating and storing a device-specific instance of the partial configuration based on the template and the values of parameters and conforming to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit the partial configuration;

publishing the partial configuration to an event service that is communicatively coupled to the one or more network devices.

16. The method as recited in claim 1, further comprising the steps of:

determining that a partial configuration should be sent to one or more network devices;

based on the template and the one or more values of parameters specific to the network device, creating and storing a device-specific instance of the partial configuration based on the template and the values of parameters and conforming to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit the partial configuration;

publishing a partial configuration trigger event to an event service that is communicatively coupled to the one or more network devices; and

providing the partial configuration to one or more network devices in response to requests therefrom that are received in response to the trigger event.

17. A method of automatically configuring a network device, the method comprising the computer-implemented steps of:

generating a request to provide configuration information;

receiving a set of configuration information conforming to an Extensible Markup Language Document Type Definition (XML DTD), the configuration information comprising one or more XML tags that delimit a beginning and an end of the configuration information, said set of configuration information based on a template describing a device configuration that is instantiated with one or more values of parameters that are specific to the network device;

wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may receive values specific to a particular device, wherein each symbolic reference identifies an operation and a list of parameters for that operation;

syntax checking only configuration commands of the set of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device; and

applying the configuration information to the network device.

18. A method as recited in claim 17, wherein the set of configuration information is received concurrently at a plurality of network devices, and further comprising the steps of:

at one of the network devices, syntax checking only configuration commands of the set of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device;

upon successful syntax checking, generating a status event to an event service to which the plurality of network devices subscribe, wherein the status event announces that the set of configuration commands conform to correct syntax;

in response to receiving a “

write”

event, applying the set of configuration information to the network device.

19. A method as recited in claim 17, wherein the step of generating a request to provide configuration information comprises the step of generating an HTTP request that identifies a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

20. A method as recited in claim 17, wherein the step of generating a request to provide configuration information comprises the step of generating an HTTP request that identifies an Active Server Page of a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

21. A method as recited in claim 17, wherein the step of generating a request to provide configuration information comprises the step of generating an HTTP request that identifies a Java®

Servlet of a configuration service that can provide the configuration information and that includes a unique identifier of the network device.

22. A method as recited in claim 17, wherein the step of receiving a set of configuration information comprises the steps of, at a configuration server, receiving the template describing the device configuration from a directory service, wherein receiving said one or more values of parameters specific to the network device comprises retrieving a container object associated with the network device from a directory in a directory service and obtaining the values of parameters from directory objects contained within the container object.

23. A method as recited in claim 17, wherein the step of syntax checking comprises applying the configuration commands of the set of configuration information to a parser of an operating system that is executed by the network device.

24. An apparatus for automatically configuring a network device, comprising:

a configuration service configured for carrying out the steps of;

receiving, from a configuration agent executed by the network device, a request to provide configuration information;

retrieving a template describing a device configuration, wherein the template comprises symbolic reference to one of a plurality of values of one or more parameters that may be resolved into values specific to a particular device;

wherein each symbolic reference identifies an operation and a list of parameters for that operation;

retrieving from a repository of the plurality of values, based on the symbolic references, one or more values of parameters specific to the network device;

creating and storing a device-specific instance of the configuration information based on the template and the values of parameters specific to said network device and conforming to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit the configuration information, including at least one pair of XML tags that delimit a beginning and an end of the configuration information.

25. An apparatus as recited in claim 24, further comprising:

one or more configuration templates stored in a directory service, wherein each of the configuration templates comprises an object in the directory service that describes a configuration;

one or more container objects stored in the directory service and associated with the network device, each of the container objects comprising values for the one or more parameters in one of the configuration templates that corresponds to the network device.

26. A computer-readable medium carrying one or more sequences of instructions for automatically configuring a network device, which instructions, when executed by one or more processors, cause the one or more processors to carry out the steps of:

receiving a request from the network device to provide configuration information;

retrieving a template describing a device configuration, wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may be resolved into values specific to a particular device;

wherein each symbolic reference identifies an operation and a list of parameters for that operation;

retrieving from a repository of the plurality of values, based on the symbolic references, one or more values of parameters specific to the network device;

creating and storing a device-specific instance of the configuration information based on the template and the values of parameters specific to said network device and conforming to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit the configuration information, including at least one pair of XML tags that delimit a beginning and an end of the configuration information.

27. An apparatus for automatically configuring a network device, comprising:

means for receiving a request from the network device to provide configuration information;

means for retrieving a template describing a device configuration, wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may be resolved into values specific to a particular device;

wherein each symbolic reference identifies an operation and a list of parameters for that operation;

means for retrieving from a repository of the plurality of values, based on the symbolic references, one or more values of parameters specific to the network device;

means for creating and storing a device-specific instance of the configuration information based on the template and the values of parameters specific to said network device and conforming to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit the configuration information, including at least one pair of XML tags that delimit a beginning and an end of the configuration information.

28. An apparatus for automatically configuring a network device, comprising:

a network interface that is coupled to a data network for receiving one or more packet flows therefrom;

a processor;

one or more stored sequences of instructions which, when executed by the processor, cause the processor to carry out the steps of;

generating a request to provide configuration information;

retrieving a set of configuration information conforming to an Extensible Markup Language Document Type Definition (XML DTD), the configuration information comprising one or more XML tags that delimit a beginning and an end of the configuration information, based on a template describing a device configuration that is instantiated with one or more values of parameters that are specific to the network device;

wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may receive values specific to a particular device, wherein each symbolic reference identifies an operation and a list of parameters for that operation;

syntax checking only configuration commands of the set of configuration information to determine whether the configuration commands therein conform to a command language that is understood by the network device; and

applying the configuration information to the network device.

29. An apparatus for automatically configuring a network device, comprising:

a configuration agent executed by the network device and configured for carrying out the steps of;

generating a request to provide configuration information;

receiving a device-specific instance of configuration information based on a template describing a device configuration, wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may be resolved into values specific to a particular device, and based on one or more values of parameters specific to the device that are retrieved from a repository based on the symbolic references, and wherein the template conforms to an Extensible Markup Language Document Type Definition (XML DTD), comprising one or more XML tags that delimit a beginning and an end of the configuration information, wherein each symbolic reference identifies an operation and a list of parameters for that operation; and

applying the device-specific instance of configuration information to the network device to result in re-configuring the network device in accordance with the template.

30. An apparatus as recited in claim 29, further comprising:

one or more configuration templates stored in a directory service, wherein each of the configuration templates comprises an object in the directory service that describes the device configuration;

one or more container objects stored in the directory service and associated with the network device, each of the container objects comprising values for the one or more parameters in one of the configuration templates that corresponds to the network device.

31. A method of automatically configuring a computer program application that uses information about network devices or topology in order to operate in a network environment, comprising the steps of:

receiving a request for network topology information from the computer program application;

retrieving a template of network topology information from a repository;

wherein the template comprises symbolic references to one of a plurality of values of one or more parameters that may receive values specific to a particular element of the topology;

wherein each symbolic reference identifies an operation and a list of parameters for that operation;

resolving elements for the topology into application-specific values, resulting in creating and storing resolved network topology information; and

providing the resolved network topology information to a configuration agent within the application that is configured to re-configure the computer program application to operate with the resolved network topology.

32. A method as recited in claim 31, wherein resolving elements of the topology includes the step of carrying out application-specific syntax checking of elements of the template.