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

目次

Dot1xApp サービス

Dot1xApp サービスについて

disableDot1x

disableDot1xInInterfaces

disableDot1xService

enableDot1x

enableDot1xInInterfaces

enableDot1xService

getDot1xConflictingPorts

getDot1xGlobalSetting

getDot1xInterfacesSetting

getDot1xNetworkInterfacesInNetworkElement

modifyDot1xGlobalSetting

modifyDot1xNetworkInterfacesSetting

Dot1xApp サービス

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

Dot1xApp サービスについて

IEEE 802.1X は、ポートベースのネットワーク アクセス コントロールのためのフレームワークを定義します。802.1X はデバイスの物理的特性を使用して、スイッチ ポートに接続されたデバイスを認証して認可し、認証と認可が失敗した場合にそのポートへのアクセスを阻止します。API カテゴリは次のとおりです。

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

Modify API:既存の Dot1x インターフェイスとグローバル設定を変更します。

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

disableDot1x

1 つまたは複数のネットワーク要素で dot1x 認証をディセーブルにします。この API は、デバイスで system-auth-control オプションをグローバルにディセーブルにします。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

dot1xNetworkInterfaceInstanceNameIdCol が AbstractNetworkElement オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:dot1x がイネーブルになっている 1 つまたは複数のネットワーク要素の InstanceNameId。

戻り値

void

disableDot1xInInterfaces

1 つまたは複数のインターフェイスの dot1x 設定をディセーブルにします。dot1x がイネーブルになっている 1 つまたは複数のインターフェイスの InstanceNameId を指定すると、対応するインターフェイスの dot1x がディセーブルになります。

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

dot1xNetworkInterfaceInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

dot1xNetworkInterfaceInstanceNameIdCol が Dot1xNetworkInterfaceSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

dot1xNetworkInterfaceInstanceNameIdCol:1 つまたは複数の NetworkInterface オブジェクトの InstanceNameId。

戻り値

void

disableDot1xService

1 つまたは複数のネットワーク要素で dot1x 認証をディセーブルにします。この API は、デバイスで dot1x サービスをグローバルにディセーブルにします。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:dot1x がイネーブルになっている 1 つまたは複数のネットワーク要素の InstanceNameId。

戻り値

void

enableDot1x

1 つまたは複数のネットワーク要素で dot1x 認証をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で dot1x がイネーブルになります。この API は、デバイスで system-auth-control オプションをグローバルにイネーブルにします。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

dot1xNetworkInterfaceInstanceNameIdCol が AbstractNetworkElement の有効な InstanceNameId ではない場合。

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

いずれかの NetworkInterface で dot1x が設定されていて、次のいずれかの機能がイネーブルの場合。

NetworkInterface が SPAN 宛先のインターフェイス。

NetworkInterface がポート セキュリティ イネーブルのインターフェイス。

NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:dot1x がディセーブルになっているネットワーク要素インスタンス名 ID のリスト。

戻り値

void

enableDot1xInInterfaces

1 つまたは複数のインターフェイスの dot1x 設定をイネーブルにします。dot1x がイネーブルになっている 1 つまたは複数のインターフェイスの InstanceNameId を指定すると、対応する dot1x インターフェイス設定オブジェクトを戻します。

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

dot1xNetworkInterfaceInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

dot1xNetworkInterfaceInstanceNameIdCol が Dot1xNetworkInterfaceSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

dot1xNetworkInterfaceInstanceNameIdCol:1 つまたは複数の NetworkInterface オブジェクトの InstanceNameId。

戻り値

ポート コントロールが force-authorized として設定されている Dot1xNetworkInterfaceSetting オブジェクトのコレクション。戻されたオブジェクトには、対応する NetworkInterface 参照が含まれます。ただし、その NetworkInterface に他のアソシエーションがある場合、それらはクリアされます。

enableDot1xService

1 つまたは複数のネットワーク要素で dot1x 認証をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で dot1x がイネーブルになります。この API は、デバイスで dot1x サービス オプションをグローバルにイネーブルにします。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:dot1x がディセーブルになっているデバイスの InstanceNameId のリスト。

戻り値

void

getDot1xConflictingPorts

プラットフォーム タイプが Catalyst 6500 シリーズ スイッチの場合、ポート コントロールが Force_Authorized ではない dot1x および次のいずれかで設定されているネットワーク インターフェイス オブジェクトのリストを戻します。

NetworkInterface が SPAN 宛先のインターフェイス。

NetworkInterface がポート セキュリティ イネーブルのインターフェイス。

NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。

NetworkInterface がタイプ TRUNK

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

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

プラットフォーム タイプが Nexus 7000 シリーズ スイッチの場合、空のコレクションを戻します。

パラメータ

opContext:動作コンテキスト

neInstanceNameId:AbstractNetworkElement オブジェクトの InstanceNameId。

