router/mpls/bypass-lsp

Configures, modifies or retrieves MPLS Bypass LSP information.

Resource URIs


URI	Description
<base_URI>/config/running/router/mpls/bypass-lsp	Configures, modifies or retrieves MPLS Bypass LSP information.


GET URIs	Descriptions
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	Configures, modifies or retrieves MPLS Bypass LSP information.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/to	Retrieves LSP destination address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/from	Retrieves LSP source address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/tie-breaking	Retrieves the tie breaking mode configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/adaptive	Retrieves LSP adaptive configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/reoptimize-timer	Retrieves Reoptimization timer configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/commit	Retrieves changes to adaptive LSP configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/record	Retrieves the recording path routes configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cos	Retrieves class of service.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/hop-limit	Displays the imit of hops the LSP can traverse.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cspf-computation-mode	Displays cspf-computation-mode.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering	Displays traffic engineering details.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/mean-rate	Retrieves the mean rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-rate	Retrieves the max-rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-burst	Retrieves the max-burst in bytes. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/priority	Displays priority
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/priority/lsp-hold-priority	Displays LSP-hold priority. Range is 0 to 7. Deafult is 0.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/exclude-any	Exclude any of the administrative groups.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-any	Include any of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-all	Include all of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/exclude-interface/{bypass-exclude-interface-type},{bypass-exclude-interface-name}	Displays exclude-interface status (true / false).
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/primary-path	Displays primary explicit path.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/enable	Enables a bypass lsp.


POST URIs	Payload	Description
<base_URI>/config/running/router/mpls	<bypass-lsp><bypass-lsp-name>{string}</bypass-lsp-name></bypass-lsp>	Creates bypass LSP configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<exclude-interface><bypass-exclude-interface-type>{mpls-interface-type}</bypass-exclude-interface-type><bypass-exclude-interface-name>{interface-type}</bypass-exclude-interface-name></exclude-interface>	Configures a bypass LSP.


PATCH URIs	Payload	Description
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><to>{inet:ipv4-address}</to></bypass-lsp>	Configures LSP destination address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><from>{inet:ipv4-address}</from></bypass-lsp>	Configures LSP source address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><tie-breaking>{tie-breaking}</tie-breaking></bypass-lsp>	Configures the tie breaking mode.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><adaptive>true</adaptive></bypass-lsp>	Modifies the LSP adaptive configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><reoptimize-timer>{uint32}</reoptimize-timer></bypass-lsp>	Modifies eeoptimization timer configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><commit>true</commit></bypass-lsp>	Commit the changes to adaptive LSP.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><record>{enable-disable}</record></bypass-lsp>	Enablesdisables recording path routes.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><cos>{uint32}</cos></bypass-lsp>	Updates class of service.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><hop-limit>{uint16}</hop-limit></bypass-lsp>	Updates the limit of hops which the LSP can traverse.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><cspf-computation-mode>{cspf-computation-mode}</cspf-computation-mode></bypass-lsp>	Updates cspf-computation-mode.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}//traffic-engineering	<traffic-engineering><mean-rate>{uint32}</mean-rate></traffic-engineering>	Updates mean rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering	<traffic-engineering><max-rate>{uint32}</max-rate></traffic-engineering>	Updates max rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering	<traffic-engineering><max-burst>{uint32}</max-burst></traffic-engineering>	Updates Max-burst in bytes. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/priority	<priority><lsp-setup-priority>{uint32}</lsp-setup-priority><lsp-hold-priority>{uint32}</lsp-hold-priority></priority>	Updates the lsp setup priority to include all ofthe administrative groups.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><exclude-any>{string}</exclude-any></bypass-lsp>	Excludes any of the administrative groups.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><include-any>{string}</include-any></bypass-lsp>	Includes any of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><include-all>{string}</include-all></bypass-lsp>	Includes all of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><primary-path>{string}</primary-path></bypass-lsp>	Updates a primary explicit path.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}	<bypass-lsp><enable>true</enable></bypass-lsp>	Enables a bypass LSP.


