RESTful API
Interface Description

RESTful API
インターフェイス
マニュアル

バージョン:2.7
更新: 2014 年 4 月

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 1 / 44

RESTful API
Interface Description

著作権
Copyright © 2002-2014 KEMP Technologies, Inc.. 著作権は KEMP Technologies Inc.が保有しています。
KEMP Technologies および KEMP Technologies のロゴは、KEMP Technologies Inc.の登録商標です。
KEMP TechnologiesInc.は、ソフトウェアおよびドキュメントを含むロードマスター製品ラインのすべての所有権を保有します。ロードマスターExchange アプライアンスの使用は、ライセンス契約に従うものとします。このガイドの情報は、事前の予告なしに変更されることがあります。
Microsoft Windows は Microsoft Corporation の米国およびその他の国における登録商標です。その他すべての商標とサービスマークはそれぞれの所有者の財産です。
制限事項：著作権に関する文書およびその内容のすべては、所有者が提示しているままを記載しています。弊社は、ここに提示された情報が正しいことを確認するための努力を払っていますが、この情報の正確性については明示または黙示的に保証するものではありません。弊社は、このドキュメント上のすべての資料の誤りや不正確な情報に対して、可能であれば使用者が法律上または衡平法上の唯一かつ排他的な救済手段として受け入れられる適切な矯正の通知を提示します。
この文書に記載されている情報の使用者は、受取人、または第三者によるコンパイル、またはこのドキュメントを提供したり、通信や公開の任意のアクションまたは不作為からの傷害または損
害、およびこれらに限定されない現在または将来失われる利益および損失を含むあらゆる直接的、
特殊的、付随的または派生的損害（を含むがこれらに限らず、あらゆる種類の損失、のれんの損傷）に対して、弊社が責任を負うことはできないことを認めるものとします。
このガイドで使われるインターネット・プロトコル（IP）アドレス、電話番号または他のデータが、実際に存在する連絡先に似ている場合も、実際のアドレス、電話番号または連絡先であることを目的としません。この文書に含まれる例、コマンド出力、ネットワークトポロジ図、およびその他の図は説明のみを目的として提示されています。例示の内容に、実際のアドレスや連絡先情報が使用されている場合は、意図的なものではなく偶然の一致によるものです。
このソフトウェアの一部（2004 年に発行 2006 年に修正）は、Frank Denis が著作権を保有しています。2002 年の著作権は、Michael Shalayeff がすべての権利を保有し、2003 年の著作権は、Ryan
McBride がすべての権利を保有しています。
この部分に関して、ソースおよびバイナリ形式での再配布および使用は、改変の有無にかかわらず、次の条件が満たされていることにより許可されます。
1. ソースコードの再配布は、上記の著作権表示、および本条件と下記免責条項を保持しなければなりません。
2. バイナリ形式で再配布する場合は、上記の著作権表示、本条件、およびドキュメント、または配布時に提供される他の資料に、以下の免責事項を複製して提示する必要があります。
THIS SOFTWARE IS PROVIDED BY THE ABOVE COPYRIGHT HOLDERS ''AS IS'' AND ANY EXPRESS OR IMPLIEDWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ABOVE COPYRIGHTHOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS ORSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

（参考訳）
本ソフトウェアは、上記の著作権保持者によって“現状有姿”で提供され、明示または黙示の保証を含み、それに限定されない特定の目的に適合するような黙示的な保証は放棄されています。いロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 2 / 44

RESTful API
Interface Description

かなる場合においても、上記の著作権保持者、または貢献者は、損害の可能性について知らされているものも含めて、このソフトウェアの停止によるいかなる直接的、間接的、偶発的、特殊的、
懲戒的、間接的損害 （代替製品やサービスの調達費用、または、これらに限定されない使用不能
損失、データ、または利益の損失、または事業の中断による損失）、またはいかなる原因およびその理論による債務、いかなる契約、厳格責任、または不法行為（不注意、またはその他を含む）
による損害に対して、何ら責任を負わないものとします。
ソフトウェアおよびドキュメントに含まれる見解および結論は著者のものであり、上記著作権者の表現、または暗黙な公式方針を表すものではありません。
ロードマスターのソフトウェアの一部分は、1989、1991 年に、51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA にあるフリーソフトウェア財団（株）と KEMP Technologies Inc.が著作権を保有し、GNU ライセンスのバージョン 2（1991 年 6 月）の要件に完全に準拠しています。このライ
センス文書の写しをコピーして、正確に言葉通りに頒布することは誰もが許可されていますが、それを変更することは許されません。
ソースファイルへのリンクは、KEMP 米国ウェブサイトの Product Matrix ページと Support ページ
を参照ください。
このソフトウェアの一部は、カリフォルニア大学のリージェンツが 1988 年に著作権を所有し、すべての権利を保有しています。
この部分については、ソースおよびバイナリ形式での再配布および使用は、広告材料、およびそのような流通と使用に関連した資料、フォーム、ドキュメンテーションに、上記著作権表示と、ソフトウェアがカリフォルニア大学バークレー校によって開発されたことを認めるこの文節を複写して行うことで許可されています。 大学の名前は、特定の書面による事前の許可なしに、本ソ
フトウェアから派生する製品を是認または促進するために使用することはできません。
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULARPURPOSE.
（参考訳）
本ソフトウェアは“現状有姿”で提供され、特定の目的に対する商品性および適合性の黙示の保証に限定されずに明示的または黙示的ないかなる保証も致しません。
このソフトウェアの一部は、マサチューセッツ工科大学が 1998 年に著作権を保有しています。
この部分のソフトウェアおよび関連文書のファイル（“ソフトウェア”）は、変更、コピー、配布、他のソフトウェアとの併合、サブライセンスの発行、本ソフトウェアのコピーの販売、および/
または本ソフトウェアの他製品への組み込みは、以下の条件に従うすべての人へ制限なしに許可されます。
ソフトウェアがすべてそのまま複製されているか、または重要な部分として使用されているなら
ば、上記著作権表示および本許諾表示を記載しなければなりません。
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDINGBUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
（参考訳）
本ソフトウェアは、“現状有姿”で提供され、明示または黙示の保証を含み、それに限定されない
特定の目的に適合するような黙示的な保証は放棄されています。いかなる場合においても、作者
または著作権者は、ソフトウェアの使用またはその他の扱いに関連して、または関連しないで生ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 3 / 44

RESTful API
Interface Description

じる、契約、不法行為またはその他の行為によるいかなる請求、損害、またはその他の責任の債
務は負いません。
このソフトウェアの一部（1995 年発行 2004 年に修正）は、Jean-loup Gailly および Mark Adler が著作権を所有しています。
この部分のソフトウェアは“現状有姿”で、明示または黙示の保証なく提供されています。いかな
る場合においても、作者はこのソフトウェアの使用から生じるいかなる損害に対しても責任を負いません。
このソフトウェアは、次の制限事項を例外として、自由に変更、再配布し、商用アプリケーショ
ンへの使用を含めあらゆる目的に対して誰でも使用することを許可されます：
1. このソフトウェアの出所について虚偽の表示をしてはなりません。あなたが、オリジナルのソフトウェアを書いたと主張してはいけません。任意の製品でこのソフトウェアを使用した場合は、必須ではありませんが、製品ドキュメント内にその旨を述べて頂ければ感謝します。
2. ソースを変更したバージョンを使用するならば、オリジナルのソフトウェアとして誤解されないように、その旨を明示しなければなりません。
3.このソースを配布する場合は、これらの通知を削除したり変更したりすることはできません。
このソフトウェアの一部は、2003 年に Internet Systems Consortium が著作権を所有しています。
この部分に関して、手数料の有無にかかわらず、本ソフトウェアを使用、コピー、変更、および/または任意の目的での配布は、上記の著作権表示とこの許可告知文があらゆるコピーに表示されている限り許可されます。
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
USE OR PERFORMANCE OF THIS SOFTWARE.

（参考訳）
本ソフトウェアは、"現状のまま"で提供され、作書は、市場への適合性や適切性へのすべての黙示的保証を含め、本ソフトウェアに関して一切の保証をいたしません。作者は、いかなる場合においても、本ソフトウェアの性能、使用または不使用によって生じるいかなるデータまたは利益の損失、契約、過失、またはその他の不法行為から生じる特別、直接的、間接的は損害、または
結果的損害に対して一切の責任を負いません。

