RESTful API
Interface Description

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

バージョン:2.18
更新: 2014 年 10 月

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 1 / 76

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.

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

リリースノート（Ver 7.1-22)
Page 2 / 76

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.
（参考訳）
本ソフトウェアは、“現状有姿”で提供され、明示または黙示の保証を含み、それに限定されない
特定の目的に適合するような黙示的な保証は放棄されています。いかなる場合においても、作者
または著作権者は、ソフトウェアの使用またはその他の扱いに関連して、または関連しないで生ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 3 / 76

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 を使用しています。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 4 / 76

RESTful API
Interface Description

目次
1

2

3

はじめに......................................................................................................................................... 8
1.1

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

1.2

対象読者................................................................................................................................. 8

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

RESTful API とは ..................................................................................................................... 9

2.2

セキュリティ....................................................................................................................... 10

2.3

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

2.4

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

2.5

エラーレポート................................................................................................................... 11

2.6

表記....................................................................................................................................... 11

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

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

3.2

ホーム................................................................................................................................... 15

3.3

仮想サービス....................................................................................................................... 15

3.3.1

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

3.3.2

テンプレートの管理................................................................................................... 32

3.3.3

SSO の管理 ................................................................................................................... 32

3.3.4

WAF の設定 .................................................................................................................. 35

3.4

グローバルバランシング................................................................................................... 40

3.4.1

完全修飾ドメイン名（FQDN）の管理 ..................................................................... 40

3.4.2

クラスタの管理........................................................................................................... 44

3.4.3

その他のパラメータ................................................................................................... 45

3.4.4

IP 範囲の選択基準....................................................................................................... 47

3.4.5

GEO の有効化/無効化 ................................................................................................. 48

3.5

統計情報............................................................................................................................... 48

3.6

実サーバー........................................................................................................................... 49

3.6.1
3.7

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

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 5 / 76

RESTful API
Interface Description

3.7.1

ルールの表示............................................................................................................... 51

3.7.2

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

3.7.3

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

3.7.4

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

3.7.5

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

3.7.6

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

3.7.7

Check パラメータ ........................................................................................................ 54

3.8

証明書................................................................................................................................... 54

3.8.1
3.9

OCSP の設定 ................................................................................................................. 55

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

3.9.1

インターフェイス詳細の取得 ................................................................................... 55

3.9.2

インターフェイス詳細の変更 ................................................................................... 55

3.9.3

追加アドレス............................................................................................................... 56

3.9.4

ボンディングインターフェイス ............................................................................... 57

3.9.5

VLANs ............................................................................................................................ 57

3.10

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

3.11

ルート管理....................................................................................................................... 57

3.12

アクセスリスト............................................................................................................... 58

3.13

システム管理................................................................................................................... 59

3.13.1

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

3.13.2システムの再起動....................................................................................................... 60

3.13.3

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

3.13.4

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

3.13.5

日付/時刻 ..................................................................................................................... 61

3.14

ログオプション............................................................................................................... 62

3.14.1

Debug Options .............................................................................................................. 62

3.14.2

Syslog オプション........................................................................................................ 62

3.14.3

SNMP オプション ........................................................................................................ 62

3.14.4

E メールのオプション................................................................................................ 63

3.15

その他のオプション....................................................................................................... 63
ロードマスターシリーズ

Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 6 / 76

RESTful API
Interface Description

3.15.1

3.15.1 WUI 設定 ........................................................................................................... 63

3.15.2

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

3.15.3WUI の認証および承認オプション........................................................................... 64

3.15.4L7 設定 .......................................................................................................................... 66

3.15.5

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

3.15.6

アプリケーションフロントエンド（AFE）の設定 ................................................. 67

3.15.7

HA 管理 ......................................................................................................................... 68

3.15.8Azure の HA パラメータ ............................................................................................. 69

3.16

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

3.16.1RESTful API を使用して通常のロードマスターに HA を設定する......................... 70

3.16.2RESTful API を使用してロードマスターfor Azure に HA を設定する..................... 71

4

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

5

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

Document History ................................................................................................................................. 76

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 7 / 76

RESTful API
Interface Description

1 はじめにKEMP テクノロジーは、アプリケーション提供と負荷分散に関して、価格/性能比に優れた製品群をお求めやすい価格でお客様にご提供しています。当社の製品はさまざまな用
途に対応できる高性能なアーキテクチャを採用しており、最高の価値をもたらすとともに、インターネットベースのインフラストラクチャに依存するビジネスを最適化して、当社のお客様が顧客、従業員、およびパートナーと連携してビジネスを行えるようにします。
KEMP テクノロジーの製品は、高可用性（HA）、高パフォーマンス、柔軟なスケーラビ
リティ、セキュリティ、および管理のしやすさによって定義されるように、Web および
アプリケーションのインフラストラクチャを最適化します。また、柔軟で幅広い導入オ
プションを提供するとともに、Web インフラストラクチャの総所有コスト（TCO）を最小限に抑えます。

1.1

ドキュメントの目的

本ドキュメントでは、KEMP ロードマスターへの RESTful API インターフェイスについて説明します。本ドキュメントでは、RESTful API を使って KEMP ロードマスターの各種機能を設定する方法について詳しく説明します。
本ドキュメントでは、個々の機能やオプションについては詳しく説明していません。詳細については、www.kemptechnologies.com/documentation にある機能説明のドキュメン
トを参照してください。

1.2

対象読者

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 8 / 76

RESTful API
Interface Description

2 The RESTful API Interface インターフェイス
このドキュメントは、ロードマスターへのリモートアクセスを容易に行う為にデザインされたインターフェイスである 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>
100</cachesize>
ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 9 / 76

RESTful API
Interface Description</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” チェックボックスをオンにします。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 10 / 76

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 アドレス

表 2-1: Parameter Notation

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 11 / 76

RESTful API
Interface Description

3 RESTful API コマンド
3.1

コマンドのリスト

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

コマンドは、下記の中の一つとなります。
Commandshowvs
addvs
delvs
modvs
listvs
addrs
delrs
modrs
showrsenablers
disablers
showrule
addruledelrulemodruleaddrsruledelrsrulestats

addcertdelcertbackupcert
restorecert
addintermediatedelintermediate
shutdown
rebootbackuprestorelicenseaccesskey

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 12 / 76

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 の追加
vsaddwafrule
仮想サービスへのアプリケーションファイアウォールパッ
ク（AFP）ルールの割り当て
vsremovewafrule
仮想サービスからの AFP ルールの割り当て解除
adddomain
SSO ドメインの追加
deldomain
SSO ドメインの削除
showdomain
SSO ドメインに関する詳細表示
moddomain
SSO ドメインの変更
showdomainlockedusers SSO ドメインからロックアウトされたユーザーのリスト表
示
installpatch
restorepatch
addroute

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 13 / 76

RESTful API
Interface Description

Command

詳細

SSO ドメインからロックアウトされたユーザーのロック解
除listssoimages
SSO イメージセットのリスト表示
delssoimages
SSO イメージセットの削除
ssoimages
SSO イメージセットのアップロード
getwafsettings
AFP 設定の表示
listwafrules
インストールされた AFP ルールの表示
setwafautoupdate
最新の AFP ルールの自動ダウンロードを有効化
enablewafautoinstall
最新の AFP ルールの自動インストールを有効化
downloadwafrules
最新の AFP ルールの手動ダウンロード
maninstallwafrules
最新の AFP ルールの手動インストール
addwafcustomrule
カスタム AFP ルールの追加
downloadwafcustomrule カスタム AFP ルールのダウンロード
addwafcustomdata
AFP カスタムデータファイルの追加
downloadwafcustomdata AFP カスタムデータファイルのダウンロード
addfqdn
FQDN の新規作成
delfqdn
既存の FQDN の削除
listfqdns
既存の FQDN に関する詳細のリスト表示
showfqdn
特定の FQDN に関する詳細表示
modfqdn
既存の FQDN の変更
modmapFQDN 内のマップ変更
delmapFQDN からのマップ削除
changemaploc
マップの場所の変更
addcountry
FQDN への国の追加
removecountry
FQDN からの国の削除
changecheckeraddr
FQDN チェッカーのアドレス変更
listclusters
既存のクラスターの詳細表示
showcluster
特定のクラスターに関する詳細表示
addcluster
クラスターの新規追加
delcluster
既存のクラスターの削除
modcluster
既存のクラスターの変更
clustchangeloc
クラスターの場所の変更
listparams
GEO の各種パラメーターのリスト表示
modparams
GEO の各種パラメーターの更新
locdataupdate
ロケーションデータファイルのアップロード
listips
IP 範囲選択基準のための IP アドレスセットのリスト表示
showip
IP 範囲選択基準のための特定の IP アドレスセットの表示
addip
IP 範囲選択基準への IP アドレス追加
delip
IP 範囲選択基準からの IP アドレス削除
modiploc
IP 範囲選択基準におけるアドレスの場所の変更
deliploc
IP 範囲選択基準におけるアドレスの場所の削除
unlockdomainusers

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 14 / 76

RESTful API
Interface Description

詳細Commandmodiploc
deliploc
addipcountry
removeipcountry
addcustomlocation
isgeoenabled
enablegeo
disablegeo
aclcontrol
downloadwafauditlog
setmotd
azurehamodeazurehaparamgetazurehaparams

IP 範囲選択基準におけるアドレスの場所の変更
IP 範囲選択基準におけるアドレスの場所の削除
IP アドレスへの国割り当ての追加
IP アドレスへの国割り当ての削除
GEO のカスタムロケーションの追加
GEO が有効かどうかのチェック
GEO 機能の有効化
GEO 機能の無効化
グローバルなブラック/ホワイトリストのリスト表示
AFP 監査ログのダウンロード
Message of the Day（MOTD）の設定
Azure 環境における HA モードの有効化
Azure 環境における HA パラメーターの変更
Azure 環境における Azure HA パラメーターの表示
表 3-1: コマンド

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

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

3.2

ホーム

ロードマスターのバージョンは、get コマンドと version パラメーターを使用して取得できます。
https://<LoadMasterIPAddress>/access/get?param=version

3.3

