ジャバ SDK

最終公開日 : Sep 25, 2026
SDX NITRO APIは、APIのスコープと目的に応じて、システムAPIと構成APIに分類されます。NITRO操作のトラブルシューティングも可能です。
Related information

システムAPI

NITROを使用するための最初のステップは、SDXアプライアンスとのセッションを確立し、その後、管理者の資格情報を使用してセッションを認証することです。
アプライアンスのIPアドレスと、アプライアンスに接続するためのプロトコル（HTTPまたはHTTPS）を指定して、nitro_serviceクラスのオブジェクトを作成します。その後、このオブジェクトを使用して、管理者のユーザー名とパスワードを指定してアプライアンスにログオンします。
注: そのアプライアンスにユーザーアカウントが必要です。実行できる構成操作は、アカウントに割り当てられている管理ロールによって制限されます。
次のサンプルコードは、HTTPSプロトコルを使用してIPアドレス10.102.31.16のSDXアプライアンスに接続します。
//Specify the IP address of the appliance and service type
nitro_service nitroservice = new nitro_service ("10.102.31.16", "https");

//Specify the login credentials
nitroservice.login("nsroot", "verysecret");
注: アプライアンスでの今後のすべてのNITRO操作で、 nitro_serviceオブジェクトを使用してください。
アプライアンスから切断するには、次のようにlogout()メソッドを呼び出します。
nitroservice.logout();

構成API

NITROプロトコルは、SDXアプライアンスのリソースを構成するために使用できます。
リソースを構成するためのAPIは、com.citrix.sdx.nitro.resource.config.<resource_type>という形式のパッケージまたは名前空間にグループ化されています。これらのパッケージまたは名前空間のそれぞれには、リソースを構成するためのAPIを提供する<resource_type>という名前のクラスが含まれています。
たとえば、NetScalerリソースには、com.citrix.sdx.nitro.resource.config.nsパッケージまたは名前空間があります。
リソースクラスは、他の多くの操作を実行するためのAPIを提供します。これらの操作には、リソースの作成、リソースの詳細と統計の取得、リソースの更新、リソースの削除、およびリソースに対する一括操作の実行などがあります。

リソースの作成

SDXアプライアンス上にリソース（例：NetScalerインスタンス）を作成するには、次の手順を実行します。
  1. 対応するプロパティ名を使用して、リソースの必須プロパティの値を設定します。結果として、リソースに必要な詳細を含むリソースオブジェクトが作成されます。 注：これらの値はクライアントにローカルで設定されます。オブジェクトがアップロードされるまで、値はアプライアンスに反映されません。
  2. 静的add()メソッドを使用して、リソースオブジェクトをアプライアンスにアップロードします。
次のサンプルコードは、SDXアプライアンス上に「ns_instance」という名前のNetScalerインスタンスを作成します。
ns newns = new ns();

//Set the properties of the NetScaler locally
newns.set_name("ns_instance");
newns.set_ip_address("10.70.136.5");
newns.set_netmask("255.255.255.0");
newns.set_gateway("10.70.136.1");
newns.set_image_name("nsvpx-9.3.45_nc.xva");
newns.set_profile_name("ns_nsroot_profile");
newns.set_vm_memory_total(new Double(2048));
newns.set_throughput(new Double(1000));
newns.set_pps(new Double(1000000));
newns.set_license("Standard");
newns.set_username("admin");
newns.set_password("admin");

int number_of_interfaces = 2;
network_interface[] interface_array = new network_interface[number_of_interfaces];

//Adding 10/1
interface_array[0] = new network_interface();
interface_array[0].set_port_name("10/1");

//Adding 10/2
interface_array[1] = new network_interface();
interface_array[1].set_port_name("10/2");

newns.set_network_interfaces(interface_array);

//Upload the NetScaler instance
ns result = ns.add(nitroservice, newns);

リソースの詳細の取得

SDXアプライアンス上のリソースのプロパティを取得するには、次の手順を実行します。
  1. get()メソッドを使用して、アプライアンスから構成を取得します。結果として、リソースオブジェクトが作成されます。
  2. 対応するプロパティ名を使用して、オブジェクトから必要なプロパティを抽出します。
次のサンプルコードは、すべてのNetScaler®リソースの詳細を取得します。
//Retrieve the resource object from the SDX appliance
ns[] returned_ns = ns.get(nitroservice);