本製品は、正当な許可を得て、米国特許 6,473,802、6,374,300、8,392,563、8,103,770、7,831,712、7,606,912、7,346,695、7,287,084 および 6,970,933 を使用しています。

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 4 / 44

RESTful API
Interface Description

目次
1

2

3

はじめに......................................................................................................................................... 7
1.1

ドキュメントの目的............................................................................................................. 7

1.2

対象読者................................................................................................................................. 7

The RESTful API インターフェイス .............................................................................................. 8
2.1

RESTful API とは ..................................................................................................................... 8

2.2

セキュリティ......................................................................................................................... 9

2.3

RESTful API インターフェイスの有効化 ............................................................................. 9

2.4

get および set コマンドの使用 ......................................................................................... 10

2.5

エラーレポート................................................................................................................... 10

2.6

表記....................................................................................................................................... 10

RESTful API コマンド ................................................................................................................... 11
3.1

コマンドのリスト............................................................................................................... 11

3.2

ホーム................................................................................................................................... 13

3.3

仮想サービス....................................................................................................................... 13

3.3.1

仮想サービス(VS)の制御 ............................................................................................ 13

3.3.2

SSO の管理 ................................................................................................................... 183.4

統計情報............................................................................................................................... 20

3.5

実サーバー........................................................................................................................... 21

3.5.1
3.6

実サーバーの有効化 / 無効化 ................................................................................... 22

ルールとチェック............................................................................................................... 22

3.6.1

ルールの表示............................................................................................................... 22

3.6.2

ルールのシステムよりの削除 ................................................................................... 23

3.6.3

ルールのシステムへの追加、変更 ........................................................................... 23

3.6.4

実サーバーへのルールの追加/削除 ......................................................................... 24

3.6.5

仮想サーバーのルールの追加 ................................................................................... 24

3.6.6

仮想サーバーのルールの削除 ................................................................................... 25

3.6.7

Check パラメータ ........................................................................................................ 25

3.7

証明書................................................................................................................................... 25

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 5 / 44

RESTful API
Interface Description

3.8

インターフェイス............................................................................................................... 26

3.9

ローカル DNS 設定.............................................................................................................. 27

3.10

ルート管理....................................................................................................................... 27

3.11

アクセスリスト............................................................................................................... 28

3.12システム管理................................................................................................................... 29

3.12.1

ライセンスの更新....................................................................................................... 29

3.12.2システムの再起動....................................................................................................... 29

3.12.3

ソフトウェアの更新................................................................................................... 30

3.12.4

バックアップ/復元 ..................................................................................................... 30

3.12.5

日付/時刻 ..................................................................................................................... 31
ログオプション............................................................................................................... 31

3.13
3.13.1

デバッグオプション................................................................................................... 31

3.13.2

Syslog オプション........................................................................................................ 31

3.13.3

SNMP オプション ........................................................................................................ 32

3.13.4

Email オプション ......................................................................................................... 32
その他のオプション....................................................................................................... 33

3.14
3.14.1WUI 設定 ...................................................................................................................... 33

3.14.2

リモートアクセス....................................................................................................... 33

3.14.3WUI の認証および承認オプション........................................................................... 34

3.14.4L7 設定 .......................................................................................................................... 35

3.14.5

ネットワークオプション ........................................................................................... 36

3.14.6

AFE 設定........................................................................................................................ 36

3.14.7

HA 管理 ......................................................................................................................... 37

3.15

RESTful API による HA の設定 ............................................................................................ 38

4

ロードマスターRESTful API のスクリプト例文 ....................................................................... 40

5

参考ドキュメント....................................................................................................................... 43

Document History ................................................................................................................................. 44

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 6 / 44

RESTful API
Interface Description

1 はじめにKEMP テクノロジーの製品は、高可用性（HA）、高パフォーマンス、柔軟なスケーラビ
リティ、セキュリティ、および管理のしやすさによって定義されるように、Web および
アプリケーションのインフラストラクチャを最適化します。また、柔軟で幅広い導入オ
プションを提供するとともに、Web インフラストラクチャの総所有コスト（TCO）を最小限に抑えます。

1.1

ドキュメントの目的

本ドキュメントでは、KEMP ロードマスターへの RESTful API インターフェイスについて説明します。本ドキュメントでは、RESTful API を使って KEMP ロードマスターの各種機能を設定する方法について詳しく説明します。

1.2

対象読者

本ドキュメントは、RESTful API を使って KEMP ロードマスターを設定するユーザを対象としています。

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 7 / 44

RESTful API
Interface Description

2 The RESTful API インターフェイス
このドキュメントは、ロードマスターへのリモートアクセスを容易に行う為にデザインされたインターフェイスである RESTful API に関して記述しています。このインターフェ
イスは、REST（Representational State Transfer）に類似したものです。REST（Representational State Transfer）は、分散システム用ソフトウェア・アーキテクチャの1 つのスタイルで、卓越したウェブサービスのデザインモデルの一つです。

2.1

RESTful API とは

ロードマスターの RESTful API は、ユーザもしくはアプリケーションが HTTPS リクエストをロードマスターに送るのを許可させるインターフェイスです。ロードマスターは、その HTTPS リクエストに対して XML フォーマットのレスポンスを返します。HTTPS リクエ
ストは、下記のようなフォーマットとなります。
https://<LoadMaster IP Address>/access/<command>?<parameter1>=value& <parameter2>=value&

基本的なインターフェイスは、URL によって指定されるコマンドを HTTPS GET にて送信します。もし、パラメータが必要なものは、クエリ用パラメータとして渡します。
下記は、この HTTPS リクエストのフォーマットについての注意点です。


一回に一つのコマンドのみ送信できます。

‘?’キャラクターは、コマンドの最後を意味します。

‘&’キャラクターは、パラメータ/バリューのペアの最後を意味します。



もし不必要なパラメータ／バリューのペアを含んでいる場合は、それらは無視されます。
コマンドに続くパラメータ／バリューのペアの順序はありません。



クエリ内にスペースはありません。ただし、ブラウザなどのアプリケーションでは、文字列を LoadMaster に送信する前にスペースが HTML コードに変換されます。



複数のパラメータは、同じコマンド内であれば変更可能です。

例えば、下記のクエリは IP アドレス 10.11.0.20 のロードマスターより最大キャッシュメ
モリーサイズを求めるものです。
https://10.11.0.20/access/get?param=cachesize

このクエリに対するロードマスターからのレスポンスは、下記のように容易にデコードできる XML フォーマットです。
---------------------------------------------------------<?xml version="1.0" encoding="ISO-8859-1"?><Response stat="200" code="ok"><Success><Data><cachesize>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 8 / 44

RESTful API
Interface Description

100</cachesize></Data></Success></Response>---------------------------------------------------------

本ドキュメントに記載されているすべてのコマンドがすべてのロードマスターで使用できるわけではありません。コマンドによっては、ロードマスターの一部のライセンスでのみ使用可能なものもあり
ます。

2.2

セキュリティ

アプリケーションは、一般的な WUI 用 IP アドレスを介してロードマスターにアクセス可能です。セキュリティとして、HTTPS を介して WUI へアクセスする時と同じ有効なユーザー資格をアクセスする毎に HTTP ベーシック認証を使用して渡す必要があります。
ユーザー名"bal" は、すべての機能へのアクセスが可能です。他のユーザーは、そのユーザーに与えられているサブシステムにのみへのアクセスだけが認められます。
セッション管理が有効になっている場合、bal ユーザーのみ RESTful
API を使用できます。
現状では、このインターフェイスによるユーザーの権限変更はできません。
セキュリティの設定にもよりますが、WUI へのログインが既になされていない場合は、ログイン情報を追加しなければなりません。通常の既にログインがなされている場合のコマンドフォーマットは下記ですが、
https://<LoadMaster IP address>/access/<command>?params

もし、ユーザー情報を含ませなければならない場合は下記のフォーマットになります。
https://<UserName>:<UserPassword>@<LoadMasterIPaddress>/access/<command>?params

2.3

RESTful API インターフェイスの有効化

