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

目次

デバイス グループ管理関数

addDevicesToGroup

createDeviceGroup

deleteDeviceGroup

listAllGroups

removeDevicesFromGroup

renameDeviceGroup

デバイス グループ管理関数

この章では、次のデバイス グループ管理関数に関する情報を示します。

「addDevicesToGroup」

「createDeviceGroup」

「deleteDeviceGroup」

「listAllGroups」

「removeDevicesFromGroup」

「renameDeviceGroup」

addDevicesToGroup

構文

IDStatus addDevicesToGroup(UserToken token, String[] dev_ids, String group) throws RemoteException;

説明

この関数は、指定したデバイス グループにデバイスを追加します。デバイスは複数のグループに追加できます。


) デバイスを 1 つのグループに維持する場合は、removeDevicesFromGroup() 関数を呼び出して対象のデバイスを他のグループから削除します。


入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev_ids

String の配列、必須

--

グループに追加するデバイス ID の配列。

group

String、必須

--

グループの名前。

戻り値

この関数は IDStatus オブジェクトを返します。操作が成功した場合、IDStatus で次の情報が返されます。

エラー コードは ClmErrors.SUCCESS になります。

追加されるデバイスの ID が IDStatusItem 配列に格納されます。

正常に追加された各項目の IDStatusItem エラー コードが CLMError.SUCCESS になります。

エラーと例外

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

エラーが発生した場合、この関数は、エラー コードとエラー メッセージを含む IDStatus オブジェクトを返します。

createDeviceGroup

構文

Status createDeviceGroup(UserToken token, String group) throws RemoteException;

説明

この関数は、指定した名前を持つ新しいデバイス グループを作成します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

x21 ~ x7A の範囲の ASCII 文字を含む最大 64 文字の文字列

グループの名前。

戻り値

この関数は Status オブジェクトを返します。操作が成功した場合は、エラー コードで ClmErrors.SUCCESS が返されます。

エラーと例外

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

エラーが発生した場合、この関数は、エラー コードとエラー メッセージを含む IDStatus オブジェクトを返します。

deleteDeviceGroup

構文

Status deleteDeviceGroup(UserToken token, String group) throws RemoteException;

説明

この関数は、システムからデバイス グループを削除します。このグループに属するデバイスは削除されませんが、グループ化されていない状態になります。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

--

デバイス グループの名前。

戻り値

この関数は Status オブジェクトを返します。操作が成功した場合は、エラー コードで ClmErrors.SUCCESS が返されます。

エラーと例外

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

エラーが発生した場合、この関数は、エラー コードとエラー メッセージを含む IDStatus オブジェクトを返します。

listAllGroups

構文

public IDPagingInfo listAllGroups(UserToken token, Pagination pageinfo) throws RemoteException;

説明

この関数は、ステータス、総数、およびグループ名の配列を含む IDPagingInfo オブジェクトを返します。

有効なオフセットと最大数を指定してページ分割オプションを設定できます。次の例は、オフセットと最大数を指定してページ分割を設定する方法を示します。

1 ページ目を取得するには、次のようにします。

Pagination p = new Pagination(0, 10)

5 ページ目を取得するには、次のようにします。

Pagination p = new Pagination(50, 10)

ページ分割せずにすべてのレコードを取得するには、次のようにします。

Pagination p = new Pagination(0, -1)

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

pageinfo

String、必須

--

offset と max を含むページ分割オブジェクト。offset は、この関数によって取得する、最初のレコード セットからの相対的なオフセットを指定します。max は、取得するレコードの最大数を指定します。max を -1 に設定すると、値が -1 であるすべてのレコードが返されます。

戻り値

この関数は、ライセンスの配列を含む PagingInfo オブジェクトを返します。offset がレコード数よりも大きい場合は、サイズが 0 の配列が返されます。操作エラーが発生した場合、Status オブジェクトはエラー コードとエラー メッセージを返します。

エラーと例外

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

エラーが発生した場合、この関数は null を返します。

removeDevicesFromGroup

構文

IDStatus removeDevicesFromGroup(UserToken token, String[] dev_ids, String group) throws RemoteException;

説明

この関数は、指定したデバイス グループからデバイスを削除します。個々のデバイスはグループ化されていない状態になりますが、デバイス インベントリには残ります。インベントリからデバイスを削除するには、deleteDevices() 関数を使用します。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

dev_ids

String の配列、必須

--

グループから削除するデバイス ID の配列。

group

String、必須

--

デバイス グループの名前。

戻り値

この関数は IDStatus オブジェクトを返します。操作が成功した場合、IDStatus オブジェクトで次の情報が返されます。

エラー コードは ClmErrors.SUCCESS になります。

追加されるデバイスの ID が IDStatusItem 配列に格納されます。

正常に追加された各項目の IDStatusItem エラー コードが CLMError.SUCCESS になります。

エラーと例外

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

renameDeviceGroup

構文

Status renameDeviceGroup(UserToken token, String group, String new_name) throws RemoteException;

説明

この関数は、特定のデバイス グループの名前を変更します。グループに含まれるデバイスは変更されません。

入力パラメータ

 

パラメータ
タイプ
説明

token

UserToken、必須

--

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

group

String、必須

--

デバイス グループの現在の名前。

new_name

String、必須

--

デバイス グループの新しい名前。

戻り値

この関数は Status オブジェクトを返します。操作が成功した場合は、エラー コードで ClmErrors.SUCCESS が返されます。

エラーと例外

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

エラーが発生した場合、この関数は、エラー コードとエラー メッセージを含む IDStatus オブジェクトを返します。