router/mpls/policy

Resource URIs

URI Description
<base_URI>/config/running/router/mpls/policy Enters MPLS Policy configuration mode.
GET URI Description
<base_URI>/config/running/router/mpls/policy/backup-retry-time Configures Backup retry time.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/ignore-overload-bit Ignores overload bit during CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/metric-type Selects metric type for CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-group-computation/add-penalty Adds penalty of all matching CSPF-groups to TE metric of TE link.
<base_URI>/config/running/router/mpls/policy/cspf-interface-constraint Uses interface IP address for CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-metric Displays Bypass Path cost for FRR LSP backup path.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-liberal Displays information on Liberal mode of Bypass selection.
<base_URI>/config/running/router/mpls/policy/handle-isis-neighbor-down Configures MPLS to handle ISIS neighbor down event.
<base_URI>/config/running/router/mpls/policy/handle-ospf-neighbor-down Configures MPLS to handle OSPF neighbor down event.
<base_URI>/config/running/router/mpls/policy/retry-time Configures LSP retry time.
<base_URI>/config/running/router/mpls/policy/retry-limit Configures LSP retry limit.
<base_URI>/config/running/router/mpls/policy/rapid-retry Configures Rapid retry.
<base_URI>/config/running/router/mpls/policy/rsvp-periodic-flooding-time Set the interval for RSVP TE periodic flooding.
<base_URI>/config/running/router/mpls/policy/up Bandwidth percentage when bandwidth is increased.
<base_URI>/config/running/router/mpls/policy/soft-preemption/cleanup-timer Defines timer value for soft preemption to happen.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis IS-IS traffic engineering parameters.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode Configures MPLS TTL and QOS propagation model.
<base_URI>/config/running/router/mpls/policy/ingress-tunnel-accounting Enables Traffic Statistics for Tunnels.
<base_URI>/config/running/router/mpls/policy/transit-session-accounting Enables Traffic Statistics for transit sessions.
<base_URI>/config/running/router/mpls/policy/auto-bandwidth Displays auto-bandwidth details.
<base_URI>/config/running/router/mpls/policy/auto-bandwidth/sample-interval Displays sample interval: the time after which the traffic rate is sampled.
<base_URI>/config/running/router/mpls/policy/auto-bandwidth/num-sample-record Displays number of samples collected in the current adjustment-interval.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-liberal Displays information on Liberal mode of Bypass selection.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-metric Displays Bypass Path cost.
POST URIs Payload Description
<base_URI>/config/running/router/mpls <policy /> Enters MPLS Policy configuration mode.
<base_URI>/config/running/router/mpls/policy <admin-group> <admin-group-name>{req_val}</admin-group-name> <admin-group-number>{req_val}</admin-group-number> </admin-group> Sets administrative group names.
<base_URI>/config/running/router/mpls/policy <up /> Sets bandwidth percentage when bandwidth is increased.
<base_URI>/config/running/router/mpls/policy <auto-bandwidth /> Configures auto-bandwidth.
PATCH URIs Payload Description
<base_URI>/config/running/router/mpls/policy/backup-retry-time <backup-retry-time>{uint32}</backup-retry-time> Configures Backup retry time.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/ignore-overload-bit <ignore-overload-bit /> Ignores overload bit during CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode <cspf-computation-mode><use-bypass-liberal>true</use-bypass-liberal></cspf-computation-mode> Enables liberal mode.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode <cspf-computation-mode><use-bypass-metric>true</use-bypass-metric></cspf-computation-mode> Enabled bypass metric.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/metric-type <metric-type>{cspf-computation-mode}</metric-type> Selects metric type for CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-group-computation/add-penalty <add-penalty /> Adds penalty of all matching CSPF-groups to TE metric of TE link.
<base_URI>/config/running/router/mpls/policy/cspf-interface-constraint <cspf-interface-constraint /> Uses interface IP address for CSPF computation.
<base_URI>/config/running/router/mpls/policy/handle-isis-neighbor-down <handle-isis-neighbor-down /> Configures MPLS to handle ISIS neighbor down event.
<base_URI>/config/running/router/mpls/policy/handle-ospf-neighbor-down <handle-ospf-neighbor-down /> Configures MPLS to handle OSPF neighbor down event.
<base_URI>/config/running/router/mpls/policy/retry-time <retry-time>{uint32}</retry-time> Configures LSP retry time.
<base_URI>/config/running/router/mpls/policy/retry-limit <retry-limit>{uint32}</retry-limit> Configures LSP retry limit.
<base_URI>/config/running/router/mpls/policy/rapid-retry <rapid-retry>{enable-disable}</rapid-retry> Configures Rapid retry.
<base_URI>/config/running/router/mpls/policy/rsvp-periodic-flooding-time <rsvp-periodic-flooding-time>{uint32}</rsvp-periodic-flooding-time> Sets the interval for RSVP TE periodic flooding.
<base_URI>/config/running/router/mpls/policy/soft-preemption/cleanup-timer <cleanup-timer>{uint32}</cleanup-timer> Defines timer value for soft preemption to happen.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis <all><isis>{enumeration}</isis></all> Enables implicit commit for all triggers and advertises via IS-IS.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis <lsp-reoptimize-timer><isis>{enumeration}</isis></lsp-reoptimize-timer> Enables implicit commit for reoptimizations and advertises via IS-IS.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode <ospf-area-as-ip-address><qos-ttl-mode>{enumeration}</qos-ttl-mode></ospf-area-as-ip-address> MPLS TTL and QoS propagation model.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode <all><qos-ttl-mode>{enumeration}</qos-ttl-mode></all> MPLS TTL and QoS propagation model.
<base_URI>/config/running/router/mpls/policy/ingress-tunnel-accounting <ingress-tunnel-accounting /> Enables Traffic Statistics for Tunnels.
<base_URI>/config/running/router/mpls/policy/transit-session-accounting <transit-session-accounting /> Enables Traffic Statistics for transit sessions.
PUT URIs Payload Description
<base_URI>/config/running/router/mpls/policy/backup-retry-time <backup-retry-time>{uint32}</backup-retry-time> Configures Backup retry time.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/ignore-overload-bit <ignore-overload-bit /> Ignores overload bit during CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/metric-type <metric-type>{cspf-computation-mode}</metric-type> Selects metric type for CSPF computation.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-liberal <use-bypass-liberal>true</use-bypass-liberal> Enables Liberal mode of Bypass selection.
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-metric <use-bypass-metric>true</use-bypass-metric> Enable Use Bypass Path cost for FRR LSP backup path.
<base_URI>/config/running/router/mpls/policy/cspf-group-computation/add-penalty <add-penalty /> Adds penalty of all matching CSPF-groups to TE metric of TE link.
<base_URI>/config/running/router/mpls/policy/cspf-interface-constraint <cspf-interface-constraint /> Uses interface IP address for CSPF computation.
<base_URI>/config/running/router/mpls/policy/handle-isis-neighbor-down <handle-isis-neighbor-down /> Configures MPLS to handle ISIS neighbor down event.
<base_URI>/config/running/router/mpls/policy/handle-ospf-neighbor-down <handle-ospf-neighbor-down /> Configures MPLS to handle OSPF neighbor down event.
<base_URI>/config/running/router/mpls/policy/retry-time <retry-time>{uint32}</retry-time> Configures LSP retry time.
<base_URI>/config/running/router/mpls/policy/retry-limit <retry-limit>{uint32}</retry-limit> Configures LSP retry limit.
<base_URI>/config/running/router/mpls/policy/rapid-retry <rapid-retry>{enable-disable}</rapid-retry> Configures Rapid retry.
<base_URI>/config/running/router/mpls/policy/rsvp-periodic-flooding-time <rsvp-periodic-flooding-time>{uint32}</rsvp-periodic-flooding-time> Sets the interval for RSVP TE periodic flooding.
<base_URI>/config/running/router/mpls/policy/soft-preemption/cleanup-time <cleanup-timer>{uint32}</cleanup-timer> Defines timer value for soft preemption to happen.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis <all><isis>{enumeration}</isis></all> Configures traffic engineering parameters.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis <auto-bandwidth-adjustment><isis>{enumeration}</isis></auto-bandwidth-adjustment> Configures auto-bandwidth-adjustment parameters.
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis <lsp-reoptimize-timer><isis>{enumeration}</isis></lsp-reoptimize-timer> Configure Reoptimization timer.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode <ospf-area-as-ip-address><qos-ttl-mode>{enumeration}</qos-ttl-mode></ospf-area-as-ip-address> MPLS TTL and QoS propagation model.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode <ospf-area-as-decimal><qos-ttl-mode>{enumeration}</qos-ttl-mode></ospf-area-as-decimal> Configures OSPF area as decimal.
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode <all><qos-ttl-mode>{enumeration}</qos-ttl-mode></all> Configures MPLS ttl and qos propagation model.
<base_URI>/config/running/router/mpls/policy/ingress-tunnel-accounting <ingress-tunnel-accounting /> Enables Traffic Statistics for Tunnels.
<base_URI>/config/running/router/mpls/policy/transit-session-accounting <transit-session-accounting /> Enables Traffic Statistics for transit sessions.
<base_URI>/config/running/router/mpls/policy/auto-bandwidth <auto-bandwidth /> Configures auto-bandwidth
<base_URI>/config/running/router/mpls/policy/auto-bandwidth/sample-interval <sample-interval>{uint32}</sample-interval> Sets sample interval: the time after which the traffic rate is sampled.
<base_URI>/config/running/router/mpls/policy/implicit-commit/auto-bandwidth-adjustment <auto-bandwidth-adjustment>true</auto-bandwidth-adjustment> Enables auto-bandwidth adjustment.
DELETE URIs
<base_URI>/config/running/router/mpls/policy
<base_URI>/config/running/router/mpls/policy/admin-group/{admin-group-name},{admin-group-number}
<base_URI>/config/running/router/mpls/policy/backup-retry-time
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/ignore-overload-bit
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/metric-type
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-metric
<base_URI>/config/running/router/mpls/policy/cspf-computation-mode/use-bypass-liberal
<base_URI>/config/running/router/mpls/policy/cspf-group-computation/add-penalty
<base_URI>/config/running/router/mpls/policy/cspf-interface-constraint
<base_URI>/config/running/router/mpls/policy/handle-isis-neighbor-down
<base_URI>/config/running/router/mpls/policy/handle-ospf-neighbor-down
<base_URI>/config/running/router/mpls/policy/retry-time
<base_URI>/config/running/router/mpls/policy/retry-limit
<base_URI>/config/running/router/mpls/policy/rapid-retry
<base_URI>/config/running/router/mpls/policy/rsvp-periodic-flooding-time
<base_URI>/config/running/router/mpls/policy/up
<base_URI>/config/running/router/mpls/policy/soft-preemption/cleanup-timer
<base_URI>/config/running/router/mpls/policy/traffic-engineering/isis
<base_URI>/config/running/router/mpls/policy/qos-ttl-mode
<base_URI>/config/running/router/mpls/policy/ingress-tunnel-accounting
<base_URI>/config/running/router/mpls/policy/transit-session-accounting
<base_URI>/config/running/router/mpls/policy/auto-bandwidth
<base_URI>/config/running/router/mpls/policy/auto-bandwidth/num-sample-record
<base_URI>/config/running/router/mpls/policy/auto-bandwidth/sample-interval