RESTful API インターフェイスは、ロードマスターの WUI から有効化／無効化を行います。デフォルトでは、このインターフェイスは無効になっています。
RESTful API インターフェイスを使用できるようにするには、下記の手順で行います。
1. WUI のメニューより System Configuration > Miscellaneous Options > Remote Access オ
プションに移動します。
2. “Enable API Interface” チェックボックスをオンにします。
ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 9 / 44

RESTful API
Interface Description

2.4

get および set コマンドの使用

ロードマスターのパラメータの多くは、set および get コマンドを使用して管理できます。各パラメータについては、このドキュメント全体を通して説明します。
パラメータの値は、以下のようなフォーマットの get コマンドで取得できます。
https://<LoadMasterIPAddress>/access/get?param=<ParameterName>

パラメータの値は、以下のようなフォーマットの set コマンドで設定できます。
https://<LoadMasterIPAddress>/access/set?param=<ParameterName>&value=<ParameterValue>

2.5

エラーレポート

必要なパラメータが不足していたり、バリューが正しくない場合は、システムが下記のようなエラーレポートを返します。
---------------------------------------------------------<?xml version="1.0" encoding="ISO-8859-1"?><Response stat="400" code="fail"><Error>param: String Value missing</Error></Response>----------------------------------------------------------リクエストの HTTP ステータスや、レスポンスコードがこのレポート内に反映されま
す。

2.6

表記

このドキュメント全体を通して、パラメータのタイプは以下のように定義されます。
タイプ

省略形

標準値

ブール（Boolean）

B

整数（Integer）
文字列（String）
アドレス（Address
）

I
S
A

Y または N、y またはn、1 または 0<最小値>-<最大値>"値"
IP アドレス

表 1: パラメータの表記

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 10 / 44

RESTful API
Interface Description

3 RESTful API コマンド
3.1

コマンドのリスト

リクエストは、コマンドとパラメータの 2 つの部分より成り立っています。
https://<LoadMaster IP address>/access/<command>?params

コマンドは、下記の中の一つとなります。
Command詳細

仮想サービス（VS）の表示
新 VS の追加
VS の削除VS の変更ロードマスター上にある全ての仮想サービスの表示
実サーバー（RS）の VS への追加
RS の VS からの削除
VS 内の特定 RS の変更
VS 内の特定 RS の表示
VS 内の特定 RS の有効化
VS 内の特定 RS の無効化
ルール（(header modify ／matching rule)の表示
ルールの追加ルールの削除ルールの変更ルールの RS への追加
ルールの RS からの削除
HA ペアのロールを切り替えます。コマンドを実行すると、新たにアクティブになったホストの IP アドレスが返されます。
addcertVS と RS の統計情報の取得
delcert仮想サービスへの証明書の追加
backupcert
仮想サービスからの証明書の削除
restorecert
すべての VIP および中間証明書のバックアップ
addintermediate 特定の証明書の復元
delintermediate 仮想サービスへの中間証明書の追加
shutdown
仮想サービスからの中間証明書の削除
rebootロードマスターの電源停止の試行
backup
ロードマスターの再起動
restore仮想サービス設定、ローカルアプライアンス情報、統計データを含む、バックアップの生成
license以前に生成した設定のバックアップの復元
accesskey
ロードマスターへの新しいライセンスの適用
showvs
addvs
delvs
modvs
listvs
addrs
delrs
modrs
showrsenablers
disablers
showrule
addruledelrulemodruleaddrsruledelrsrulestats

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 11 / 44

RESTful API
Interface Description

Command詳細

ロードマスターからのアクセスキーの取得
ロードマスターのファームウェアの更新
ロードマスターに以前にインストールしたファームウェア
バージョンの復元
delroute
デフォルトゲートウェイのアドレスの追加
updatedetect
デフォルトゲートウェイのアドレスの削除
addnocache"Detect Malicious Requests"オプションの有効化
delnocache
キャッシュ対象外リストへのファイル拡張子の追加
addnocompress キャッシュ対象外リストからのファイル拡張子の削除
delnocompress
圧縮対象外リストへのファイル拡張子の追加
addprerule
圧縮対象外リストからのファイル拡張子の削除
delprerule
仮想サービスへのルールの追加
addrequestrule 仮想サービスからのルールの削除
delrequestrule
仮想サービスへのルールの追加
addresponserule 仮想サービスからのルールの削除
delresponserule 仮想サービスへのルールの追加
showhealth
仮想サービスからのルールの削除
modhealthService Health Check パラメータの取得
showadaptive
Service Health Check パラメータの変更
modadaptive
Adaptive Health Check パラメータの取得
showiface
Adaptive Health Check パラメータの変更
modiface
インターフェイスのパラメータの取得
addadditional
インターフェイスのパラメータの変更
deladditional
インターフェイスへの追加アドレスの追加
createbond
インターフェイスからの追加アドレスの削除
unbondボンディングインターフェイスの作成
addbond
ボンディングインターフェイスからのインターフェイスのボンディング解除
delbond
ボンディングインターフェイスへのインターフェイスの追加
addvlan
ボンディングインターフェイスの削除
delvlan
インターフェイスへの新しい VLAN の追加
installpatch
restorepatch
addroute

表 2: コマンド

すべてのコマンドは、矛盾があってはなりません。例えば、仮想サービス（VS）関連のすべてのコマンドにおいては、下記のように VS は‘vs=<ipaddr>’のフォーマットで VIP ア
ドレスを指定する必要があります。
https://<LoadMasterIPAddress>/access/showvs?vs=10.0.0.10&port=80&prot=tcp

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 12 / 44

RESTful API
Interface Description

VS 上の特定 RS を指定する場合は、下記のように‘rs=<ipaddress>’のフォーマットになります。
https://<LoadMasterIPAddress>/access/showrs?vs=10.0.0.10&port=80&prot=tcp&rs=99.1.1.1&rsport=8
0

3.2

ホーム

The LoadMaster version can be obtained using the get command and the version parameterhttps://<LoadMasterIPAddress>/access/get?param=version

3.3

仮想サービス

3.3.1

仮想サービス(VS)の制御

仮想サービスコマンドの基本形式を以下に示します。仮想サービスは、IP アドレスとインデックスのいずれでも指定できます。
https://<LoadMasterIPAddress>/access/showvs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>
https://<LoadMasterIPAddress>/access/delvs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>
https://<LoadMasterIPAddress>/access/addvs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>[&...]
https://<LoadMasterIPAddress>/access/modvs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>[&...]
https://<LoadMasterIPAddress>/access/showvs?vs=<index>&port=<Port>&prot=<tcp/udp>
https://<LoadMasterIPAddress>/access/delvs?vs=<index>&port=<Port>&prot=<tcp/udp>
https://<LoadMasterIPAddress>/access/addvs?vs=<index>&port=<Port>&prot=<tcp/udp>[&...]
https://<LoadMasterIPAddress>/access/modvs?vs=<index>&port=<Port>&prot=<tcp/udp>[&...]
https://<LoadMasterIPAddress>/access/listvs‘delvs’コマンドによる VS の削除が成功した場合は、OK のステータスを返しますが、それ以外は VS の現設定情報を返します。
‘addvs’ と ‘modvs’ の両方とも、ユーザーは仮想サービスのすべての設定を変更可能です。‘modvs’は、既存の仮想サービスを変更するコマンドですが、‘addvs’は、新しい仮想サービスの作成を行うためのものです。
listvs コマンドを使用すると、ロードマスター上にある全ての仮想サービスが表示されます。
（新しい仮想サービスが作成される場合、udp プロトコルでの指定以外は L7 のトランス
ペアレンシーモードのデフォルトの設定が適用されます。）
仮想サービスのステータスが返される時に、付属する実サーバー（RS）情報も返されます。

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 13 / 44

RESTful API
Interface Description

コマンドによっては、他のコマンドの実行が必須条件となっているものがあります。その条件が満たされない場合、指定したコマンドを実行しても何も起こりません。

