Cisco License Manager 用 Java API リファレンス ガイド
ライセンス ライン管理関数
ライセンス ライン管理関数
発行日;2012/01/08 | 英語版ドキュメント(2009/10/27 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

ライセンス ライン管理関数

asyncAnnotateLicenseLines

asyncDeployLicenseLines

getLicenseLinesByLicense

getLicenseLinesOnDevice

listExpiredLicenseLines

listExpiringLicenses

readLicenseLines

writeLicenseLines

ライセンス ライン管理関数

この章では、次のライセンス ライン管理関数に関する情報を示します。

「asyncAnnotateLicenseLines」

「asyncDeployLicenseLines」

「getLicenseLinesByLicense」

「getLicenseLinesOnDevice」

「listExpiredLicenseLines」

「listExpiringLicenses」

「readLicenseLines」

「writeLicenseLines」

asyncAnnotateLicenseLines

構文

public String asyncAnnotateLicenseLines(UserToken token, String jobGroup,String[] liclineIDs, String[] annotation, IDStatusListener listener) throws RemoteException;
 

説明

この関数を使用すると、ライセンス ラインに注釈を付けることができます。

この関数はノンブロッキングであり、呼び出し元に即座に要求 ID を返します。この関数を呼び出している間、クライアント プログラムは StatusListener インターフェイスを実装するリスナー オブジェクトを提供します。操作が完了すると、リスナー オブジェクトの onStatus() メソッドが呼び出されます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

jobGroup

--

--

この非同期ジョブが属するグループ。null に設定した場合は、返されたジョブ ID がジョブ グループ名として使用されます。

licline_ids

String の配列、必須

--

ライセンス ライン オブジェクトの ID。

annotation

String の配列、必須

最大 99 文字のテキスト文字列

各ライセンス ラインの注釈テキスト。Cisco License Manager は annotation パラメータの長さをチェックしません。文字列制限を超える場合は、Cisco IOS ソフトウェアがエラーを返します。

listener

IDStatusListener オブジェクト、必須

--

IDStatusListener インターフェイスを実装するオブジェクト。

戻り値

この関数は呼び出し元に要求 ID 文字列を返します。操作が完了すると、onStatus() メソッドの入力パラメータとしてステータスが提供されます。リスナーは、IDStatusItem のリストを含む IDStatus を受信します。各 IDStatusItem には、ライセンス ライン ID、この操作のエラー コード、およびエラー メッセージが含まれます。

次の例では、onStatus() メソッドでエラー コードとエラー メッセージを取得しています。

public void onStatus(IDStatus status) {
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
IDStatusItem[] items = status.getIDStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual object ID returned by the operation.
String id = items[i].getID();
 
// Get the individual error code corresponding to
// the object ID.
int item_err_code = items[i].getErrorCode();
 
// Get the individual error message corresponding to
// the object ID.
String item_err_msg = items[i].getErrorMessage();
}
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

IDStatusListener の onStatus() メソッドの入力パラメータには、エラー コードとエラー メッセージが含まれます。IDStatus オブジェクトには複数のエラー コードとエラー メッセージが含まれる場合があります。

asyncDeployLicenseLines

構文

public String asyncDeployLicenseLines(UserToken token, String jobGroup, String[] liclineIDs, IDStatusListener listener) throws RemoteException;

説明

この関数は、指定したライセンス ラインをそのターゲット デバイスに配備します。

この関数はノンブロッキングであり、呼び出し元に即座に要求 ID を返します。この関数を呼び出している間、クライアント プログラムは StatusListener インターフェイスを実装するリスナー オブジェクトを提供します。関数が完了すると、リスナー オブジェクトの onStatus() メソッドが呼び出されます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

jobGroup

--

--

この非同期ジョブが属するグループ。null に設定した場合は、返されたジョブ ID がジョブ グループ名として使用されます。

licline_ids

String の配列、必須

--

ライセンス ライン ID の配列。

listener

IDStatusListener オブジェクト、必須

--

IDStatusListener インターフェイスを実装するオブジェクト。

戻り値

この関数は呼び出し元に要求 ID 文字列を返します。操作が完了すると、onStatus() メソッドの入力パラメータとしてステータスが提供されます。リスナーは、IDStatusItem のリストを含む IDStatus を受信します。各 IDStatusItem には、ライセンス ライン ID、この操作のエラー コード、およびエラー メッセージが含まれます。

次の例では、onStatus() メソッドでエラー コードとエラー メッセージを取得しています。

public void onStatus(IDStatus status) {
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
IDStatusItem[] items = status.getIDStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual object ID returned by the operation.
String id = items[i].getID();
 
// Get the individual error code corresponding to
// the object ID.
int item_err_code = items[i].getErrorCode();
 
// Get the individual error message corresponding to
// the object ID.
String item_err_msg = items[i].getErrorMessage();
}
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

IDStatusListener の onStatus() メソッドの入力パラメータには、エラー コードとエラー メッセージが含まれます。IDStatus オブジェクトには複数のエラー コードとエラー メッセージが含まれる場合があります。

getLicenseLinesByLicense

構文

LicLineStatus getLicenseLinesByLicense(UserToken token, String lic_id) throws RemoteException;

説明

この関数は、指定したライセンスに含まれるライセンス ラインを取得します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

lic_id

String、必須

--

ライセンス ID。

戻り値

この関数は LicLineStatus オブジェクトを返します。次の例では、ステータスに含まれるエラー コード、エラー メッセージ、および戻りオブジェクトを取得しています。

LicLineStatus status = getLicenseLinesByLicense (..., ...);
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
LicLineStatusItem[] items = status.getLicLineStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual object returned by the operation.
LicenseLine liclines = items[i].getLicenseLine();
 
// Get the individual error code corresponding to
// the object.
int item_err_code = items[i].getErrorCode();
 
// Get the individual error message corresponding to
// the object.
String item_err_msg = items[i].getErrorMessage();
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

入力配列の要素でエラーが発生した場合は、エラー コードとエラー メッセージを含む Status オブジェクトが返されます。

getLicenseLinesOnDevice

構文

LicLineStatus getLicenseLinesOnDevice(UserToken token, String dev_id) throws RemoteException;

説明

この関数は、指定したデバイス ID に含まれるライセンス ラインを取得します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

dev_id

String、必須

--

デバイス ID。

戻り値

この関数は LicLineStatus オブジェクトを返します。次の例では、ステータスに含まれるエラー コード、エラー メッセージ、および戻りオブジェクトを取得しています。

LicLineStatus status = getLicenseLinesOnDevice (..., ...);
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
LicLineStatusItem[] items = status.getLicLineStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual object returned by the operation.
LicenseLine liclines = items[i].getLicenseLine();
 
// Get the individual error code corresponding to
// the object.
int item_err_code = items[i].getErrorCode();
 
// Get the individual error message corresponding to
// the object.
String item_err_msg = items[i].getErrorMessage();
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

入力配列の要素でエラーが発生した場合は、エラーに関する情報を含む Status オブジェクトが返されます。

listExpiredLicenseLines

構文

HashSet<Expired License> listExpiredLicenseLines (UserToken token) throws RemoteException;

説明

この関数は、有効期限が切れたライセンス ラインのリストを返します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

戻り値

この関数は HashSet<ExpiredLicense> オブジェクトを返します。次の例では、ステータスに含まれるエラー コード、エラー メッセージ、および戻りオブジェクトを取得しています。

HashSet<ExpiredLicense> _hash = listExpiredLicenseLines(..., ...);
 
If(_hash==null || _hash.size()==0){
System.out.println(" No Expired License found. ") ;
}
// Iterate through the list to get individual status.
Iterator licIt = _hash.iterator();
while(licIt.hasNext()) {
ExpiredLicense _lic = (ExpiredLicense)licIt.next();
String[] _licLine_ids=_lic.getLicLineIDs();
String _dev_id=_lic.getDeviceID();
String _feature=_lic.getFeatureName();
String _version=_lic.getVersion();
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

この関数は ExpiredLicense オブジェクトのセットを返します。エラーが発生した場合は null が返されます。

listExpiringLicenses

構文

ExpiringLicenseStatus listExpiringLicenses (UserToken token, int days_to_expire) throws RemoteException;

説明

この関数は、指定した日数以内に有効期限が切れるライセンスのリストを返します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

days_to_expire

int、必須

1 ~ 65535 の範囲

有効期限が切れるライセンスの残り日数。

戻り値

この関数は、ExpiringLicenseStatusItem 配列、エラー番号、およびエラー メッセージを含む ExpiringLicenseStatus を返します。

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。操作エラーが発生した場合は、SUCCESS 以外のエラー コードを示すエラー番号とエラー メッセージが返され、各 LicenseLineStatusItem を反復処理してすべての LicenseLine オブジェクトを取得する必要があります。

readLicenseLines

構文

LicLineStatus readLicenseLines(UserToken token, String[] licline_ids) throws RemoteException;

説明

この関数は、指定したライセンス ライン ID を使用して、インベントリからライセンス ライン オブジェクトの配列を取得します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

licline_ids

String の配列、必須

--

ライセンス ライン ID の配列。

戻り値

この関数は LicLineStatus オブジェクトを返します。次の例では、ステータスに含まれるエラー コード、エラー メッセージ、および戻りオブジェクトを取得しています。

LicLineStatus status = readLicenseLines(..., ...);
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
LicLineStatusItem[] items = status.getLicLineStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual object returned by the operation.
LicenseLine license = items[i].getLicenseLine();
 
// Get the individual error code corresponding to
// the object.
int item_err_code = items[i].getErrorCode();
 
// Get the individual error message corresponding to
// the object.
String item_err_msg = items[i].getErrorMessage();
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

入力配列の要素でエラーが発生した場合は、エラーに関する情報を含む Status オブジェクトが返されます。

writeLicenseLines

構文

IDStatus writeLicenseLines(UserToken token, LicenseLine[] liclines) throws RemoteException;

説明

この関数は、指定したライセンス ライン オブジェクトをインベントリに書き込みます。入力ライセンス ライン オブジェクトには、readLicenseLines() 関数によってインベントリから取得された既存のライセンス ライン オブジェクトを指定します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

ユーザの認証パスを表すトークン。これは、ユーザが login 関数を呼び出して、バックエンド サーバがそのユーザを認証した後に取得されます。

liclines

LicenseLine の配列、必須

LicenseLine オブジェクトの配列

ライセンス ライン オブジェクトの配列。

戻り値

この関数は IDStatus オブジェクトを返します。次の例では、ステータスに含まれるエラー コード、エラー メッセージ、および戻りオブジェクトを取得しています。

IDStatus status = writeLicenseLines(..., ...);
 
// The general error code of the operation.
int err_code = status.getErrorCode();
 
// The general error message of the operation.
String err_msg = status.getErrorMessage();
 
// A list of status for each individual element in the
// bulk operation.
IDStatusItem[] items = status.getIDStatusItems()
 
// Iterate through the list to get individual status.
for (int i = 0; i < items.length(); i++) {
 
// Get the individual ID returned by the operation.
String id = items[i].getID();
 
// Get the individual error code corresponding to
// the ID.
int item_err_code = items[i].getErrorCode();
// Get the individual error message corresponding to
// the ID.
String item_err_msg = items[i].getErrorMessage();
}

エラーと例外

システム エラーによって操作が完了しなかった場合は、RemoteException がスローされます。

入力配列の要素でエラーが発生した場合は、エラーに関する情報を含む Status オブジェクトが返されます。