Application Delivery Management

APIを使用してStyleBookから設定を作成する

February 6, 2024

寄稿者:

StyleBookを作成したら、それをCitrix Application Delivery Management（ADM）にインポートして、Citrix ADM またはCitrix ADM APIを使用して使用する必要があります。NetScaler ADM はインポート時にStyleBookを検証し、検証が成功すると、StyleBookのNetScaler ADMカタログにStyleBookが表示され、構成の作成に使用できます。

StyleBook APIを使用して、このStyleBookに基づいて構成を作成できるようになりました。curlコマンドラインツールやPostman chromeブラウザ拡張機能などの任意のツールを使用して、Citrix ADM にHTTPリクエストを送信できます。

例1

負荷分散仮想サーバーを作成するために、StyleBookで作成した「lb-vserver」StyleBookについて考えてみます。REST APIを使用して、このStyleBookから次のように構成パックを作成します。

POST

https://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/lb-vserver/configpacks

<!--NeedCopy-->

Content-Type: application/json
Accept: application/json
{
  "configpack":
  {
    "parameters": {
      "name": "lb1",
      "ip": "10.102.117.31"
    },
    "target_devices":
    [
      {
        "id": "deecee30-f478-4446-9741-a85041903410"
      }
    ]
}
}
<!--NeedCopy-->

このHTTPリクエストでは、ID（例：”deecee30-f478-4446-9741-a85041903410”）は、負荷分散仮想サーバー lb1 がIPアドレス10.102.117.31が作成されるNetScaler ADC インスタンスのインスタンスIDです。NetScaler ADC インスタンスのインスタンス ID は NetScaler ADM から取得されます。

NetScaler ADM によって管理されるインスタンスのIDを取得するには、NetScaler ADM APIを使用します。たとえば、IPアドレスが192.168.153.160のCitrix ADC インスタンスのインスタンスIDを取得するには、次のAPIを使用できます。

GET https://<MAS-IP>/nitro/v1/config/ns?filter=ip_address:192.168.153.160
<!--NeedCopy-->

Accept: application/json
<!--NeedCopy-->

応答ではペイロード内に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-->

構成 (configpack) が正常に作成されると、次の HTTP 応答が返されます。

200 OK
Content-Type: application/json
{
  "configpack":
  {
    "config_id": "1460806080"
  }
}
<!--NeedCopy-->

これで、ID 1460806080 を使用して一意に識別される最初の構成 (コンフィグパック) が作成されました。このIDを使用して、構成のクエリ、更新、削除を行えます。

例2

同じStyleBookを使用して別の構成または構成パックを作成し、同じまたは異なるCitrix ADC インスタンスで実行できます。この例では、別の構成を作成し、仮想サーバーに異なる名前とIPアドレスを指定します。また、負荷分散の方法としてLEASTCONNECTIONを指定します。この構成を 2 つの NetScaler ADC インスタンスにデプロイします。

HTTP要求は次のとおりです。

POST

https://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/lb-vserver/configpacks
<!--NeedCopy-->

Content-Type: application/json
Accept: application/json
{
  "configpack":
  {
    "parameters":
    {
      "name": "lb2",
      "ip": "10.102.117.32",
      "lb-alg": "LEASTCONNECTION"
    },
    "target_devices"
    [
     {"id": "deecee30-f478-4446-9741-a85041903410"},
     {"id": "debecc60-d589-4557-8632-a74032802412"}
    ]
  }
}
<!--NeedCopy-->

このHTTPリクエストでは、IPアドレス10.102.117.32の負荷分散仮想サーバーlb2が、ids “deecee30-f478-4446-9741-a85041903410”と”debecc60-d589-4557-8632-a74032802412”で表される2つのNetScaler ADC インスタンスに作成されます。

構成パックが正常に作成されると、次の HTTP 応答が受信されます。

200 OK
Content-Type: application/json
{
   "configpack":
  {
     "config_id": "1657696292"
  }
}
<!--NeedCopy-->

この新しいコンフィグパックの ID は 165769629 が異なります。このIDを使用することで、この構成を更新または削除できます。

例3

「基本的な負荷分散の構成を作成するためのStyleBook」で作成した「basic-lb-config」StyleBookを参考にします。REST APIを使用して、このStyleBookから次のように構成パックを作成します。

POST