仮想サービス

3.3.1

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

仮想サービスコマンドの基本形式を以下に示します。仮想サービスは、IP アドレスとインデックスのいずれでも指定できます。インデックスとは、仮想サービスを内部で追跡するための値です。インデックスは showvs コマンドまたは listvs コマンドで表示できます。
https://<LoadMasterIPAddress>/access/listvs

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 15 / 76

RESTful API
Interface Description

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

すべてのパラメータがすべての設定に使用できるとは限りません。
パラメータが使用できるかどうかは、設定する環境により変化します。
SubVSs
仮想サービスのコマンドは SubVS でも使用できます。ただし、SubVS は IP アドレスを持っていないため、SubVS のインデックスを使用する必要があります。SubVS のインデックスを調べるには listvs コマンドを使用します。
特定の SubVS に関する詳細を表示するには、次のコマンドを実行します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 16 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/showvs?vs=<SubVSindex>

次のいずれかのコマンドを実行することで、SubVS を新規に追加できます。
https://<LoadMasterIPAddress>/access/modvs?vs=<VSIP>&port=<Port>&prot=<tcp/udp>&createsubvs=
https://<LoadMasterIPAddress>/access/modvs?vs=<index>&createsubvs=

次のコマンドを実行することで、仮想サービスから SubVS を削除できます。
https://<LoadMasterIPAddress>/access/delrs?vs=<VSindex>&rs=%21<SubVSindex>%21 は!に相当します。
次のコマンドを実行することで、SubVS から実サーバーを削除できます。
https://<LoadMasterIPAddress>/access/delrs?vs=<SubVSindex>&rs=%21<RSindex>

SubVS の設定を変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/modvs?vs=<SubVSindex> [&...]SubVS のインデックスは整数値です。
‘addvs’ と ‘modvs’コマンドに次のパラメータが設定できます。
Name

Type

Default

Adaptive

S (Read only)<unset>

AddVia

I

Cache

B

N

Range

追加情報

このパラメータは読み取り専用であり、表示されるのはScheduling Method
が resource based(adaptive) に設定されている場合に限定されます。
0 = Legacy Operation
これは、WUIの Add
1 = X-Forwarded-For
HTTP Headersフィー
2 = None
ルドに対応します。
3 = X-Client-Side
HTTP リクエストに
4 = X-Client-Side (No Via)
追加されるヘッダを
5 = X-Forwarded-For (No
選択します。XVia)
ClientSide およびX6 = Via Only
Forwarded-Forが追加されるのは、非トラ
ンスペアレンシー接続に限定されます。
0 = Caching disabled
URL のキャッシングを有1 – Caching enabled
効または無効にします。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 17 / 76

RESTful API
Interface Description

Name

Type

Default

CertFile

S<unset>CheckType

S

<tcp>

CheckHost
CheckPatternA
S<unset><unset>

Range

追加情報

インストールされている証明書の ID。
Default dependent on Virtual Real Server のヘルスチェ
Service port. The list of values ックに使用されるプロ
is:トコルを指定します。
 icmp https
 http
 tcp
 smtp nntp
 ftp
 telnet pop3
 imap
 rdp
 bdata noneCheck Type が http または https に設定されている場合: WUI の Reply 200
Pattern に対応します。
このパラメーターは、
HTTP Method が GET ま
たは POST に設定されている場合のみ適用されます。
Check Type が bdata に設定されている場合: 応答内で検索する 16 進文字列を指定します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 18 / 76

RESTful API
Interface Description

Name

CheckUrlType

S

Default

追加情報

Range

<unset>Check Type が http または https に設定されている場合: デフォルトでは、ヘルスチェッカー
はマシンが利用可能かどうかを判断するために URL /へのアクセスを試みます。CheckUrl パ
ラメーターにて他の URLを設定できます。
CheckType が bdata に設定されている場合:
実サーバーに送信する
16 進文字列を指定します。

Ciphers

S

Default
assignment

All supported ciphers

コロンで区切ることにより、複数の暗号化方式を追加できます。
注: この方法で暗号化方式を追加した場合、暗号化方式の割り当てリ
ストが上書きされます。割り当てたい暗号化方式がすべて含まれていることを確認してください。
デフォルトで割り当てられている暗号化方式のリスト、およびサポートされている暗号化のリストについては、
SSL アクセラレーション
サービス 機能説明を参照してください。

MatchLenS

00-8000

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

このパラメーターは、CheckType が bdata に設定されているときのみ関係します。
CheckPattern を検索する
バイト数を指定してください。

リリースノート（Ver 7.1-22)
Page 19 / 76

RESTful API
Interface Description

Name

Type

Default

Range

追加情報

N – Disabled
Y - Enabled

デフォルトでは、ヘルスチェッカーは
HTTP/1.0 を使用して実サーバーの状態をチェックします。このオプションを有効にすると、より効率的な
HTTP/1.1 が使用されます。
チェックするポートです。ポートを指定しない場合、実サーバーのポートが使用されます。
0 = クライアント証明書が不要
1 = クライアント証明書が必要
2 = クライアント証明書と、ヘッダの追加
3 = クライアント証明書と、SSL-CLIENT-CERT としての DER の受け渡し
4 = クライアント証明書と、X-CLIENT-CERT としての DER の受け渡し
5 = クライアント証明書と、SSL-CLIENT-CERT としての DER の受け渡し
6 = クライアント証明書と、X-CLIENT-CERT としての PEM の受け渡し
このオプションを有効にすると、ロードマス
ターから送信されるフ
ァイルが Gzip で圧縮されます。
このパラメーターは、
パーシステンスモード
が Active Cookie に設定されているときのみ関係します。チェックするクッキーの名前を入力してください。

CheckUse1.1

B

N

CheckPortI<unset>ClientCert

I

0

0-6

Compress

BN

N – Disabled
Y - Enabled

CookieS<unset>3-65530

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 20 / 76

RESTful API
Interface Description

Name

Type

Default

CachePercent

I

0DefaultGW

A<unset>EnableB

Y

ErrorCodeI

0

ErrorUrl

S<unset>PortFollow

I<unset>

Range

追加情報

0-100

このパラメーターは、
キャッシングが有効のときのみ関係します。
この仮想サービスで許可するキャッシュ空間の最大使用率を指定してください。
クライアントに応答を返すために使用する、
仮想サービス固有のデ
フォルトゲートウェイ
を指定します。このパラメーターを設定しない場合、グローバルのデフォルトゲートウェ
イが使用されます。
仮想サービスのアクテ
ィブ化または非アクテ
ィブ化
ロードマスターは、実サーバーが利用できな
い場合に HTTP エラーコ
ードをつけて接続を切断できます。このパラメーターでエラーコー
ド番号を指定してください。
実サーバーが利用可能
で、クライアントにエラー応答が返された場
合、リダイレクト URLを指定できます。
フォローする仮想サー
ビスの ID を指定します。この値を 0 に設定
すると、ポートフォロ
ーウィングが無効になります。1 と 2 は無効な値であるため、フォロ
ーする仮想サービスが 3～65530 の値を持っていることを確認してください。

300-550

0 and 3-65530

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 21 / 76

RESTful API
Interface Description

Default

Range

追加情報

ForceL7B

Y (if not UDP)

N - Disabled
Y - Enabled

Idletime
LocalBindAddrs

IA0<unset>VStypeS<portdependent>

このオプションを有効にすると、レイヤ 4 ではなくレイヤ 7 で仮想サービスが実行されます。さまざまな理由でこの設定が必要になります（レイヤー7 のサー
ビスのみ非透過にできる場合など）。
秒単位
これは WUI の Alternate
Source Address に対応します。この機能を動作させるには、Allow
connections scaling over
64K Connections を L7
Configuration で有効にする必要があります。
log タイプを使用できるのは、LoadMasters に
Log Insight アドオンパッ
クがインストールされている場合に限定されます。

NickName
NRequestRules

S
I (Read only)<unset><unset>NResponseRules

I (Read only)<unset>NumberOfRSs

I (Read only)<unset>NRulesI (Read only)<unset>

Name

Type

0-86400
List of IP addresses

gen - Generichttp - HTTP/HTTPS
ts - Remote Terminal
tls – STARTTLS protocols
log – Log Insight

HTTP ヘッダ変更リクエストルールの数を表示します。
HTTP ヘッダ変更レスポ
ンスルールの数を表示します。
HTTP 選択ルールの数を表示します。
コンテンツスイッチが有効なときに Real Serverに割り当てられるルールの数を表示します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 22 / 76

RESTful API
Interface Description

Name

Type

Default

PersistS

none

VSPortProtocolI
S<unset><unset>PersistTimeout

I

0

QueryTag
RequestRules

S
List (Read only)<unset>ResponseRules

List (Read only)

SSLReencrypt

B

N

SSLReverse
SSLRewrite

B
S

N<unset>

Range

追加情報

The list of relevant persist
values are:
 ssl
 cookie active-cookie
 cookie-src
 active-cook-src
 cookie-hash cookie-hash-src
 url query-hash host header super super-src
 src
 rdp
 rdp-src
 rdp-sb
 rdp-sb-src
3-65530
udp, tcp

この仮想サービスで使用するパーシステンス（スティッキネス）の種類を指定します。

0-86400

N – Disabled
Y - Enabled

仮想サービスのポート
仮想サービスで使用するプロトコル
最後に接続してからロードマスターがパーシ
ステンス情報を保持する時間（単位: 秒）
仮想サービスに割り当
てるリクエストルールのリスト
仮想サービスに割り当てる応答ルールのリス
ト
このパラメーターは、
SSL アクセラレーションが有効のときのみ関係します。
このオプションを有効にすると、実サーバーに送信される前に SSL の
データストリームが再暗号化されます。

<unset>, http, https

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 23 / 76

RESTful API
Interface Description

Name

Type

Default

追加情報

Range

ReverseSNIHostname
RuleList
ScheduleS
List(Read only)S<unset>
rr

rr
wrr
lc
wlc
fixed
adaptiveshdlServerInit

I

0

0-6

SSLAcceleration

BN

N - Disabled
Y - EnabledStandbyPort
StandbyAddr
Transparent

