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

目次

NacLpIpApp サービス

NacLpIpApp サービスについて

addExceptionListHostsToIdentityProfile

bindAccessListToIdentityPolicies

bindEapOverUdpValidationToNetworkInterfaces

bindIdentityPolicyToExceptionListHosts

bindIdentityPolicyToExceptionListHostsByName

bindIpAdmissionControlRulesToNetworkInterfaces

clearIpAdmissionControlRuleFromInterfaces

createIdentityPoliciesInNetworkElement

createIdentityProfile

createIpAdmissionControlRulesInNetworkElement

deleteAllAdmissionControlRulesInNetworkElement

deleteAllIdentityPoliciesInNetworkElement

deleteIdentityPolicies

deleteIdentityProfileFromNetworkElement

deleteIpAdmissionControlRules

disableClientlessAuthenticationInNetworkElements

disableIpDeviceTrackingInNetworkElements

disableNacService

enableClientlessAuthenticationInNetworkElements

enableIpDeviceTrackingInNetworkElements

enableNacService

getAdmissionControlRulesInNetworkElement

getAllNacHostSessionInNetworkElement

getClientlessAuthenticationInNetworkElements

getEapOudpValidationSettingInInterfaces

getExceptionListHostsInIdentityProfile

getIdentityPoliciesInNetworkElement

getIdentityPolicyForExceptionListHost

getIdentityProfilesInNetworkElement

getInterfacesUsingIpAdmissionControlRule

getIpAdmissionControlRuleAppliedOnInterfaces

getIpDeviceTrackingInNetworkElements

getLpIpGlobalSettingsInNetworkElements

getLpIpTrackedDevicesInNetworkElement

getLpIpTrackedDevicesInSwitchedNetworkInterface

getNacHostSessionInSwitchedNetworkInterface

modifyClientlessAuthentication

modifyExceptionListHostsInIdentityProfile

modifyIdentityPolicies

modifyIdentityProfiles

modifyIpAdmissionControlRules

modifyIpDeviceTracking

modifyLpIpGlobalSettingsInNetworkElements

removeExceptionListHostsFromIdentityProfile

unbindIdentityPolicyFromExceptionListHosts

NacLpIpApp サービス

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

NacLpIpApp サービスについて

NacLpIpApp を使用すると、ネットワークにアクセスしようとしているホストに最新のウイルス署名セットやオペレーティング システムの最新パッチを保持させ、感染を防ぐことができます。この機能はポスチャ検証と呼ばれ、ウイルス、ワーム、およびスパイウェアによるネットワークへの損害を抑制します。

ポスチャ検証に合格したホストは、ネットワークへのアクセスが許可されます。ポスチャ検証に合格しなかったホストは、アクセスを拒否されるか、修復を行うために必要な制限されたアクセスが許可されます。修復サーバには、アンチウイルス ソフトウェアおよびセキュリティ パッチの更新のリポジトリが保持されます。ポスチャ検証に合格しなかったホストはこの修復サーバに転送され、アンチウイルス ソフトウェアおよびオペレーティング システムのセキュリティ パッチをダウンロードまたはアップグレードできます。

NAC API は次のカテゴリで定義されます。

1. Query および Get API:永続的なデータベースからデータを照会します。

2. Create API:新しいポリシー、プロファイル、または ExemptedHost を作成します。

3. Modify API:ポリシー、プロファイル、または ExemptedHost を変更します。

4. Delete API:ポリシーまたはプロファイルを削除します。

5. Bind および Unbind API:2 つの機能間の関連付けをバインドまたはアンバインドします。

6. Add および Remove API:2 つの機能間の関連付けを追加または削除します。

addExceptionListHostsToIdentityProfile

例外リスト ホストを ID ポリシーに追加します。

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

exceptionListHostCol コレクションがヌル、または空の場合。

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

identityProfileId がヌル、または空の場合。

identityProfileId にタイプ IdentityProfile InstanceNameId ではない要素が含まれている場合。

identityProfileId に、データベースに存在しない IdentityProfile が含まれている場合。

パラメータ

