8.4.11 Refer to bandwidth limitation rules
You can simultaneously acquire the following items of the bandwidth limitation rules created in the managed domain: the ID, rule name, domain name, maximum transmission bandwidth for uploading and downloading, and flag that indicates whether each bandwidth limitation rule is enabled. The acquired bandwidth limitation rules are output to an XML file.
- Organization of this subsection
(1) Format
DWAdminClient.bat GETBANDWIDTHRULE
-result the path of the Bandwidth Limitation Rules file
-property property-file
{-concurrenttimeout timeout time (second)}
(2) Arguments
|
No. |
Option |
Description |
|---|---|---|
|
1 |
-result |
Specifies the path to the Bandwidth Limitation Rules file. If the file does not exist, a new audit log file is created. If the file exists, the existing file is overwritten. When a space is contained in a file path, surround that file path with double quotation marks (""). |
|
2 |
-concurrenttimeout |
For details, see 8.3.2 Common options. |
|
3 |
-property |
(3) Description
(a) Format of the bandwidth limitation rules file
The format of the execution Bandwidth Limitation Rules file is as follows :
<data>
<rules>
<rule id="1" name="Refer to bandwidth limitation rules 01" cid="0" upload-limit="20" download-limit="17" avtive="true" create-time="2015-04-06T17:22:56+09:00" update-time="2015-04-27T13:29:52+09:00">
<group id="1" name="All Users"/>
<network-set id="2" name="Myself">
<networks>
<network cidr="133.108.167.127/32"/>
<network cidr="133.108.179.0/24"/>
</networks>
</network-set>
</rule>
<rule id="2" name="Refer to bandwidth limitation rules 02" cid="0" upload-limit="100" download-limit="80" avtive="true" create-time="2015-04-20T14:38:32+09:00" update-time="2015-04-20T14:38:32+09:00">
<group id="1" name="All Users"/>
<network-set id="3" name="network-set 01">
<networks>
<network cidr="133.108.179.127/32"/>
</networks>
</network-set>
</rule>
<rule id="3" name="Refer to bandwidth limitation rules 03" cid="0" upload-limit="100" download-limit="80" avtive="true" create-time="2015-04-27T13:31:12+09:00" update-time="2015-04-27T13:31:12+09:00">
<group id="1" name="All Users"/>
<network-set id="1" name="ANY">
<networks>
<network cidr="0.0.0.0/0"/>
</networks>
</network-set>
</rule>
</rules>
</data>The following table describes the elements.
|
Element/attribute |
Number of elements |
Description |
Abridgement propriety during file editing |
|
|---|---|---|---|---|
|
data Element |
1 |
Root Element. It is always outputted. |
N |
|
|
rules Element |
1 |
The bandwidth limitation rules file lisr. |
N |
|
|
rule Element |
0 or more |
The bandwidth limitation rules. |
N |
|
|
id Attribute |
1 |
The bandwidth limitation rules id. If the value is omitted, 0 is assumed to be set. If the attribute is omitted, -1 is assumed to be set. |
N |
|
|
name Attribute |
1 |
The bandwidth limitation rules name. |
Y |
|
|
cid Attribute |
1 |
The system administrator's id. Specifies 0. |
Y |
|
|
upload-limit Attribute |
1 |
The maximum transmission bandwidth for uploading. If 0 is specified or if the value is omitted, there is no limit. Note that the attribute cannot be omitted. By using a modification command for bandwidth limitation rules, you can change the maximum transmission bandwidth. When changing the maximum transmission bandwidth, specify the value in the range of 0 to 1,000 (unit: Mbps). |
N |
|
|
download-limit Attribute |
1 |
The maximum transmission bandwidth for downloading. If 0 is specified or if the value is omitted, there is no limit. Note that the attribute cannot be omitted. By using a modification command for bandwidth limitation rules, you can change the maximum transmission bandwidth. When changing the maximum transmission bandwidth, specify the value in the range of 0 to 1,000 (unit: Mbps). |
N |
|
|
active Attribute |
1 |
A flag indicates whether the setting of a bandwidth limitation rule is enabled (active).
If the value and attribute are omitted, or if a character string other than true is specified, false is assumed to be set. By using a modification command for bandwidth limitation rules, you can change the active flag setting. |
N |
|
|
create-time Attribute |
1 |
The creation date-time. |
Y |
|
|
update-time Attribute |
1 |
The updated date-time. |
Y |
|
|
group Element |
1 |
Limitation group of the bandwidth limitation rules. |
Y |
|
|
id Attribute |
1 |
The ID of the limitation group of the bandwidth limitation rules. The value must be 1 (fixed). |
Y |
|
|
name Attribute |
1 |
The name of the limitation group of the bandwidth limitation rules. The value must be ALL Users (fixed). |
Y |
|
|
network-set Element |
1 |
The network set. |
Y |
|
|
id Attribute |
1 |
The network set id. |
Y |
|
|
name Attribute |
1 |
The network set name. |
Y |
|
|
networks Element |
1 |
The network set list. |
Y |
|
|
network Element |
1 or more |
The network. |
Y |
|
|
cidr Attribute |
1 |
The network address. |
Y |
|
- Legend:
-
Y: Editable
N: Not Editable
(4) Execution example
DWAdminClient.bat GETBANDWIDTHRULE -result C:\data\band_width_limitation_rules.xml -property "C:\DWAdminClient\property.xml"