Parameters

admin-group-name
Sets administrative group name.
admin-group-number
Admin-group number {range 0-31}.
backup-retry-time
Specifies the backup retry time. Range is from 10 to 600.
metric-type
Specifies the metric type for CSPF computation. Valid values are 1 or 2. To use IGP metric of the link for CSPF computation configure 1 and to use TE metric of the link for CSPF computation configure 2.
retryt-time
Specifies the LSP retry time. The range is from 1 to 600. The default value is 30.
retry-limit
Specifies the LSP retry limit. The range is from 0 to 8192. The default value is 65535.
rapid-retry
Enables or disables Rapid retry.
rsvp-periodic-flooding-time
Specifies the MPLS TE Periodic Flooding Timer in seconds. Valid values are 0 or between 30 to 3600.
cleanup-timer
Specifies the Soft preemption cleanup-timer in seconds. Valid values are 0 or between 30 to 300. The default is 30.
lsp-reoptimize-timer
Specifies LSP reoptimize timer. The range is from 30 to 65535.
ospf-area-as-ip-address
Specifies the OSPF area as IPv4 address.
ospf-area-as-decimal
Specifies OSPF area as a decimal. The range is from 0 to 2147483647.

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 MPLS policy configuration details.

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

None

<policy xmlns="urn:brocade.com:mgmt:brocade-mpls" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/mpls/policy">
  <cspf-computation-mode y:self="/rest/config/running/router/mpls/policy/cspf-computation-mode">
  </cspf-computation-mode>
  <cspf-group-computation y:self="/rest/config/running/router/mpls/policy/cspf-group-computation">
  </cspf-group-computation>
  <rsvp-flooding-threshold y:self="/rest/config/running/router/mpls/policy/rsvp-flooding-threshold">
  </rsvp-flooding-threshold>
  <soft-preemption y:self="/rest/config/running/router/mpls/policy/soft-preemption">
  </soft-preemption>
  <implicit-commit y:self="/rest/config/running/router/mpls/policy/implicit-commit">
  </implicit-commit>
  <traffic-engineering y:self="/rest/config/running/router/mpls/policy/traffic-engineering">
    <ospf y:self="/rest/config/running/router/mpls/policy/traffic-engineering/ospf">
      <area y:self="/rest/config/running/router/mpls/policy/traffic-engineering/ospf/area">
      </area>
    </ospf>
  </traffic-engineering>
</policy>

URI

The following example uses the POST option to configure MPLS policy.

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

<policy/>

None

URI

The following example uses the DELETE option to remove the MPLS policy configuration.

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

None

None