I (Read only)A
B<unset><unset>Y

N – Disabled
Y - Enabled

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

rr = round robin（ラウンドロビン）
wrr = weighted roundrobin（加重ラウンドロビン）
lc = least connection（最小接続）
wlc = weighted least
connection（加重最小接続）fixed = 固定加重adaptive = （リソースベース（適応））
sh = source IP hash（ソース IP ハッシュ）dl = weighted
response time（加重レス
ポンス時間）
0 = 通常プロトコル
1 = SMTP
2 = SSH
3 = その他のサーバー初
期化
4 = IMAP4
5 = MySQL
6 = POP3
この仮想サービスで SSLの処理を有効にします。

レイヤー7 を使用している場合、このオプションを有効にすると、実サーバーに到達する接続がクライアントから直接来ているように見えます。または、接続を非透過にすることも可能で、その場合、実サーバーへの接続はロードマスターから来ているように見えます。

リリースノート（Ver 7.1-22)
Page 24 / 76

RESTful API
Interface Description

Name

Type

Default

UseforSnat

B

N

CheckUseGet
VerifyB
I

N
0

VSAddress

A

Address

ExtraHdrKey
ExtraHdrValue
AllowedHosts

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

S<unset>

Range

追加情報

N – Disabled
Y – Enabled

NAT 実サーバーに対してロードマスターを使用している場合、デフォルトでは、ロードマ
スターのソース IP アド
レスがインターネット
で使用されます。
このオプションを有効にすると、仮想サービ
スを使用するよう設定された実サーバーがソース IP アドレスとして使用されます。このオ
プションが設定された複数の仮想サービス上
で実サーバーを構成した場合、宛先ポート 80への接続のみ、この仮想サービスをソース IP
アドレスとして使用します。

0-7 (bitmask)

Verify パラメーターの詳細については、セクシ
ョン 3.3.1.1 を参照
仮想サービスの IP アドレス

このパラメーターは、
ESP が有効のときのみ関係します。この仮想サービスからアクセス可
能な仮想ホストを指定してください。
このパラメーターは ESPが有効のときのみ関係します。この仮想サー
ビスからアクセス可能なすべての仮想ディレ
クトリを指定してください。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 25 / 76

RESTful API
Interface Description

Name

Type

Default

DomainS<unset>LogoffS<unset>ESPLogs

I

7

SMTPAllowedDomains S<unset>EspEnabled

N

B

追加情報

Range

Integer 0-7

N – Disabled
Y - Enabled

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

この仮想サービスが動作するシングルサイン
オン（SSO）ドメイン
このパラメーターは、
ESP が有効かつクライア
ント認証モードがフォ
ームベースに設定されているときのみ関係します。ロードマスター
がログアウトイベントを検出するのに使用する文字列を指定してください。
0 = ログを記録しない
1 = ユーザーアクセス
2 = セキュリティ
3 = ユーザーアクセスとセキュリティ
4 = 接続5 = ユーザーアクセスと接続
6 = セキュリティと接続
7 = ユーザーアクセス、
セキュリティ、接続
注: SMTP サービスの場
合、0 と 4 のみ有効です。SMTP サービスではセキュリティの問題は常に記録されます。ロ
グインされないため、ユーザーアクセスは記録されません。
仮想サービスによる受信を許可するすべてのドメインを指定します。
エッジセキュリティパ
ック（ESP）機能を有効/
無効にします。

リリースノート（Ver 7.1-22)
Page 26 / 76

RESTful API
Interface Description

Range

追加情報

InputAuthMode

I

0

0-4

OutputAuthModeI

Dependant on
InputAuthMode
value

0-2

OutConfS<unset>StartTLSModeI

0-6

ExtraPorts

I

3-65535

AltAddressA

クライアント認証モード。
0 = なし1 = 基本認証
2 = フォームベース
3 = 将来的に使用
4 = 将来的に使用
サーバー認証モード。
0 = なし1 = 基本認証
2 = KCD
アウトバウンド SSO ド
メイン名を入力
0 = HTTP/HTTPS （この機能を動作させるには、Service Type を
HTTP/HTTPS に設定する必要があります）
残りの値を設定するには、Virtual Service Typeを STARTTLS に設定する必要があります。
1 = SMTP（必要な場合
STARTTLS）
2 = SMTP（常にSTARTTLS）
3 = FTP
4 = IMAP
6 = POP3
仮想サービスがリッスンする追加ポートを指定します。
この仮想サービスの代
替アドレスを指定しま
す。

Name

Type

Default<unset>IP address

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 27 / 76

RESTful API
Interface Description

Name

Type

AddViaI

SingleSignOnDir
MasterVSS
I (Read Only)

CreateSubVS

Default<unset><unset>

Range

追加情報

0-6

HTTP ヘッダを追加します。
0 = 従来の操作（XForwarded-For）
1 = X-Forwarded-For（+Via）
2 = なし3 - X-ClientSide（+ Via）
4 = X-ClientSide（Via なし）
5 = X-Forwarded-For（Viaなし）
6 = Via のみ

0 – Not a parent Virtual
仮想サービスが親仮想
Service
サービスであるかどう
1 – Is a parent Virtual Service か（1 つ以上の SubVS を持つかどうか）を表します。
このパラメーターを使用すると、仮想サービ
ス内に SubVS を作成できます。このパラメー
ターは値を持ちません（createsubvs と入力す
ると SubVS が作成されます）。

<unset>

SubVS
Non-local
AllowedGroups

I (Read Only)
B
S<unset>OCSPVerifyB

0 – disabled

この仮想サービスへのアクセスを許可するグ
ループを指定します。
0 – disabled
1 – enabled（オンライ証明書状態
プロトコル（OCSP）を使用して）クライアン
ト証明書が有効かどうかを検証します。

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

パーシステンス方式を‘cookie’に指定した場合、コマンドにてクッキ
ー名も指定する必要があります。
例：
ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 28 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/modvs?vs=10.0.2.194&port=80&prot=tcp&persist=cookie&cookie=<cookie name>&
3.3.1.1

テンプレートを用いた仮想サービスの追加

テンプレートを使用して、仮想サービスの追加と自動設定を行うには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/addvs?vs=<VSIPAddress>&port=<port>&prot=<tcp/udp>&temp
late=<TemplateName>

テンプレートを追加/削除/表示するコマンドについては、セクション 3.3.1.3 を参照してください。
3.3.1.2
1

パラメーターの検証

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

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




3.3.1.3

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

AFP の InterceptOpts は特殊なパラメーターです。このパラメーターを使用すると、他の多くのパラメーターのように 1 つのフィールドではなく、複数のフィールドに値を設定できます。InterceptOpts パラメーターを使用すると、ロードマスターの仮想サービス変
更画面の WAF Options セクションにあるほとんどのフィールドを指定できます。以下に、このパラメーターが関係する WUI のフィールド名の一覧を示します。
1 つのコマンドで 1 つ以上のフィールド値を設定できます。値をセミコロンで区切ることで、1 つのコマンドで複数の値を設定できます。例:
https://<LoadMasterIPAddress>/access/modvs?vs=<VirtualServiceIPAddress>&port=<Port>&prot=<tcp/udp>&InterceptOpts=opnormal;auditnone;reqdataenable;resdataenable;jsondisable;xmldisable

以下の表に、各値が何を意味するかの概要を示します。
同じ WUI オプションに関する値は同時には設定できません。例えば、Basic Operation に opnormal と opblock の両方を設定することはできません。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 29 / 76

RESTful API
Interface Description

関連する WUI オプショ
ン

値

opnormal
opblock
auditnone
auditrelevant
auditallreqdataenablereqdatadisable
resdataenableresdatadisable
jsondisable

jsonenable

xmldisable

xmlenable

意味

Basic Operation を Audit Only に設定します。
Basic Operation を Block Mode に設定します。
Basic Operation を No Audit に設定します。デー
タは記録されません。
Audit mode
Audit mode を Audit Relevant に設定します。警告レベル以上のデータが記録されます。
Audit mode
Audit mode を Audit All に設定します。仮想サービス経由のすべてのデータが記録されます。
通常の動作では Audit All オプションは推奨しま
せん。Audit All は、特定の問題を解決する場合のみ使用してください。
Process Request Data Process Request Data オプションを有効にします。
Process Request Data Process Request Data オプションを無効にします。
Process Response Data Process Response Data オプションを有効にします。
Process Response Data Process Response Data オプションを無効にします。
Disable JSON Parser
JSON パーサーを無効にします。
このオプションは、Process Request Data オプシ
ョンが有効のときのみ関係します。
Disable JSON Parser
JSON パーサーを有効にします。
このオプションは、Process Request Data オプシ
ョンが有効のときのみ関係します。
Disable XML Parser
XML パーサーを無効にします。
このオプションは、Process Request Data オプシ
ョンが有効のときのみ関係します。
Disable XML Parser
XML パーサーを有効にします。
このオプションは、Process Request Data オプシ
ョンが有効のときのみ関係します。
Basic Operation
Basic Operation
Audit mode

表 3-3: InterceptOpts のパラメーター値

3.3.1.4

仮想サービスへの AFP ルールの割り当て

次のコマンドを実行することで、仮想サービスに AFP ルールを割り当てられます。
https://<LoadMasterIPAddress>/access/vsaddwafrule?vs=<VSIPAddress>&port=<Port>&prot=<tcp/udp>&rule=C/<RuleName>

例:
https://10.11.0.30/access/vsaddwafrule?vs=10.11.0.35&port=80&prot=tcp&rule=C/modsecurity_crs_1
3_xml_enabler

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 30 / 76

RESTful API
Interface Description<RuleName>の前には 1 つの文字とスラッシュを記述する必要があります。この文字は、追加するルールの種類によって決まります。
大文字と小文字は区別されます。コマンドを動作させるためにはこの文字は大文字でなければなりません。いずれかのパラメーターを省略すると、String value missing（文字列値がありません）のエラーが表示されます。


C – カスタム
Z – アプリケーション汎用
A – アプリケーション固有G – 汎用vsaddwafrule コマンドでは、上記のコマンド例に示したすべてのパラメーターが必要です。

