Description of mpls.conf

The mpls.conf file contains configuration parameters that you edit to customize
discovery. The parameters are a subset of attributes that are defined for the MPLS topology manager (“MPLS-Manager” object) in the
MPLS Topology Server
environment.
You use the parameters in this file to accomplish such tasks as:
  • Disabling the discovery of LSP, Layer 2 VPN, or Layer 3 VPN objects.
  • Prohibiting command line interface (CLI) discovery for certain devices.
  • Specifying one or more
    IP Availability Manager
    s as topology sources for the
    MPLS Topology Server
    .
  • Enabling the MPLS-BGP cross-domain correlation feature.
    Each parameter entry in the mpls.conf file is commented-out (preceded with a # character) and is set to its non-default value. To change a parameter to its non-default value, remove the preceding # character from the associated parameter entry.
    Parameters in the mpls.conf file describes the parameters in the mpls.conf file. The parameters and their values are case-sensitive.
    A description of the parameter to enable LSP load balancing discovery follows this table.
Parameters in the mpls.conf file
Parameter
Value
Description
Discovery options
Disable_Light_Discovery
TRUE,FALSE
Default: FALSE
Controls whether the
MPLS Topology Server
imports (1) just MPLS-enabled router and switch objects or (2) all router and switch objects from
IP Availability Manager
.
  • A value of TRUE indicates that the
    MPLS Topology Server
    imports all router and switch objects. The server also imports the containment and connectivity objects that are associated with the imported router and switch objects.
  • A value of FALSE indicates that the
    MPLS Topology Server
    imports just the MPLS-enabled router and switch objects that are contained in an MPLS topology collection set named MPLS-System. The server also imports the containment and connectivity objects that are associated with the imported router and switch objects.
SkipLSPDiscovery
TRUE,FALSE
Default: FALSE
Controls whether traffic engineering (TE) tunnels and label switched paths (LSPs) are discovered.
  • A value of TRUE indicates that TE tunnels and LSPs are not discovered.
  • A value of FALSE indicates that TE tunnels and LSPs are discovered.
Four things to note about the SkipLSPDiscovery parameter:
  • When this parameter is FALSE (default), the
    MPLS Topology Server
    discovers the following LSP-related objects:
    - TE tunnels
    - TE LSPs
    - Point-to-multipoint (P2MP) LSPs
    - subLSPs
    - Label Distribution Protocol (LDP) LSPs
    - LSPHops for TE LSPs, subLSPs, and LDP LSPs
  • When this parameter is TRUE, the
    MPLS Topology Server
    does not discover LSP-related objects.
  • If this parameter was previously FALSE (default), and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing all LSP-related objects from its repository.
  • If this parameter was previously TRUE, and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering LSP-related objects and adding them to its repository.
The procedure for initiating a discovery or rediscovery is presented in the
.
SkipVPNDiscovery
TRUE,FALSE
Default: FALSE
Controls whether Layer 2 and Layer 3 VPNs are discovered.
  • A value of TRUE indicates that Layer 2 and Layer 3 VPNs are not discovered.
  • A value of FALSE indicates that Layer 2 and Layer 3 VPNs are discovered.
Six things to note about the SkipVPNDiscovery parameter:
  • When this parameter is FALSE (default),
    and an L2VPN license is available, the L2VPN_ENABLED parameter is TRUE, and the L2VPN_CREATE_VPN parameter is TRUE
    , the
    MPLS Topology Server
    discovers Layer 2 VPN objects.
  • When this parameter is FALSE (default),
    and an L3VPN license is available
    , the
    MPLS Topology Server
    discovers Layer 3 VPN objects.
  • When this parameter is TRUE, the
    MPLS Topology Server
    does not discover Layer 2 and Layer 3 VPN objects.
  • If this parameter was previously FALSE (default), and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing all Layer 2 and Layer 3 VPN objects from its repository.
  • If this parameter was previously TRUE, and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering Layer 2 and Layer 3 VPN objects and adding them to its repository.
StopAutoAMSync
TRUE,FALSE
Default: FALSE
Controls whether the
MPLS Topology Server
automatically performs a topology synchronization to import topology from
IP Availability Manager
whenever
IP Availability Manager
completes a discovery cycle.
  • A value of TRUE indicates that automatic topology synchronization does not occur.
  • A value of FALSE indicates that automatic topology synchronization does occur.
“Disabling automatic topology synchronization” on page 45
clarifies the use of the StopAutoAMSync parameter.
LSRMIBUseFilter
Regular expression
Default: ““ (empty string)
Excludes certain Cisco devices from MIB discovery of MPLS-LSR-MIB and MPLS-LSR-STD-MIB. The LSRMIBUseFilter parameter was added to the mpls.conf file in response to the Cisco advisory for TAC case CSCef37186.
You can use the wildcards described in Appendix A, “Wildcard Patterns,” to specify matching patterns for the LSRMIBUseFilter parameter. For example:
LSRMIBUseFilter = "*-pe-*.net|128.12*.*.*|apic*"
For any discovered Cisco device that has a name that matches this filter, MIB discovery of MPLS-LSR-MIB and MPLS-LSR-STD-MIB is not used; instead, CLI discovery is used. The CLI command is
show mpls forwarding brief
.
For any discovered Cisco device that has a name that does not match this filter, MIB discovery of MPLS-LSR-MIB and MPLS-LSR-STD-MIB is used.
By default, because LSRMIBUseFilter is set to an empty string, no devices will match the filter, which means that, by default, MIB discovery of MPLS-LSR-MIB and MPLS-LSR-STD-MIB is used for all discovered Cisco devices.
Options
Regular expression
Default: ““ (empty string)
Enables the use of the “DiscoverRouteMaps” option when discovering VPN routing and forwarding (VRF) instances. To activate this option, uncomment the following entry in the mpls.conf file:
Options = “DiscoverRouteMaps”
As further explanation:
  • For Options = ““ (default), the
    MPLS Topology Server
    uses the following CLI command to discover VRFs:
    show route-map
  • For Options = “DiscoverRouteMaps”, the
    MPLS Topology Server
    uses the following CLI command to discover VRFs:
    show route-map application DiscoverRouteMaps
VRF_IF_NOIPOVERLAP
TRUE,FALSE
Default: FALSE
Controls whether the
MPLS Topology Server
uses interface criteria,
in addition
to route target (RT) criteria, to associate a discovered CE-VRF with a PE-VRF, for the purpose of including the CE-VRF in the VPN to which the CE-VRF belongs.
A CE-VRF is a VRF on a multi-VRF CE, and a PE-VRF is a VRF on a PE.
  • A value of TRUE indicates that
    uses CE-VRF and PE-VRF interfaces to match a discovered CE-VRF to a PE-VRF
    when no RT values are available for the CE-VRF
    .
  • A value of FALSE indicates that
    does not use CE-VRF and PE-VRF interfaces to match a discovered CE-VRF to a PE-VRF when no RT values are available for the CE-VRF.
If no RT values are available for the discovered CE-VRFs, and assuming that no overlapping IP addresses exist among the VRF interfaces, you should set this parameter to TRUE. Otherwise, you should accept the default.
CLI options
CLIProhibitType
CLI_AGENTADDRESS,CLI_SYSTEMNAME
Default: CLI_AGENTADDRESS
Determines the
type
of filter to use for the CLI filter that is specified for the CLIProhibitPattern parameter; valid values are CLI_AGENTADDRESS and CLI_SYSTEMNAME.
  • If IP addresses are specified for CLIProhibitPattern, set CLIProhibitType to CLI_AGENTADDRESS (default).
  • If names are specified for CLIProhibitPattern, set CLIProhibitType to CLI_SYSTEMNAME.
“Prohibiting CLI discovery for certain devices” on page 46
clarifies the use of this parameter and the CLIProhibitPattern parameter.
CLIProhibitPattern
Regular expression
Default: ““ (empty string)
Prohibits the CLI discovery for certain devices. Use wildcards, described in Appendix A, “Wildcard Patterns,” to specify ranges of IP addresses or ranges of names.
CLIProhibitPattern is an exclusive-type filter. Any device that matches the filter is excluded from CLI discovery, and any device that does not match the filter is included in CLI discovery.
By default, because CLIProhibitPattern is set to an empty string, no devices will match the filter, which means that, by default, CLI discovery is available for all devices.
L2VPN options
L2VPN_ENABLED
TRUE,FALSE
Default: TRUE
Controls whether L2VPNs are discovered.
  • A value of TRUE indicates that L2VPNs are discovered.
  • A value of FALSE indicates that L2VPNs are not discovered.
Four things to note about the L2VPN_ENABLED parameter:
  • When this parameter is TRUE (default), and an L2VPN license is available, the SkipVPNDiscovery parameter is FALSE, and the L2VPN_CREATE_VPN parameter is TRUE, the
    MPLS Topology Server
    discovers the following L2VPN-related objects:
    - VPNs (Layer 2)
    - Forwarders
    - ForwarderEndpoints
    - PseudoWires
  • When this parameter is FALSE, the
    MPLS Topology Server
    does not discover L2VPN-related objects.
  • If this parameter was previously TRUE (default), and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing all L2VPN-related objects from its repository.
  • If this parameter was previously FALSE, and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering L2VPN-related objects and adding them to its repository.
L2VPN_CREATE_VPN
TRUE,FALSE
Default: TRUE
Controls whether Layer 2 VPN objects are discovered.
  • A value of TRUE indicates that a Layer 2 VPN object is created for each discovered L2VPN.
  • A value of FALSE indicates that a Layer 2 VPN object is not created for any discovered L2VPN.
Four things to note about the L2VPN_CREATE_VPN parameter:
  • When this parameter is TRUE (default),
    and an L2VPN license is available, the SkipVPNDiscovery parameter is FALSE, and the L2VPN_ENABLED parameter is TRUE
    , the
    MPLS Topology Server
    discovers Layer 2 VPN and Forwarder objects (see note).
  • When this parameter is FALSE, the
    MPLS Topology Server
    does not discover Layer 2 VPN and Forwarder objects.
  • If this parameter was previously TRUE (default), and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing all Layer 2 VPN objects from its repository.
  • If this parameter was previously FALSE, and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering Layer 2 VPN and Forwarder objects and adding them to its repository.
    Layer 2 VPN and Forwarder objects are created during the postprocessing phase of the discovery process. The creation of Forwarder objects depends on the creation of Layer 2 VPN objects: When Layer 2 VPN objects are created, Forwarder objects are created. Conversely, when Layer 2 VPN objects are not created, Forwarder objects are not created.
ENABLE_TARGETED_LDP_SESSION
TRUE,FALSE
Default: TRUE
Controls whether targeted LDP sessions are discovered.
  • A value of TRUE indicates that targeted LDP sessions are discovered: An LdpAdjacency object and two LdpProtocolEndpoint objects are created for each discovered pair of targeted LDP protocol endpoint peers.
  • A value of FALSE indicates that targeted LDP sessions are not discovered.
ENABLE_NON_TARGETED_LDP_SESSION
TRUE,FALSE
Default: TRUE
Controls whether non-targeted LDP sessions are discovered.
  • A value of TRUE indicates that non-targeted LDP sessions are discovered: An LdpAdjacency object and two LdpProtocolEndpoint objects are created for each discovered pair of non-targeted LDP protocol endpoint peers.
  • A value of FALSE indicates that non-targeted LDP sessions are not discovered.
ENABLE_RSVP_SESSION
TRUE,FALSE
Default: TRUE
Controls whether Resource Reservation Protocol (RSVP) sessions are discovered.
  • A value of TRUE indicates that RSVP sessions are discovered: An RsvpSession object and two RsvpProtocolEndpoint objects are created for each discovered pair of RSVP protocol endpoint peers.
  • A value of FALSE indicates that RSVP sessions are not discovered.
ASSOCIATE_LSP_TO_LDP
TRUE,FALSE
Default: TRUE
Controls whether a LayeredOver relationship is created between a discovered LDP LSP that is layered over one or more discovered TE LSPs.
  • A value of TRUE indicates that the LayeredOver relationship is created.
  • A value of FALSE indicates that the LayeredOver relationship is not created.
If LDP LSPs are tunneled over TE LSPs in your MPLS network, you should accept the default value for this parameter. Doing so will enable the
MPLS Analysis Server
to perform impact analysis between the TE LSPs and the layered-over LDP LSPs.
ENABLE_XD_EBGP
TRUE,FALSE
Default: FALSE
Controls whether exterior BGP (eBGP) sessions are discovered. An eBGP session is between two BGP peers in different autonomous systems.
  • A value of TRUE indicates that eBGP sessions are discovered.
  • A value of FALSE indicates that eBGP sessions are not discovered.
Two things to note about the ENABLE_XD_EBGP parameter:
  • If this parameter was previously FALSE (default), and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering AutonomousSystem, BGPService, BGPProtocolEndpoint, and BGPSession objects for the eBGP sessions.
  • If this parameter was previously TRUE, and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing from its repository all BGPProtocolEndpoint and BGPSession objects (if any) (but not Autonomous System and BGPService objects) that were previously discovered for the eBGP sessions.
“Enabling MPLS-BGP cross-domain correlation” on page 47
clarifies the use of this parameter.
ENABLE_XD_IBGP
TRUE,FALSE
Default: FALSE
Controls whether interior BGP (iBGP) sessions are discovered. An iBGP session is between two BGP peers in the same autonomous system.
  • A value of TRUE indicates that iBGP sessions are discovered.
  • A value of FALSE indicates that iBGP sessions are not discovered.
Two things to note about the ENABLE_XD_IBGP parameter:
  • If this parameter was previously FALSE (default), and you set it to TRUE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by discovering AutonomousSystem, BGPService, BGPProtocolEndpoint, and BGPSession objects for the iBGP sessions. The
    MPLS Topology Server
    will also identify BGP route reflectors.
  • If this parameter was previously TRUE, and you set it to FALSE, initiate a rediscovery of the topology. The
    MPLS Topology Server
    will respond by removing from its repository all AutonomousSystem, BGPService, BGPProtocolEndpoint, and BGPSession objects (if any) that were previously discovered for the iBGP sessions.
“Enabling MPLS-BGP cross-domain correlation” on page 47
clarifies the use of this parameter.
General options
EnableRtMisconfig
TRUE,FALSE
Default: TRUE
Controls whether the RouteTarget misconfiguration event is enabled or disabled.
  • A value of TRUE indicates that the RouteTarget misconfiguration event is enabled.
  • A value of FALSE indicates that the RouteTarget misconfiguration event is disabled.
Syslog options
SyslogName
Regular expression
Default: ““ (empty string)
Not currently used
Trace options
TraceSNMPInstrumentation
TRUE,FALSE
Default: FALSE
Not currently used
TraceEvents
TRUE,FALSE
Default: FALSE
Not currently used
TraceSetting
TRUE,FALSE
Default: FALSE
Not currently used
TraceTraps
TRUE,FALSE
Default: FALSE
Not currently used
TraceSyslog
TRUE,FALSE
Default: FALSE
Not currently used
Instances of AM Server
InChargeDomain::   InChargeDomain_INCHARGE-AM {
Type = "AM"
DomainName = "INCHARGE-AM"
DisplayName = "INCHARGE-AM"
}
As shown
Note that this object and its attributes are not commented-out.
The default
IP Availability Manager
from which the
MPLS Topology Server
in this
deployment is to import topology.
“Adding IP Availability Manager as a source” on page 44
clarifies the use of this object and its attributes.
Instances of BGP Server
InChargeDomain::   InChargeDomain_INCHARGE-BGP {
Type = "BGP"
DomainName = "INCHARGE-BGP"
DisplayName = "INCHARGE-BGP"
}
As shown
Note that this object and its attributes are commented-out.
The default
from which the
MPLS Topology Server
in this
deployment is to import topology.
“Enabling MPLS-BGP cross-domain correlation” on page 47
clarifies the use of this object and its attributes.
To enable the discovery of LSP load balancing, add the following parameter and value to the mpls.conf file:
EnableLoadBalancingLSP = TRUE
By default, the discovery is disabled.