http://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/basic-lb-config/configpacks
<!--NeedCopy-->

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
    },
    "target_devices":
    [
     {
      "id": "deecee30-f478-4446-9741-a85041903410"
     },
     {
      "id": "debecc60-d589-4557-8632-a74032802412"
     }
    ]
  }
}
<!--NeedCopy-->

このHTTPリクエストでは、2つのNetScaler ADC インスタンスで負荷分散構成が実行されます。これらのNetScaler ADC インスタンスにログオンして、仮想サーバーと2つのサービスがバインドされたサービスグループが作成されているかどうかを確認できます。

例4

「複合StyleBookの作成」で作成した複合StyleBookのcomposite-exampleを参考にします。REST APIを使用して、このStyleBookから次のように構成パックを作成します。

POST http://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/composite-example/configpacks
<!--NeedCopy-->

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"]
    },
    "target_devices":
    [
    {
      "id": "deecee30-f478-4446-9741-a85041903410"
    },
    {
      "id": "debecc60-d589-4557-8632-a74032802412"
    }
    ]
 }
}
<!--NeedCopy-->

このHTTPリクエストでは、構成はIDで表される2つのNetScaler ADC インスタンスに作成されます。NetScaler ADC インスタンスにログオンすると、「複合例」StyleBookにインポートされた「basic-lb-config」StyleBookで作成された構成オブジェクトを表示できます。また、「composite-example」StyleBookの一部だった「myapp-mon」という新しいHTTPモニターも表示されます。

構成パックが正常に作成されると、次の HTTP 応答が受信されます。

200 OK
Content-Type: application/json{
  "configpack": {
    "config_id": "4917276817"
  }
}
<!--NeedCopy-->

構成の更新

たとえば、IP アドレスが 10.102.29.54 の新しいバックエンドサーバーを負荷分散仮想サーバー myapp に追加してこの構成を更新するには、以下のように API を使用して構成パックを更新します。

PUT http://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/composite-example/configpacks/4917276817
<!--NeedCopy-->

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"]
  },
  "target_devices":
  [
    {
    "id": "deecee30-f478-4446-9741-a85041903410"
    },
  {
    "id": "debecc60-d589-4557-8632-a74032802412"
  }
]
}
}
<!--NeedCopy-->

構成パックが正常に更新されると、次の HTTP 応答が受信されます。

200 OK
Content-Type: application/json
{
   "configpack": {
     "config-id": "4917276817"
  }
}
<!--NeedCopy-->

構成の削除

この構成を（すべてのCitrix ADC インスタンスから）削除するには、次のようにAPIを使用して構成パックを削除します。

DELETE http://<MAS-DNS-or-IP>/stylebook/nitro/v1/config/stylebooks/com.example.stylebooks/0.1/composite-example/configpacks/4917276817
<!--NeedCopy-->

Accept: application/json
<!--NeedCopy-->

コンフィグパックが正常に削除されると、次の HTTP 応答が受信されます。

200 OK
Content-Type: application/json
{
   "configpack": {
     "config_id": "4917276817"
  }
}
<!--NeedCopy-->

Citrix ADC インスタンスにログオンして、この構成パックに含まれるすべての構成オブジェクトが削除されていることを確認できます。

すべてのNetScaler ADCインスタンスからではなく、特定のNetScaler ADC インスタンスから構成を削除する場合は、上記の構成パックの更新操作を使用し、JSONペイロードの「target_devices」属性を変更して、特定のNetScaler ADCインスタンスIDを削除します。

このコンテンツの正式なバージョンは英語で提供されています。Cloud Software Groupドキュメントのコンテンツの一部は、お客様の利便性のみを目的として機械翻訳されています。Cloud Software Groupは機械翻訳されたコンテンツを管理していないため、誤り、不正確な情報、不適切な用語が含まれる場合があります。英語の原文から他言語への翻訳について、精度、信頼性、適合性、正確性、またはお使いのCloud Software Group製品またはサービスと機械翻訳されたコンテンツとの整合性に関する保証、該当するライセンス契約書またはサービス利用規約、あるいはCloud Software Groupとのその他すべての契約に基づき提供される保証、および製品またはサービスのドキュメントとの一致に関する保証は、明示的か黙示的かを問わず、かかるドキュメントの機械翻訳された範囲には適用されないものとします。機械翻訳されたコンテンツの使用に起因する損害または問題について、Cloud Software Groupは責任を負わないものとします。

APIを使用してStyleBookから設定を作成する

February 6, 2024

寄稿者:

February 6, 2024

寄稿者: