RbacApp サービス
この章では、DCNM Web サービスの、RbacApp サービスに対応する API メソッドについて説明します。
About 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
disablePasswordStrengthCheck
指定 VNE に対してパスワード強度チェックをディセーブルにします。1 つまたは複数の VNE のインスタンス名 ID を指定すると、「PasswordStrengthcheck」はこれらの要素でイネーブルにされます。この API は、DC-OS デバイスの PasswordStrengthcheck をイネーブルにします。他の IOS デバイスには適していません。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vneInstanceNameIdCol がヌルの場合。
• タイプ VirtualNetworkElement の vneInstanceNameIdColis に 1 つまたは複数のヌル要素が含まれている場合、あるいはコレクションが空の場合またはタイプ InstanceNameId ではない場合。
• 指定インターフェイスが他の IOS で稼動している場合。
パラメータ
opContext:動作コンテキスト
vneInstanceNameIdCol:情報が必要な VirtualNetworkElement の InstanceNameId のリスト。
戻り値
void
enablePasswordStrengthCheck
指定 VNE に対して PasswordStrengthCheck をイネーブルにします。1 つまたは複数の VNE のインスタンス名 ID を指定すると、「PasswordStrengthcheck」はこれらの要素でイネーブルにされます。この API は、DC-OS デバイスの PasswordStrengthcheck をイネーブルにします。他の IOS デバイスには適していません。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vneInstanceNameIdCol がヌルの場合。
• タイプ VirtualNetworkElement の vneInstanceNameIdColis に 1 つまたは複数のヌル要素が含まれている場合、あるいはコレクションが空の場合またはタイプ InstanceNameId ではない場合。
• 指定インターフェイスが他の IOS で稼動している場合。
パラメータ
opContext:動作コンテキスト
vneInstanceNameIdCol:情報が必要な VirtualNetworkElement の InstanceNameId のリスト。
戻り値
void
getComponentAuths
ComponentAuth オブジェクトをその InstanceNameIds から戻します。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
ComponentGroup オブジェクトをその InstanceNameIds から戻します。ComponentGroup の InstanceNameId のコレクションを指定すると、対応する ComponentGroup オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• componentGroupInstanceNameIdCol がヌル、または空の場合。
• componentGroupInstanceNameIdCol に ComponentGroup の無効な InstanceNameId が含まれている場合。
• componentGroupInstanceNameIdCol コレクションにヌル値が含まれている場合。
• componentGroupInstanceNameIdCol の指定 InstanceNameId と同等の ComponentGroup オブジェクトがない場合。
パラメータ
opContext:動作コンテキスト
componentGroupInstanceNameIdCol:ComponentGroup の InstanceNameId のコレクション。
戻り値
InstanceNameId の指定コレクションに対応する ComponentGroup オブジェクトのリスト。戻された ComponentGroup オブジェクトのリストでは、戻された ComponentGroup オブジェクトに関連する ComponentGroupAuthRule オブジェクトおよび ComponentAuth オブジェクトだけが存在します。その他のすべてのアソシエーションはクリアされます。ComponentAuth オブジェクトには、関連する CommandAuth オブジェクトが含まれます。
getComponentGroupsInNetworkElement
ネットワーク要素で設定されたすべてのコンポーネント グループを戻します。ネットワーク要素の InstanceNameId を指定すると、コンポーネント グループ オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
ComponentGroup オブジェクトのリスト。戻された ComponentGroup オブジェクトのリストでは、戻された ComponentGroup オブジェクトに関連する ComponentGroupAuthRule オブジェクトおよび ComponentAuth オブジェクトだけが存在します。その他のすべてのアソシエーションはクリアされます。ComponentAuth オブジェクトには、関連する CommandAuth オブジェクトが含まれます。
getNetworkElementUserRoles
NetworkElementUserRole オブジェクトをその InstanceNameIds から戻します。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
NetworkElementUser オブジェクトをその InstanceNameIds から戻します。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