//Extract the properties of the resource from the object
System.out.println(returned_ns[i].get_ip_address());
System.out.println(returned_ns[i].get_netmask());

リソース統計の取得

SDXアプライアンスは、その機能の使用状況に関する統計を収集します。これらの統計はNITROを使用して取得できます。
次のサンプルコードは、ID 123456aのNetScalerインスタンスの統計を取得します。
ns obj = new ns();
obj.set_id("123456a");
ns stats = ns.get(nitroservice, obj);
System.out.println("CPU Usage:" + stats.get_ns_cpu_usage());
System.out.println("Memory Usage:" + stats.get_ns_memory_usage());
System.out.println("Request rate/sec:" +stats.get_http_req());

リソースの更新

アプライアンス上の既存のリソースのプロパティを更新するには、次の手順を実行します。
  1. idプロパティを、更新するリソースのIDに設定します。
  2. 対応するプロパティ名を使用して、リソースの必須プロパティの値を設定します。結果はリソースオブジェクトになります。 注：これらの値はクライアントにローカルで設定されます。オブジェクトがアップロードされるまで、値はアプライアンスに反映されません。
  3. update() メソッドを使用して、リソースオブジェクトをアプライアンスにアップロードします。
次のサンプルコードは、ID 123456a の NetScaler インスタンスの名前を「ns_instance_new」に更新します。
ns update_obj = new ns();

//Set the ID of the NetScaler to be updated
update_obj.set_id("123456a");

//Get existing NetScaler details
update_obj = ns.get(nitroservice, update_obj);

//Update the name of the NetScaler to "ns_instance_new" locally
update_obj.set_name("ns_instance_new");

//Upload the updated NetScaler details
ns result = ns.update(nitroservice, update_obj);

リソースの削除

既存のリソースを削除するには、削除するリソースの ID を引数として渡して、リソースクラスの静的メソッド delete() を呼び出します。
次のサンプルコードは、ID 1 の NetScaler インスタンスを削除します。
ns obj = new ns();
obj.set_id("123456a");
ns.delete(nitroservice, obj);

一括操作

複数のリソースを同時に照会または変更できるため、ネットワークトラフィックを最小限に抑えることができます。たとえば、同じ操作で複数の NetScaler SDX アプライアンスを追加できます。
各リソースクラスには、リソースの追加、更新、削除のためにリソースの配列を受け取るメソッドがあります。一括操作を実行するには、各操作の詳細をローカルで指定し、その詳細を一度にサーバーに送信します。
一括操作内の一部の操作の失敗を考慮するために、NITRO では次のいずれかの動作を構成できます。
  • 終了。 最初のエラーが発生すると、実行は停止します。エラーの前に実行されたコマンドはコミットされます。
  • 続行。 一部のコマンドが失敗しても、リスト内のすべてのコマンドが実行されます。
注： アプライアンスとの接続を確立する際に、 onerror パラメータを nitro_service() メソッドで設定して、必要な動作を構成します。
次のサンプルコードは、1 回の操作で 2 つの ADC アプライアンスを追加します。
ns[] newns = new ns[2];

//Specify details of first NetScaler
newns[0] = new ns();
newns[0].set_name("ns_instance1");
newns[0].set_ip_address("10.70.136.5");
newns[0].set_netmask("255.255.255.0");
newns[0].set_gateway("10.70.136.1");
...
...
...

//Specify details of second NetScaler
newns[1] = new ns();
newns[1].set_name("ns_instance2");
newns[1].set_ip_address("10.70.136.8");
newns[1].set_netmask("255.255.255.0");
newns[1].set_gateway("10.70.136.1");
...
...

//upload the details of the NetScalers to the NITRO server
ns[] result = ns.add(nitroservice, newns);

例外処理

エラーコードフィールドは、操作のステータスを示します。
  • エラーコードが0の場合、操作は成功したことを示します。
  • 0以外のエラーコードは、NITROリクエストの処理におけるエラーを示します。
エラーメッセージフィールドは、簡潔な説明と障害の性質を提供します。
com.citrix.sdx.nitro.exception.nitro_exceptionクラスは、NITRO APIの実行におけるすべての例外を捕捉します。例外に関する情報を取得するには、getErrorCode()メソッドを使用できます。
エラーコードの詳細については、<NITRO_SDK_HOME>/docフォルダーで利用可能なAPIリファレンスを参照してください。