How to Use the Hardware Configuration (Hcon) API
Hcon Problem Domain
The Hardware Configuration (Hcon) package is used to intelligently select equipment to support a set of services required by a networking entity such as a device or a site. The networking entity contains one or more pieces of equipment, which themselves may contain other pieces of equipment, and so on. This type of hierarchical relationship is referred to as a “device containment hierarchy”, or DCH.
A typical DCH with 3 levels is [port–>card–>router], Port is at level 0 and router at level 2. The services of interest may be the types of traffic, protocols, and port speeds supported by the routers. The networking entity where services are aggregated to perform an Hcon-based analysis may be the router itself, or a network site, where several routers are clustered together to handle all of the traffic.
Hcon’s analysis “works up the hierarchy”, starting with the lowest level components, to find a cost-effective configuration of equipment to house all of the low-level devices (e.g., ports in the example above) needed to satisfy the required services. Cost-effectiveness is measured in terms of financial cost. Hcon tries to find the most cost-effective solution possible, but does not always guarantee that the optimal solution is provided. Hcon also determines the specific physical relationships between the selected devices (e.g., which cards are placed in which slots of each router).
Hcon can be used to solve problems such as these:
- Pick the cheapest routers which can provide 12 DS3 and 4 OC3 ports; also find out which interface cards are needed.
- Pick the cheapest routers where I can put 12 Nortel PP15K_ATM cards and 8 Nortel PP15K_FR cards; also find out which slots in the routers each card goes into.
Defining Your Networking Arsenal
Hcon analyses are data-driven to support quickly evaluating the same problem against different product lines, with no additional programming. The universe of equipment from which devices can be taken to solve an “Hcon problem” are specified in a family of simple text files called “Device Containment Relationship” (DCR) files.
A single DCR file defines which devices are available at one specific DCH level. Also, for each device, a DCR file specifies which kind and how many lower-level devices (components) it may contain. Figure 1 shows the DCR file format, which is in CSV (comma separated value) form and is easy to edit using Microsoft Excel or other spreadsheets. Concrete examples are presented immediately afterward.
Figure 1: Device Containment Relationship (DCR) File Format

In the DCR format, <device properties> is a string of properties separated by a + (plus sign), where each property takes the format <Property Name>:<Property Value>. The integers N1,N2,N3 mean the device can hold N1 components (devices that have property Property1), plus N2 components (devices that have Property2), and so on. The Icon and IPriority (icon priority) columns are used internally and can be left blank.
In the sample level-1 DCR in Table 1, the PP15K_4xDS3+2xOC8 card can support 4 DS3 ports and 2 OC48 ports, it can be inserted to any PP15K slot and its power consumption is high.
In every DCH, “level zero” devices (e.g. ports), are treated specially. They have no DCR files; they are defined implicitly by level 1 devices’ DCR files. Also, they have only one property (e.g. “Port:DS3”), their vendor is defined to be the property’s name (e.g. “Port”), and their model to be the property’s value (e.g. “DS3”).
Table 1: Sample Card DCR File (Level 1 Device)
| Vendor | Model | Cost | Properties | Icon | IPriority | Port: DS3 |
Port: OC48 |
Port: ATM |
|---|---|---|---|---|---|---|---|---|
| Nortel | PP15K_ATM | 20000 | Slot: PP15K + Power:Low | 4 | ||||
| Nortel | PP15K_FR | 20000 | Slot: PP15K + Power:Low | |||||
| Nortel | PP15K_4xDS3+2xOC48 | 20000 | Slot: PP15K + Power:High | 4 | 2 |
In the sample level-2 DCR in Table 2, the Passport 1500 router has 40 slots for cards which have property Slot:PP15K, so a maximum of 40 PP15K_4xDS3+2xOC48 cards can be housed in it.
If a router has 10 slots, but 2 of these are used by mandatory routing processor cards, then in the DCR file the 2 routing processor cards’ cost should be included in the router’s cost and the router should be defined as having only 8 slots available.
Table 2: Sample Router DCR File (Level 2 Device)
| Vendor | Model | Cost | Properties | Icon | Icon Priority | Slot: PP15K | Slot: OPMetro 3500 |
|---|---|---|---|---|---|---|---|
| Nortel | Passport 15000 | 236000 | Weight: Medium | rtr_nortel | 1 | 40 | |
| Nortel | OPTera Metro 3500 | 27000 | Weight: Heavy | rtr_nortel | 1 | 40 |