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

目次

RbacApp Service

RbacApp サービスの概要

createComponentGroups

createNetworkElementUserRoles

createNetworkElementUsers

deleteComponentGroups

deleteNetworkElementUserRoles

deleteNetworkElementUsers

getComponentAuths

getComponentAuthsInNetworkElement

getComponentGroups

getComponentGroupsInNetworkElement

getNetworkElementUserRoles

getNetworkElementUserRolesInNetworkElement

getNetworkElementUsers

getNetworkElementUsersInNetworkElement

modifyComponentGroups

modifyNetworkElementUserRoles

modifyNetworkElementUsers

RbacApp Service

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

RbacApp サービスの概要

Role-Based Access Control(RBAC; ロールベース アクセス コントロール)により、許可されたユーザへのシステム アクセスを制限します。これにより、各種ジョブ機能に対するロールを作成することによってネットワーク化された大規模なアプリケーションにおけるセキュリティ管理の複雑性とコストが軽減されます。ロールごとに、所定の操作を実行する許可が指定されます。ユーザには、所定の機能を実行するための許可を取得できるロールが割り当てられます。

ユーザには直接許可が割り当てられていませんが、ロール経由で許可を取得するので、適切なロールをユーザに割り当てることにより個々のユーザの権利を管理できます。これにより、ユーザの追加やユーザの部署の変更といった一般的な操作を簡素化します。

createComponentGroups

ネットワーク要素に 1 つまたは複数の コンポーネント グループ オブジェクトを作成します。ネットワーク要素の InstanceNameId と、ComponentGroup オブジェクトのリストの場合、サーバにオブジェクトを作成し、InstanceNameIds を戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

neInstanceNameId がヌルの場合

neInstanceNameId がネットワーク要素の有効な InstanceNameId でない場合

componentGroupCol がヌルである、またはコレクションが空の場合

componentGroupCol に 1 つまたは複数のヌル エレメントが含まれる、またはコレクションにタイプ ComponentGroup ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupCol コレクションで、いずれの ComponentGroup アトリビュートも有効でない場合

ComponentGroup の名前が疑問符で始まります。コンポーネント グループ名にスペースまたは疑問符を含めることができないからです。

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupCol に、データベースにすでに存在する ComponentGropu が含まれる場合

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

componentGroupCol ― 作成する必要がある ComponentGroup オブジェクトのコレクション(1 つまたは複数)

戻り値

新しく作成された ComponentGroup オブジェクトの InstanceNameIds

createNetworkElementUserRoles

ネットワーク要素に、1 つまたは複数のネットワーク要素ユーザ ロール オブジェクトを作成します。ネットワーク要素の InstanceNameId と、ユーザ ロール オブジェクトのリストの場合、サーバにオブジェクトを作成し、インスタンス名 ID を戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

neInstanceNameId がヌルの場合

neInstanceNameId が有効なネットワーク要素 InstanceNameId でない場合

networkElementUserRoleCol がヌルである、またはコレクションが空の場合

networkElementUserRoleCol に 1 つまたは複数のヌル エレメントが含まれる、またはコレクションにタイプ NetworkElementUserRole ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleCol コレクションで、いずれの NetworkElementUserRole アトリビュートも有効でない場合

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleCol に、データベースにすでに存在する NetworkElementUserRole が含まれる場合

この API はユーザ アソシエーションを考慮しません。ユーザ ロールがユーザ アソシエーションとともに渡されても、この API によって考慮されません。別の API を呼び出して、ユーザとユーザ ロールをバインドする必要があります。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

networkElementUserRoleCol ― 作成する必要がある NetworkElementUserRole オブジェクトのコレクション(1 つまたは複数)

戻り値

新しく作成された NetworkElementUserRole オブジェクトのインスタンス名 ID

createNetworkElementUsers

ネットワーク要素に、1 つまたは複数のネットワーク要素ユーザ オブジェクトを作成します。ネットワーク要素の InstanceNameId と、ネットワーク要素ユーザ オブジェクトのリストの場合、サーバにオブジェクトを作成し、インスタンス名 ID を戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

neInstanceNameId がヌルの場合

neInstanceNameId が有効なネットワーク要素 InstanceNameId でない場合

networkElementUserCol がヌルである、またはコレクションが空の場合

networkElementUserCol に 1 つまたは複数のヌル エレメントが含まれる、またはコレクションにタイプ NetworkElementUser ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserCol コレクションで、いずれの NetworkElementUser アトリビュートも有効でない場合

NetworkElementUser の名前が疑問符で始まります。NetworkElementUser 名に疑問符を含めることができないからです。

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserCol に、データベースにすでに存在する NetworkElementUser が含まれる場合

実際のパスワードがデータベースに保存されません。代わりに、ダミー値が保存されます。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