opContext:動作コンテキスト

identityProfileId:IdentityProfile オブジェクトの InstanceNameId

exceptionListHostCol:ExceptionListHost オブジェクトのコレクション

戻り値

void

bindAccessListToIdentityPolicies

アクセス リストを ID ポリシーのコレクションに割り当てます。ID ポリシーにバインドするアクセス リストには、リストの名前のみが必要です。アクセス リストはデバイスで設定されている必要はありません。この API は、この事前プロビジョニング設定を指定します。ネットワーク要素の InstanceNameId は identityPolicyIds から取得できます。

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

identityPolicyIdCol コレクションがヌル、または空の場合。

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

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

aclName がヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

aclName:IP アクセス リスト名

identityPolicyIdCol:ID ポリシーの InstanceNameId のコレクション

戻り値

void

bindEapOverUdpValidationToNetworkInterfaces

特定の EapOUdpValidation オブジェクトを特定のインターフェイス セットに適用します。*

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

interfaceNameIdCol コレクションがヌル、または空の場合。

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

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

eapOudpValidation がヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

eapOudpValidation:インターフェイスのコレクションに適用される EapOudpValidation オブジェクト。

interfaceNameIdCol:EapOudpValidation が適用されるインターフェイスの InstanceNameId。

戻り値

void

bindIdentityPolicyToExceptionListHosts

特定の ID ポリシーを、スタティックに設定された例外リスト ホストの特定のコレクションに割り当てます。

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

exceptionLishHostIdCol コレクションがヌル、または空の場合。

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

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

identityPolicyId がヌル、または空の場合。

identityPolicyId にタイプ IdentityPolicy InstanceNameId ではない要素が含まれている場合。

identityPolicyId に、データベースに存在しない IdentityPolicy が含まれている場合。

パラメータ

opContext:動作コンテキスト

identityPolicyId:IdentityPolicy の InstanceNameId

exceptionLishHostIdCol:ExceptionListHost の InstanceNameId のコレクション

戻り値

void

bindIdentityPolicyToExceptionListHostsByName

事前にプロビジョニングされた ID ポリシーを例外リスト ホストのコレクションに割り当てます。例外リスト ホストのコレクションにバインドする ID ポリシーについては、デバイスで ID ポリシーを設定している必要はありません。この API は、この事前プロビジョニング設定を指定します。

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

exceptionListHostIdCol コレクションがヌル、または空の場合。

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

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

policyName がヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

policyName:IdentityPolicy の名前。このポリシーは、デバイスで設定している必要はありません。

exceptionListHostIdCol:ExceptionListHost の InstanceNameId のコレクション

戻り値

void

bindIpAdmissionControlRulesToNetworkInterfaces

IP アドミッション制御ルールをスイッチド ネットワーク インターフェイスのコレクションに割り当てます。

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

interfaceNameIdCol コレクションがヌル、または空の場合。

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

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

ipAdmissionControlRuleId がヌル、または空の場合。

ipAdmissionControlRuleId にタイプ IpAdmissionControlRule InstanceNameId ではない要素が含まれている場合。

ipAdmissionControlRuleId に、データベースに存在しない IpAdmissionControlRule が含まれている場合。

パラメータ

opContext:動作コンテキスト

ipAdmissionControlRuleId:インターフェイス セットに適用される IpAdmissionControlRule の InstanceNameId

interfaceNameIdCol:特定の IP アドミッション制御ルールが適用されるインターフェイスの InstanceNameId のコレクション。

戻り値

void

clearIpAdmissionControlRuleFromInterfaces

インターフェイスのコレクションに割り当てられた特定の IP アドミッション制御ルールを消去します。

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

interfaceNameIdCol がヌル、または空の場合。

interfaceNameIdCol に無効なスイッチド ネットワーク インターフェイスの InstanceNameId またはヌル値が含まれている場合。

interfaceNameIdCol の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIdCol:特定の IP アドミッション制御ルールを消去するインターフェイスの InstanceNameIds のコレクション

戻り値

void

createIdentityPoliciesInNetworkElement