スペース（または%20）で区切ることで、1 つのコマンドに複数のルールを割り当てることができます。例:
https://10.11.0.30/access/vsaddwafrule?vs=10.11.0.35&port=80&prot=tcp&rule=C/modsecurity_crs_1
3_xml_enabler%20C/modsecurity_crs_10_ignore_static

この方法で複数のルールを割り当てる場合は注意が必要です。既に割り当て済みのルールを追加すると、WAF Misconfigured（WAF の設定が間違っている）状態になります。仮想サービスがこの状態になると、すべてのトラフィックがブロックされます。AFP は、問題解決の際に、必要に応じて仮想サービスがトラフィックをブロックしないようにできます。
関連する WUI 項目
Virtual Services > View/Modify Services > Modify > WUI Options > Assign Rules

3.3.1.5

仮想サービスからの AFP ルールの割り当て解除

次のコマンドを実行することで、仮想サービスから AFP ルールの割り当てを解除できます。このコマンドは、WUI の Modify Virtual Service（仮想サービスの変更）画面のAvailable Rules フィールドおよび Assigned Rules フィールドに関係しています。
https://<LoadMasterIPAddress>/access/vsremovewafrule?vs=<VSIPAddress>&port=<Port>&prot=<tcp/udp>&rule=C/<RuleName>

例：

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 31 / 76

RESTful API
Interface Description

https://10.11.0.30/access/vsremovewafrule?vs=10.11.0.35&port=80&prot=tcp&rule=C/modsecurity_cr
s_13_xml_enabler<RuleName>の前には 1 つの文字とスラッシュを記述する必要があります。この文字は、追加するルールの種類によって決まります。
C – カスタム
Z – アプリケーション汎用
A – アプリケーション固有G – 汎用vsremovewafrule コマンドでは、上記のコマンド例に示したすべてのパラメーターが必要です。いずれかのパラメーターを省略すると、String value missing（文字列値がありません）のエラーが表示されます。

関連する WUI 項目
Virtual Services > View/Modify Services > Modify > WUI Options > Assign Rules

3.3.2

テンプレートの管理

3.3.2.1

テンプレートのアップロード

次の cURL コマンドを実行することで、テンプレートをアップロードできます。
curl –X POST --data-binary “@<TemplateFileName.tmpl>” –k
https://bal:<password>@<LoadMasterIPAddress>/access/uploadtemplate3.3.2.2

インストールされているテンプレートのリスト表示

ロードマスターに存在するテンプレートのリストを表示するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/listtemplates

3.3.2.3

テンプレートの削除

ロードマスターからテンプレートを削除するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/deltemplate?name=<TemplateName>

3.3.3

SSO の管理3.3.3.1

SSO ドメイン

SSO ドメインは、以下のコマンドで管理できます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 32 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/adddomain?domain=<DomainName>

最大 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-LDAPSRADIUSRSA-SECURID
KCD
Certificates

認証サーバーとの通信で使用する転送プロトコルを指定します。

“not-specified”“Principalname”“Username”

LDAP サーバーにより認証されるためのログイン文字列の形式を指定します。
このパラメータは、WUI のDomain/Realm フィールドに対応しています。使用するログインド
メインです。
ログオンフォーマットでも使用され、標準のユーザー名を形成します。例:Principalname:<username>@<domain>
Username:<domain>\<username>
ユーザーがロックアウトされるまでの最大のログイン試行回数
0 – ロックアウトしない
セッションアイドルタイムアウト
値（単位: 秒）。この値はパブリック環境で使用されます。

radius_shared_secreSt(masked)logon_fmt
S<unset>“Principalname”

logon_domain

S<unset>max_failed_auths

I

0

0-999

sess_tout_idle_pub

I90060-86400

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 33 / 76

RESTful API
Interface Description

Name

Type

Default

Range

追加情報

sess_tout_duration_
pub

I

1800

60-86400

sess_tout_idle_priv

I90060-86400

sess_tout_duration_
priv

I

2800

60-86400

sess_tout_type

S“idle time”“idle time”“max duration”

testuser

S<unset>testpass<unset>reset_fail_tout

S(masked)
I

セッションがタイムアウトするまでの最大のセッション継続時間（単位: 秒）。この値はパブリッ
ク環境で使用されます。
セッションアイドルタイムアウト
値（単位: 秒）。この値はプライ
ベート環境で使用されます。
セッションがタイムアウトするまでの最大のセッション継続時間（単位: 秒）。この値はプライベート環境で使用されます。
使用するセッションタイムアウトの種類を指定します。
認証サーバーのチェックで使用されるユーザー名
認証サーバーのチェックで使用されるパスワード

60

60-86400

unblock_tout

I

1800

60-86400

serverS<unset>kerberos_domain
kerberos_kdc
kcd_username
kcd_password

S
S
S
S

<unset><unset><unset><unset>ldap_adminS<unset>ldap_password

S<unset>ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

Failed Login Attempts カウンターを 0 にリセットするまでに必要な時間（単位: 秒）。この値はunblock_tout より小さくなければなりません。
ブロックされたアカウントが自動的にブロック解除されるまでの時間（単位: 秒）。この値はreset_fail_tout より大きくなければなりません。
このドメインを有効にするのに使用されるサーバーのアドレス
The Kerberos Realm
Kerberos Realm
Kerberos Key Distribution Center
kcd_usernames には、二重引用符
または一重引用符を含めることはできません。
kcd_password には、二重引用符または一重引用符を含めることはできません。
データベースにログインして証明書に含まれているユーザーが存在するかどうかをチェックするた
め、ldap_password とともに使用されます。

リリースノート（Ver 7.1-22)
Page 34 / 76

RESTful API
Interface Description

追加情報

Name

Type

Default

Rangecert_check_asi

B

0 - Disabled

0 – Disabled
1 – Enabledserver_side

B

Y – Outbound KCD
SSO domain

Y = Outbound KCD SSO domain
N = Inbound configuration

このオプションは、
Authentication Protocol がCertificates に設定されているときのみ利用できます。このオプションを有効にすると、クライアントの証明書が有効かどうかのチェックに加え、
アクティブディレクトリにあるユーザーの
altSecurityIdentities（ASI）アト
リビュートに基づきクライア
ント証明書がチェックされます。
構成がインバウンドまたはアウト
バウンドのどちらであるかを指定します。

表 3-4: Moddomain parameters

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

3.3.3.2

SSO 画像の設定

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

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

3.3.4

WAF の設定
以下のコマンドは、AFP が有効なライセンスを保有するロードマス
ターでのみ機能します。

KEMP は、AFP ライセンスと AFP サポートを保有するユーザーに対し、ip reputation などのさまざまな商用ルールを提供します。このルールは、毎日自動的にダウンロード/更新

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 35 / 76

RESTful API
Interface Description

するよう設定できます。この商用ルールは、特定の脅威から保護することを目的としています。KEMP が提供する商用ルールは、AFP サポートに申し込むと利用可能になります。
また、ModSecurity コアルールセットなどの汎用の攻撃検出ルールをアップロードすることもできます。これらのルールは、各 Web アプリケーションに基本レベルの保護を提供します。
必要であれば、ユーザー独自のカスタムルールを記述してアップロードすることも可能です。
AFP が有効なロードマスターでは、KEMP が提供したルールを使用するか、アップロー
ド可能なカスタムルールを使用するか、またはそれらを組み合わせて使用するかを選択できます。以下のセクションでは、商用ルールやカスタムルールに特有のコマンド、およびその両方に関するコマンドについて詳しく説明します。
3.3.4.1

商用ルールファイルに関するコマンド

本セクションのコマンドは、すべて商用ルールファイルに関係します。
2.3.3.1.2 商用自動更新設定の表示
getwafsettings コマンドは、商用ルールファイルの自動更新が有効か無効か（それぞれ 1と 0）を表示します。
https://<LoadMasterIPAddress>/access/getwafsettings

関連する WUI 項目
Virtual Services > WAF Settings > Enable Automatic Rule Updates
2.3.3.1.3 商用ルールファイルの自動更新の有効化
setwafautoupdate コマンドを使用すると、最新の商用 AFP ルールファイルの自動ダウン
ロードが有効になります。最新ルールのデフォルトのインストール時刻は午前 4 時です。最新ルールのインストール時刻は、SetWafInstallTime コマンドを実行することで設定できます。詳細はセクション 2.3.3.1.5 を参照してください。
GetWafSetting コマンドを実行することで、現在の設定を確認できます。詳細はセクショ
ン 2.3.3.1.1 を参照してください。
https://<LoadMasterIPAddress>/access/setwafautoupdate?enable=<yes/no>

関連する WUI 項目
Virtual Services > WAF Settings > Enable Automatic Rule Updates
2.3.3.1.4 最新の商用ルールファイルの自動インストールを有効/無効にする
次のコマンドを実行することで、最新の商用ルールファイルの自動インストールを有効/無効にできます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 36 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/enablewafautoinstall?enable=<yes/no>
関連する WUI 項目
Virtual Services > WAF Settings > Enable Automated Installs
2.3.3.1.5 商用ルールファイルの自動インストール時刻の設定
次のコマンドを実行することで、商用ルールファイルの自動インストール時刻を設定できます。これは、WUI の WAF Settings 画面にある When to Install ドロップダウンメニュ
ーに関連しています。
https://<LoadMasterIPAddress>/access/setwafinstalltime?hour=<hour>

hours は 24 時間制の時刻（0～23）です。例えば、13 は午後 1 時を表します。
https://10.11.0.31/access/setwafinstalltime?hour=13

範囲は 0～23 です。分は指定できません。
関連する WUI 項目
Virtual Services > WAF Settings > When to Install
2.3.3.1.6 AFP 商用ルールファイルを直ちにダウンロードする
次のコマンドを実行することで、最新の AFP 商用ルールファイルを手動でダウンロード
できます。これは、WUI の WAF Settings 画面にある Download Now ボタンに関連しています。
https://<LoadMasterIPAddress>/access/downloadwafrules