すべてのパラメータがすべての設定に使用できるとは限りません。
パラメータが使用できるかどうかは、設定する環境により変化します。
SubVSsコマンドは SubVS でも使用できます。ただし、SubVS は IP アドレスを持っていないた
め、SubVS のインデックスを使用する必要があります。例：
https://<LoadMasterIPAddress>/access/showvs?vs=<VSIP>&port=<Port>&prot=<tcp/udp>&rs=!<SubVS
index>
https://<LoadMasterIPAddress>/access/delvs?vs=<VSIP>&port=<Port>&prot=<tcp/udp>&rs=!<SubVSin
dex>
https://<LoadMasterIPAddress>/access/addvs?vs=<VSIP>&port=<Port>&prot=<tcp/udp>&rs=!<SubVSin
dex>[&...]
https://<LoadMasterIPAddress>/access/modvs?vs=<VSIP>&port=<Port>&prot=<tcp/udp>&rs=!<SubVSindex>[&...]SubVS のインデックスは整数値です。
次のパラメータが設定できます。
Name

Type

Default

Adaptive
AddViaS(ReadOnly)I<unset>Cache
CertFile

B
S

Range

0 = Legacy
Operation
1 = X-Forwarded-For
2 = None
3 = X-Client-Side
4 = X-Client-Side (NoVia)
5 = X-Forwarded-For(No Via)
6 = Via OnlyN
<unset>

インストールされている証明書の識別子

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 14 / 44

RESTful API
Interface Description

Name

CheckTypeTypeS

Default

Range

<tcp>

デフォルトは VS のポート設定により変化します。設定可能バリューとして下記がありま
す。













CheckHost
CheckPattern
CheckUrl
CheckUse1.1
CheckPort
ClientCert
Compress
CookieCachePercent
DefaultGW
EnableErrorCode

A
S
S
B
I
I
B
S
I
A
B
I

<unset><unset><unset>N<unset>0
N<unset>0<unset>Y
0

ErrorUrl
PortFollow
ForceL7
Idletime

S
I
B
I<unset><unset>Y (if not UDP)
0

LocalBindAddrs
VStypeA+S

NickName

S

NRequestRules
NResponseRules

I(Readonly)<unset><port
dependent><unset><unset><unset><unset>I(Readonly)

icmp
https
http
tcp
smtp
nntp
ftp
telnet
pop3
imap
rdp
none

3-655300-2

0-100

An error code from therange 300-550
3-655300-86400
List of IP addresses
gen,http,ts

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 15 / 44

RESTful API
Interface Description

Name

Type

NumberOfRSs
NRulesPersistI(Readonly)
I(Readonly)S

Default

Range<unset><unset>
none



















VSPortProtocolPersistTimeout
QueryTag
RequestRules
ResponseRules
SSLReencrypt
SSLReverse
SSLRewrite
RuleList
Schedule

I
S
I
S
List(Readonly)
List(Readonly)
B
B
S
List(Read only)S<unset><unset>0<unset>ServerInit
SSLAcceleration
StandbyPort
StandbyAddr
Transactionlimit

I
B
I(Read only)A
I

0N<unset><unset><unset>NN<unset>

The list of relevant
persist values are:ssl
cookieactive-cookie
cookie-src
active-cook-src
cookie-hashcookie-hash-src
url
query-hashhostheadersuper
super-src
src
rdp
rdp-src
rdp-sb
rdp-sb-src
3-65530
udp, tcp
0-86400<unset>, http, https

rr

- rr
- wrr
- lc
- wlc
- fixed- adaptive
- sh
0-5

0-<maxint>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 16 / 44

RESTful API
Interface Description

Name

Type

Default

Transparent
UseforSnat
CheckUseGet
Verify1
VSAddress
ExtraHdrKey
ExtraHdrValue
AllowedHosts
AllowedDirectories
DomainLogoff
ESPLogs

B
B
B
I
A
S
S
S
S
S
S
I

Y
N
N
0
Address<unset><unset><unset><unset><unset><unset>7

SMTPAllowedDomains
EspEnabled
InputAuthMode

S
B
I<unset>N0

OutputAuthModeI

StartTLSMode

I

ExtraPorts
AltAddress

I
A

Range

0-7 (bitmask)

Integer 0-7
1: User Access
2: Security
3: 1&2
4: Connection
5: 1&4
6: 2&4
7: 1&2&4

Integer 0-4(Client Authent)
0: None1: Basic
2: Form Based
3: Future use
4: Future use
Dependant on Integer 0-2
InputAuthMode (Server Authent)
value
0: None1: Basic
2: Future use
Integer 0-6*
0: HTTP/HTTPS (requires
VStype=http)1: STARTTLS protocol(requires VStype=tls)
2: Future use
3: Future use
4: Future use
5: Future use
6: Future use
Integer 3- 65535<unset>IP address

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 17 / 44

RESTful API
Interface Description

Name

Type

Default

MultiConnect
AddViaB
I

SingleSignOnDir
MasterVS
CreateSubVS
SubVS
Non-local
AllowedGroups

S
I (Read Only)<unset><unset>I (Read Only)
B
S<unset>Range

Integer 0-6
0: Legacy Operation
1: X-Forwarded-For
2: None3: X-Client-Side
4: X-Client-Side (No Via)
5: X-Forwarded-For (No Via)
6: Via Only

表 3: 仮想サービスのパラメータ

パーシステンス方式を‘cookie’に指定した場合、コマンドにてクッキ
ー名も指定する必要があります。
例：
https://<LoadMasterIPAddress>/access/modvs?vs=10.0.2.194&port=80&pr
ot=tcp&persist=cookie&cookie=<cookie name>&
1

Verify はビットマスクです。Verify パラメータの有効な値は以下のとおりです。


ビット 0: 侵入検知を有効にするにはこのビットを 1 にします。
他の 2 つのビットを使用するにはビット 0 を 1 に設定する必要があ
ります。




ビット 1 は、接続をリジェクトするかドロップするかを決定します。1 にセット
すると接続がドロップされます。
ビット 2 は、不正な要求や悪意ある（ただし無効ではない）要求に対して単に警告を与えるだけにするかどうかを決定します。

3.3.2

SSO の管理3.3.2.1

SSO ドメイン

SSO ドメインは、以下のコマンドで管理できます。
https://<LoadMasterIPAddress>/access/adddomain?domain=<DomainName>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 18 / 44

RESTful API
Interface Description

最大 128 個の SSO ドメインを設定できます。
https://<LoadMasterIPAddress>/access/deldomain?domain=<DomainName>
https://<LoadMasterIPAddress>/access/showdomain
https://<LoadMasterIPAddress>/access/showdomain?domain=<domain.name>https://<LoadMasterIPAddress>/access/moddomain?domain=<domain.name>[&paramname=value...]https://<LoadMasterIPAddress>/access/moddomain?domain=<DomainName >moddomain には以下の追加（オプション）パラメータを指定できます。
Name

Type

Default

Range

auth_typeS“LDAP-StartTLS”“LDAP-Unencrypted”“LDAP-StartTLS”“LDAP-LDAPS”“RADIUS”“RSA-SECURID”

radius_shared_secretlogon_fmt

S<unset>(masked)S“Principalname”

logon_domain
max_failed_auths
sess_tout_idle_pub
sess_tout_duration_pub
sess_tout_idle_priv
sess_tout_duration_priv
sess_tout_type

S
I
I
I
I
I
S

<unset>
0
900
1800
900
2800
“idle time”

testusertestpass

S
S(masked)I
I<unset><unset>reset_fail_tout
unblock_tout“not-specified”“Principalname”“Username”
0-999
60-86400
60-86400
60-86400
60-86400“idle time”“max duration”

60
1800

60-86400
60-86400

https://<LoadMasterIPAddress>/access/showdomainlockedusers?
https://<LoadMasterIPAddress>/access/unlockdomainusers?domain=<example.com>&users=<example
user>

3.3.2.2

SSO 画像の設定

以下のコマンドを使用してカスタムの SSO 画像を管理できます。
https://<LoadMasterIPAddress>/access/listssoimages

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 19 / 44

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/delssoimage?name=<Imagesetname>

SSO 画像をアップロードするには以下のコマンドを使用します。
curl –X POST -–data-binary “@<pathToImageSet>” –k
https://<LoadMasterIPAddress>/access/ssoimages?

3.4

統計情報

仮想サービスおよび実サーバーのあらゆる統計情報は、stats コマンドで取得できます。
https://<LoadMasterIPAddress>/access/stats