戻り値

NetworkInterface オブジェクトのコレクション。

getDot1xGlobalSetting

1 つまたは複数のネットワーク要素のデバイス レベルの dot1x 設定を戻します。1 つまたは複数のネットワーク要素の InstanceNameId を指定すると、これらのネットワーク要素の対応する Dot1xGlobalSetting オブジェクトを戻します。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が AbstractNetworkElement オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:1 つまたは複数の AbstractNetworkElement オブジェクトの InstanceNameId。

戻り値

Dot1xGlobalSetting オブジェクトのコレクション。

getDot1xInterfacesSetting

1 つまたは複数のインターフェイスの dot1x 設定を戻します。dot1x がイネーブルになっている 1 つまたは複数のインターフェイスの InstanceNameId を指定すると、対応する dot1x インターフェイス設定オブジェクトを戻します。

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

dot1xNetworkInterfaceInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

dot1xNetworkInterfaceInstanceNameIdCol が Dot1xNetworkInterfaceSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

dot1xNetworkInterfaceInstanceNameIdCol:1 つまたは複数の NetworkInterface オブジェクトの InstanceNameId。

戻り値

ポート コントロールが force-authorized ではない Dot1xNetworkInterfaceSetting オブジェクトのコレクション。戻されたオブジェクトには、対応する NetworkInterface 参照が含まれます。ただし、その NetworkInterface に他のアソシエーションがある場合、それらはクリアされます。

getDot1xNetworkInterfacesInNetworkElement

指定されたポート コントロール状態を持つネットワーク要素の dot1x インターフェイス設定オブジェクトを戻します。

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

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

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

PortControl 状態のコレクションでは、ユーザは次の 1 つまたは複数の dot1x ポート コントロール状態を送信できます。

auto

Force_Authorized

Force_Unauthorized

Disabled

次に例を示します。

ユーザがポート コントロールを Auto および Force_Authorized として渡す場合、この API は、PortControl アトリビュート値が Auto または Force_Authorized であるすべての dot1x インターフェイス設定オブジェクトを戻します。

PortControl 状態のコレクションがヌルの場合、その PortControl 状態に関係なく、すべての dot1x インターフェイス設定オブジェクトを戻します。

注:ディセーブルとは、Dot1x をイネーブルにできないインターフェイスを意味します。次に、dot1x をイネーブルにできないインターフェイスを示します。

タイプ TRUNK のすべての物理インターフェイス

タイプ Private_VLAN のすべての物理インターフェイス

SPAN 宛先として設定されているすべての物理インターフェイス

すべての論理インターフェイス

パラメータ

opContext:動作コンテキスト

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

dot1xPortControlStateFilter:1 つまたは複数の Dot1xPortControl 状態の列挙。

戻り値

Dot1xNetworkInterfaceSetting オブジェクトのコレクション。戻されたオブジェクトには、対応する NetworkInterface 参照が含まれます。ただし、その NetworkInterface に他のアソシエーションがある場合、それらはクリアされます。

modifyDot1xGlobalSetting

デバイス レベルの dot1x 設定を変更するメソッドです。

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

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

Dot1xGlobalSetting がヌルであるか、またはオブジェクトがデータベースに存在しない場合。

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

いずれかの NetworkInterface で dot1x が設定されていて、次のいずれかの機能がイネーブルの場合。

NetworkInterface が SPAN 宛先のインターフェイス。

NetworkInterface がポート セキュリティ イネーブルのインターフェイス。

NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。

パラメータ

opContext:動作コンテキスト

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

dot1xGlbSetting:変更された(@link Dot1xGlobalSetting)オブジェクト。

戻り値

void

modifyDot1xNetworkInterfacesSetting

1 つまたは複数のインターフェイスの dot1x 設定を変更します。

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

dot1xNetworkInterfaceSettingCol がヌルか空であるか、またはタイプ Dot1xNetworkInterfaceSetting ではない場合。

既存の dot1x インターフェイス設定(データベースに存在)だけを変更できます。

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

dot1xNetworkInterfaceSettingCol コレクションに、有効な Dot1xNetworkInterfaceSetting アトリビュートがない場合。

例:

Dot1xNetworkInterfaceSetting の quietPeriod は範囲外です。

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

dot1xNetworkInterfaceSettingCol のコレクションに、次のいずれかを含む NetworkInterface に関連付けられた Dot1xNetworkInterfaceSetting オブジェクトが含まれる場合。

NetworkInterface が論理インターフェイス。

NetworkInterface が SPAN 宛先のインターフェイス。

NetworkInterface がポート セキュリティ イネーブルのインターフェイス。

NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。

パラメータ

opContext:動作コンテキスト

dot1xNetworkInterfaceSettingCol:変更された(@link Dot1xNetworkInterfaceSetting)オブジェクトのコレクション。

戻り値

void