関連する WUI 項目
Virtual Services > WAF Settings > Download Now
2.3.3.1.7 商用ルールファイルの手動インストール
次のコマンドを実行することで、商用ファイルを手動でインストールできます。これは、WUI の WAF Settings 画面にある Install Now ボタンに関連しています。
https://<LoadMasterIPAddress>/access/maninstallwafrules

関連する WUI 項目
Virtual Services > WAF Settings > Install Now

3.3.4.2

カスタムルールファイルに関するコマンド

本セクションのコマンドは、すべてカスタムルールに関係します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 37 / 76

RESTful API
Interface Description

2.3.3.2.1 カスタムルールファイル/ルールセットのアップロード
addwafcustomrule コマンドと filename パラメーター（必須）とともに cURL コマンドを使用すると、AFP のカスタムルールをアップロードできます。例:
curl –X POST --data-binary “@<FileName.conf>” –k
https://bal:<BalPassword>@<LoadMasterIPAddress>/access/addwafcustomrule?filename=<FileName.conf>

また、カスタムルールファイルの個別アップロードに加え、カスタムルールセット（.tar.gz ファイル）もアップロードできます。OWASP コアルールセットのアップロードの例を以下に示します。
curl –X POST --data-binary “@SpiderLabs-owasp-modsecurity-crs-2.2.9-5gebe8790.tar.gz” –khttps://bal:<BalPassword>@<LoadMasterIPAddress>/access/addwafcustomrule?filename= SpiderLabs-owasp-modsecurity-crs-2.2.9-5-gebe8790.tar.gz

これは、ロードマスターWUI の WAF Settings 画面にある Custom Rules セクションに関連しています。
関連する WUI 項目
Virtual Services > WAF Settings > Custom Rules
2.3.3.2.2 カスタムルールファイルの削除
次のコマンドを実行することで、カスタムルールファイルを削除できます。
https://<LoadMasterIPAddress>/access/delwafcustomrule?filename=<filename>例：
https://10.11.0.30/access/delwafcustomrule?filename=modsecurity_crs_10_ignore_static

この操作では関連するデータファイルは削除されません。
関連する WUI 項目
Virtual Services > WAF Settings > Custom Rules > Delete
2.3.3.2.3 カスタムルールファイルのダウンロード
次のコマンドを実行することで、お使いのローカルマシンにカスタムルールファイルを
ダウンロードできます。
https://<LoadMasterIPAddress>/access/downloadwafcustomrule?filename=<filename>例：
https://10.11.0.30/access/downloadwafcustomrule?filename=modsecurity_crs_55_response_profiling

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 38 / 76

RESTful API
Interface Description

関連する WUI 項目
Virtual Services > WAF Settings > Custom Rule Data > DownloadUpload a Custom Rule Data Fileaddwafcustomdata コマンドと filename パラメーター（必須）とともに cURL コマンドを使用すると、カスタムルールデータファイルをアップロードできます。例:
curl –X POST --data-binary “@<FileName.data>” –k

https://bal:<BalPassword>@<LoadMasterIPAddress>/access/addwafcustomdata?filename=<filename.data>
関連する WUI 項目
Virtual Services > WAF Settings > Custom Rule Data > Add Data File
2.3.3.2.4 カスタムルールデータファイルの削除
次のコマンドを実行することで、カスタムルールデータファイルを削除できます。
https://<LoadMasterIPAddress>/access/delwafcustomdata?filename=<filename.data>
関連する WUI 項目
Virtual Services > WAF Settings > Custom Rule Data > Delete
2.3.3.2.5 カスタムルールデータファイルのダウンロード
次のコマンドを実行することで、カスタムルールデータファイルをダウンロードできます。
https://<LoadMasterIPAddress>/access/downloadwafcustomdata?filename=<filename>例：
https://10.11.0.30/access/downloadwafcustomdata?filename=modsecurity_35_bad_robots

関連する WUI 項目
Virtual Services > WAF Settings > Custom Rule Data > Download
3.3.4.3

カスタムルールと商用ルールの両方に関するコマンド

本セクションのコマンドは、商用ルールとカスタムルールの両方に関係します。
2.3.3.3.1 AFP ルールのリスト表示
listwafrules コマンドは、インストールされているすべてのルール（商用ルールとカスタ
ムルール）をリスト表示します。
このコマンドは、ルールがアクティブかどうかも表示します。アクティブなルールとは、1 つ以上の仮想サービスに割り当てられているルールのことです。
https://<LoadMasterIPAddress>/access/listwafrules

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 39 / 76

RESTful API
Interface Description

関連する WUI 項目
Virtual Services > WAF Settings > Custom Rules
Virtual Services > View/Modify Services > Modify > WAF Options > Available Rules

3.4

グローバルバランシング

3.4.1

完全修飾ドメイン名（FQDN）の管理

3.4.1.1

FQDN の追加

次のコマンドを実行することで、FQDN を追加できます。
https://<LoadMasterIPAddress>/access/addfqdn?fqdn=<FQDNName>

このコマンドでは、fqdn が必須パラメータです。
3.4.1.2

FQDN の削除

次のコマンドを実行することで、FQDN を削除できます。
https://<LoadMasterIPAddress>/access/delfqdn?fqdn=<FQDNName>
このコマンドでは、fqdn が必須パラメータです。
3.4.1.3

FQDN のリスト表示

次のコマンドを実行することで、既存の FQDN のリストを表示できます。
https://<LoadMasterIPAddress>/access/listfqdns
3.4.1.4

FQDN の表示

次のコマンドを実行することで、既存の FQDN についての詳細を表示できます。
https://<LoadMasterIPAddress>/access/showfqdn?fqdn=<FQDNName>
3.4.1.5

FQDN の変更

次のコマンドを実行することで、既存の FQDN を変更できます。
https://<LoadMasterIPAddress>/access/modfqdn?fqdn=<FQDNName>
modfqdn コマンドでは、次のオプションパラメータを使用できます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 40 / 76

RESTful API
Interface Description

Name

Type

Default

SelectionCriteria

S

“rr”

FailTimeI

0siterecoverymode

S

auto

isolateips

B

1 – enabled

failoverB

0 – disabled

追加情報

Range

rr = round robin
FQDN に関連付けられたア
wrr = weighted
ドレスの選択基準
round robin
fw = fixed weighting
rsr = real server loadprx = proximity
lb = location based
0-1440障害遅延が設定されていな
い場合、通常のヘルスチェックが実行されます。設定されている場合、このパラメータによって、障害後、最終的に無効化するまでに待機する時間（分単位）を定義します。
無効化された時点で、通常は元の動作に戻ることはありません。
auto – automatic このパラメータによって、
manual - manual
Site Recovery Mode（サイトリカバリモード）を定義します。automatic に設定されている場合、サイトリ
カバリ後、サイトは即座に元の動作に戻ります。
manual に設定されている
場合、サイトで障害が発生した時点で、サイトは無効化されます。通常の動作に戻すには、手動による対応が必要です。
0 – disabled
パブリックサイトとプライ
1 – enabled
ベートサイトの分離を有効/無効にします。
0 – disabled
このパラメーターは、
1 – enabled
SelectionCriteria が lb（ロケーションベース）に設定されているときのみ関係します。
FQDN フェイルオーバーを有効/無効にします。

表 3-5: ModFQDN のパラメーター

3.4.1.6

マップの追加次のコマンドを実行することで、FQDN にマップを追加できます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 41 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/addmap?fqdn=<FQDNName>&ip=<IPAddressToAdd>
3.4.1.7

マップの変更マップを変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/modmap?fqdn=<FQDNName>&ip=<IPAddressToModify>modmap コマンドでは、次のオプションパラメータを使用できます。
Name

Type

Default

Range

追加情報

CheckerS“icmp”

この IP アドレスに対して実行するチ
ェックの種類を指定します。

Weight

I

1000

none
icmp
tcp
1-65535

EnableB

Y – enabled

ClusterI<unset>MapAddressA<unset>Y – enable
N – disable

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

IP アドレスに関連付ける加重を指定します。最も高い加重を持つアドレスが返されます。このパラメータが関連するのは、FQDN の Selection Criteria
が Weighted Round Robin または Fixed
Weighting に設定されている場合に限定されます。
IP アドレスを有効化または無効化します。
この IP アドレスに関連付けるクラス
タの ID 番号を指定します。
これは、SelectionCriteria が RealServer Load に、Checker が Cluster
Checks に設定されていて、クラスターの種類が Remote LM または Local
LM のときのみ関係します。
関連するロードマスターからマッピン
グされる仮想サービスの IP アドレスを入力してください。

リリースノート（Ver 7.1-22)
Page 42 / 76

RESTful API
Interface Description

Name

Type

Default

MapPortI<unset>

追加情報

Range

これは、SelectionCriteria が RealServer Load に、Checker が Cluster
Checks に設定されていて、クラスターの種類が Remote LM または Local
LM のときのみ関係します。
このパラメーターは、MapAddress パ
ラメーターとともに使用し、マッピン
グする IP アドレスとポートの組み合
わせを指定します。
このパラメーターが設定されていない
場合、選択したアドレスと同じ IP ア
ドレスを持つすべての仮想サービスに対してヘルスチェックが行われます。
いずれかが"UP"（稼働中）状態の場
合、FQDN は"UP"であると表示されます。ポートが指定されている場合、
FQDN のヘルスチェック時にその仮想サービスに対してのみヘルスチェックが行われます。

表 3-6: ModMap のパラメーター

3.4.1.1

マップの削除マップを削除するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/delmap?fqdn=<FQDNName>&ip=<IPAddressToDelete>

3.4.1.2

マップのロケーションの変更

マップのロケーションを変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/changemaploc?fqdn=<FQDNName>&ip=<IPaddress>&lat=<Latit
udeDegreesAndMinutes>&long=<LongituteDegreesAndMinutes>

このコマンドが関連するのは、FQDN の Selection Criteria が Proximityに設定されている場合に限定されます。
3.4.1.3

国の追加

国を追加するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/addcountry?fqdn=<FQDNName>&ip=<IPAddress>&coun
trycode=<TwoCharacterCountry/ContinentCode>&iscontinent=<yes/no>
このコマンドが関連するのは、FQDN の Selection Criteria が Location
Based に設定されている場合に限定されます。Selection Criteria の変更方法に関する詳細は、セクション 3.4.1.5 を参照してください。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 43 / 76

