Understanding Router Management Functions

The following sections discuss the different types of router management functions and what you should know to use them effectively.

All router management functions require administrator privileges. A user in the Power User group does not have sufficient privileges to use the router management functions.

The Different Classes of Router Management Functions

The router management functions can be divided up into the administration functions and the configuration functions. The administration functions have a prefix of MprAdmin and the configuration functions have a prefix of MprConfig. Despite the naming, both sets of functions are used for router management. The MprAdmin functions operate directly on the running router. The MprConfig functions have similar functionality, but operate on the router configuration stored in the registry. Both types of functions pass information blocks.

The router management functions can also be divided up based on what components of the router they manage: interfaces, router managers, or router manager clients.

The router interface functions have a prefix of either MprAdminInterface or MprConfigInterface. Use these functions to access interfaces. The router manager functions have a prefix of MprAdminTransport or MprConfigTransport. Use these functions to access the router managers. Lastly, the router manager client functions have a prefix of MprAdminInterfaceTransport or MprConfigInterfaceTransport. Use these functions to access the clients running on the router.

A subset of MprAdmin functions are the MprAdminMib functions. These also operate on the running route alone. However, these functions do not pass information blocks. These functions provide additional flexibility to the protocol designer, especially for retrieving non-configuration information, such as statistics.

Ensuring that Changes Occur Immediately and are Persistent

A developer can make changes to the router configuration directly using the router configuration functions. However, any changes made to the configuration do not take effect until the router is restarted, since this is the only time that DIM reads the configuration from the registry.

A developer can make changes to the running router by using the router administration functions. However, these changes are not persistent: since they have not been written to the registry, they are lost if the router is restarted.

In order to make changes that are both immediate and persistent, a developer needs to use both the router administration and the router configuration functions. If the router is not running, the developer need only call the appropriate router configuration functions.

For querying information from the running router, use the router administration functions. If the router is not running, query information using the router configuration functions.

The MprAdminInterfaceCreate and MprAdminInterfaceSetInfo functions support the MPR_INTERFACE_2 structure. However, MprConfigInterfaceCreate and MprConfigInterfaceSetInfo do not. In order to create a demand-dial interface that is persistent after a reboot, call MprAdminInterfaceCreate with MPR_INTERFACE_2, then call MprConfigInterfaceCreate with MPR_INTERFACE_0 or MPR_INTERFACE_1. Similarly, to make persistent changes to a demand-dial interface, call MprAdminInterfaceSetInfo with MPR_INTERFACE_2, then call MprConfigInterfaceSetInfo with MPR_INTERFACE_0 or MPR_INTERFACE_1.

Using Router Administration and Configuration Functions Remotely

Most of the router administration and configuration functions can be called on a computer other than the one being administered. These functions take as a parameter, a handle to the router service or configuration to administer. The administration functions use RPC (Remote Procedure Call) to communicate with the routing service specified by the handle. The configuration functions write to and read from the registry of the computer specified by the handle.

To administer the routing service on a remote machine first call MprAdminIsServiceRunning to verify that the service is running. Then call MprAdminServerConnect to obtain the handle. If the router service is not running on the remote machine, all router administration (MprAdmin) calls fail.

To make changes to the router configuration on a remote machine obtain a handle by calling the MprConfigServerConnect function.



Community Additions