ネットワーク要素内に ID ポリシーのコレクションを作成します。

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

networkElementId がヌルであるか、または引数が有効なネットワーク要素の InstanceNameId ではない場合。

identityPoliciyCol コレクションがヌル、または空の場合。

identityPoliciyCol コレクションに既存の ID ポリシー名が含まれる場合。

パラメータ

opContext:動作コンテキスト

networkElementId:ID ポリシーを作成するネットワーク要素の InstanceNameId。

identityPoliciyCol:作成する IdentityPolicy のコレクション。

戻り値

void

createIdentityProfile

ネットワーク要素内に ID プロファイルを作成します。

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

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

identityProfile がヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素の InstanceNameId

identityProfile:IdentityProfile オブジェクト

戻り値

作成された ID プロファイルの InstanceNameId

createIpAdmissionControlRulesInNetworkElement

ネットワーク要素内に特定の IP アドミッション制御ルールを作成します。

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

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

ipAdmissionControlRules コレクションがヌル、または空の場合。

ipAdmissionControlRules コレクションに既存の IP アドミッション制御名が含まれる場合。

IP アドミッション制御名の長さが 128 文字を超えている場合。

パラメータ

opContext:動作コンテキスト

networkElementId:ルールを作成するネットワーク要素の InstanceNameId。

ipAdmissionControlRules:IP アドミッション制御ルールのコレクション

戻り値

作成されたルールの InstanceNameIds のコレクション。

deleteAllAdmissionControlRulesInNetworkElement

特定のネットワーク要素で設定されたすべての IP アドミッション制御ルールを削除します。

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

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素の InstanceNameId

戻り値

void

deleteAllIdentityPoliciesInNetworkElement

特定のネットワーク要素のすべての ID ポリシーを削除します。

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

パラメータ

opContext:動作コンテキスト

networkElementId:ID ポリシーを削除するネットワーク要素の InstanceNameId。

戻り値

void

deleteIdentityPolicies

ID ポリシーの特定のコレクションを削除します。

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

identityPolicyIdCol コレクションがヌル、または空の場合。

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

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

パラメータ

opContext:動作コンテキスト

identityPolicyIdCol:削除する ID ポリシーの InstanceNameId。

戻り値

void

deleteIdentityProfileFromNetworkElement

特定のネットワーク要素で設定された ID プロファイルを削除します。

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

identityProfileId がヌル、または空の場合。

identityProfileId にタイプ IpAdmissionControlRule InstanceNameId ではない要素が含まれている場合。

identityProfileId に、データベースに存在しない IpAdmissionControlRule が含まれている場合。

パラメータ

opContext:動作コンテキスト

identityProfileId:削除する ID プロファイルの InstanceNameId

戻り値

void

deleteIpAdmissionControlRules

IP アドミッション制御ルールの特定のコレクションを削除します。

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

ipAdmissionControlRuleIdCol コレクションがヌル、または空の場合。

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

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

パラメータ

opContext:動作コンテキスト

ipAdmissionControlRuleIdCol:削除する IpAdmissionControlRule の InstanceNameId のコレクション。

戻り値

void

disableClientlessAuthenticationInNetworkElements

ネットワーク要素のコレクションで、Clientless 認証機能をディセーブルにします。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIds:ClientlessAuthentication をディセーブルにするネットワーク要素の InstanceNameId のコレクション。

戻り値

void

disableIpDeviceTrackingInNetworkElements

ネットワーク要素のコレクションで、IP デバイス トラッキング機能をディセーブルにします。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:デバイス トラッキング機能をディセーブルにするネットワーク要素の InstanceNameIds のコレクション。

戻り値

void

disableNacService

InstanceNameId ネットワーク要素で Nac サービスをディセーブルにします。サービスのイネーブル化とディセーブル化は、NX-OS プラットフォームでサポートされています。この API が Cat6k プラットフォームのネットワーク要素を使用してコールされた場合、FeatureException がスローされます。

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

1. neInstanceNameIdCol がヌルの場合。

2. neInstanceNameIdCol に有効なネットワーク要素 InstanceNameId が含まれていない場合。

3. ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:TODO

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

void

enableClientlessAuthenticationInNetworkElements

ネットワーク要素のコレクションで、Clientless 認証機能をイネーブルにします。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:ClientlessAuthentication をイネーブルにするネットワーク要素の InstanceNameId のコレクション。

戻り値

void

enableIpDeviceTrackingInNetworkElements

ネットワーク要素のコレクションで、IP デバイス トラッキング機能をイネーブルディセーブルにします。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:デバイス トラッキング機能をイネーブルにするネットワーク要素の InstanceNameId のコレクション。

戻り値

void

enableNacService

InstanceNameId ネットワーク要素で Nac サービスをイネーブルにします。サービスのイネーブル化とディセーブル化は、NX-OS プラットフォームでサポートされています。この API が Cat6k プラットフォームのネットワーク要素を使用してコールされた場合、FeatureException がスローされます。

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

1. neInstanceNameIdCol がヌルの場合。

2. neInstanceNameIdCol に有効なネットワーク要素 InstanceNameId が含まれていない場合。

3. ネットワーク要素がデータベースに存在しない場合。

パラメータ

opContext:TODO

neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

void

getAdmissionControlRulesInNetworkElement

特定のネットワーク要素で設定されたすべての IP アドミッション制御ルールを戻します。

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

パラメータ

opContext:動作コンテキスト

networkElementId:特定のネットワーク要素のインスタンス ID。

戻り値

IP アドミッション制御ルールのコレクション。このコレクションは、タイプ IpAdmissionControlRule のオブジェクトが保持されます。

getAllNacHostSessionInNetworkElement

ネットワーク要素の NAC ホスト セッションのリストを戻します。

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素。

戻り値

void

getClientlessAuthenticationInNetworkElements

ネットワーク要素のコレクションで行われた Clientless 認証の設定を戻します。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等のネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:ネットワーク要素の InstanceNameId のコレクション。

戻り値

ネットワーク要素で設定された Clientless 認証機能を表す ClientlessAuthentication オブジェクトのコレクション。

getEapOudpValidationSettingInInterfaces

特定のインターフェイスのコレクションで設定された EAPoUDP プロトコル パラメータを戻します。

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

interfaceNameIds がヌル、または空の場合。

interfaceNameIds に無効なスイッチド ネットワーク インターフェイス InstanceNameId またはヌル値が含まれている場合。

interfaceNameIds の特定の InstanceNameId を持つ同等のスイッチド ネットワーク インターフェイス オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

interfaceNameIds:戻される EAPoUDP パラメータを持つスイッチド ネットワーク インターフェイスの InstanceNameIds のコレクション。

戻り値

設定された EAPoUDP パラメータを表す EapOUdpValidation オブジェクトのコレクション。

getExceptionListHostsInIdentityProfile

特定の ID プロファイルに関連付けられた除外ホストのコレクションを取得します。

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

identityProfileId がヌル、または空の場合。

identityProfileId に無効な ID プロファイルの InstanceNameId またはヌル値が含まれている場合。

identityProfileId の特定の InstanceNameId を持つ同等の ID プロファイル オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

identityProfile:ID プロファイルの InstanceNameId

戻り値

ID プロファイルに関連付けられた除外ホストのコレクション。戻されたコレクションには、タイプ com.cisco.dcbu.dcm.model.nac.ExemptedHost のオブジェクトが保持されます。

getIdentityPoliciesInNetworkElement

特定のネットワーク要素で設定された ID ポリシーのコレクションを戻します。

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

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素のインスタンス ID

戻り値

ネットワーク要素で設定された ID ポリシーのコレクション。戻されたコレクションには、タイプ IdentityPolicy のオブジェクトが保持されます。

getIdentityPolicyForExceptionListHost

除外リスト ホストに割り当てられた ID ポリシーを戻します。

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

exemptHostInstanceNameIdCol がヌル、または空の場合。

exemptHostInstanceNameIdCol に無効な除外リスト ホストの InstanceNameId またはヌル値が含まれている場合。