コマンドが正常に実行された場合、仮想サービスおよび実サーバーのあらゆる統計情報
が以下のフォーマットで返されます。
実サーバーの統計情報は、仮想サービス単位に返されます。
<?xml version="1.0" encoding="ISO-8859-1"?><Response stat="200" code="ok"><Success><Data><VStotals><ConnsPerSec>0</ConnsPerSec><BytesPerSec>0</BytesPerSec><BitsPerSec>0</BitsPerSec><PktsPerSec>0</PktsPerSec></VStotals><Vs><VSAddress>206.130.201.210</VSAddress><VSPort>80</VSPort><VSProt>tcp</VSProt><Index>59</Index><ErrorCode>0</ErrorCode><Enable>0</Enable><TotalConns>0</TotalConns><TotalPkts>0</TotalPkts><TotalBytes>0</TotalBytes><TotalBits>0</TotalBits><ActiveConns>0</ActiveConns>
</Vs>
<Rs>
<VSIndex>59</VSIndex><RSIndex>100</RSIndex><Addr>10.99.0.212</Addr><Port>80</Port><Enable>1</Enable><Weight>1000</Weight><Pkts>0</Pkts><Bytes>0</Bytes>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 20 / 44

RESTful API
Interface Description<Bits>0</Bits><Persist>0</Persist><ActiveConns>0</ActiveConns></Rs></Data></Success></Response>

3.5

実サーバー

実サーバーは、下記のコマンドの中の一つを使用することで管理が可能です。
https://<LoadMasterIPAddress>/access/showrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>
https://<LoadMasterIPAddress>/access/delrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>
https://<LoadMasterIPAddress>/access/addrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>
https://<LoadMasterIPAddress>/access/modrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>rs パラメータには、IP アドレスの他に、整数値およびサービス名を設定することができます。整数値を使用する場合、showvs コマンドの<RSIndex>エレメントに設定します。
このパラメータを使用する際は、整数値またはサービス名の前に必ず感嘆符（‘!’）を記
述してください。
例：
https://<LoadMasterIPAddress>/access/showrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=!<RSIndex>
https://<LoadMasterIPAddress>/access/showrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=!<Servi
ce Name >サービス名とインデックスが競合した場合、例えば、“10”という名前のサービスがあり、それとは別に、インデックス値 10 を持つ実サーバーが存在する場合、“rs=!10”は 10 というサービス名ではなく、
インデックス値 10 を指します。

‘addrs‘と‘modrs’ は、オプションとして下記のパラメータが許されます。
Name

Type

Default

RangeweightnewportI
I

1000<unset>forwardenable
limit

S
B
I

nat
Y
0

1-65535
3-65535 （実サーバーのポート変更)
nat, route
0-100000

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 21 / 44

RESTful API
Interface Description

表 4: 実サーバーのパラメータ

もし、仮想サービスが L7 モードならば、“forward”パラメータを‘route’に設定しても何の効果もありません。

3.5.1

実サーバーの有効化 / 無効化

3.5.1.1

実サーバーのグローバルな有効化/無効化

実サーバーをグローバルに有効化/無効化する（全ての仮想サービスを有効化/無効化する）には、以下のコマンドを使用します。
https://<LoadMasterIPAddress>/access/enablers?rs=<IP-addr>

or
https://<LoadMasterIPAddress>/access/disablers?rs=<IP-addr>

3.5.1.2

実サーバーのローカルな有効化/無効化

実サーバーをローカルに有効化/無効化する（ある 1 つの仮想サービスを有効化/無効化）するには、以下のコマンドを使用します。
https://<LoadMasterIPAddress>/access/modrs?vs=<VirtualServiceIPAddress>&port=<Port>&prot=<tcp/udp>&rs=<RealServerIPAddress>&rsport=<port>&enable=n

または、
https://<LoadMasterIPAddress>/access/modrs?vs=<VirtualServiceIPAddress>&port=<Port>&prot=<tcp/udp>&rs=<RealServerIPAddress>&rsport=<port>&enable=y

3.6

ルールとチェック

コンテンツルールは、RESTful API で管理できます。

3.6.1

ルールの表示システムに設定しているルールは、下記の showrule コマンドを使用して表示が可能です。
https://<LoadMasterIPAddress>/access/showrule?[name=<Rule Name>][type=<0-4>]表示されるリストは、ルール名、もしくはルールのタイプを指定することでフィルターができます。ルールのタイプを下記に示します。
0

MatchContentRule

The original rules.

1
2

AddHeaderRule Rule to Add header field
DeleteHeaderRule Rule to Delete a header field.

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 22 / 44

RESTful API
Interface Description

0

MatchContentRule

3
4

ReplaceHeaderRule Rule to modify a header field.
ModifyURLRule URL rewrite rule.

The original rules.

表 5: ルールのタイプ

3.6.2

ルールのシステムよりの削除

ルールは、delrule コマンドにより削除できます。
https://<LoadMasterIPAddress>/access/delrule?name=<Rule Name>

3.6.3

ルールのシステムへの追加、変更

ルールは、delrule コマンドにより削除できます。
https://<LoadMasterIPAddress>/access/addrule?name=<Rule Name>
https://<LoadMasterIPAddress>/access/modrule?name=<Rule Name>

ルールの種類によりますが、下記のパラメータを設定できます。ルールを作成する時に“Type”を指定しなかった場合は、デフォルトの‘0’が適用され MatchContentRule となります。ルール変更コマンドの使用時、“Type”を指定しなかった場合は、タイプは変更されません。
Type 1 の AddHeaderRule の追加／変更以外は、pattern パラメータを付加しなければなりません。
Type 0 (MatchContentRule)
Name

Type

Default

Range

matchtype

S

regex

 regex prefix postfix

inchostnocasenegateincqueryheaderpattern

B
B
B
B
S
S

N
N
N
N
<unset><unset>See below

表 6: ルールのタイプ 0 のパラメータ“ header”パラメータは、オプショナルでヘッダー名がマッチした場
合のみ Value としての“pattern”を変更可能です。

Type 1 (AddHeaderRule)
ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 23 / 44

RESTful API
Interface Description

Name

Type

Default

headerreplacement

S
S<unset><unset>

表 7: ルールのタイプ 1 のパラメータType 2 (DeleteHeaderRule)
Name

Type

Default

patternS<unset>

表 8: ルールのタイプ 2 のパラメータType 3 (ReplaceHeaderRule)
Name

Type

Default

headerreplacement
pattern

S
S
S<unset><unset><unset>

表 9: ルールのタイプ 3 のパラメータType 4 (ModifyURLRule)
Name

Type

Default

replacement
patternS
S<unset><unset>

表 10: ルールのタイプ 4 のパラメータ

3.6.4

実サーバーへのルールの追加/削除

ルールは、addrsrule と delrsrule コマンドを使用して実サーバーに追加、もしくは実サーバーより削除できます。
https://<LoadMasterIPAddress>/access/addrsrule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>&rule=<RuleName>
https://<LoadMasterIPAddress>/access/delrsrule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=<RS
IPaddr>&rsport=<RS-Port>&rule=<RuleName>

3.6.5

仮想サーバーのルールの追加

ルールは、addprerule、addresponserule、および addrequestrule コマンドで仮想サービ
スに追加できます。
https://<LoadMasterIPAddress>/access/addprerule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rule=<RuleName>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 24 / 44

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/addresponserule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&
rule=<RuleName>
https://<LoadMasterIPAddress>/access/addrequestrule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&r
ule=<RuleName>

3.6.6

仮想サーバーのルールの削除

ルールは、delprerule、delresponserule、および delrequestrule コマンドで仮想サービス
から削除できます。
https://<LoadMasterIPAddress>/access/delprerule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rule=<
RuleName>
https://<LoadMasterIPAddress>/access/delresponserule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&r
ule=<RuleName>
https://<LoadMasterIPAddress>/access/delrequestrule?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&ru
le=<RuleName>

3.6.7

Check パラメータ

Service Check パラメータは、以下のコマンドで取得できます。
https://<LoadMasterIPAddress>/access/showhealth?

Service Check パラメータは、以下のコマンドで変更できます。
https://<LoadMasterIPAddress>/access/modhealth?RetryInterval=<IntervalValue>&Timeout=<Timeout
Value>&RetryCount=<CountValue>

Adaptive Check パラメータは、以下のコマンドで取得できます。
https://<LoadMasterIPAddress>/access/showadaptive?