RESTful API
Interface Description

3.4.1.4

国の削除

国を削除するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/removecountry?fqdn=<FQDNName>&ip=<IPAddress>&country
code=<TwoCharacterCountry/ContinentCode>&iscontinent=<yes/no>

このコマンドが関連するのは、FQDN の Selection Criteria が Location
Based に設定されている場合に限定されます。
3.4.1.5

チェッカーアドレスの変更

チェッカーのアドレスを変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/changecheckeraddr?fqdn=<FQDNName>&ip=<IPAddress>changecheckeraddr コマンドでは、次のオプションパラメータを使用できます。
Name

Type

Default

ip

S<unset>

port

I

80

追加情報

Range

IP アドレスのヘルスチェッ
クに使用されるアドレスを指定します。
IP アドレスのヘルスチェッ
クに使用されるポートを指定します。

1-65530

表 3-7: ChangeCheckerAddr のパラメーター

3.4.2

クラスタの管理

3.4.2.1

クラスタのリスト表示

次のコマンドを実行することで、既存のクラスタのリストを表示できます。
https://<LoadMasterIPAddress>/access/listclusters

3.4.2.2

クラスタの表示

次のコマンドを実行することで、特定のクラスタについての詳細を表示できます。
https://<LoadMasterIPAddress>/access/showcluster?id=<ClusterID>

このコマンドでは、id が必須パラメータです。
3.4.2.3

クラスタの追加

次のコマンドを実行することで、クラスタを追加できます。
https://<LoadMasterIPAddress>/access/addcluster?ip=<ClusterIPAddress>&name=<ClusterName>

このコマンドでは、ip および name が必須パラメータです。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 44 / 76

RESTful API
Interface Description

3.4.2.4

クラスタの削除

次のコマンドを実行することで、クラスタを削除できます。
https://<LoadMasterIPAddress>/access/delcluster?id=<ClusterID>

このコマンドでは、id が必須パラメータです。
3.4.2.5

クラスタの変更

次のコマンドを実行することで、クラスタを変更できます。
https://<LoadMasterIPAddress>/access/modcluster?id=<ClusterID>

modcluster コマンドでは、次のオプションパラメータを使用できます。
Name

Type

Default

Range

追加情報

type

S

“Default”

default
remoteLM
localLM

クラスタの種類を変更しま
す。

name

S

checkerS“none”

checkerport

I“0”enableB

1 – enabled

none
tcp
icmp
1-65530

1 = enabled
0 = disabled

クラスタの名前を指定します。
クラスタのステータスチェックに使用される方法を指定します。
クラスタのチェックに使用されるポートを設定します。このパラメータが関連するのは、checker が tcp に設定されている場合に限定されます。
クラスタを有効化または無効化します。

表 3-8: ModCluster のパラメーター

3.4.2.6

クラスタのロケーションの変更

クラスタのロケーションを変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/clustchangeloc?id=<ClusterID>&latsecs=<LatitudeSeconds>&longsecs=<LongitudeSeconds>

3.4.3

その他のパラメータ

3.4.3.1

その他のパラメータのリスト表示

GEO のその他のパラメータのリストを表示するには、次のコマンドを実行します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 45 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/listparams

3.4.3.2

その他のパラメータの変更

次のコマンドを実行することで、GEO のその他のパラメータを変更できます。
https://<LoadMasterIPAddress>/access/modparams

modparams コマンドでは、次のオプションパラメータを使用できます。
Name

Type

Default

SourceOfAuthority

S<unset>namesrv

S<unset>

SOAEmailS<unset>

TTL

I<unset>1-86400

persistI

00-86400

CheckIntervalI120

9-3600ConnTimeout

I

20

4-60

追加情報

Range

Source of Authority リクエストに対する応答を設定します。
Name Server リクエストに対する応答を設定します。
Source of Authority リクエストに対して送信する E メール文
字列を設定します。
ロードマスターから返信された応答の Time To Live（TTL）（単位: 秒）を設定します。
これは、WUI の Stickiness フィールドに対応します。特定の応答をホストに返す時間（単位: 秒）を設定します。
デバイスをチェックする頻度（単位: 秒）を設定します。
注: インターバルの値は、
ConnTimeout と RetryAttemptsの値の積より大きくなければなりません（インターバル＞
タイムアウト×リトライ＋1）。これは、現在のヘルスチ
ェックが完了する前に次のヘ
ルスチェックが開始されないようにするためです。タイム
アウト値またはリトライ値を増やしてこのルールが破られた場合、インターバルの値が自動的に増やされます。
チェックリクエストのタイム
アウト時間（単位: 秒）を設定します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 46 / 76

RESTful API
Interface Description

Name

Type

Default

Range

追加情報

RetryAttempts

I

2

2-10

デバイス故障としてマークされるまでのチェック回数を設定します。

表 3-9: ModParams のパラメーター

3.4.3.3

ロケーションデータパッチファイルのアップロード

ロケーションデータの更新ファイルをアップロードするには、次の cURL コマンドを実行します。
curl –X POST --data-binary “@<GEOPatchFileName>” -khttps://<username>:<password>@<LoadMasterIPAddress>/access/locdataupdate

3.4.4

IP 範囲の選択基準

3.4.4.1

IP アドレスのリスト表示

IP 範囲の選択基準用に設定された IP アドレスのリストを表示するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/listips
3.4.4.2

IP アドレスの詳細表示

IP 範囲の選択基準用に設定された特定の IP アドレスの詳細を表示するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/showip?ip=<IPAddress>
3.4.4.3

IP アドレスの追加

IP アドレスを IP 範囲の選択基準に追加するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/addip?ip=<IPAddress>

3.4.4.4

IP アドレスの削除

IP アドレスを IP 範囲の選択基準から削除するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/delip?ip=<IPAddress>

3.4.4.5

IP アドレスのロケーションの変更

IP アドレスのロケーションを変更するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/modiploc?ip=<IPAddress>&lat=<LatitudeMinutes>&long=<Long
itudeMinutes>

3.4.4.6

IP アドレスのロケーションの削除

IP アドレスのロケーションを削除するには、次のコマンドを実行します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 47 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/deliploc?ip=<IPAddress>

3.4.4.7

IP アドレスに関連付けられた国の追加

IP アドレスに関連付けられた国を追加するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/addipcountry?ip=<IPAddress>&countrycode=<TwoCharacterCo
untryCode>

3.4.4.8

IP アドレスに関連付けられた国の削除

IP アドレスに関連付けられた国を削除するには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/removeipcountry?ip=<IPAddress>

3.4.4.9

カスタムロケーションの追加

次のコマンドを実行することで、カスタムロケーションを追加できます。
https://<LoadMasterIPAddress>/access/addcustomlocation?location=<CustomLocationName>location は必須パラメータです。

3.4.5

GEO の有効化/無効化

3.4.5.1

GEO が有効であるかどうかのチェック

GEO が有効であるかどうかをチェックするには、次のコマンドを実行します。
https://<LoadMasterIPAddress>/access/isgeoenabled

3.4.5.2

GEO の有効化

次のコマンドを実行することで、GEO を有効化できます。
https://<LoadMasterIPAddress>/access/enablegeo
3.4.5.3

GEO の無効化

次のコマンドを実行することで、GEO を無効化できます。
https://<LoadMasterIPAddress>/access/disablegeo

3.5

統計情報

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

コマンドが正常に実行された場合、仮想サービスおよび実サーバーのあらゆる統計情報
が以下のフォーマットで返されます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 48 / 76

RESTful API
Interface Description

実サーバーの統計情報は、仮想サービス単位に返されます。
<?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><Bits>0</Bits><Persist>0</Persist><ActiveConns>0</ActiveConns></Rs></Data></Success></Response>

3.6

実サーバー

実サーバーは、下記のコマンドの中の一つを使用することで管理が可能です。
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/delrs?vs=<IPaddr>&port=<Port>&prot=<tcp/udp>&rs=%21<RealServerindex>

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 49 / 76

RESTful API
Interface Description

listvs コマンドを実行して RsIndex を見ることで、実サーバーのインデックスを取得できます。実サーバーのインデックス値は、%21 の後に入力します。例:
https://<LoadMasterIPAddress>/access/delrs?vs=10.11.0.30&port=80&prot=t
cp&rs=%211
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=!<RSIn
dex>

サービス名とインデックスが競合した場合、例えば、“10”という名前のサービスがあり、それとは別に、インデックス値 10 を持つ実サーバーが存在する場合、“rs=!10”は 10 というサービス名ではなく、
インデックス値 10 を指します。
‘addrs‘と‘modrs’ は、オプションとして下記のパラメータが許されます。
Name

Type

Default

weightI

1000

newportI<unset>forwardSnat

enable
limit

B
I

Y
0

Range

追加情報

重み付けラウンドロビンスケジューリング
を使用している場合、実サーバーの重みを使用して、サーバーに送信されるトラフィ
ックの相対比が指定されます。高い値を持つサーバーほど、多くのトラフィックを受信します。
3-65535 (change the Port 実サーバーで使用されるポートof the Real Server)nat, route
使用されるフォワーディング方式の種類。
デフォルトの方式は NAT です。サーバーからの直接返信は、レイヤ 4 サービスでのみ使用可能です。
実サーバーを有効/無効にします。
0-100000
実サーバーがローテーションから外される前に、実サーバーに送信可能なオープン接
続の最大数
1-65535

表 3-10: 実サーバーのパラメータ

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 50 / 76

RESTful API
Interface Description

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

3.6.1

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

3.6.1.1

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

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

または、
https://<LoadMasterIPAddress>/access/disablers?rs=<IPaddr>

3.6.1.2

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

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

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

3.7

ルールとチェック

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

3.7.1

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

0
1
2
3
4

Type

Description

MatchContentRule The original rules.
AddHeaderRule Rule to Add header field
DeleteHeaderRule Rule to Delete a header field.
ReplaceHeaderRule Rule to modify a header field.
ModifyURLRule URL rewrite rule.
ロードマスターシリーズ

Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 51 / 76