exemptHostInstanceNameIdCol の特定の InstanceNameId を持つ同等の除外リスト ホスト オブジェクトが存在しない場合。

パラメータ

opContext:ExemptedHost の * @param exemptHostInstanceNameIdCol インスタンス ID。

戻り値

特定の例外ホスト IdentityPolicy に対して設定された ID ポリシー

getIdentityProfilesInNetworkElement

ネットワーク要素で設定されたすべての ID プロファイルを戻します。NX-OS では EapoUdp のみをサポートするため、戻されたリストのサイズはデータ センターに対するサイズになります。

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

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素の InstanceNameId

戻り値

特定のネットワーク要素で設定された ID プロファイルのコレクション。戻されたコレクションには、タイプ IdentityProfile のオブジェクトが保持されます。

getInterfacesUsingIpAdmissionControlRule

特定の IP アドミッション制御ルールを適用するインターフェイスのコレクションを戻します。

渡された引数がヌルであるか、または引数が有効な IP アドミッション制御ルールの InstanceNameId ではない場合に、ValidationException がスローされます。

パラメータ

opContext:動作コンテキスト

ipAdmissionControlRule:IP アドミッション制御ルールの InstanceNameId

戻り値

特定の IP アドミッション制御を適用するインターフェイスのコレクション。このコレクションは、タイプ SwitchedNetworkInterface のオブジェクトが保持されます。

getIpAdmissionControlRuleAppliedOnInterfaces

インターフェイスに適用された IP アドミッション制御ルールのコレクションを戻します。この API は、Catalyst 6500 スイッチに適用可能です。DC3 には適用できません。DC3 では、この API は検証例外をスローします。特定のインターフェイスに IP アドミッション制御ルールがない場合、インターフェイスに対して戻されるコレクションに API によりヌル値が読み込まれます。

ValidationException は、渡された引数がヌルの場合、または有効なスイッチド ネットワーク インターフェイス InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト

interfaceInstanceIds:インターフェイスの InstanceNameId のコレクション

戻り値

この API への引数として指定されたコレクションと一対一で対応する IpAdmissionControlRule のコレクション。

getIpDeviceTrackingInNetworkElements

ネットワーク要素のコレクションで行われた IP デバイス トラッキングの設定を戻します。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:ネットワーク要素の InstanceNameId のコレクション

戻り値

ネットワーク要素の IpDeviceTracking オブジェクトのコレクション。

getLpIpGlobalSettingsInNetworkElements

ネットワーク要素のコレクションで設定された LPIP グローバル設定を戻します。

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

networkElementIdCol がヌル、または空の場合。

networkElementIdCol に無効なネットワーク要素の InstanceNameId またはヌル値が含まれている場合。

networkElementIdCol の特定の InstanceNameId を持つ同等の理論ネットワーク要素オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

networkElementIdCol:ネットワーク要素の InstanceNameId のコレクション

戻り値

ネットワーク要素で設定されたグローバル LPIP 設定を表す LpIpGlobalSetting オブジェクトのコレクション。

getLpIpTrackedDevicesInNetworkElement

LPIP トラック対象デバイスのリストを戻します。

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素 ID

戻り値

LpIpTrackedDeviceStatus のリスト。

getLpIpTrackedDevicesInSwitchedNetworkInterface

スイッチド ネットワーク インターフェイスの LPIP トラック対象デバイスのリストを戻します。

パラメータ

opContext:動作コンテキスト

networkElementId:スイッチド ネットワーク インターフェイスのネットワーク要素 ID

戻り値

LpIpTrackedDeviceStatus のリスト。

getNacHostSessionInSwitchedNetworkInterface

LPIP トラック対象デバイスのリストを戻します。

パラメータ

opContext:動作コンテキスト

networkElementId:スイッチド ネットワーク インターフェイスのネットワーク要素 ID。

戻り値

スイッチド ネットワーク インターフェイスの NacHostSession のリスト。

modifyClientlessAuthentication

変更された Clientless 認証の設定でサーバを更新します。

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

networkElementId がヌルであるか、または引数が有効なネットワーク要素の InstanceNameId ではない場合。

