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

目次

ユーティリティ関数

checkCiscoPortalConnection

checkDeviceConnection

getServerProperties

getVersion

ユーティリティ関数

この章では、次のトラブルシューティング ユーティリティ関数に関する情報を示します。

「checkCiscoPortalConnection」

「checkDeviceConnection」

「getServerProperties」

「getVersion」

checkCiscoPortalConnection

構文

Status checkCiscoPortalConnection(UserToken token) throws RemoteException;

説明

この関数は、Cisco Product License Registration Portal 接続の状態をチェックします。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

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

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。

checkDeviceConnection

構文

Status checkDeviceConnection(UserToken token, String dev_id) throws RemoteException

説明

この関数は、デバイス接続の状態をチェックします。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev_id

String、必須

--

接続をチェックするデバイス ID。

戻り値

この関数は Status オブジェクトを返します。

エラーと例外

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

エラーが発生した場合、Status オブジェクトは SUCCESS 以外のエラー コードとエラー メッセージを返します。

getServerProperties

構文

public Properties getServerProperties(UserToken token) throws RemoteException;
 

説明

この関数は、サーバから設定プロパティを取得します。現在サポートされているプロパティ キーは次のとおりです。

REQUEST_LIMIT

このプロパティは、着信要求に含めることができる項目数の制限を設定します。Device、PAK、License、LicenseLine の各 ID またはオブジェクトの複数項目を含む配列を受け取る一括操作には、制限チェックが適用されます。この制限はサーバ側で設定されます。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

戻り値

この関数は、サーバ設定プロパティを含むプロパティ オブジェクトを返します。

エラーと例外

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

getVersion

構文

public Version getVersion(UserToken token) throws RemoteException;

説明

この関数は、Cisco License Manager のバージョンとビルド番号を返します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

戻り値

この関数は、Cisco License Manager のバージョンとビルド番号を含むバージョン オブジェクトを返します。

エラーと例外

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