networkElementUserCol ― 作成する必要がある NetworkElementUser オブジェクトのコレクション(1 つまたは複数)

戻り値

新しく作成された NetworkElementUser オブジェクトのインスタンス名 ID

deleteComponentGroups

1 つまたは複数のコンポーネント グループ オブジェクトを削除します。ComponentGroup オブジェクトの InstanceNameId の場合、これらのオブジェクトはサーバから削除されます。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupInstanceNameIdCol コレクションがヌルである、または空の場合

componentGroupInstanceNameIdCol コレクションに、タイプ ComponentGroup InstanceNameId ではないエレメントが含まれている場合

componentGroupInstanceNameIdCol コレクションに、データベースに存在しない ComponentGroup が含まれている場合

パラメータ

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

componentGroupInstanceNameIdCol ― 削除する必要がある 1 つまたは複数の ComponentGroup オブジェクトの InstanceNameId を含んだコレクション

戻り値

void

deleteNetworkElementUserRoles

1 つまたは複数のネットワーク要素ユーザ ロール オブジェクトを削除します。NetworkElementUserRole オブジェクトの InstanceNameId の場合、これらのオブジェクトはサーバから削除されます。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleInstanceNameIdCol コレクションがヌルである、または空の場合

networkElementUserRoleInstanceNameIdCol コレクションに、タイプ NetworkElementUserRole InstanceNameId ではないエレメントが含まれている場合

networkElementUserRoleInstanceNameIdCol コレクションに、データベースに存在しない NetworkElementUserRole が含まれている場合

パラメータ

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

networkElementUserRoleInstanceNameIdCol ― 削除する必要がある 1 つまたは複数の NetworkElementUserRole オブジェクトの InstanceNameId を含んだコレクション

戻り値

void

deleteNetworkElementUsers

1 つまたは複数のネットワーク要素ユーザ オブジェクトを削除します。NetworkElementUser オブジェクトの InstanceNameId の場合、これらのオブジェクトはサーバから削除されます。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserInstanceNameIdCol コレクションがヌルである、または空の場合

networkElementUserInstanceNameIdCol コレクションに、タイプ NetworkElementUser InstanceNameId ではないエレメントが含まれている場合

networkElementUserInstanceNameIdCol コレクションに、データベースに存在しない NetworkElementUser が含まれている場合

パラメータ

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

networkElementUserInstanceNameIdCol ― 削除する必要がある 1 つまたは複数の NetworkElementUser オブジェクトの InstanceNameId を含んだコレクション

戻り値

void

getComponentAuths

InstanceNameIds から ComponentAuth オブジェクトを戻します。ComponentAuth の InstanceNameId のコレクションの場合、対応する ComponentAuth オブジェクトを戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

componentAuthInstanceNameIdCol がヌルである、または空の場合

componentAuthInstanceNameIdCol に、ComponentAuth の無効な InstanceNameId が含まれる場合

componentAuthInstanceNameIdCol コレクションにヌル値が含まれる場合

componentAuthInstanceNameIdCol 内の特定の InstanceNameId と等しい ComponentAuth オブジェクトがない場合

パラメータ

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

componentAuthInstanceNameIdCol ― ComponentAuth の InstanceNameId のコレクション

戻り値

InstanceNameId の特定のコレクションに対応する ComponentAuth オブジェクトのリスト。ComponentAuth オブジェクトの戻されたリストでは、戻された ComponentAuth オブジェクトに関連付けられた CommandAuth オブジェクトのみが存在します。その他すべてのアソシエーションはクリアされます。

getComponentAuthsInNetworkElement

ネットワーク要素に設定されたすべてのコンポーネントを戻します。ネットワーク要素の InstanceNameId の場合、コンポーネント オブジェクトのコレクションを戻します。

ValidationException は、渡された引数がヌルである、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

ComponentAuth オブジェクトのリストComponentAuth オブジェクトの戻されたリストでは、戻された ComponentAuth オブジェクトに関連付けられた CommandAuth オブジェクトのみが存在します。その他すべてのアソシエーションはクリアされます。

getComponentGroups

InstanceNameIds から ComponentGroup オブジェクトを戻します。ComponentGroup の InstanceNameId のコレクションの場合、対応する ComponentGroup オブジェクトを戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupInstanceNameIdCol がヌルである、または空の場合

componentGroupInstanceNameIdCol に、ComponentGroup の無効な InstanceNameId が含まれる場合

componentGroupInstanceNameIdCol コレクションにヌル値が含まれる場合

componentGroupInstanceNameIdCol 内の特定の InstanceNameId と等しい ComponentGroup オブジェクトがない場合

パラメータ

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

componentGroupInstanceNameIdCol ― ComponentGroup の InstanceNameId のコレクション

戻り値

