APIを使用したStyleBookからの構成作成
NetScaler Consoleは、StyleBookをインポートする際に検証します。検証が成功すると、StyleBookはNetScaler ConsoleのStyleBookカタログに表示され、構成の作成に使用できるようになります。
これで、StyleBook APIを使用してこのStyleBookに基づいた構成を作成できます。cURLコマンドラインツールやPostman Chromeブラウザ拡張機能など、任意のツールを使用して、NetScaler ConsoleにHTTPリクエストを送信できます。
例 1
ロードバランシング仮想サーバーを作成するためのStyleBookで作成したlb-vserver StyleBookを検討します。このStyleBookから構成パックを作成するには、次のようにREST APIを使用します。
HTTPメソッド: POST
URL: https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
Content-Type: application/json
Accept: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "lb1",
"vip-ipaddress": "10.102.117.31"
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
}
],
"stylebook": {
"name": "lb-vserver",
"namespace": "com.example.stylebooks",
"version": "1.0"
}
}
}
<!--NeedCopy-->
このHTTPリクエストでは、IPアドレス10.102.117.31のロードバランシング仮想サーバーlb1が、インスタンスID「deecee30-f478-4446-9741-a85041903410」を持つNetScalerインスタンス上に作成されます。NetScalerインスタンスのインスタンスIDは、NetScaler Consoleから取得されます。
NetScaler Consoleによって管理されているインスタンスのIDを取得するには、NetScaler Console APIを使用できます。たとえば、IPアドレスが192.168.153.160のNetScalerインスタンスのインスタンスIDを取得するには、次のAPIを使用できます。
HTTPメソッド: GET
URL: https://<IP>/nitro/v2/config/ns?filter=ip_address:192.168.153.160
リクエストヘッダー:
Accept: application/json
応答には、JSONペイロードにIDが含まれています。
期待される応答ヘッダー (成功時):
200 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"errorcode": 0,
"message": "Done",
"operation": "get",
"resourceType": "ns",
"username": "nsroot",
"tenant_name": "Owner",
"resourceName": "",
"ns":
[
{
"is_grace": "false",
"hostname": "",
"std_bw_config": "0",
"gateway_deployment": "false",
"id": "deecee30-f478-4446-9741-a85041903410",
}
]
}
<!--NeedCopy-->
構成 (構成パック) が正常に作成された場合、次のHTTP応答が返されます。
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"job":
{
"job_id": "1460806080"
}
}
<!--NeedCopy-->
ID 1460806080を使用して一意に識別される最初のジョブを作成しました。このIDを使用して、構成のクエリ、更新、または削除を行うことができます。
ジョブのステータスを照会するには、次のURLを使用できます。
https://<IP>/stylebook/nitro/v2/config/jobs/<jobid>。
例 2
同じStyleBookを使用して別の構成パックを作成し、同じまたは異なるNetScalerインスタンスで実行できます。この例では、別の構成を作成し、仮想サーバーに異なる名前とIPアドレスを指定します。ロードバランシングメソッドとしてLEASTCONNECTIONを指定します。この構成を2つのNetScalerインスタンスに展開します。
HTTPリクエストは次のとおりです。
HTTPメソッド: POST
URL: https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
Content-Type: application/json
Accept: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "lb1",
"vip-ipaddress": "10.102.117.31",
"lb-alg": "LEASTCONNECTION"
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abcdee30-f478-4446-9741-a85041903410"
}
],
"stylebook": {
"name": "lb-vserver",
"namespace": "com.example.stylebooks",
"version": "1.0"
}
}
}
<!--NeedCopy-->
このHTTPリクエストでは、IPアドレス10.102.117.31のロードバランシング仮想サーバーlb1が、インスタンスID「deecee30-f478-4446-9741-a85041903410」と「abcdee30-f478-4446-9741-a85041903410」を持つ2つのNetScalerインスタンス上に作成されます。
構成パックの作成が成功すると、次のHTTP応答が返されます。
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"job": {
"job_id": "165769629"
}
}
<!--NeedCopy-->
この新しい構成パックには、異なるID 1657696292が割り当てられています。このIDを使用して、この構成を更新または削除できます。
例 3
基本的なロードバランシング構成を作成するためのStyleBookで作成した「basic-lb-config」StyleBookを検討します。このStyleBookから構成パックを作成するには、次のようにREST APIを使用します。
HTTPメソッド: POST
URL: https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
Content-Type: application/json
Accept: application/json
リクエストボディペイロード:
Content-Type: application/json
Accept: application/json
{
"configpack":
{
"parameters":
{
"name": "myapp",
"ip": "10.70.122.25",
"svc-servers": ["192.168.100.11","192.168.100.12"],
"svc-port": 8080
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abcdefgi-d589-4557-8632-a74032802412"
}
],
"stylebook": {
"name": "basic-lb-config",
"namespace": "com.example.stylebooks",
"version": "0.1"
}
}
}
<!--NeedCopy-->
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"job": {
"job_id": "3628681382"
}
}
<!--NeedCopy-->
このHTTPリクエストでは、ロードバランシング構成が2つのNetScalerインスタンスで実行されます。これらのNetScalerインスタンスにログオンして、仮想サーバーと2つのサービスがバインドされたサービスグループが作成されているかどうかを確認できます。
例 4
複合StyleBookの作成で作成した複合StyleBook composite-example を検討します。このStyleBookから構成パックを作成するには、次のようにREST APIを使用します。
HTTPメソッド: POST
URL: https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
Content-Type: application/json
Accept: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "myapp",
"ip": "2.2.2.2",
"svc-servers": ["10.102.29.52","10.102.29.53"]
},
"targets":
[
{
"id": "deecee30-f478-4446-9741-a85041903410"
},
{
"id": "abcdefgg-d589-4557-8632-a74032802412"
}
],
"stylebook": {
"name": "composite-example",
"namespace": "com.example.stylebooks",
"version": "0.1"
}
}
<!--NeedCopy-->
このHTTPリクエストでは、構成はIDで表される2つのNetScalerインスタンス上に作成されます。NetScalerインスタンスにログオンすると、「composite-example」StyleBookにインポートされた「basic-lb-config」StyleBookによって作成された構成オブジェクトを表示できます。また、「composite-example」StyleBookの一部であったmyapp-monという新しいHTTPモニターも確認できます。
構成パックの作成が成功すると、次のHTTP応答が返されます。
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"job": {
"job_id": "3628681382"
}
}
<!--NeedCopy-->
構成の更新
IPアドレス10.102.29.54の新しいバックエンドサーバーで更新したい構成を検討します。myappロードバランシング仮想サーバーにサーバーを追加するには、次のAPIを使用します。
HTTPメソッド: PUT
URL: https://<IP>/stylebook/nitro/v2/config/configpacks/<configpackid>
リクエストヘッダー:
Content-Type: application/json
Accept: application/json
リクエストボディペイロード:
{
"configpack": {
"parameters": {
"name": "myapp",
"ip": "2.2.2.2",
"svc-servers": ["10.102.29.52","10.102.29.53","10.102.29.54"]
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abdcedff-d589-4557-8632-a74032802412"
}
]
}
}
<!--NeedCopy-->
構成パックの更新が成功すると、次のHTTP応答が返されます。
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ボディ (成功時):
{
"job": {
"job_id": "3628681382"
}
}
<!--NeedCopy-->
構成の削除
この構成を (すべてのNetScalerインスタンスから) 削除するには、次のように構成パックを削除するためのAPIを使用できます。
構成パックの削除が成功すると、次のHTTP応答が返されます。
HTTPメソッド: DELETE
URL: https://<DNS-or-IP>//stylebook/nitro/v2/config/configpacks/<configpackid>
リクエストヘッダー:
Accept: application/json
期待される応答ヘッダー (成功時):
202 OK
Content-Type: application/json
期待される応答ペイロード (成功時):
{
"job": {
"job_id": "3628681382"
}
}
<!--NeedCopy-->
NetScalerインスタンスにログオンし、この構成パックの一部であるすべての構成オブジェクトが削除されていることを確認します。
すべてのインスタンスからではなく、特定のNetScalerインスタンスから構成を削除するには、構成の更新の構成パック更新操作を使用します。JSONペイロードのターゲット属性を変更して、特定のNetScalerインスタンスIDを削除します。