Adaptive Check パラメータは、以下のコマンドで変更できます。
https://<LoadMasterIPAddress>/access/modadaptive?AdaptiveURL=<URL>&AdaptivePort=<Port>&<Ad
aptiveInterval=<Interval>&MinPercent=%Value>

3.7

証明書

証明書は、以下のコマンドで管理できます。
https://<LoadMasterIPAddress>/access/addcert?cert=<CertName>&password=<Password>&replace=<0
or1>
https://<LoadMasterIPAddress>/access/delcert?cert=<CertName>
https://<LoadMasterIPAddress>/access/addintermediate?cert=<CertName>
https://<LoadMasterIPAddress>/access/delintermediate?cert=<CertName>
https://<LoadMasterIPAddress>/access/backupcert?password=<Password>
https://<LoadMasterIPAddress>/access/restorecert?password=<Password>&Type=<type>

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 25 / 44

RESTful API
Interface Description

パスフレーズ（パスワード）は英数字で指定する必要があり、大文字と小文字が区別されます。文字数の下限は 7、上限は 64 です。
Replace は、既存の証明書を同じ名前で置き換えるかどうかをロードマスターに通知するためのブール値です。
get および set コマンドで管理できる証明書関連のパラメータの詳細については、表 11を参照してください。
Name

Type

admincertsslrenegotiate
localcert

S
B
S

表 11: 証明書のパラメータ3.8

インターフェイス

インターフェイスの詳細は、以下のコマンドで取得できます。
https://<LoadMasterIPAddress>/access/showiface?interface=<InterfaceID>

インターフェイスのパラメータは、以下のコマンドで変更できます。
https://<LoadMasterIPAddress>/access/modiface?interface=<InterfaceID>&IPAddress=<InterfaceIPAdd
ress>&Mtu=<MTUValue>&InterfaceType=<Type>&DefaultInterface=<yes/no>

追加アドレスは、以下のコマンドでインターフェイスに追加できます。
https://<LoadMasterIPAddress>/access/addadditional?interface=<InterfaceID>&IPAddress=<Additional
AdressIP/prefix>

追加アドレスは、以下のコマンドでインターフェイスから削除できます。
https://<LoadMasterIPAddress>/access/deladditional?interface=<InterfaceID>&IPAddress=<Additional
AdressIP/prefix>

ボンディングインターフェイスは、以下のコマンドで作成できます。
https://<LoadMasterIPAddress>/access/createbond?interface=<InterfaceID>

インターフェイスは、以下のコマンドでボンディングインターフェイスから削除できます。
https://<LoadMasterIPAddress>/access/unbond?interface=<InterfaceID>

インターフェイスは、以下のコマンドでボンディングインターフェイスに追加できます。
https://<LoadMasterIPAddress>/access/addbond?interface=<InterfaceID>&bond=<BondID>

ボンディングインターフェイスは、以下のコマンドで削除できます。
ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 26 / 44

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/delbond?interface=<InterfaceID>

新しい VLAN は、以下のコマンドでインターフェイスに追加できます。
https://<LoadMasterIPAddress>/access/addvlan?interface=<InterfaceID>&vlanid=<ID>

VLAN は、以下のコマンドでインターフェイスから削除できます。
https://<LoadMasterIPAddress>/access/delvlan?interface=<InterfaceID>&vlanid=<ID>

3.9

ローカル DNS 設定

get および set コマンドで管理できるローカル DNS 設定関連のパラメータの詳細については、表 12 を参照してください。
Name

Type

Hostname
ha1hostname
ha2hostnamenamserver
searchlist

S
S
S
A
S

表 12: ローカル DNS のパラメータ

3.10

ルート管理

追加ルートは、以下のコマンドで追加または削除できます。
https://<LoadMasterIPAddress>/access/addroute?dest=<DestIPAddress>&gateway=<GatewayIPAddress>https://<LoadMasterIPAddress>/access/delroute?dest=<DestIPAddress>

get および set コマンドで管理できるルート管理関連のパラメータの詳細については、表13 を参照してください。
Name

Type

dfltgw
dfltgwv6

A (IPv4)
A (IPv6)

DefaultRange

表 13: ルート管理のパラメータ

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 27 / 44

RESTful API
Interface Description

3.11

アクセスリスト

アクセスコントロールリスト（ACL）コマンドを使用すると、ACL のオン/オフの切り替
えや、関連するパラメーターの設定が行えます。
全体的なブラック/ホワイトリストの表示:
https://<LoadMasterIPAddress>/aclcontrol?list=<ListType>
リストの種類black（ブラック）white（ホワイト）

ブラック/ホワイトリストへの（またはブラック/ホワイトリストからの）アドレスの追加/削除:
https://<LoadMasterIPAddress>/aclcontrol?add=<ListType>&addr=<IPAddress/CIDR>
https://<LoadMasterIPAddress>/aclcontrol?del=<ListType>&addr=<IPAddress/CIDR>
特定の仮想サーバーに関するブラック/ホワイトリストの表示:
https://<LoadMasterIPAddress>/aclcontrol?listvs=<ListType>&vsip=<VirtualServerIPAddress>&vsprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>
仮想サーバーのプロト
コル

tcp
udp
CIDR が指定されていない場合、システムは独自のデフォルト値を使用します。

ブラック/ホワイトリストからのアドレスの追加/削除:
https://<LoadMasterIPAddress>/aclcontrol?addvs=<ListType>&vsip=<VirtualServerIPAddress>&vsprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>&addr=<IPAddressToAd
d/CIDR>
https://<LoadMasterIPAddress>/aclcontrol?delvs=<ListType>&vsip=<VirtualServerIPAddress>&vsprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>&addr=<IPAddressToRemove/CIDR>

アクセスコントロールリストが有効かどうかのチェック:https://<LoadMasterIPAddress>/aclcontrol?isenabled

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 28 / 44

RESTful API
Interface Description

アクセスコントロールリストの有効化:
https://<LoadMasterIPAddress>/aclcontrol?enabled=1

接続がブラックリスト上にあるとき、その接続がドロップまたはリジェクトされたかど
うかのチェック:https://<LoadMasterIPAddress>/aclcontrol?isdrop

ブラックリストエントリのドロップの有効化:
https://<LoadMasterIPAddress>/aclcontrol?drop=1

ブラックリストエントリのドロップの無効化:
https://<LoadMasterIPAddress>/aclcontrol?drop=0

接続がブラックリスト上にあるとき、その接続がブロックされたかどうかのチェック:https://<LoadMasterIPAddress>/aclcontrol?isifblock

ブラックリストエントリのブロックの有効化:
https://<LoadMasterIPAddress>/aclcontrol?ifblock=1

ブラックリストエントリのブロックの無効化:
https://<LoadMasterIPAddress>/aclcontrol?ifblock=0

3.12システム管理各種のシステム管理タスクは、RESTful API で管理できます。

3.12.1

ライセンスの更新

ロードマスターのライセンスは、以下のコマンドで更新できます。
https://<LoadMasterIPAddress>/access/license

このコマンドには、いくつかの使用方法があります。たとえば、Linux で CURL コマンドを使用する場合は、以下のようになります。
curl –X –data-binary “@license.txt” –k https://<LoadMasterIPAddress>/access/license

このコマンドは、ライセンス情報を含む license.txt という名前のテキストファイルをシ
ステムにアップロードします。
アクセスキーは、以下のコマンドで取得できます。
https://<LoadMasterIPAddress>/access/accesskey?

3.12.2システムの再起動

ロードマスターは、以下のコマンドでシャットダウンまたは再起動できます。
https://<LoadMasterIPAddress>/access/shutdown?
ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 29 / 44

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/reboot?

3.12.3

ソフトウェアの更新

ロードマスターは、以下のコマンドで新しいバージョンのソフトウェアにアップグレー
ドできます。
https://<LoadMasterIPAddress>/access/installpatch

このコマンドには、いくつかの使用方法があります。たとえば、Linux で CURL コマンドを使用する場合は、以下のようになります。
curl –X POST -–data-binary “@<LM Patch File>” –k https://<LoadMasterIPAddress>/access/installpatch

このコマンドは、パッチ（<LM Patch File>）をシステムにインストールします。
ロードマスターの以前のバージョンのファームウェアは、以下のコマンドで復元できます。
https://<LoadMasterIPAddress>/access/restorepatch

