router/mpls

Configures and manages the MPLS protocol.

Resource URIs


URI	Description
<base_URI>/config/running/router/mpls	MPLS Protocol

Following are the supported URIs.

Note

There are separate sections for other MPLS APIs which are not covered in this topic.


GET URIs	Description
<BASE_URI>/config/running/router/mpls	MPLS Protocol
<BASE_URI>/config/running/router/mpls/lsp-xc-traps/enable	Enable the LSP XC up/down logging/traps
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}/penalty	Configure cspf group penalty value


POST URIs	Payload	Description
<BASE_URI>/config/running/router	<mpls />	MPLS Protocol
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}	<from><cspf-group-ip-address>{req_val}</cspf-group-ip-address></from>	Configure cspf group from ip address
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}	<link><cspf-group-link-from>{req_val}</cspf-group-link-from><to>{req_val}</to></link>	Configure cspf group from and to ip address
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}	<subnet><cspf-group-subnet-ip>{req_val}</cspf-group-subnet-ip></subnet>	Configure cspf group subnet address
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}	<node><cspf-group-node-ip>{req_val}</cspf-group-node-ip></node>	Configure cspf group node ip address
<BASE_URI>/config/running/router/mpls	<path><path-name>{req_val}</path-name></path>	Defines a path
<BASE_URI>/config/running/router/mpls/path/{path-name}	<hop><path-hop-ip>{req_val}</path-hop-ip><path-hop-type>{strict-loose-hop}</path-hop-type></hop>	Configures path strict or loose hops
<BASE_URI>/config/running/router/mpls/path/{path-name}	<insert><path-insert-ip>{req_val}</path-insert-ip><path-insert-type>{strict-loose-hop}</path-insert-type><before>{inet:ipv4-address}</before></insert>	Insert path strict or loose hops


PATCH URIs	Payload	Description
<BASE_URI>/config/running/router/mpls/lsp-xc-traps/enable	<enable />	Enable the LSP XC up/down logging/traps
<BASE_URI>/config/running/router/mpls/cspf-group	<absolute>{uint32}</absolute>	Configure Max reservable bandwidth as absolute value
<BASE_URI>/config/running/router/mpls/cspf-group	<percentage>{uint32}</percentage>	Configure Max reservable bandwidth as percentage
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}	<cspf-group><penalty>{uint32}</penalty></cspf-group>	Define a CSPF group penalty and configure cspf group penalty value
<BASE_URI>/config/running/router/mpls/path/{path-name}/hop/{path-hop-ip}	<hop><path-hop-type>{strict-loose-hop}</path-hop-type></hop>	Configure path strict or loose hops
<BASE_URI>/config/running/router/mpls/path/{path-name}/insert/{path-insert-ip}	<insert><path-insert-type>{strict-loose-hop}</path-insert-type><before>{inet:ipv4-address}</before></insert>	Insert path strict or loose hops


PUT URIs	Payload	Description
<BASE_URI>/config/running/router/mpls/lsp-xc-traps/enable	<enable />	Enable the LSP XC up/down logging/traps
<BASE_URI>/config/running/router/mpls/cspf-group	<absolute>{uint32}</absolute>	Configure cspf-group
<BASE_URI>/config/running/router/mpls/cspf-group	<percentage>{uint32}</percentage>	Bandwidth percentage when bandwidth is decreased or increased
<BASE_URI>/config/running/router/mpls/cspf-group/{cspf-group-name}/penalty	<penalty>{uint32}</penalty>	Configure cspf group penalty value

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 CSPF group configuration details.

http://host:80/rest/config/running/router/mpls/cspf-group

None

<cspf-group xmlns="urn:brocade.com:mgmt:brocade-mpls" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/mpls/cspf-group/cspf1">
  <cspf-group-name>cspf1</cspf-group-name>
</cspf-group>

URI

The following example uses the PATCH option to set the penalty value to 22.

http://host:80/rest/config/running/router/mpls/cspf-group/cspf1

<cspf-group><penalty>22</penalty></cspf-group>

None

URI

The following example uses the DELETE option to remove the penalty configuration.

http://host:80/rest/config/running/router/mpls/cspf-group/cspf1/penalty

None