InstanceNameId の特定のコレクションに対応する ComponentGroup オブジェクトのリスト。ComponentGroup オブジェクトの戻されたリストでは、戻された ComponentGroup オブジェクトに関連付けられた ComponentGroupAuthRule オブジェクトと CommandAuth オブジェクトのみが存在します。その他すべてのアソシエーションはクリアされます。ComponentAuth オブジェクトには、関連付けられた CommandAuth オブジェクトが含まれます。

getComponentGroupsInNetworkElement

ネットワーク要素に設定されたすべてのコンポーネント グループを戻します。ネットワーク要素の InstanceNameId の場合、コンポーネント グループ オブジェクトのコレクションを戻します。

ValidationException は、渡された引数がヌルである、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

ComponentGroup オブジェクトのリストComponentGroup オブジェクトの戻されたリストでは、戻された ComponentGroup オブジェクトに関連付けられた ComponentGroupAuthRule オブジェクトと CommandAuth オブジェクトのみが存在します。その他すべてのアソシエーションはクリアされます。ComponentAuth オブジェクトには、関連付けられた CommandAuth オブジェクトが含まれます。

getNetworkElementUserRoles

InstanceNameIds から NetworkElementUserRole オブジェクトを戻します。NetworkElementUserRole の InstanceNameId のコレクションの場合、対応する NetworkElementUserRole オブジェクトを戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleInstanceNameIdCol がヌルである、または空の場合

networkElementUserRoleInstanceNameIdCol に、NetworkElementUserRole の無効な InstanceNameId が含まれる場合

networkElementUserRoleInstanceNameIdCol にヌル値が含まれる場合

networkElementUserRoleInstanceNameIdCol 内の特定の InstanceNameId と等しい NetworkElementUserRole オブジェクトがない場合

パラメータ

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

networkElementUserRoleInstanceNameIdCol ― NetworkElementUserRole の InstanceNameId のコレクション

戻り値

InstanceNameId の特定のコレクションに対応する NetworkElementUserRole オブジェクトのリスト。戻された NetworkElementUserRole オブジェクト リストでは、次のアソシエーションのみが存在します。その他すべてのアソシエーションはクリアされます。

戻された NetworkElementUserRole オブジェクトの、関連付けられたすべての
RoleBasedAuthorizationRule オブジェクトRoleBasedAuthorizationRule が
ComponentGroupAuthRule である場合、関連付けられた ComponentGroup も ComponentAuth オブジェクトとともに戻されます。RoleBasedAuthorizationRule が ComponentAuthRule のインスタンスである場合、関連付けられた ComponentGroup も ComponentAuth オブジェクトとともに戻されます。ComponentAuth オブジェクトに関連付けられた CommandAuth オブジェクトも戻されます。

NetworkElementUserRole の VlanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VsanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VrfPolicy アソシエーション(存在する場合)Vrf オブジェクト以外で、VlanPolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

NetworkElementUserRole の NetworkInterfacePolicy アソシエーション(存在する場合)NetworkInterface 以外で、NetworkInterfacePolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

getNetworkElementUserRolesInNetworkElement

ネットワーク要素に設定されたすべてのネットワーク要素ユーザ ロールを戻します。ネットワーク要素の InstanceNameId の場合、ユーザ ロール オブジェクトのコレクションを戻します。

ValidationException は、渡された引数がヌルである、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

NetworkElementUserRole オブジェクトのリスト戻されたオブジェクト リストでは、次のアソシエーションのみが存在します。その他すべてのアソシエーションはクリアされます。

戻された NetworkElementUserRole オブジェクトの、関連付けられたすべての
RoleBasedAuthorizationRule オブジェクトRoleBasedAuthorizationRule が
ComponentGroupAuthRule である場合、関連付けられた ComponentGroup も ComponentAuth オブジェクトとともに戻されます。RoleBasedAuthorizationRule が ComponentAuthRule のインスタンスである場合、関連付けられた ComponentGroup も ComponentAuth オブジェクトとともに戻されます。ComponentAuth オブジェクトに関連付けられた CommandAuth オブジェクトも戻されます。

NetworkElementUserRole の VlanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VsanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VrfPolicy アソシエーション(存在する場合)Vrf オブジェクト以外で、VlanPolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

NetworkElementUserRole の NetworkInterfacePolicy アソシエーション(存在する場合)
NetworkInterface 以外で、NetworkInterfacePolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

getNetworkElementUsers

InstanceNameIds から NetworkElementUser オブジェクトを戻します。NetworkElementUser の InstanceNameId のコレクションの場合、対応する NetworkElementUser オブジェクトを戻します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserInstanceNameIdCol がヌルである、または空の場合

networkElementUserInstanceNameIdCol に、NetworkElementUser の無効な InstanceNameId が含まれる場合

networkElementUserInstanceNameIdCol にヌル値が含まれる場合

