router/mpls/autobw-template

Configures, retrieves and modifies an autobandwidth template.

Resource URIs


URI	Description
<base_URI>/config/running/router/mpls/autobw-template	Configures, retrieves and modifies an autobandwidth template.


GET URIs	Description
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-interval	Displays the time interval after which the LSP bandwidth should be adjusted.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold	Displays the adjustment threshold.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/min-bandwidth	Displays the minimum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/max-bandwidth	Displays the maximum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/overflow-limit	Displays the overflow limit.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/underflow-limit	Displays the underflow limit.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/mode	Displays mode value. Allowed values: monitor-only or monitor-and-signal
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/sample-recording	Displays whether sample recording is enabled or disabled.


POST URIs	Payload	Description
<base_URI>/config/running/router/mpls	<autobw-template><autobw-template-name>{string}</autobw-template-name></autobw-template>	Cpnfigures an Auto-bandwidth template


PATCH URIs	Payload	Description
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><adjustment-interval>{uint32}</adjustment-interval></autobw-template>	Configures the time interval after which the LSP bandwidth should be adjusted.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold	<adjustment-threshold><threshold-percentage>{uint32}</threshold-percentage></adjustment-threshold>	Configures the adjustment threshold.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold	<adjustment-threshold><use-threshold-table>true</use-threshold-table></adjustment-threshold>	Sets the status of use-threshold-table to true.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><min-bandwidth>{uint32}</min-bandwidth></autobw-template>	Configures the minimum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><max-bandwidth>{uint32}</max-bandwidth></autobw-template>	Configures the maximum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><overflow-limit>{uint32}</overflow-limit></autobw-template>	Sets the overflow limit.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><underflow-limit>{uint32}</underflow-limit></autobw-template>	Sets the underflow limit.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><mode>{autobw-mode}</mode></autobw-template>	Sets mode value. Allowed values: monitor-only or monitor-and-signal
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}	<autobw-template><sample-recording>{enable-disable}</sample-recording></autobw-template>	Enables or disables sample recording.


PUT URIs	Payload	Description
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-interval	<adjustment-interval>{uint32}</adjustment-interval>	Configures the time interval after which the LSP bandwidth should be adjusted.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold/threshold-percentage	<threshold-percentage>{uint32}</threshold-percentage>	Configures the adjustment threshold.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold/use-threshold-table	<use-threshold-table>true</use-threshold-table>	Sets the status of use-threshold-table to true.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/max-bandwidth	<max-bandwidth>{uint32}</max-bandwidth>	Configures the maximum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/min-bandwidth	<min-bandwidth>{uint32}</min-bandwidth>	Configures the minimum bandwiidth value in kbps.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/mode	<mode>{autobw-mode}</mode>	Sets mode value. Allowed values: monitor-only or monitor-and-signal .
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/overflow-limit	<overflow-limit>{uint32}</overflow-limit>	Sets the overflow limit.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/sample-recording	<sample-recording>{enable-disable}</sample-recording>	Enables or disables sample recording.
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/underflow-limit	<underflow-limit>{uint32}</underflow-limit>	Sets the underflow limit.


DELETE URIs
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-interval
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/adjustment-threshold
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/max-bandwidth
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/min-bandwidth
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/mode
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/overflow-limit
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/sample-recording
<base_URI>/config/running/router/mpls/autobw-template/{autobw-template-name}/underflow-limit

Parameters

adjustment-interval: Time interval after which the LSP bandwidth should be adjusted. Range: 300 - 2592000(30 days) seconds. Default: 86400 sec (1 day).
adjustment-threshold: Bandwidth will be adjusted only if percentage difference of Max-Sample-bandwidth w.r.t current bandwidth is greater than this value. Range 0-100%. Deafult 0%
max-bandwidth: The LSP bandwidth can never be greater than this value. In case the traffic-eng max-rate is configured, max-bandwidth cannot be configured to be greater than the traffic-eng max-rate. Range 0 - 2147483647 kbps. Default 2147483647 kbps.
min-bandwidth: The LSP bandwidth can never be lower than this value. Range 0 - 2147483647 kbps. Default 0 kbps.
mode: Allowed values: monitor-only or monitor-and-signal. If the mode is set to monitor-only, the adjustment of bandwidth will be disabled and only the rate info will be collected. Default: monitor-and-signal
overflow-limit: The least number of times the sampled-BW should consecutively overflow adjustment-threshold to trigger premature adjustment. Range: 0 - 65535. Default: 0 (never adjust for limit overflow).
underflow-limit: Sets the number of samples that must be below the threshold to trigger a premature adjustment for primary path. Range: 0 - 65535. Default: 0 (meaning there is no premature adjustment because of underflow).

Usage Guidelines

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

Examples

URI

The following example uses the GET option to display the details of auto-bandwidth template "aaa".

http://host:80/rest/config/running/router/mpls/autobw-template/aaa

None

<autobw-template xmlns="urn:brocade.com:mgmt:brocade-mpls" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/router/mpls/autobw-template/aaa">
  <autobw-template-name>aaa</autobw-template-name>
  <adjustment-interval>1800</adjustment-interval>
  <adjustment-threshold y:self="/rest/config/running/router/mpls/autobw-template/aaa/adjustment-threshold">
  </adjustment-threshold>
  <min-bandwidth>5000</min-bandwidth>
</autobw-template>

URI

The following example uses the POST option to create an auto-bandwidth template called "aaa".

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

<autobw-template><autobw-template-name>aaa</autobw-template-name></autobw-template>

None

URI

The following example uses the DELETE option to remove auto-bandwidth template "aaa".

http://host:80/rest/config/running/router/mpls/autobw-template/aaa

None