Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
AaaApp サービス
AaaApp サービス
発行日;2012/02/02 | 英語版ドキュメント(2011/07/18 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

AaaApp サービス

AaaApp サービスについて

bindNetworkInterfaceToAaaServerGroups

bindNetworkInterfaceToGlobalRadiusServerSetting

bindNetworkInterfaceToGlobalTACACSServerSetting

createAaaServerGroups

createAccountingRulesInNetworkElement

createAuthenticationRulesInNetworkElement

createAuthorizationRulesInNetworkElement

createGlobalAaaServers

deleteAaaServerGroups

deleteAccountingRules

deleteAuthenticationRules

deleteAuthorizationRules

deleteGlobalAaaServers

disableAaa

disableTACACS

enableAaa

enableTACACS

getAaaGlobalSettings

getAaaServerGroups

getAaaServerGroupsInNetworkElement

getAaaStateOfNetworkElements

getAccountingRules

getAccountingRulesInNetworkElement

getAuthenticationRules

getAuthenticationRulesInNetworkElement

getAuthorizationRules

getAuthorizationRulesInNetworkElement

getGlobalAaaServerSettings

getGlobalAaaServers

getGlobalAaaServersForGroupAaaServers

getGlobalAaaServersInNetworkElement

getGlobalRadiusServerSettings

getGlobalRadiusServersInNetworkElement

getGlobalTACACSServerSettings

getGlobalTACACSServersInNetworkElement

getRadiusServerGroupsInNetworkElement

getTACACSServerGroupsInNetworkElement

getTACACSStateOfNetworkElements

modifyAaaGlobalSetting

modifyAaaServerGroups

modifyAccountingRules

modifyAuthenticationRules

modifyAuthorizationRules

modifyGlobalAaaServerSetting

modifyGlobalAaaServers

unbindNetworkInterfaceFromAaaServerGroups

unbindNetworkInterfaceFromGlobalRadiusServerSettings

unbindNetworkInterfaceFromGlobalTACACSServerSettings

AaaApp サービス

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

AaaApp サービスについて

Authentication, Authorization, and Accounting(AAA; 認証、認可、およびアカウンティング)サービスは、ルータまたはアクセス サーバ上でアクセス コントロールを設定する、基本的なフレームワークを提供します。アクセス コントロールにより、ネットワーク サーバにアクセスできるユーザおよびアクセスできるサービスを制御できます。

認証は、個々のユーザを識別するプロセスであり、通常はユーザ名とパスワードに基づいて行われます。

認可は、ユーザ名とパスワードによる認証後、ユーザにネットワーク リソースへのアクセスを許可する、または拒否するプロセスです。ユーザがアクセスできる情報量およびサービス量は、ユーザの承認レベルによって決まります。

アカウンティングは、ネットワーク リソースにアクセス中のユーザのアクティビティを追跡するプロセスです。ネットワークで費やした時間、アクセスしたサービス、セッション中に転送したデータ量などが含まれます。

API カテゴリは次のとおりです。

Query/Get API:永続的なデータベースのデータを照会します。

Create API:新しい AAA サーバおよび AAA ルールを作成します。

Modify API:既存の AAA サーバおよび AAA ルールの基本アトリビュートを変更します。

Delete API:既存の AAA サーバおよび AAA ルールを削除します。

Enable および Disable API:デバイスの AAA 機能または TACACS をイネーブルおよびディセーブルにします。

この章では、次の機能の API を扱います。

AAA ルール

AAA サーバ グループ

bindNetworkInterfaceToAaaServerGroups

1 つまたは複数の AAA サーバ グループに、送信元インターフェイスとしてネットワーク インターフェイスを割り当てます。サーバ グループに既存の送信元インターフェイスのアソシエーションがある場合、この新しいインターフェイス アソシエーションによって既存のアソシエーションが上書きされます。

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

neInstanceNameId または aaaServerGrpInstanceNameIdCol がヌルの場合。

aaaServerGrpInstanceNameIdCol のコレクションにヌルの要素が含まれている、コレクションが空、またはコレクションがタイプ AaaServerGroup InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のサーバ タイプが TACACS+ であり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

ネットワーク インターフェイスと AAA サーバ グループが同じネットワーク要素に属していない場合。

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

特定の networkInterfaceInstanceNameId のオブジェクトがデバイスに存在しない場合。

特定の aaaServerGrpInstanceNameIdCol のオブジェクトがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

aaaServerGrpInstanceNameIdCol:送信元インターフェイスを割り当てる必要がある AaaServerGroup の InstanceNameId のリスト

networkInterfaceInstanceNameId:ネットワーク インターフェイスの InstanceNameId。

戻り値

void

bindNetworkInterfaceToGlobalRadiusServerSetting

ネットワーク要素でグローバルに設定された RADIUS サーバに対応する送信元インターフェイスとして、ネットワーク インターフェイスを割り当てます。グローバル RADIUS サーバに既存の送信元インターフェイスのアソシエーションがある場合、この新しいインターフェイス アソシエーションによって既存のアソシエーションが上書きされます。

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

networkInterfaceInstanceNameIdis がヌルの場合。

aaaServerGrpInstanceNameIdCol がタイプ AaaServerGroup InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

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

特定の networkInterfaceInstanceNameId のオブジェクトがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameId:ネットワーク インターフェイスの InstanceNameId。

戻り値

void

bindNetworkInterfaceToGlobalTACACSServerSetting

ネットワーク要素でグローバルに設定された TACACS サーバに対応する送信元インターフェイスとして、ネットワーク インターフェイスを割り当てます。グローバル TACACS サーバ設定に送信元インターフェイスのアソシエーションがすでにある場合、この新しいインターフェイス アソシエーションによって既存のアソシエーションが上書きされます。

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

networkInterfaceInstanceNameIdis がヌルの場合。

aaaServerGrpInstanceNameIdCol がタイプ AaaServerGroup InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

Cisco NX-OS が動作している特定のネットワーク要素で TACACS がディセーブルの場合。

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

特定の networkInterfaceInstanceNameId のオブジェクトがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

networkInterfaceInstanceNameId:ネットワーク インターフェイスの InstanceNameId。

戻り値

void

createAaaServerGroups

ネットワーク要素内で、1 つまたは複数の AAA サーバ グループおよび関連付けられたグループ AAA サーバを作成します。グローバル サーバとして設定されていないグループ サーバでは、グループ サーバに対するグローバル サーバが作成されます。

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

neInstanceNameId がヌル、または有効なネットワーク要素の InstanceNameId ではない場合。

aaaServerGrpCol がヌルの場合。

aaaServerGrpCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

aaaServerGrpCol のコレクションに、タイプ AaaServerGroup ではない要素が含まれている場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定の AAA サーバ グループが TACACS+ サーバであり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

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

AAA サーバ グループが無効の場合。

例:

サーバ グループ名がヌル

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

同じ名前のサーバ グループがすでにデバイスに存在している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:AAA サーバ グループの作成が必要なネットワーク要素の InstanceNameId。

aaaServerGrpCol:作成する必要のある AaaServerGroup オブジェクトのリスト。

戻り値

このメソッドによって作成された AaaServerGroup オブジェクトの InstanceNameId のリスト。

createAccountingRulesInNetworkElement

ネットワーク要素内で 1 つまたは複数のアカウンティング ルールを作成します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

acRuleCol がヌルの場合。

acRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

neInstanceNameId がヌル、または有効なネットワーク要素の InstanceNameId ではない場合。

特定のルールにメソッドがない場合。

デバイスで Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

ネットワーク要素で Cisco NX-OS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 10 より多い場合。

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

アカウンティング ルールが無効の場合。

例:

ルール名がヌル

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

同じ名前とサービスを持つアカウンティング ルールがすでにデバイスに存在している場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:アカウンティング ルールの作成が必要なネットワーク要素の InstanceNameId。

acRuleCol:作成する必要のある AccountingRule オブジェクトのリスト。

戻り値

このメソッドによって作成された AccountingRule オブジェクトの InstanceNameId のリスト。

createAuthenticationRulesInNetworkElement

ネットワーク要素内で 1 つまたは複数の認証ルールを作成します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

atRuleCol がヌルの場合。

atRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

neInstanceNameId がヌル、または有効なネットワーク要素の InstanceNameId ではない場合。

特定のルールにメソッドがない場合。

特定のネットワーク要素で Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

特定のネットワーク要素で Cisco NX-OS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 10 より多い場合。

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

認証ルールが無効の場合。

例:

ルール名がヌル

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

同じ名前とサービスを持つ認証ルールがすでにデバイスに存在している場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:認証ルールの作成が必要なネットワーク要素の InstanceNameId。

atRuleCol:作成する必要のある AuthenticationRule オブジェクトのリスト。

戻り値

このメソッドによって作成された AuthenticationRule オブジェクトの InstanceNameId のリスト。

createAuthorizationRulesInNetworkElement

ネットワーク要素内で 1 つまたは複数の認可ルールを作成します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のネットワーク要素で Cisco NX-OS が動作している場合。

arRuleCol がヌルの場合。

arRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

neInstanceNameId がヌル、または有効なネットワーク要素の InstanceNameId ではない場合。

特定のルールにメソッドがない場合。

特定のネットワーク要素で Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

ネットワーク要素で Cisco NX-OS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 10 より多い場合。

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

認可ルールが無効の場合。

例:

ルール名がヌル

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

同じ名前とサービスを持つ認可ルールがすでにデバイスに存在している場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:認可ルールの作成が必要なネットワーク要素の InstanceNameId。

arRuleCol:作成する必要のある AuthenticationRule オブジェクトのリスト。

戻り値

このメソッドによって作成された AuthorizationRule オブジェクトの InstanceNameId のリスト。

createGlobalAaaServers

ネットワーク要素内で 1 つまたは複数の AAA サーバをグローバルに作成します。

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

neInstanceNameId がヌル、または有効なネットワーク要素の InstanceNameId ではない場合。

aaaServerCol がヌルの場合。

aaaServerCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

aaaServerCol のコレクションに、タイプ GlobalAaaServer ではない要素が含まれている場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定の AAA サーバが TACACS+ サーバであり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

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

グローバル AAA サーバが無効の場合。

例:

サーバ ホスト名および IP アドレスがヌル

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

同じ名前、認証ポート、およびアカウンティング ポートを持つ AAA サーバがすでにデバイスにグローバルに存在している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:グローバル AAA サーバの作成が必要なネットワーク要素の InstanceNameId。

aaaServerCol:作成する必要のある GlobalAaaServer オブジェクトのリスト。

戻り値

このメソッドによって作成された GlobalAaaServer オブジェクトの InstanceNameId のリスト。

deleteAaaServerGroups

ネットワーク要素から 1 つまたは複数の AAA サーバ グループを削除します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

aaaServerGrpInstanceNameIdCol がヌルの場合。

aaaServerGrpInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

aaaServerGrpInstanceNameIdCol のコレクションに、タイプ AaaServerGroup InstanceNameId ではない要素が含まれている場合。

特定の AAA サーバ グループのいずれかが AAA ルールと関連付けられている場合。

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

特定の AaaServerGroup がデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

aaaServerGrpInstanceNameIdCol:削除する必要のある 1 つまたは複数の AaaServerGroup オブジェクトのインスタンス名 ID。

戻り値

void

deleteAccountingRules

ネットワーク要素から 1 つまたは複数のアカウンティング ルールを削除します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

acRuleInstanceNameIdCol がヌルの場合。

acRuleInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

acRuleInstanceNameIdCol のコレクションに、タイプ AccountingRule InstanceNameId ではない要素が含まれている場合。

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

特定のアカウンティング ルールがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

acRuleInstanceNameIdCol:削除する必要のある 1 つまたは複数の AccountingRule オブジェクトのインスタンス名 ID。

戻り値

void

deleteAuthenticationRules

ネットワーク要素から 1 つまたは複数の認証ルールを削除します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

atRuleInstanceNameIdCol がヌルの場合。

atRuleInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

atRuleInstanceNameIdCol のコレクションに、タイプ AuthenticationRule InstanceNameId ではない要素が含まれている場合。

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

特定の認証ルールがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

atRuleInstanceNameIdCol:削除する必要のある 1 つまたは複数の AuthenticationRule オブジェクトのインスタンス名 ID。

戻り値

void

deleteAuthorizationRules

ネットワーク要素から 1 つまたは複数の認可ルールを削除します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

arRuleInstanceNameIdCol がヌルの場合。

arRuleInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

arRuleInstanceNameIdCol collection のコレクションに、タイプ AuthorizationRule InstanceNameId ではない要素が含まれている場合。

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

特定の認可ルールがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

arRuleInstanceNameIdCol:削除する必要のある 1 つまたは複数の AuthorizationRule オブジェクトのインスタンス名 ID。

戻り値

void

deleteGlobalAaaServers

ネットワーク要素から 1 つまたは複数のグローバル AAA サーバを削除します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

aaaServerInstanceNameIdCol がヌルの場合。

aaaServerInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

aaaServerInstanceNameIdCol のコレクションに、タイプ GlobalAaaServer InstanceNameId ではない要素が含まれている場合。

特定のグローバル サーバのいずれかと同じ IP アドレスまたはホスト名を持つグループ サーバが存在している場合。

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

特定の GlobalAaaServer がデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

aaaServerInstanceNameIdCol:削除する必要のある 1 つまたは複数の GlobalAaaServer オブジェクトのインスタンス名 ID。

戻り値

void

disableAaa

1 つまたは複数のネットワーク要素で AAA をディセーブルにします。この API を適用できるのは、Cisco IOS が動作しているデバイスだけであり、Cisco NX-OS には適用できません。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

特定のネットワーク要素で Cisco NX-OS が動作している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AAA をディセーブルにする必要のあるネットワーク要素の InstanceNameId のリスト。

戻り値

void

disableTACACS

1 つまたは複数のネットワーク要素で TACACS+ をディセーブルにします。この API を適用できるのは Cisco NX-OS だけであり、Cisco IOS が動作しているデバイスには適用できません。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

特定のネットワーク要素で Cisco IOS が動作している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:TACACS+ をディセーブルにする必要のあるネットワーク要素の InstanceNameId のリスト。

戻り値

void

enableAaa

1 つまたは複数のネットワーク要素で AAA をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で AAA がイネーブルになります。この API を使用すると、Cisco IOS デバイスの AAA をイネーブルにできます。この API は Cisco NX-OS には適用できません。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

特定のネットワーク要素で Cisco NX-OS が動作している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AAA をイネーブルにする必要のあるネットワーク要素の InstanceNameId のリスト。

戻り値

void

enableTACACS

1 つまたは複数のネットワーク要素で TACACS+ をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で TACACS+ がイネーブルになります。この API を適用できるのは Cisco NX-OS だけであり、Cisco IOS には適用できません。

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

neInstanceNameIdCol がヌルの場合。

neInstanceNameIdCol に 1 つまたは複数のヌル要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

特定のネットワーク要素で Cisco IOS が動作している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:TACACS+ をイネーブルにする必要のあるネットワーク要素の InstanceNameId のリスト

戻り値

void

getAaaGlobalSettings

1 つまたは複数のネットワーク要素のデバイス レベルの AAA グローバル設定を戻します。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらのネットワーク要素に対応する AAA グローバル設定オブジェクトが戻ります。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameIdCol:TACACS+ サーバ設定が必要なネットワーク要素の InstanceNameId のリスト。

戻り値

特定のネットワーク要素でグローバルに設定されている AAA グローバル設定。戻されたリストには AaaGlobalSetting インスタンスのリストが含まれます。

AAA グローバル設定には、次のものがあります。

1. ASCII、MSCHAP、または MSCHAPv2 の認証をイネーブルもしくはディセーブルにします。

2. コンソールで AAA 認証失敗メッセージ表示を設定します。

3. リモート ユーザ認証のデフォルト ユーザ ロールをイネーブルまたはディセーブルにします。

getAaaServerGroups

1 つまたは複数の AAA サーバ グループを戻します。1 つまたは複数の AAA サーバ グループのインスタンス ID を指定すると、対応する AAA サーバ グループ オブジェクトが戻ります。

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

grpInstanceNameIdCol のコレクションにヌルの要素が含まれている、コレクションが空、またはコレクションがタイプ InstanceNameId ではない場合。

渡された引数がヌル、または有効な AAA サーバ グループの InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

grpInstanceNameIdCol:1 つまたは複数の AAA サーバ グループ オブジェクトの InstanceNameId。

戻り値

特定の AAA サーバ グループ InstanceNameId に対応する AAA サーバ グループ。戻されたリストには、AaaServerGroup インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

グループ AAA サーバ アソシエーション。

サーバ グループに送信元インターフェイスのアソシエーションがある場合は、そのアソシエーションを使用できます。ただし、ネットワーク インターフェイスに他のアソシエーションがある場合、それらのアソシエーションはすべてクリアされます。

その他のアソシエーションはすべてクリアされます。

getAaaServerGroupsInNetworkElement

ネットワーク要素で設定されている AAA サーバ グループを戻します。ネットワーク要素のインスタンス名 ID を指定すると、AAA サーバ グループのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:AAA サーバ グループが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在している AAA サーバ グループ。戻されたリストには、AaaServerGroup インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

グループ AAA サーバ アソシエーション。

サーバ グループに送信元インターフェイスのアソシエーションがある場合は、そのアソシエーションを使用できます。ただし、ネットワーク インターフェイスに他のアソシエーションがある場合、それらのアソシエーションはすべてクリアされます。

その他のアソシエーションはすべてクリアされます。

getAaaStateOfNetworkElements

ネットワーク要素のリストに含まれている AAA の状態(イネーブルまたはディセーブル)を戻します。ネットワーク要素のインスタンス名 ID リストを指定すると、ブール値のリストを戻します。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AAA の状態が必要な 1 つまたは複数のネットワーク要素の InstanceNameId

戻り値

戻されたリストには、ブール インスタンスが含まれます。

ブール値 TRUE は、特定のネットワーク要素で AAA がイネーブルであることを表します。

ブール値 FALSE は、特定のネットワーク要素で AAA がディセーブルであることを表します。

getAccountingRules

1 つまたは複数のアカウンティング ルールを戻します。1 つまたは複数のアカウンティング ルールのインスタンス ID を指定すると、対応するアカウンティング ルール オブジェクトが戻ります。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌル、または有効なアカウンティング ルールの InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

acRuleInstanceNameIdCol:1 つまたは複数のアカウンティング ルール オブジェクトの InstanceNameId。

戻り値

特定のアカウンティング ルール InstanceNameId に対応するアカウンティング ルール。戻されたリストには、AcountingRule インスタンスのリストが含まれます。

アカウンティング ルールには、次のアソシエーションがあります。

アカウンティング メソッド(AccountingMethod)

アカウンティング メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getAccountingRulesInNetworkElement

ネットワーク要素内に設定されているアカウンティング ルールを戻します。ネットワーク要素のインスタンス ID を指定すると、アカウンティング ルールのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:アカウンティング ルールが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在しているアカウンティング ルール。戻されたリストには、AcountingRule インスタンスのリストが含まれます。

アカウンティング ルールには、次のアソシエーションがあります。

アカウンティング メソッド(AccountingMethod)

アカウンティング メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getAuthenticationRules

1 つまたは複数の認証ルールを戻します。1 つまたは複数の認証ルールのインスタンス ID を指定すると、対応する認証ルール オブジェクトが戻ります。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌル、または有効な認証ルールの InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

atRuleInstanceNameIdCol:1 つまたは複数の認証ルール オブジェクトの InstanceNameId。

戻り値

特定の認証ルール InstanceNameId に対応する認証ルール。戻されたリストには、AuthenticationRule インスタンスのリストが含まれます。

認証ルールには、次のアソシエーションがあります。

認証メソッド(AuthenticationMethod)

認証メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getAuthenticationRulesInNetworkElement

ネットワーク要素内に設定されている認証ルールを戻します。ネットワーク要素のインスタンス名 ID を指定すると、認証ルールのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:認証ルールが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在している認証ルール。戻されたリストには、AuthenticationRule インスタンスのリストが含まれます。

認証ルールには、次のアソシエーションがあります。

認証メソッド(AuthenticationMethod)

認証メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getAuthorizationRules

1 つまたは複数の認可ルールを戻します。1 つまたは複数の認可ルールのインスタンス ID を指定すると、対応する認可ルール オブジェクトが戻ります。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌル、または有効な認可ルールの InstanceNameId ではない。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

arRuleInstanceNameIdCol:1 つまたは複数の認可ルール オブジェクトの InstanceNameId。

戻り値

特定の認可ルール InstanceNameId に対応する認可ルール。戻されたリストには、AuthorizationRule インスタンスのリストが含まれます。

認可ルールには、次のアソシエーションがあります。

認可メソッド(AuthorizationMethod)

認可メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照が削除されます。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getAuthorizationRulesInNetworkElement

ネットワーク要素内に設定されている認可ルールを戻します。ネットワーク要素のインスタンス名 ID を指定すると、認可ルールのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のネットワーク要素で Cisco NX-OS が動作している場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:認可ルールが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在している認可ルール。戻されたリストには、AuthorizationRule インスタンスのリストが含まれます。

認可ルールには、次のアソシエーションがあります。

認可メソッド(AuthorizationMethod)

認可メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照が使用可能になります。ただし、そのサーバ グループでは、すべての参照が削除されます。ただし、そのサーバ グループでは、すべての参照がクリアされます。

getGlobalAaaServerSettings

1 つまたは複数のグローバル RADIUS/TACACS サーバ設定を戻します。1 つまたは複数のグローバル RADIUS/TACACS サーバ設定のインスタンス ID を指定すると、対応するグローバル RADIUS/TACACS サーバ設定が戻ります。

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

settingInstanceNameIdCol のコレクションにヌルの要素が含まれている、コレクションが空、またはコレクションがタイプ InstanceNameId ではない。

渡された引数がヌル、または有効なグローバル AAA サーバ設定の InstanceNameId ではない。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

grpInstanceNameIdCol:1 つまたは複数のグローバル AAA サーバ オブジェクトの InstanceNameId。

戻り値

特定の AAA サーバ InstanceNameId のグローバル RADIUS/TACACS サーバ設定。戻されたリストには、GlobalAaaServerSetting インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getGlobalAaaServers

グローバルに設定されている 1 つまたは複数の AAA サーバを戻します。1 つまたは複数の AAA サーバのインスタンス ID を指定すると、対応する AAA サーバ オブジェクトが戻ります。

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

serverInstanceNameIdCol のコレクションにヌルの要素が含まれている、コレクションが空、またはコレクションがタイプ InstanceNameId ではない。

渡された引数がヌル、または有効なグローバル AAA サーバ InstanceNameId ではない。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

grpInstanceNameIdCol:1 つまたは複数のグローバル AAA サーバ オブジェクトの InstanceNameId。

戻り値

特定の AAA サーバ InstanceNameId に対応するグローバル AAA サーバ。戻されたリストには、GlobalAaaServer インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getGlobalAaaServersForGroupAaaServers

特定のグループ AAA サーバに対してグローバルに設定されている AAA サーバを戻します。グローバル AAA サーバのインスタンス名 ID を指定すると、グローバルに設定されている AAA サーバ グループのリストが戻ります。

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

渡された引数がヌル、または有効なグループ AAA サーバ InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

groupServerInstanceNameIds:AAA サーバが必要な GroupAaaServer の InstanceNameId

戻り値

特定のサーバ グループに対してグローバルに設定されている AAA サーバ。戻されたリストには、GlobalAaaServer インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getGlobalAaaServersInNetworkElement

ネットワーク要素でグローバルに設定されている AAA サーバを戻します。ネットワーク要素のインスタンス名 ID を指定すると、グローバルに設定されている AAA サーバのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:AAA サーバが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素でグローバルに設定されている AAA サーバ。戻されたリストには、GlobalAaaServer インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getGlobalRadiusServerSettings

1 つまたは複数のネットワーク要素のデバイス レベルの RADIUS サーバ設定を戻します。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらのネットワーク要素の対応するグローバル AAA サーバ設定オブジェクトが戻ります。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:RADIUS サーバ設定が必要なネットワーク要素の InstanceNameId のリスト

戻り値

特定のネットワーク要素でグローバルに設定されている RADIUS サーバ設定。戻されたリストには、タイプ RADIUS の GlobalAaaServerSetting インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

送信元インターフェイスのアソシエーション。ただし、ネットワーク インターフェイスに他のアソシエーションがすでにある場合、それらのアソシエーションはすべてクリアされます。

getGlobalRadiusServersInNetworkElement

ネットワーク要素でグローバルに設定されている RADIUS サーバを戻します。ネットワーク要素のインスタンス名 ID を指定すると、タイプ RADIUS の AAA サーバのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:RADIUS サーバが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素でグローバルに設定されている RADIUS サーバ。戻されたリストには、タイプ RADIUS の GlobalAaaServer インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getGlobalTACACSServerSettings

1 つまたは複数のネットワーク要素のデバイス レベルの TACACS+ サーバ設定を戻します。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらのネットワーク要素の対応するグローバル AAA サーバ設定オブジェクトが戻ります。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:TACACS+ サーバ設定が必要なネットワーク要素の InstanceNameId のリスト

戻り値

特定のネットワーク要素でグローバルに設定されている TACACS+ サーバ設定。戻されたリストには、タイプ TACACS+ の GlobalAaaServerSetting インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

送信元インターフェイスのアソシエーション。ただし、ネットワーク インターフェイスに他のアソシエーションがすでにある場合、それらのアソシエーションはすべてクリアされます。

getGlobalTACACSServersInNetworkElement

ネットワーク要素でグローバルに設定されている TACACS+ サーバを戻します。ネットワーク要素のインスタンス名 ID を指定すると、タイプ TACACS+ の AAA サーバのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:TACACS+ サーバが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素でグローバルに設定されている TACACS+ サーバ。戻されたリストには、タイプ TACACS+ の GlobalAaaServer インスタンスのリストが含まれます。

アソシエーションはすべてクリアされます。

getRadiusServerGroupsInNetworkElement

ネットワーク要素で設定されているタイプ RADIUS の AAA サーバ グループを戻します。ネットワーク要素のインスタンス名 ID を指定すると、タイプ RADIUS の AAA サーバ グループのリストが戻ります。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:RADIUS サーバ グループが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在している RADIUS サーバ グループ。戻されたリストには、タイプ RADIUS の GlobalAaaServerGroup インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

グループ AAA サーバ アソシエーション。

サーバ グループに送信元インターフェイスのアソシエーションがある場合は、そのアソシエーションを使用できます。ただし、ネットワーク インターフェイスに他のアソシエーションがある場合、それらのアソシエーションはすべてクリアされます。

その他のアソシエーションはすべてクリアされます。

getTACACSServerGroupsInNetworkElement

ネットワーク要素で設定されているタイプ TACACS+ の AAA サーバ グループを戻します。ネットワーク要素のインスタンス名 ID を指定すると、タイプ TACACS+ の AAA サーバ グループのリストが戻ります。次のアソシエーションが使用可能です。

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

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:TACACS+ サーバ グループが必要なネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素に存在している TACACS+ サーバ グループ。戻されたリストには、タイプ TACACS+ の AaaServerGroup インスタンスのリストが含まれます。

AAA サーバ グループには、次のアソシエーションがあります。

グループ AAA サーバ アソシエーション。

サーバ グループに送信元インターフェイスのアソシエーションがある場合は、そのアソシエーションを使用できます。ただし、ネットワーク インターフェイスに他のアソシエーションがある場合、それらのアソシエーションはすべてクリアされます。

その他のアソシエーションはすべてクリアされます。

getTACACSStateOfNetworkElements

ネットワーク要素のリストに含まれている TACACS+ サービスの状態(イネーブルまたはディセーブル)を戻します。ネットワーク要素のインスタンス名 ID リストを指定すると、ブール値のリストを戻します。

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

neInstanceNameIdCol コレクションにヌルの要素が含まれている場合、またはこのコレクションが空であるか InstanceNameId タイプではない場合。

渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:TACACS+ 状態が必要な 1 つまたは複数のネットワーク要素の InstanceNameId

戻り値

戻されたリストには、ブール インスタンスが含まれます。

ブール値 TRUE は、特定のネットワーク要素で TACACS+ がイネーブルであることを表します。

ブール値 FALSE は、特定のネットワーク要素で TACACS+ がディセーブルであることを表します。

modifyAaaGlobalSetting

ネットワーク要素内で 1 つまたは複数の既存の AAA グローバル設定を変更します。AAA グローバル設定には、次のものがあります。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

1. ASCII、MSCHAP、または MSCHAPv2 の認証をイネーブルもしくはディセーブルにします。

2. コンソールで AAA 認証失敗メッセージ表示を設定します。

3. リモート ユーザ認証のデフォルト ユーザ ロールをイネーブルまたはディセーブルにします。

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

neInstanceNameId がヌル、またはタイプ InstanceNameId ではない場合。

setting がヌルの場合。

特定のネットワーク要素で AAA がディセーブルの場合。

パラメータ

opContext:動作コンテキスト。

neInstanceNameId:AAA グローバル設定が必要なネットワーク要素の InstanceNameId。

setting:既存オブジェクトと置き換える、変更した AaaGlobalSetting オブジェクト。

戻り値

void

modifyAaaServerGroups

ネットワーク要素内で 1 つまたは複数の既存の AAA サーバ グループを変更します。

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

aaaServerCol がヌルの場合。

aaaServerCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定の AAA サーバが TACACS+ サーバであり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

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

AAA サーバが無効の場合。

例:

サーバ ホスト名および IP アドレスが更新されている。

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

特定の AAA サーバがデバイスでグローバルに存在しない場合。

*

サーバ グループに関連付けられているグループ AAA サーバ(プライベート サーバ以外)がグローバルに設定されていない場合。

パラメータ

opContext:動作コンテキスト

aaaServerGrpCol:既存オブジェクトと置き換える、変更した AaaServerGroup オブジェクトのリスト。

戻り値

void

modifyAccountingRules

ネットワーク要素内で 1 つまたは複数の既存アカウンティング ルールを変更します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

acRuleCol がヌルの場合。

acRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

特定のルールにメソッドがない場合。

デバイスで Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

ネットワーク要素で Cisco NX-OS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 10 より多い場合。

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

アカウンティング ルールが無効の場合。

例:

ルール名が更新されている。

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

アカウンティング ルールがデバイスに存在しない場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

acRuleCol:既存オブジェクトと置き換える、変更した AccountingRule オブジェクトのリスト。

戻り値

void

modifyAuthenticationRules

ネットワーク要素内で 1 つまたは複数の既存の認証ルールを変更します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

atRuleCol がヌルの場合。

atRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

特定のルールにメソッドがない場合。

デバイスで Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

ネットワーク要素で Cisco NX-OS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 10 より多い場合。

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

認証ルールが無効の場合。

例:

ルール名が更新されている。

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

特定の認証ルールがデバイスに存在しない場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

atRuleCol:既存オブジェクトと置き換える、変更した AuthenticationRule オブジェクトのリスト。

戻り値

void

modifyAuthorizationRules

ネットワーク要素内で 1 つまたは複数の既存の認可ルールを変更します。

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

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のネットワーク要素で Cisco NX-OS が動作している場合。

arRuleCol がヌルの場合。

arRuleCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

特定のルールにメソッドがない場合。

デバイスで Cisco IOS が動作していて、特定のルールのいずれかに関連付けられているメソッドが 4 つより多い場合。

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

認可ルールが無効の場合。

例:

ルール名が更新されている。

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

認可ルールがデバイスに存在しない場合。

メソッドでサーバ グループを使用する場合、これらのサーバ グループ参照は使用可能である必要があります。また、そのサーバ グループがデータベースに存在する必要があります。

パラメータ

opContext:動作コンテキスト

arRuleCol:既存オブジェクトと置き換える、変更した AuthorizationRule オブジェクトのリスト。

戻り値

void

modifyGlobalAaaServerSetting

ネットワーク要素に含まれる 1 つまたは複数の既存のグローバル AAA サーバ設定を変更します。

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

neInstanceNameId がヌル、またはタイプ InstanceNameId ではない場合。

setting がヌルの場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のサーバ タイプが TACACS+ であり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:グローバル AAA サーバ設定が必要なネットワーク要素の InstanceNameId

setting:既存オブジェクトと置き換える、変更した GlobalAaaServerSetting オブジェクト。

type:サーバ(RADIUS/TACACS)ServerType のタイプ

戻り値

void

modifyGlobalAaaServers

ネットワーク要素に含まれる 1 つまたは複数の既存のグローバル AAA サーバを変更します。

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

aaaServerCol がヌルの場合。

aaaServerCol に 1 つまたは複数のヌル要素が含まれているか、またはコレクションが空の場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定の AAA サーバが TACACS+ サーバであり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

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

AAA サーバが無効の場合。

例:

サーバ ホスト名および IP アドレスが更新されている。

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

特定の AAA サーバがデバイスでグローバルに存在しない場合。

パラメータ

opContext:動作コンテキスト

aaaServerCol:既存オブジェクトと置き換える、変更した GlobalAaaServer オブジェクトのリスト。

戻り値

void

unbindNetworkInterfaceFromAaaServerGroups

特定の AAA サーバ グループから、送信元インターフェイスのアソシエーションをクリアします。この API に渡された AAA サーバ グループに送信元インターフェイス アソシエーションがある場合、それらのアソシエーションは削除されます。インターフェイス アソシエーションがない場合、この API はこれらのサーバ グループを単に無視します。

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

aaaServerGroupInstanceNameIdColis がヌルの場合。

aaaServerGroupInstanceNameIdCol のコレクションにヌルの要素が含まれている、コレクションが空、またはコレクションがタイプ AaaServerGroup InstanceNameId ではない場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

特定のサーバ タイプが TACACS+ であり、Cisco NX-OS が動作している特定のネットワーク要素で TACACS+ がディセーブルの場合。

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

特定の aaaServerGrpInstanceNameIdCol のオブジェクトがデバイスに存在しない場合。

パラメータ

opContext:動作コンテキスト

aaaServerGroupInstanceNameIdCol:送信元インターフェイスを削除する必要がある AaaServerGroup の InstanceNameId のリスト

戻り値

void

unbindNetworkInterfaceFromGlobalRadiusServerSettings

特定のネットワーク要素の RADIUS サーバのグローバル設定から、送信元インターフェイス アソシエーションをクリアします。設定にインターフェイス アソシエーションがない場合、この API はそのネットワーク要素を単に無視します。

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

neInstanceNameId がヌルの場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

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

特定の neInstanceNameId のオブジェクトがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素の InstanceNameId。

戻り値

void

unbindNetworkInterfaceFromGlobalTACACSServerSettings

特定のネットワーク要素の TACACS サーバのグローバル設定から、送信元インターフェイス アソシエーションをクリアします。設定にインターフェイス アソシエーションがない場合、この API はそのネットワーク要素を単に無視します。

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

neInstanceNameId がヌルの場合。

Cisco IOS が動作している特定のネットワーク要素で AAA がディセーブルの場合。

Cisco NX-OS が動作している特定のネットワーク要素で TACACS がディセーブルの場合。

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

特定の neInstanceNameId のオブジェクトがデータベースに存在しない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:ネットワーク要素の InstanceNameId。

戻り値

void