Cisco DCNM Web Services API ガイド Release 4.0
UserApp サービス
UserApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

UserApp サービス

UserApp サービスの概要

bindUserToAllNetworkElements

bindUserToAllNetworkGroups

bindUserToNetworkElements

bindUserToNetworkGroups

createUsers

deleteUsers

getAllUsers

getDefaultNetworkElementUserCredentials

getNetworkElementGroupsForUser

getNetworkElementsForUser

getPreferences

getUserCredentialsForNetworkElementGroups

getUserCredentialsForNetworkElements

getUsers

modifyDefaultNetworkElementUserCredentials

modifyPreferences

modifyUserCredentialsForNetworkElementGroups

modifyUserCredentialsForNetworkElements

modifyUsers

unbindUserFromAllNetworkElements

unbindUserFromAllNetworkGroups

unbindUserFromNetworkElements

unbindUserFromNetworkGroups

UserApp サービス

この章では、DCNM Web サービスの UserApp サービスに対応する API メソッドについて説明します。

UserApp サービスの概要

この章では、ユーザ サービス機能によって公開される API を定義します。

bindUserToAllNetworkElements

全ネットワーク要素へユーザをバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

戻り値

void

bindUserToAllNetworkGroups

全ネットワーク グループへユーザをバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

戻り値

void

bindUserToNetworkElements

特定のネットワーク要素へユーザをバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

InstanceNameId ― ネットワーク要素の InstanceNameId ID リスト

戻り値

void

bindUserToNetworkGroups

特定のネットワーク グループへユーザをバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

InstanceNameId ― ネットワーク グループの InstanceNameId ID リスト

戻り値

void

createUsers

アプリケーション ユーザのリストに基づいてユーザを作成します。

パラメータ

opContext ― 動作可能なコンテキスト

ApplicationUser ― アプリケーション ユーザのリスト

戻り値

作成されたアプリケーション ユーザのリスト

deleteUsers

アプリケーション ユーザのリストに基づいてユーザを削除します。

パラメータ

opContext ― 動作可能なコンテキスト

ApplicationUser ― アプリケーション ユーザのリスト

戻り値

void

getAllUsers

全アプリケーション ユーザのユーザ情報のリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

アプリケーション ユーザのリスト

getDefaultNetworkElementUserCredentials

デフォルトのネットワーク要素ユーザ認定証を取得します。

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

NetworkElementUserCredentials

getNetworkElementGroupsForUser

指定したユーザのネットワーク要素グループのリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― ユーザのインスタンス名 ID

戻り値

NetworkElementGroup のリスト

getNetworkElementsForUser

指定したユーザのネットワーク要素のリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― ユーザのインスタンス名 ID

戻り値

AbstractNetworkElement のリスト

getPreferences

API を呼び出すユーザのプリファレンスを返します。

パラメータ

opContext ― 動作可能なコンテキスト

戻り値

プリファレンス

getUserCredentialsForNetworkElementGroups

指定したネットワーク要素グループのユーザ認定書のリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

InstanceNameId ― ネットワーク要素グループのリスト

戻り値

NetworkElementUserCredentials のリスト

getUserCredentialsForNetworkElements

指定したネットワーク要素のユーザ認定書のリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザ

InstanceNameId ― ネットワーク要素のリスト

戻り値

NetworkElementUserCredentials のリスト

getUsers

指定したアプリケーション ユーザのユーザ情報のリストを取得します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アプリケーション ユーザのリスト

戻り値

アプリケーション ユーザのリスト

modifyDefaultNetworkElementUserCredentials

デフォルトのユーザ認定書を提供された値に修正します。

パラメータ

opContext ― 動作可能なコンテキスト

NetworkElementUserCredentials ― ユーザ認定書

戻り値

NetworkElementUserCredentials

modifyPreferences

API を呼び出すユーザのプリファレンスを修正します。

パラメータ

opContext ― 動作可能なコンテキスト

Preferences ― ユーザ プリファレンス

戻り値

プリファレンス

modifyUserCredentialsForNetworkElementGroups

指定したユーザおよびネットワーク要素グループの認定書を修正します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― 修正するユーザ

InstanceNameId ― 修正するネットワーク要素グループのリスト

NetworkElementUserCredentials ― ユーザ認定書

戻り値

void

modifyUserCredentialsForNetworkElements

指定したユーザおよびネットワーク要素の認定書を修正します。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― 修正するユーザ

InstanceNameId ― 修正するネットワーク要素のリスト

NetworkElementUserCredentials ― ユーザ認定書

戻り値

void

modifyUsers

指定したアプリケーション ユーザのリストを修正します。

パラメータ

opContext ― 動作可能なコンテキスト

ApplicationUser ― ユーザのリスト

戻り値

void

unbindUserFromAllNetworkElements

全ネットワーク要素からの指定ユーザをアンバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アンバインドするユーザ

戻り値

void

unbindUserFromAllNetworkGroups

全ネットワーク グループからの指定ユーザをアンバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アンバインドするユーザ

戻り値

void

unbindUserFromNetworkElements

全ネットワーク要素からの指定ユーザをアンバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アンバインドするユーザ

InstanceNameId ― ネットワーク要素のリスト

戻り値

void

unbindUserFromNetworkGroups

全ネットワーク グループからの指定ユーザをアンバインドします。

パラメータ

opContext ― 動作可能なコンテキスト

InstanceNameId ― アンバインドするユーザ

InstanceNameId ― ネットワーク グループのリスト

戻り値

void