変更内容を反映するには、マシンを再起動する必要があります。

3.12.4

バックアップ/復元

ロードマスターの設定は、以下のコマンドでバックアッ反映するにはプまたは復元できます。
https://<LoadMasterIPAddress>/access/backup
https://<LoadMasterIPAddress>/access/restore?type=<1,2 or3>
type は 1～3 の整数値をとります。

1 = ロードマスターの基本設定
2 = VS の設定
3 = Geo の設定
LoadMaster の設定を復元するための cURL コマンドの例を以下に示します。
curl -X POST --data-binary "@<Path To Backup File>" -khttps://<LoadMasterIPAddress>/access/restore?type=<1, 2 or 3>

3.12.4.1

自動バックアップget および set コマンドで管理できる自動バックアップのパラメータの詳細については、
表 14 を参照してください。
Name

Type

backupday
backupenable
backuphost

Integer
BooleanStringDefault Range

0-7

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 30 / 44

RESTful API
Interface Description

Name

Type

Default Range

backuphourbackupminutebackuppassword
backuppath
backupuser

Integer
IntegerStringStringString0-23
0-59

表 14: バックアップのパラメータ

3.12.5

日付/時刻

get および set コマンドで管理できるバックアップおよび復元関連のパラメータの詳細については、表 15 を参照してください。
Name

Type

ntphosttime
timezoneA
I
S

表 15: 日付/時刻

3.13

ログオプション

3.13.1

デバッグオプション

get および set コマンドで管理できるデバッグオプション関連のパラメータの詳細については、表 16 を参照してください。
Name

Type

irqbalancelinearesplogs
netconsole
netconsoleinterface

B
B
A
I

表 16: デバッグオプション

3.13.2

Syslog オプション

get および set コマンドで管理できる Syslog オプション関連のパラメータの詳細について
は、表 17 を参照してください。
Name

Type

syslogcriticalsyslogemergency

AA

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 31 / 44

RESTful API
Interface Description

Name

Type

syslogerror
sysloginfo
syslognoticesyslogwarn

A
A
A
A

表 17: Syslog オプション

3.13.3

SNMP オプション

get および set コマンドで管理できる SNMP ログオプション関連のパラメータの詳細については、表 18 を参照してください。
Name

Type

snmpcommunity
snmpcontact
snmpenablesnmptrapenablesnmpv1sink
snmpv2sink

S
S
B
B
A
A

表 18: SNMP ログオプション

3.13.4

Email オプション

get および set コマンドで管理できる Email ログオプション関連のパラメータの詳細については、表 19 を参照してください。
Name

Type

emailcriticalemaildomain
emailemergency
emailenableemailerror
emailinfo
emailnoticeemailpassword
emailport
emailserver
emailsslmodeemailuser
emailwarn

S
S
S
B
S
S
S
S
I
S
I
S
S

Range

0-65535
0-3

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 32 / 44

RESTful API
Interface Description

表 19: Email ログオプション

3.14

その他のオプション

3.14.1WUI 設定get および set コマンドで管理できる WUI 設定関連のパラメータの詳細については、表20 を参照してください。
Name

Type

Range

hoverhelp
motd
sessioncontrol
sessionidletime
sessionmaxfailattempts
wuidisplaylines

B
S
B
I
I
I

60-86400
1-999
10-100

表 20: WUI 設定のパラメータ

上記のように"set"コマンドを使用して Message Of The Day（MOTD）を指定する場合、最大 5,000 文字まで入力できます。
5,000 文字を超える MOTD を入力したい場合は、プレーンテキスト
形式で MOTD を保存し、下記のコマンドにて KEMP ロードマスターにその MOTD をポストしてください。
curl –d @<filename> -k
https://bal:<BalPassword>@<PAddress>/access/setmotd

3.14.2

リモートアクセス

get および set コマンドで管理できるリモートアクセス関連のパラメータの詳細について
は、表 21 を参照してください。
Name

Type

admingw
enableapi
geoclientsgeosshportsshaccesssshiface
sshportsshv1prot
wuiaccesswuiiface

A
B
A
I
B
S
I
B
B
I

Range

3-65530

3-65530

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 33 / 44

RESTful API
Interface Description

Name

Type

wuiportgeopartners

I
A

Range

表 21: リモートアクセスのパラメータ

3.14.3WUI の認証および承認オプション

get および set コマンドで管理できる WUI の認証および承認オプション関連のパラメー
タの詳細については、表 22 を参照してください。
Name

Type

ldapbackupserver
ldapsecurity

AI

ldapserver
ldaprevalidateinterval
radiusbackupport
radiusbackupsecretradiusbackupserver
radiusport
radiusrevalidateinterval
radiussecretradiusserver
sessionlocalauth
Sessionauthmode

A
B
I
S
A
I
I
S
A
B
I

Range

0 = 暗号化なし
1 = StartTLS
2 = LDAPS

3-65535

3-65535
10-86400

値は表 23:sessionauthmode の値
で説明

表 22: WUI の認証および承認オプション

表 23 は、sessionauthmode パラメータに与えられた値に応じて選択される、Radius、
LDAP、およびローカルユーザーのオプションについて説明しています。
Radius

値
7
263
775
23
22
788
790
791

認証
No
Yes
Yes
No
No
Yes
Yes
Yes

LDAP

承認
No
No
Yes
No
No
Yes
Yes
Yes

認証
No
No
No
Yes
Yes
Yes
Yes
Yes

ローカル

値
No
Yes
Yes
Yes
No
No
No
Yes

認証
No
Yes
Yes
Yes
Yes
No
Yes
Yes

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 34 / 44

RESTful API
Interface Description

Radius

789
773
262
774
772
278
279

Yes
Yes
Yes
Yes
Yes
Yes
Yes

ローカル

LDAP

Yes
Yes
No
Yes
Yes
No
No

Yes
No
No
No
No
Yes
Yes

Yes
Yes
No
No
No
No
Yes

No
No
Yes
Yes
No
No
Yes

表 23: sessionauthmode の値

3.14.4

L7 設定

get および set コマンドで管理できる L7 関連のパラメータの詳細については、表 24 を参照してください。
Name

Type

addcookieportaddviaalwayspersist

B
B
S

Range

No = HTTP/1.1 接続における最初のリクエストに対してのみパーシステン
スをチェックYes = 全てのリクエ
ストに対してパー
システンスをチェック
0 = HTTP/1.1 接続の最初のリクエストに対してのみパー
システンスをチェ
ック
1 = 全てのリクエス
トに対してパーシ
ステンスをチェック
2 = 接続の途中であってもパーシステ
ンスの全ての変更を保存

closeonerror
dropatdrainend
droponfail

B
B
B

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 35 / 44

RESTful API
Interface Description

Name

Type

Range

expect100

I

0 = RFC 準拠
1 = 常に Expect-100
2 = Continue-100 を無視

rfcconform
rsarelocal
localbindtransparent
slowstart
addforwardheader

B
B
B
B
I
I

0-600
0 = X-ClientSide
1 = X-Forwarded-For
2 = None

表 24: L7 設定

3.14.5

ネットワークオプション

get および set コマンドで管理できるネットワークオプション関連のパラメータの詳細については、表 25 を参照してください。
Name

Type

snat
allowupload
conntimeout
keepalive
multigw
nonlocalrs
onlydefaultroutes
resetclose
subnetorigin
subnetoriginating
tcptimestamp
routefilter

B
B
I
B
B
B
B
B
B
B
B
B

Range

0-86400

表 25: ネットワークオプション

3.14.6

AFE 設定侵入検出パラメータは、以下のコマンドで更新できます。
https://<LoadMasterIPAddress>/access/updatedetect

このコマンドには、いくつかの使用方法があります。たとえば、Linux で CURL コマンドを使用する場合は、以下のようになります。
curl –X POST -–data-binary “@<Detection Rules File>” –k
https://<LoadMasterIPAddress>/access/updatedetect

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 36 / 44

RESTful API
Interface Description

