Export Routes

The ability to export routes facilitates the exchange of information in a text editable format. It also supplements the analysis of routes and plan file objects. For example, you could export demand routes using link to determine which links are used by demands. Since you can export routes that changed due to failure states, you can fine-tune your analysis of how failures impact the network.

This section contains these topics:

Route tables

You can export routes using the Cisco Crosswork Planning UI or as a CLI job in Job Manager.

This tool creates one of these tables, depending on what you are exporting. The table generated is output to a .txt file containing only this table. This exported route file is accessible from My user space > All files.

  • <DemandHops>

  • <LSPHops>

  • <LSPPathHops>

  • <ShortestIGPPathHops>

  • <ShortestLatencyPathHops>

  • <ShortestTEPathHops>

  • <CircuitStyleLSPPathHops>

Optionally, you can fail objects prior to exporting their routes and then export only the routes that changed due to that failed state.

Output table column details

The key columns in the exported table are a combination of the key column identified for its object type plus a Step column. The Step column is an integer that identifies the sequence of this hop in the route path. For example, the <Demands> table has key columns of Name, Source, Destination, and ServiceClass. Therefore, the <DemandHops> table has these four columns to uniquely identify the demand, plus a Step column to identify the hop sequence.

Each exported hops table includes these columns to specify details of the hop and its position with respect to other hops in the route.

  • UnresolvedHop: identifies the hop type and complete definition. For example, if{cr1.atl|to_cr1.hst} means this hop is an interface with a source node of cr1.atl and an egress interface of to_cr1.hst.

  • PreviousStep: identifies the previous step or steps in the route. As such, this identifies the previous hop in the route. For example, if you are on the row corresponding to Step 4, and the PreviousStep is 2, then the previous hop is contained in the row corresponding to Step 2. If the PreviousStep column is empty, then this is the first hop in the route.

  • NextStep: identifies the next step in that table. As such, this identifies the next hop in the route. If the NextStep column is empty, then this is the last hop in the route.

  • TrafficProportion: identifies the proportion of traffic on this hop compared to the other hops in the route. Although this value is usually 1, in case of ECMP routing, it could be less than 1.


Note

Routes of demands might be split to account for ECMP routing or multicast. Therefore, demand hops might not be listed sequentially as a hop could be followed by two next hops as the route and traffic split into two.

Example: Export route tables

is an example <LSPHops> table that was created using active LSPs with interface hops. The cr2.par_cr1.fra LSP has no interface hops in its route. In the table, it has only one step and no previous or next steps. The cr1.ams_cr1.par LSP has three interface hops (steps 1, 2, and 3) between source (cr1.ams) and destination (cr1.par).

Table 1. Example <LSPHops> table

Name

Source

Destination

Step

UnresolvedHop

Previous Step

Next Step

Traffic Proportion

cr2.par_cr1.fra

cr2.par

cr1.fra

1

if{cr2.par|{to_cr1.fra}}

1

cr1.ams_cr1.par

cr1.ams

cr1.par

1

if{cr1.ams | to_cr2.lon}}

2

1

cr1.ams_cr1.par

cr1.ams

cr1.par

2

if{cr2.lon|{to_cr1.lon}}

1

3

1

cr1.ams_cr1.par

cr1.ams

cr1.par

3

if{cr1.lon|{to_cr1.par}}

2

1

Export routes

Hops tables are created for the object selected in the Export Routes page. For example, if you select Demands, Cisco Crosswork Planning creates a <DemandHops> table containing all demands in the plan file.

If you want to export routes only for those objects whose route changed due failure state, fail all relevant objects before exporting the routes and select the Only export routes changed by failure state option. Alternatively, you can run the Simulation analysis tool and then fail one or more objects to the worst-case failure. For more information, see Evaluate Impact of Worst-Case Failures.

You can also use the Export routes CLI tool to export routes to the hops table. For details on using the CLI tools, see Run tools or initializers using CLI.

Procedure

Step 1

Open the plan file (see Open plan files). It opens in the Network Design page.

Step 2

From the toolbar, choose Actions > File > Export > Routes.

The Export Routes page opens.

Step 3

From the Object drop-down list, select the object for which you want to export routes.

Step 4

From the Hop type drop-down list, select the hop type that you want to export.

Step 5

If exporting only routes that changed due to a failure, select the Only export routes changed by failure state option.

Step 6

In the File name field, enter the file name for the output file. By default, the planfile.object format is used as the file name.

Step 7

Click Submit.

The exported file is saved under Network Design > My user space > All files.

Step 8

Navigate to Network Design > My user space > All files and download the exported file to your local machine.

  • Click the name of the exported file, or

  • Use the > Download option under the Actions column.