8.4.11 帯域制御ルールの取得
管理対象のドメインで作成された帯域制御ルールの帯域制御ID,帯域制御ルール名,ドメイン名,アップロード時の通信帯域の制限値,ダウンロード時の通信帯域の制限値,および帯域制御ルールが有効かどうかのフラグを,一括で取得します。なお,取得した帯域制御ルールは,XML形式のファイルで出力されます。
(1) 形式
DWAdminClient.bat△GETBANDWIDTHRULE△ △-result△帯域制御ルールの出力先ファイルパス △-property△プロパティファイルパス [△-concurrenttimeout△タイムアウト時間(秒)]
(2) 引数
項番 |
オプション |
説明 |
---|---|---|
1 |
-result |
帯域制御ルールの出力先ファイルのパスを指定します。 ファイルが存在しない場合は,新しくファイルを作成します。すでにファイルが存在する場合は,上書きして保存します。 ファイルパスにスペースを含む場合は,ファイルパスを””(ダブルクォート)で囲んでください。 |
2 |
-concurrenttimeout |
「8.3.2 共通オプション」を参照してください。 |
3 |
-property |
(3) 解説
(a) 帯域制御ルールのファイル形式
帯域制御ルールのファイル形式を次に示します。
<data> <rules> <rule id="1" name="帯域制御ルール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="自分"> <networks> <network cidr="133.108.167.127/32"/> <network cidr="133.108.179.0/24"/> </networks> </network-set> </rule> <rule id="2" name="帯域制御ルール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="ネットワークセット01"> <networks> <network cidr="133.108.179.127/32"/> </networks> </network-set> </rule> <rule id="3" name="帯域制御ルール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>
要素の意味を次に示します。
要素/属性 |
個数 |
説明 |
ファイル編集時の省略可否 |
|
---|---|---|---|---|
data要素 |
1 |
ルート要素です。 |
不可 |
|
rules要素 |
1 |
帯域制御ルールリストです。 |
不可 |
|
rule要素 |
0以上 |
帯域制御ルールです。 |
不可 |
|
id属性 |
1 |
帯域制御ルールのIDです。 値を省略した場合は0を,属性を省略した場合は-1を指定したものとして扱われます。 |
不可 |
|
name属性 |
1 |
帯域制御ルール名です。 |
可 |
|
cid属性 |
1 |
システム管理者のIDです。0を指定します。 |
可 |
|
upload-limit属性 |
1 |
アップロード時の通信帯域の制限値です。 値に0を指定した場合および値を省略した場合は,制限なしとなります。なお,属性は省略できません。 最大帯域制限値は,帯域制御ルールの編集コマンドで変更できます。 変更する場合は,0〜1,000(単位:Mbps)の範囲で指定します。 |
不可 |
|
download-limit属性 |
1 |
ダウンロード時の通信帯域の制限値です。 値に0を指定した場合および値を省略した場合は,制限なしとなります。なお,属性は省略できません。 最大帯域制限値は,帯域制御ルールの編集コマンドで変更できます。 変更する場合は,0〜1,000(単位:Mbps)の範囲で指定します。 |
不可 |
|
active属性 |
1 |
帯域制御ルールの設定が有効かどうかを判断するフラグです。
値および属性を省略した場合,true以外の文字列を指定した場合は,falseを指定したものとして扱われます。 有効フラグは,帯域制御ルールの編集コマンドで変更できます。 |
不可 |
|
create-time属性 |
1 |
作成日時です。 |
可 |
|
update-time属性 |
1 |
更新日時です。 |
可 |
|
group要素 |
1 |
帯域制御ルールの制御グループです。 |
可 |
|
id属性 |
1 |
帯域制御ルールの制御グループのIDです。 1で固定です。 |
可 |
|
name属性 |
1 |
帯域制御ルールの制御グループの名前です。 ALL Usersで固定です。 |
可 |
|
network-set要素 |
1 |
ネットワークセットです。 |
可 |
|
id属性 |
1 |
ネットワークセットのIDです。 |
可 |
|
name属性 |
1 |
ネットワークセット名です。 |
可 |
|
networks要素 |
1 |
ネットワークリストです。 |
可 |
|
network要素 |
1以上 |
ネットワークです。 |
可 |
|
cidr属性 |
1 |
ネットワークアドレスです。 |
可 |
(4) 実行例
DWAdminClient.bat GETBANDWIDTHRULE -result C:\data\band_width_limitation_rules.xml -property "C:\DWAdminClient\property.xml"