clientlessAuthentication オブジェクトがヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

networkElementId:ネットワーク要素の InstanceNameId

ClientlessAuthentication:変更された ClientlessAuthentication オブジェクト ClientlessAuthentication

戻り値

void

modifyExceptionListHostsInIdentityProfile

ID プロファイルで設定された特定の ExceptionListHosts のコレクションを変更します。

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

identityProfileId がヌル、または空の場合。

identityProfileId にタイプ IdentityProfile InstanceNameId ではない要素が含まれている場合。

identityProfileId に、データベースに存在しない IdentityProfile が含まれている場合。

exceptionListHostCol が

ヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

identityProfileId:ID プロファイルの InstanceNameId。

exceptionListHostCol:変更された ExceptionListHost オブジェクトのコレクション

戻り値

void

modifyIdentityPolicies

ID ポリシーの特定のコレクションを変更します。

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

identityPolicyCol コレクションがヌル、または空の場合。

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

パラメータ

opContext:動作コンテキスト

identityPolicyCol:クライアントによって変更された IdentityPolicy のコレクション。

戻り値

void

modifyIdentityProfiles

ID プロファイルのコレクションを変更します。この変更では、ID プロファイルにバインドされた ExceptionListHosts の追加、削除、および変更を行います。また、この変更ではそれぞれの ExceptionListHost への ID ポリシーの関連付けも行います。ネットワーク要素には、タイプ EAPoUDP の IdentityProfile が 1 つのみ含まれます。引数のそれぞれの ID プロファイルは、異なるネットワーク要素に対応します。

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

identityProfileCol コレクションがヌル、または空の場合。

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

パラメータ

opContext:動作コンテキスト

identityProfileCol:ネットワーク要素の IdentityProfile のコレクション。それぞれの ID プロファイルは、異なるネットワーク要素に対応します。

戻り値

void

modifyIpAdmissionControlRules

IP アドミッション制御ルールの特定のコレクションを変更します。

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

ipAdmissionControlRules コレクションがヌル、または空の場合。

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

パラメータ

opContext:動作コンテキスト

ipAdmissionControlRuleCol:変更する IpAdmissionControlRule のコレクション。

戻り値

void

modifyIpDeviceTracking

変更されたデバイス トラッキングの設定でサーバを更新します。

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

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

ipDeviceTracking オブジェクトがヌル、または空の場合。

パラメータ

opContext:動作コンテキスト

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

ipDeviceTracking:変更された IpDeviceTracking オブジェクト IpDeviceTracking

戻り値

void

modifyLpIpGlobalSettingsInNetworkElements

LPIP グローバル設定の特定のコレクションを変更します。

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

lpIpGlobalSettingCol コレクションがヌル、または空の場合。

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

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

lpIpGlobalSettingCol コレクションで、LpIpGlobalSetting のいずれかのアトリビュートが有効ではない場合。

パラメータ

opContext:動作コンテキスト

lpIpGlobalSettingCol:変更された LpIpGlobalSetting オブジェクトのコレクション

戻り値

void

removeExceptionListHostsFromIdentityProfile

ID プロファイルから例外リスト ホストを削除します。

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

exemptListHostIdCol コレクションがヌル、または空の場合。

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

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

identityProfileId がヌル、または空の場合。

identityProfileId にタイプ IdentityProfile InstanceNameId ではない要素が含まれている場合。

identityProfileId に、データベースに存在しない IdentityProfile が含まれている場合。

パラメータ

opContext:動作コンテキスト

identityProfileId:IdentityProfile オブジェクトの InstanceNameId

exceptionListHosts:ExceptionListHost オブジェクトの InstanceNameId のコレクション

戻り値

void

unbindIdentityPolicyFromExceptionListHosts

例外リスト ホストに割り当てられた ID ポリシーを消去します。

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

exceptionLishHostIdCol コレクションがヌル、または空の場合。

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

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

パラメータ

opContext:動作コンテキスト

exceptionListHostIdCol:ExceptionListHost オブジェクトの InstanceNameId

戻り値

void