このコマンドは、新しい検出ルール（<Detection Rules File>）をシステムにインストール
します。
ファイル拡張子は、キャッシュ対象外のファイル拡張子のリストから以下のコマンドで追加または削除できます。
https://<LoadMasterIPAddress>/access/addnocache?param=<FileExtension>
https://<LoadMasterIPAddress>/access/delnocache?param=<FileExtension><FileExtension>文字列は、"."で始める必要があります。
ファイル拡張子は、圧縮対象外のファイル拡張子のリストから以下のコマンドで追加または削除できます。
https://<LoadMasterIPAddress>/access/addnocompress?param=<FileExtension>
https://<LoadMasterIPAddress>/access/delnocompress?param=<FileExtension><FileExtension>文字列は、"."で始める必要があります。

get および set コマンドで管理できる AFE 設定関連のパラメータの詳細については、表26 を参照してください。
Name

Type

cachesize
hostcacheparanoia

I
B
I

limitinput

I

Range

yes/no0=低1 = デフォルト2=高
3 = Paranoid
0-100000

表 26: AFE 設定パラメータ

3.14.7

HA 管理

get および set コマンドで管理できる HA パラメータ関連のパラメータの詳細について
は、表 27 を参照してください。
Name

Type

haif
hainitial

I
B

Range

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 37 / 44

RESTful API
Interface Description

Name

Type

Range

hapreferedI

hastyleB

hatimeoutIhavhidhawaitmcast
vmac
Tcpfailovercookieupdate
finalpersist
hamode

I
I
I
B
B
B
I
I

0 = 優先ホストなし
1 = 最初の HA を優
先2 = 2 番目の HA を優
先
0 = レガシーハート
ビート
1 = carp
1=3秒
2=6秒
3=9秒
4 = 12 秒
5 = 15 秒
1-255
0-200

hacheck

B

0, 60-86400
0 = HA モードオフ
1 = HA 1 モード
2 = HA 2 モード

表 27: HA のパラメータ

HA モードを変更しただけでは、非 HA と HA は切り替わりません。
システムを完全に切り替えるには、パートナーと仮想 IP（VIP）のアドレスを設定して再起動する必要があります。RESTful API を使用
して HA を設定する方法については、セクション 3.15 を参照してく
ださい。

hastyle または hamode の変更内容を有効にするには再起動する必要があります。

3.15

RESTful API による HA の設定

RESTful API を使用して HA を設定するのに必要なコマンド例を以下に示します。
1. 機器 1 を HA1 に設定する:
https://192.168.1.1/access/set?param=hamode&value=1

2. HA1 を再起動する:

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 38 / 44

RESTful API
Interface Description

https://192.168.1.1/access/reboot?

3. HA1 のパートナーのアドレス（HA2 のアドレス）を設定する:
https://192.168.1.1/access/modiface?interface=0&PartnerIPAddress=192.168.1.2

4. HA ペアに共通の IP アドレスを設定する:
https://192.168.1.1/access/modiface?interface=0&SharedIPAddress=192.168.1.10

5. HA2 をセカンダリに設定する:
https://192.168.1.2/access/set?param=hamode&value=2

6. HA2 を再起動する:
https://192.168.1.2/access/reboot?

7. HA2 のパートナーのアドレス（HA1 のアドレス）を設定する:
https://192.168.1.2/access/modiface?interface=0&partner=192.168.1.1

8. HA ペアに共通の IP アドレスを設定する:
https://192.168.1.2/access/modiface?interface=0&shared=192.168.1.10

LoadMaster では、reboot などのコマンドが完了するまで数秒かかります。処理を記述する際は、reboot コマンドの後に適切な遅延を入れるよう考慮してください。
HA を削除するには以下のコマンドを使用します。
1. 非 HA に設定する:
https://192.168.1.1/access/set?param=hamode&value=0

2. 再起動する:
https://192.168.1.1/access/reboot?

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 39 / 44

RESTful API
Interface Description

4 ロードマスターRESTful API のスクリプト例文
ロードマスターRESTful API は、ユーザーもしくはアプリケーションがロードマスターへ
直接アクセスするのを許すための、多種のスクリプトとアプリケーションの組み合わせが使用可能です。
下記は、cURL（a Linux command line tool for transferring data with URL syntax）を使用して、XML ファイルによる情報を取得するためのクエリと xpath（他の Linux ツール）を送付する場合の一例です。
cURL のシンタックスは下記です。
curl -o <output XML> -k -silent -u <user>:<Password> <URL>










-o:スクリーンに表示させる代わりに特定ファイルへ結果を出力させます。
<output XML>:ロードマスターからの XML 出力をさせるファイル名。
-k:ロードマスター上の SSL 証明書を無視します。
-silent:スクリーンへの表示をさせません。
-u:下記のログイン情報を使用します。
<user>: ユーザー名。
<Password>:パスワード。
<URL>:送信するクエリ。

Xpath のシンタックスは下記です。
xpath -q –e <XML path> <XML file>-q:生データのみを出力さえ、参考情報はオミットさせます。

<XML file>：解析する XML ファイルの指定。

<XML path>：生データを見つけるための XML ストラクチャの内部パス指定。

XML の構文解析により画面に出力されたデータを印刷する代わりに、以下のようにしてその出力を変数に代入できます。
var=“expr xpath -q –e <XML path> <XML file>”cURL コマンドでは、HTTP POST メソッドを使用してパラメータを渡せます。これは、パラメータが URL にて渡されないため、より安全な方法です。
このメソッドを用いた get コマンドおよび set コマンドの例を以下に示します。
curl --data "param=motd" –k https://<user>:<password>@<LoadMasterIPAddress>/access/getcurl --data "param=motd&value=<value>" –k https://<user>:<password>@<LoadMasterIPAddress>/access/setcURL を使用しての下記のスクリプトは、新しい仮想サービスを追加するクエリをロード
マスターへ送るものです。xpath を使用することにより、ロードマスターが返送してく

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 40 / 44

RESTful API
Interface Description

る仮想サービスの詳細を含む XML よりその仮想サービスに設定されているスケジュール
方式を解析します。

curl -o "response.xml" -k -silent -u "bal":"1fourall" "https://10.0.2.193/access/addvs?vs=10.0.2.194&port=80&prot=tcp&"
var=“expr xpath -q –e "Response/Success/Data/Schedule/text()" response.xml”

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 41 / 44

RESTful API
Interface Description

下記の XML ファイルは、その時にロードマスターが返送する仮想サービスの情報の例です。
<Response stat="200" code="ok"><Success><Data><VSAddress>10.0.2.194</VSAddress><VSPort>80</VSPort><Enable>Y</Enable><SSLReverse>N</SSLReverse><Transactionlimit>0</Transactionlimit><Transparent>Y</Transparent><ServerInit>0</ServerInit><Idletime>0</Idletime><Cache>N</Cache><Compress>N</Compress><Verify>0</Verify><UseforSnat>N</UseforSnat><ForceL7>Y</ForceL7><ClientCert>0</ClientCert><CheckUse1.1>N</CheckUse1.1><CheckUseGet>N</CheckUseGet><VStype>http</VStype><Protocol>tcp</Protocol><Schedule>rr</Schedule><CheckType>http</CheckType><NumberOfRSs>0</NumberOfRSs></Data></Success></Response>

Var にアサインするバリューは‘rr’です。

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 42 / 44

RESTful API
Interface Description

5 参考ドキュメント
特に明記されていない限り、以下のドキュメントはhttp://www.kemptechnologies.com/documentation から入手できます。
WUI 設定ガイド
KEMP ロードマスター

製品概要

CLI インターフェイス説明

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 43 / 44

RESTful API
Interface Description

Document History
Date

ChangeReason for Change

VersionResp.

May 2013

Updates to document

Updates as required forrelease 7.0-4

1.4

DD

May 2013

Updated copyrightUpdated Copyright Notices
section

1.5

LB

July 2013

Major Updates

Updates as required forrelease 7.0-6

2.0

DD

Sep 2013

Minor update

New parameter added

2.1

LB

Nov 2013

Minor changes

Fixed some defects

2.2

LB

Nov 2013

Minor changes

Updates as required forrelease 7.0-10

2.3

DD

Jan 2014

Release updates

Updates for 7.0-12 release

2.4

LB

Feb 2014

Minor update

Additional information added

2.5

LB

Mar 2014

Release updates

Updates for 7.0-14 release

2.6

LB

Apr 2014

Release updates

Updates for 7.1-16 release

2.7

LB

ロードマスターシリーズ リリースノート（Ver 7.1-16)
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Page 44 / 44