Cisco DCNM Web Services API Guide, Release 4.2
RouteMapApp Service
Downloads: This chapterpdf (PDF - 95.0KB) The complete bookPDF (PDF - 7.93MB) | Feedback

RouteMapApp Service

Table Of Contents

RouteMapApp Service

Information About RouteMapApp Service

addRouteMapEntries

createRouteMaps

deleteRouteMaps

getAllRouteMapConfiguredNetworkElements

getRouteMapEntry

getRouteMapPolicyInNetworkElement

getRouteMaps

getRouteMapsInNetworkElement

getRouteMapsInNetworkElementByName

modifyRouteMapEntries

modifyRouteMaps

removeRouteMapEntries


RouteMapApp Service


This chapter describes the DCNM web services' API methods for the RouteMapApp service.

Information About RouteMapApp Service

Route maps allow you to set up policies for policy-based routing, route filtering, and redistributing routes between routing domains. Route maps are used to filter routes distributed across various routing protocols and between different entities within a given routing protocol. The route-map clients can be categorized into two types: the route-filtering clients (Layer 3 routing protocols) and the policy-based routing (PBR) clients such as IP and IPv6.

In policy-based routing, policy routes can forward a packet to a specified next hop based on the source of the packet or other fields in the packet header. Policy routes can be linked to extended IP access lists so that routing might be based on such things as protocol types and port numbers.

Route maps control the redistribution of routes between routing domains. The attributes of the routes can be configured in the route map to allow only those routes that match the selection criteria to be redistributed. The route attributes can also be modified during this redistribution.

Route-map entries consist of a list of match and set criteria. The match criteria specify the match conditions for incoming routes and the set criteria specify the action taken if the match criteria are met. Multiple route maps can be defined with the same mapname. Maps with the same mapname are differentiated by a sequence number. When a route map is applied as a redistribution policy, the redistributed routes are matched against each route-map entry. If a route matches the criteria defined in a route-map entry, the actions defined in the entry are executed. If the route does not match the criteria, it is matched against subsequent route-map entries. Route processing continues until a match is made or the route is processed by all instances of the route map with no match. If the route is processed by all instances of a route map with no match, the route is not accepted (inbound route maps) or forwarded (outbound route maps).

APIs are defined with the following categories:

RouteMap match

RouteMap Set

addRouteMapEntries

Add more RouteMap entry to RouteMap.

Following validations will be done

1. Instance of RouteMap exist for the VDC

Parameters

routeMapInstanceNameId—InstanceNameId of the RouteMap.

routeMapEntryCol—List of RouteMapEntry objects to be added to the RouteMap.

Return Value

List of RouteMapEntry created.

createRouteMaps

Create RouteMap instance.

Following validations will be done

1. Instance of RouteMap does not exist for the VDC

Parameters

neInstanceNameId—InstanceNameId of VDC

routeMapCol—List of RouteMap objects to create RouteMap instances.

Return Value

List of InstanceNameId of RouteMaps created.

deleteRouteMaps

Removes RouteMap

Parameters

routeMapInstanceNameIdCol—List of InstanceNameId of RouteMap

Return Value

void

getAllRouteMapConfiguredNetworkElements

Deprecated.

Returns list of RouteMap configured network elements in the network. This method will return neIds of VDCs that have at least one RouteMap configured. No associations will be populated in this API, only neIds will be returned by this API.

Return Value

List of network elements (@link instanceNameIds)

getRouteMapEntry

Deprecated.†

Returns RouteMapEntry objects corresponding to RouteMap name in a network element.

Following associations will be available for each RouteMapEntry :

1. {RouteMapMatchCondition}

2. {RouteMapAction}

Parameters

routeMapInstanceNameId—RouteMap InstanceNameId of network element for which RouteMap Entries are to be queried.

Return Value

List of RouteMapEntry for a given RouteMap name.

getRouteMapPolicyInNetworkElement

Deprecated.†

Returns list of RouteMap configured within the network element.

Parameters

neInstanceNameId—Instance name ID of network element for which RouteMap are to be queried.

Return Value

List of RouteMap InstanceNameId created in the network element (@link name)

getRouteMaps

Returns list of RouteMap configured within the network element.

Following associations will be available for each RouteMap :

1. {RouteMapEntry}

2. {RouteMapMatchCondition}

3. {RouteMapAction}

Parameters

routeMapNameInstanceNameIdCol—List of instanceNameId of the RouteMap objects.

Return Value

List of RouteMap objects from the network element (@link name)

getRouteMapsInNetworkElement

Returns list of RouteMap configured within the network element.

Following associations will be available for each RouteMap :

1. {RouteMapEntry}

2. {RouteMapMatchCondition}

3. {RouteMapAction}

Parameters

neInstanceNameId—Instance name ID of network element for which RouteMap are to be queried.

Return Value

List of RouteMap objects created in the network element (@link name)

getRouteMapsInNetworkElementByName

Returns list of RouteMap configured within the network element.

Following associations will be available for each RouteMap :

1. {RouteMapEntry}

2. {RouteMapMatchCondition}

3. {RouteMapAction}

Parameters

neInstanceNameId—Instance name ID of network element for which RouteMap are to be queried.

routeMapNameCol—List of RouteMap Names for which to query RouteMap object.

Return Value

List of RouteMap objects created in the network element (@link name)

modifyRouteMapEntries

Modify RouteMapEntry in RouteMap.

Parameters

routeMapEntryCol—List of RouteMapEntry objects to be added

Return Value

void

modifyRouteMaps

Modify RouteMaps.

Following validations will be done

1. Instance of RouteMap exist for the VDC

Parameters

routeMapCol—List of RouteMap objects to be modified.

Return Value

List of RouteMaps modified.

removeRouteMapEntries

Removes one or more RouteMapEntry

Parameters

routeMapEntryInstanceNameIdCol—List of InstanceNameId of RouteMapEntry

Return Value

void