networkElementUserInstanceNameIdCol 内の特定の InstanceNameId と等しい NetworkElementUser オブジェクトがない場合

パラメータ

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

networkElementUserInstanceNameIdCol ― NetworkElementUser の InstanceNameId のコレクション

戻り値

InstanceNameId の特定のコレクションに対応する NetworkElementUser オブジェクトのリスト。戻された NetworkElementUser オブジェクト リストでは、次のアソシエーションのみが存在します。その他すべてのアソシエーションはクリアされます。

関連付けられた NetworkElementUserCredentials オブジェクト(存在する場合)

NetworkElementUser ごとに NetworkElementUserRole アソシエーション(存在する場合)。NetworkElementUserRole に RoleBasedAuthorizationRule エントリなどの他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

getNetworkElementUsersInNetworkElement

ネットワーク要素内のすべての NetworkElementUser オブジェクトを戻します。ネットワーク要素の InstanceNameId の場合、ネットワーク要素内の NetworkElementUser オブジェクトのコレクションを戻します。

ValidationException は、渡された引数がヌルである、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

NetworkElementUser オブジェクトのリスト戻されたオブジェクト リストでは、次のアソシエーションのみが維持されます。その他すべてのアソシエーションはクリアされます。

関連付けられた NetworkElementUserCredentials オブジェクト(存在する場合)

NetworkElementUser ごとに NetworkElementUserRole アソシエーション(存在する場合)。NetworkElementUserRole に RoleBasedAuthorizationRule エントリなどの他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

modifyComponentGroups

1 つまたは複数の既存の ComponentGroup オブジェクトを変更します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupCol コレクションがヌルである、または空の場合

componentGroupCol コレクションに、タイプ ComponentGroup ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupCol コレクションで、ComponentGroup のいずれのアトリビュートも有効でない場合

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

componentGroupCol コレクションに、データベースに存在しない ComponentGroup が含まれている場合

パラメータ

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

componentGroupCol ― データベース内の既存の ComponentGroup オブジェクトから置き換えられる、ComponentGroup オブジェクトのコレクション(1 つまたは複数)

戻り値

void

modifyNetworkElementUserRoles

1 つまたは複数の既存のネットワーク要素ユーザ ロール オブジェクトを変更します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleCol コレクションがヌルである、または空の場合

networkElementUserRoleCol コレクションに、タイプ NetworkElementUserRole ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleCol コレクションで、NetworkElementUserRole のいずれのアトリビュートも有効でない場合

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserRoleCol コレクションに、データベースに存在しない NetworkElementUserRole が含まれている場合

この API はユーザ アソシエーションを考慮しません。ユーザ ロールがユーザ アソシエーションとともに渡されると、この API によって考慮されません。別の API を呼び出して、ユーザとユーザ ロールをバインドする必要があります。

パラメータ

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

networkElementUserRoleCol ― データベース内の既存の NetworkElementUserRole オブジェクトから置き換えられる、NetworkElementUserRole オブジェクトのコレクション(1 つまたは複数)

戻り値

NetworkElementUserRole オブジェクトのリスト戻されたオブジェクト リストでは、次のアソシエーションのみが存在します。その他すべてのアソシエーションはクリアされます。

戻された NetworkElementUserRole オブジェクトの、関連付けられたすべての RoleBasedAuthorizationRule オブジェクトRoleBasedAuthorizationRule が ComponentGroupAuthRule である場合、関連付けられた ComponentGroup も戻されます。

NetworkElementUserRole の VlanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VsanPolicy アソシエーション(存在する場合)

NetworkElementUserRole の VrfPolicy アソシエーション(存在する場合)Vrf オブジェクト以外で、VlanPolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

NetworkElementUserRole の NetworkInterfacePolicy アソシエーション(存在する場合)
NetworkInterface 以外で、NetworkInterfacePolicy に他のアソシエーションがある場合、これらのアソシエーションはクリアされます。

modifyNetworkElementUsers

1 つまたは複数の既存のネットワーク要素ユーザ オブジェクトを変更します。

ValidationException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserCol コレクションがヌルである、または空の場合

networkElementUserCol コレクションに、タイプ NetworkElementUser ではないオブジェクトが含まれている場合

PropertiesException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserCol コレクションでは、NetworkElementUser のアトリビュートの場合

IntegrityException は、次のうち、いずれかの状況が発生したときにスローされます。

networkElementUserCol コレクションに、データベースに存在しない NetworkElementUser が含まれている場合

実際のパスワードがデータベースに保存されません。代わりに、ダミー値が保存されます。

パラメータ

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

networkElementUserCol ― データベース内の既存の NetworkElementUser オブジェクトから置き換えられる、NetworkElementUser オブジェクトのコレクション(1 つまたは複数)

戻り値

void