RESTful API
Interface Description

表 3-11: ルールのタイプ

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

3.7.2

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

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

3.7.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

inchostB

NnocaseBNnegateincqueryB
B

N
N

headerS<unset>patternS<unset>See below

追加情報

ルールにより実行される照合の種類照合を行う前に、リクエスト URIの先頭にホスト名を追加します。
文字列比較の際に大文字と小文字を区別しません。
照合の意味を反転します。
照合を行う前に、URI にクエリ文字列を追加します。
照合するヘッダーフィールド名。
ヘッダーフィールドが設定されていない場合、デフォルトで URL にて照合が行われます。
照合パターン

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 52 / 76

RESTful API
Interface Description

Type 1 (AddHeaderRule)
Name

Type

Default

追加情報

headerreplacement

S
S<unset><unset>追加するヘッダーフィールド名

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

Type

Default

patternS<unset>

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

Type

Default

追加情報

headerreplacement
pattern

S
S
S<unset><unset><unset>置換対象のヘッダーフィールド名
置換文字列
照合パターン

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

Type

Default

追加情報

replacement
patternS
S<unset><unset>

URL 変更方法
照合パターン

表 3-16: ルールのタイプ 4 のパラメータ

3.7.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.7.5

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

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 53 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/addrequestrule?vs=<IPaddr>&port=<P
ort>&prot=<tcp/udp>&rule=<RuleName>

3.7.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>&rule=<RuleName>
https://<LoadMasterIPAddress>/access/delrequestrule?vs=<IPaddr>&port=<P
ort>&prot=<tcp/udp>&rule=<RuleName>

3.7.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.8

証明書

証明書は、以下のコマンドで管理できます。
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>

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 54 / 76

RESTful API
Interface Description

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

Type

admincertsslrenegotiate
localcert

S
B
S

表 3-17: 証明書のパラメータ

3.8.1

OCSP の設定

get コマンドと set コマンドで管理可能な OCSP に関するパラメーターの詳細を以下の表
3-25 に示します。get コマンドと set コマンドについてはセクション 2.4 を参照してくだ
さい。
Name

Type

追加情報

OCSPPort
OCSPUseSSLOCSPOnServerFail

I
B
B

OCSPServer
OCSPUrlAS

OCSP サーバーのポート
SSL を使用して OCSP サーバーに接続します。
OCSP サーバーの接続障害またはタイムアウト
を、OCSP サーバーが有効な応答を返したものとして（クライアント証明書が有効であるもの
として）処理します。
OCSP サーバーのアドレス
OCSP サーバーにアクセスするための URL

3.9

インターフェイス

3.9.1

インターフェイス詳細の取得

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

インターフェイス ID とは、インターフェイスの番号のことです。例えば、eth0 のイン
ターフェイス ID は 0 です。

3.9.2

インターフェイス詳細の変更

インターフェイスのパラメータは、以下のコマンドで変更できます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 55 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/modiface?<parameter>=<value>

1 回の呼び出しにつき 1 つのパラメータのみ変更できます。このパラメータは以下の順序でチェックされます。
Name

Type

Description

追加情報

addr

S

IP アドレス

mtu

I

MTU サイズ
範囲: 512-9216

このインターフェイスのインターネッ
トアドレスを指定します。
このインターフェイスから送信される
イーサネットフレームの最大サイズを変更します。

hacheck
gwifaceB
B

bondmodeIpartnerS

sharedSadminwuienableB

geotraffic

B

HA のみ
このインターフェイスをデ
フォルトゲートウェイとして使用する
1 = active-backup
4 = 802.3ad
パートナーマシンの IP アド
レス（HA のみ）
共有アドレスの IP アドレス
（HA のみ）このオプションは、"multihomedwui"パラメータが yes に設定されているときのみ yes にできる。このコマンドについてはセクシ
ョン 3.15.2 を参照
GEO のレスポンスおよびリ
クエスト用に、このインターフェイスを使用するかどうかを指定します。
表 3-18: インターフェイスパラメータの変更

3.9.3

追加アドレス

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

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 56 / 76

RESTful API
Interface Description

3.9.4

ボンディングインターフェイス

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

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

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

BondID は、WUI のメインメニューの Interfaces セクションにおけるボンディング番号です。例えば、bnd2 は値 2 の BondID を持ちます。

3.9.5

VLANs

ボンディングは、以下のコマンドで削除できます。
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.10

ローカル DNS 設定

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

Type

追加情報

Hostname
ha1hostname
ha2hostnamenamserver

S
S
S
A

ローカルマシンのホスト名を設定します。

searchlist

S

ロードマスターでローカルに名前解決するための DNS サーバーの IP アドレス
DNS ネームサーバーへのリクエストの先頭に追加するドメイン名を指定します。

表 3-19:ローカル DNS のパラメータ

3.11

ルート管理

追加ルートは、以下のコマンドで追加または削除できます。
ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 57 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/addroute?dest=<DestIPAddress>&gateway=<GatewayIPAddress>https://<LoadMasterIPAddress>/access/delroute?dest=<DestIPAddress>

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

Type

dfltgw

A (IPv4)<unset>dfltgwv6

A (IPv6)<unset>

追加情報

Default

インターネットとの接続に使用する IPv4
デフォルトゲートウェイを指定します。

表 3-20: ルート管理のパラメータ

3.12

アクセスリスト
アクセス制御リスト（ACL）コマンドでは、ACL のオン/オフの切り替
えと、関連パラメータの設定および取得を実行できます。仮想サー
ビス IP アドレスの指定なしで ACL コマンドを実行すると、グローバ
ル ACL に対して実行されます。仮想サービス IP アドレスが設定されている場合、このコマンドは特定の仮想サービスの ACL に対してのみ実行されます。
‘All Permissions’の権限を持つユーザーのみグローバルコマンドを実行できます。
‘All Permissions’および‘Virtual Service’の権限を持つユーザーは、仮想サービス固有のコマンドを実行できます。

全体的なブラック/ホワイトリストの表示:
https://<LoadMasterIPAddress>/access/aclcontrol?list=<ListType>
リストの種類black（ブラック）white（ホワイト）
表 3-21: アクセスリストの種類

全体的なブラック/ホワイトリストへの（または全体的なブラック/ホワイトリストからの）アドレスの追加/削除:
https://<LoadMasterIPAddress>/access/aclcontrol?add=<ListType>&addr=<IPAddress/CIDR>
https://<LoadMasterIPAddress>/access/aclcontrol?del=<ListType>&addr=<IPAddress/CIDR>

特定の仮想サービスに関するブラック/ホワイトリストの表示:

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 58 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/aclcontrol?listvs=<ListType>&vsip=<VirtualServerIPAddress>&v
sprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>
仮想サーバーのプロトコル

tcp
udp
表 3-22: 仮想サーバーのプロトコル

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

仮想サービスのブラック/ホワイトリストへの（またはブラック/ホワイトリストからの）アドレスの追加/削除:
https://<LoadMasterIPAddress>/access/aclcontrol?addvs=<ListType>&vsip=<VirtualServerIPAddress>&
vsprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>&addr=<IPAddressToAdd/CIDR>
https://<LoadMasterIPAddress>/access/aclcontrol?delvs=<ListType>&vsip=<VirtualServerIPAddress>&v
sprot=<VirtualServerProtocol>&vsport=<VirtualServerPort>&addr=<IPAddressToRemove/CIDR>

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

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

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

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

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

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

3.13

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 59 / 76

RESTful API
Interface Description

3.13.1

ライセンスの更新

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

このコマンドは、ライセンス情報を含む license.txt という名前のテキストファイルをシ
ステムのカレントディレクトリにアップロードします。license.txt を別の場所に保存したい場合は、コマンドにてそのパスを指定してください。
アクセスキーは、以下のコマンドで取得できます。
https://<LoadMasterIPAddress>/access/accesskey?

3.13.2システムの再起動

ロードマスターは、以下のコマンドでシャットダウンまたは再起動できます。
https://<LoadMasterIPAddress>/access/shutdown?
https://<LoadMasterIPAddress>/access/reboot?

3.13.3

ソフトウェアの更新

installpatch コマンドを実行することで、ロードマスターのソフトウェアを新しいバージ
ョンにアップグレードできます。
このコマンドには、いくつかの使用方法があります。たとえば、Linux で CURL コマンドを使用する場合は、以下のようになります。
curl –X POST -–data-binary “@<LM Patch File>” –k https://<LoadMasterIPAddress>/access/installpatch

この cURL コマンドは、パッチ（<LM Patch File>）をシステムにインストールします。
アップロードするファイルは有効なパッチファイルでなければなりません。WUI にてファイルが機能しない場合、そのファイルはRESTful API コマンドでも機能しません。
ロードマスターの以前のバージョンのファームウェアは、以下のコマンドで復元できます。
https://<LoadMasterIPAddress>/access/restorepatch

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

3.13.4

バックアップ/復元

ロードマスターの設定は、以下のコマンドでバックアッ反映するにはプまたは復元できます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 60 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/backup

https://<LoadMasterIPAddress>/access/restore?type=<1,2 or3>
type は 1～3 の整数値をとります。
Name

type

Type

Range

Integer

1-3

Description

1 = ロードマスターの基本設定
2 = VS の設定
3 = GGeo の設定

表 3-23: バックアップのパラメータ

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

3.13.4.1

Automated Backups

Parameters relating to automated backups that can be managed using get and set commands
are detailed in 表 3-24. Refer to Section 2.3 for the get and set commands.
Name

Type

Default Range

backupday

IntegerDailybackupenable

BooleanNbackuphostbackuphourbackupminutebackuppassword
backuppath
backupuser

StringInteger
IntegerStringStringString

0
0

0-7

0-23
0-59

追加情報

自動バックアップを何曜日に実行するか（または毎日実行するか）を指定します。
自動定期バックアップを有効にします（FTP 経由）。
リモートホスト
自動バックアップ実行時刻（時）自動バックアップ実行時刻（分）リモートユーザーのパスワード
リモートパス名を指定します。
リモートユーザー名を指定します。