PUT URIs	PAYLOAD	Descriptions
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/to	<to>{inet:ipv4-address}</to>	Configures bypass LSP destination address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/from	<from>{inet:ipv4-address}</from>	Configures bypass LSP source address.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/tie-breaking	<tie-breaking>{tie-breaking}</tie-breaking>	Updates the tie breaking mode.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/adaptive	<adaptive>true</adaptive>	Configures bypass LSP adaptive configuration.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/reoptimize-timer	<reoptimize-timer>{uint32}</reoptimize-timer>	Configures reoptimization timer.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/commit	<commit>true</commit>	Commit the changes to adaptive LSP.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/record	<record>{enable-disable}</record>	Enable/disable recording path routes.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cos	<cos>{uint32}</cos>	Configure class of service.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/hop-limit	<hop-limit>{uint16}</hop-limit>	Configures limit of hops the LSP can traverse.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cspf-computation-mode	<cspf-computation-mode>{cspf-computation-mode}</cspf-computation-mode>	Specify cspf-computation-mode.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/mean-rate	<mean-rate>{uint32}</mean-rate>	Sets Mean rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-rate	<max-rate>{uint32}</max-rate>	Sets Max-rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-burst	<max-burst>{uint32}</max-burst>	Sets Max-burst-rate in kbps. Range is 0-2147483647.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/priority/lsp-hold-priority	<priority><lsp-setup-priority>{uint32}</lsp-setup-priority><lsp-hold-priority>{uint32}</lsp-hold-priority></priority>	Sets lsp hold priority.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/exclude-any	<exclude-any>{string}</exclude-any>	Excludes any of the administrative groups.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-any	<include-any>{string}</include-any>	Includes any of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-all	<include-all>{string}</include-all>	Includes all of the administrative groups
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/primary-path	<primary-path>{string}</primary-path>	Updates a primary explicit path.
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/enable	<enable>true</enable>	Enables a bypass LSP.


DELETE URIs
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/to
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/from
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/tie-breaking
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/adaptive
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/reoptimize-timer
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/record
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cos
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/hop-limit
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/cspf-computation-mode
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/mean-rate
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-rate
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/traffic-engineering/max-burst
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/priority/lsp-hold-priority
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/exclude-any
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-any
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/include-all
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/exclude-interface/{bypass-exclude-interface-type},{bypass-exclude-interface-name}
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/primary-path
<base_URI>/config/running/router/mpls/bypass-lsp/{bypass-lsp-name}/enable

Parameters

max-bypasses: Maximum number of dynamic bypass LSPs that can be created for this MPLS interface.
max-bypasses-per-mp: The limit for total number of dynamic bypass LSPs that can be created to a merge point.
enable-all-interfaces: Enable a dynamic bypass on all MPLS interfaces.
reoptimize-timer: Reoptimiztion timer value in seconds for the dynamic bypass LSPs. Range 30 - 65535 seconds. The default is 0, which means re-optimization is disabled.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/router/mpls/bypass-lsp/bypass1

None

<bypass-lsp xmlns="urn:brocade.com:mgmt:brocade-mpls" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/mpls/bypass-lsp/bypass1">
  <bypass-lsp-name>bypass1</bypass-lsp-name>
  <traffic-engineering y:self="/rest/config/running/router/mpls/bypass-lsp/bypass1/traffic-engineering">
  </traffic-engineering>
  <priority y:self="/rest/config/running/router/mpls/bypass-lsp/bypass1/priority">
  </priority>
</bypass-lsp>

URI

The following example uses the POST option to configure a bypass LSP, "bypass1".

http://host:80/rest/config/running/router/mpls

<bypass-lsp><bypass-lsp-name>bypass1</bypass-lsp-name></bypass-lsp>

None.

URI

The following example uses the DELETE option to remove a configured bypass LSP, "bypass1".

http://host:80/rest/config/running/router/mpls/bypass-lsp/bypass1

None