表 3-24: Backup Parameters3.13.5

日付/時刻

get および set コマンドで管理できる日付と時刻のパラメータの詳細については、表3-25 を参照してください。get および set コマンドについてはセクション 2.4 を参照して
ください。
Name

Type

ntphosttime
timezoneS
I
S

表 3-25: 日付/時刻

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 61 / 76

RESTful API
Interface Description

RESTful API コマンドを使用して時刻を設定することはできません。

3.14

ログオプション

3.14.1

Debug Options

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

Type

irqbalancelinearesplogs
netconsole
netconsoleinterface

B
B
A
I

表 3-26: デバッグオプション

3.14.2

Syslog オプション

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

Type

syslogcriticalsyslogemergency
syslogerror
sysloginfo
syslognoticesyslogwarn

A
A
A
A
A
A

表 3-27: Syslog オプション

3.14.3

SNMP オプション

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

Type

snmpcommunity
snmpcontact
snmpenablesnmptrapenablesnmpv1sink
snmpv2sink

S
S
B
B
A
A

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 62 / 76

RESTful API
Interface Description

Name

Type

snmplocationsnmpclientSS

表 3-28: SNMP ログオプション

3.14.4

E メールのオプション

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

Type

emailcriticalemaildomain
emailemergency
emailenableemailerror
emailinfo
emailnoticeemailpassword
emailport
emailserver
emailsslmode

S
S
S
B
S
S
S
S
I
S
I

emailuser
emailwarn

S
S

追加情報

Range

0-655350-30 = None
1 = STARTTLS, if available
2 = STARTTLS
3 = SSL/TLS

表 3-29: Email ログオプション

3.15

その他のオプション

3.15.1

3.15.1 WUI 設定

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

Type

hoverhelp
motd
sessioncontrol
sessionidletime
sessionmaxfailattempts

B
S
B
I
I

Range

追加情報

最大 5,000 文字
60-86400
1-999

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

単位: 秒

リリースノート（Ver 7.1-22)
Page 63 / 76

RESTful API
Interface Description

Name

Type

wuidisplaylines

I

追加情報

Range

10-1001 つの統計情報ページで表示可能な最大行数を設定します。

表 3-30: WUI 設定のパラメータ

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

3.15.2

リモートアクセス

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

Type

admingw
enableapi
geoclientsgeosshportsshaccesssshiface
sshportsshv1prot
wuiaccesswuiiface
wuiport

A
B
A
I
B
S
I
B
B
I
I

geopartners
multihomedwui

A
B

Range

追加情報

3-65530

3-65530

デフォルト値は443

表 3-31: リモートアクセスのパラメータ3.15.3WUI の認証および承認オプション

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 64 / 76

RESTful API
Interface Description

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 = Not Encrypted
1 = StartTLS
2 = LDAPS

3-65535

3-65535
10-86400

秒単位

値は表 3-33 で説明

表 3-32: WUI の認証および承認オプション

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

値
7
263
775
23
22
788
790
791
789
773
262
774
772
278
279

認証
No
Yes
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes

ローカル

LDAP

承認
No
No
Yes
No
No
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
No
No

認証
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
Yes
Yes

値
No
Yes
Yes
Yes
No
No
No
Yes
Yes
Yes
No
No
No
No
Yes

認証
No
Yes
Yes
Yes
Yes
No
Yes
Yes
No
No
Yes
Yes
No
No
Yes

表 3-33: sessionauthmode の値

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 65 / 76

RESTful API
Interface Description

3.15.4

L7 設定

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

Type

addcookieportaddviaalwayspersist

B
B
S

Range

closeonerror
dropatdrainend
droponfail
expect100

B
B
B
I

rfcconform
rsarelocal
localbindtransparent
slowstart
addforwardheader

B
B
B
B
I
I

0-2

logsplitinterval

I

1-100

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

説明

このパラメーター
は no と yes も有効な値として受け付
けます。no と yesはそれぞれ 0 と 1に対応します。

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

0-2

0-600

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

0 = X-クライアントサイド
1 = X-フォワーディング
される
2 =なし
デフォルト値は 10 です。このパラメータが関連するのは、
LoadMasters に Log
Insight アドオンパックが含まれている場合に限定されます。

リリースノート（Ver 7.1-22)
Page 66 / 76

RESTful API
Interface Description

表 3-34: L7 設定

3.15.5

ネットワークオプション

get および set コマンドで管理できるネットワークオプション関連のパラメータの詳細については、表 3-35 を参照してください。get および set コマンドについてはセクション
2.4 を参照してください。
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

表 3-35: ネットワークオプション

3.15.6

アプリケーションフロントエンド（AFE）の設定

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

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

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 67 / 76

RESTful API
Interface Description

https://<LoadMasterIPAddress>/access/delnocompress?param=<FileExtension><FileExtension>文字列は、"."で始める必要があります。

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

Type

cachesize
hostcacheparanoia

I
B
I

limitinput

I

Range

1-409
yes/no0 = Low
1 = Default
2 = High
3 = Paranoid
0-100000

表 3-36: AFE 設定パラメータ3.15.7

HA 管理
ロードマスターfor Azure を使用する場合は次のセクションを参照してください。

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

Type

haif
hainitial
hapreferedI
B
I

hastyleB

hatimeoutIhavhidIRange

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

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 68 / 76

RESTful API
Interface Description

Name

Type

hawaitmcast
vmac
Tcpfailovercookieupdate
finalpersist
hamode

I
I
B
B
B
I
I

hacheck

B

Range

0-200

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

表 3-37: HA のパラメータ

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

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

3.15.8Azure の HA パラメータ
このコマンドはロードマスターfor Azure にのみ関係します。

Azure の HA モードは、以下のコマンドで設定できます。
https://<LoadMasterIPAddress>/access/azurehamode?hamode=<master/slave/single>

Azure の HA パラメータは、以下のコマンドで設定できます。
https://<LoadMasterIPAddress>/access/azurehaparam?partner=<PartnerHostNameOrIPAddress>&
hcp=<HealthCheckPort>

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

3.16

RESTful API による HA の設定

以下の 2 つのセクションでは、RESTful API を使用して通常のロードマスターおよびロードマスターfor Azure に HA を設定する方法について、ステップバイステップで説明します。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 69 / 76

RESTful API
Interface Description

3.16.1RESTful API を使用して通常のロードマスターに HA を設定する

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

2. HA1 を再起動する:
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?

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 70 / 76

RESTful API
Interface Description

3.16.2RESTful API を使用してロードマスターfor Azure に HA を設定する

RESTful API を使用してロードマスターfor Azure に HA を設定するのに必要なコマンド例を以下に示します。
1. マスターユニットをマスターHA モードに設定する:
https://192.168.1.1/access/azurehamode?hamode=master2. マスターの HA パラメータ（パートナーアドレスおよびヘルスチェックポート）
https://192.168.1.1/access/azurehaparam?partner=192.168.1.2&hcp=8444

3. スレーブユニットをスレーブ HA モードに設定する:
https://192.168.1.2/access/azurehamode?hamode=slave

4. スレーブの HA パラメータ（パートナーアドレスおよびヘルスチェックポート）を設定する:
https://192.168.1.2/access/azurehaparam?partner=192.168.1.1&hcp=8444
HA を削除するには以下のコマンドを使用します。
https://192.168.1.1/access/azurehamode?hamode=single
https://192.168.1.2/access/azurehamode?hamode=single

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 71 / 76

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>

ユーザー名またはパスワードにスペースが含まれる場合は、"<user">:"<password>"のように、<user>と<password>を二重引用符で囲んでください。









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

Xpath のシンタックスは下記です。
xpath -q –e <XML path> <XML file>-q:生データのみを出力さえ、参考情報はオミットさせます。
<XML path>：生データを見つけるための XML ストラクチャの内部パス指定。
<XML file>：解析する XML ファイルの指定。

XML の構文解析により画面に出力されたデータを印刷する代わりに、以下のようにしてその出力を変数に代入できます。
var=“expr xpath -q –e <XML path> <XML file>”cURL コマンドでは、HTTP POST メソッドを使用してパラメータを渡せます。これは、パラメータが URL にて渡されないため、より安全な方法です。
このメソッドを用いた get コマンドおよび set コマンドの例を以下に示します。
curl --data "param=motd" –khttps://<user>:<password>@<LoadMasterIPAddress>/access/get

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 72 / 76

RESTful API
Interface Description

curl --data "param=motd&value=<value>" –k https://<user>:<password>@<LoadMasterIPAddress>/access/setcURL を使用しての下記のスクリプトは、新しい仮想サービスを追加するクエリをロード
マスターへ送るものです。xpath を使用することにより、ロードマスターが返送してくる仮想サービスの詳細を含む 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”

下記の 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>

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 73 / 76

RESTful API
Interface Description

上記の例では、response.xml を構文解析し、"Response/Success/Data/Schedule/text()"のパスからデータを取得しています。schedule のデータは‘rr’であるため、var 変数には ‘rr’が代入されます。

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 74 / 76

RESTful API
Interface Description

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

製品概要

SSL アクセラレーションサービス

機能説明

CLI インターフェイス説明

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 75 / 76

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

May 2014

Defects resolved

Fixed some defects

2.8

LB

June 2014

Minor changes

Fixed some defects

2.9

LB

June 2014

Release updates

Updates for 7.1-18 release

2.10

LB

July 2014

Minor changes

Fixed some defects

2.11

LB

Aug 2014

Updates madeFixed some defects

2.12

LB

Aug 2014

Minor changes

Fixed some defects

2.13

LB

Sep 2014

Release updates

Updates for 7.1-20a release

2.14

LB

Sep 2014

Minor changes

Fixed some defects

2.15

LB

Sep 2014

Minor changes

Fixed some defects

2.16

LB

Oct 2014

Minor changes

Fixed some defects

2.17

LB

Oct 2014

Release updates

Updates for 7.1-22 release

2.18

LB

ロードマスターシリーズ
Copyright © 2002 - 2014 KEMP Technologies, Inc. All Rights Reserved.

リリースノート（Ver 7.1-22)
Page 76 / 76