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

目次

SpanApp サービス

SpanApp サービスについて

addDestinationPortsToSpanSession

addFilteredVlanRangeToSpanSession

addFilteredVlansToSpanSession

addPortsToSpanPermitList

addSourcesToSpanSession

addSourcesToSpanSessionByRange

createSpanSessions

createSpanSessionsInNetworkElement

deleteSpanSessions

disableInterfacesMonitor

enableInterfacesMonitor

getLocalSpanSessionsInNetwork

getSpanDestinationPorts

getSpanPermitListSettingsInNetwork

getSpanSessions

getSpanSessionsAssociatedToVlan

getSpanSessionsInNetwork

getSpanSources

modifyFilteredVlanRangeForSpanSession

modifyFilteredVlansByRangeForSpanSession

modifyFilteredVlansForSpanSession

modifySpanPermitListSettingsInNetworkElement

modifySpanSessions

modifySpanSourceTrafficDirection

modifySpanSources

removeDestinationPortsFromSpanSession

removeFilteredVlanRangeInSpanSession

removeFilteredVlansInSpanSession

removePortsFromSpanPermitList

removeSourcesFromSpanSession

removeSourcesInSpanSession

unbindDestinationPortsFromSpanSession

SpanApp サービス

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

SpanApp サービスについて

スイッチは、Switch Port Analyzer(SPAN; スイッチ ポート アナライザ)機能を使用して、スイッチの送信元ポートまたは VLAN から宛先ポートにトラフィックをコピーします。この機能によって、ネットワーク アナライザなどのモニタリング デバイスを使用して、宛先ポートでトラフィックを分析できます。API カテゴリは次のとおりです。

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

Modify API:SPAN セッションの設定またはグローバル設定を変更します。

Delete API:デバイスから SPAN セッションを削除します。

次のセッションは、Query API および Delete API でサポートされます。

ローカル SPAN

RSPAN 送信元

RSPAN 宛先

変更できるのはローカル SPAN セッションだけです。RSPAN 送信元または宛先セッションでは、例外がスローされます。

インターフェイスでは次のアソシエーションが使用可能です。

インターフェイス名

インターフェイス ステータス

VLAN では次のアソシエーションが使用可能です。

VLAN ステータス

addDestinationPortsToSpanSession

宛先ポートやイーサネット チャネルをローカル SPAN セッションに追加します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

すでに SPAN 送信元として使用されている NetworkInterface が宛先として使用される場合。

NetworkInterface が他の SPAN セッションの SPAN 宛先としてすでに設定されている場合。

SPAN 許可リストがイネーブルになっていて、NetworkInterface が許可リスト宛先ポートとして設定されていない場合。

Catalyst 6500 シリーズ スイッチで SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface が SPAN 宛先として使用される場合。

Etherchannel メンバー ポートが SPAN 宛先として設定されている場合。

NetworkInterface が SPAN 宛先対応ではない場合。

dstPortNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

dstPortNameIds:SPAN 宛先として追加するインターフェイスの InstanceNameId のリスト。

戻り値

void

addFilteredVlanRangeToSpanSession

フィルタリング済み VLAN をローカル SPAN セッションに追加します。リモート SPAN はサポートされません。デバイスに存在しない VLAN を追加できます(事前プロビジョニング)。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

フィルタリング済み VLAN をローカル SPAN に追加する場合、および特定のローカル SPAN セッションで送信元 VLAN が追加されている場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

filteredVlans:フィルタリング済み VLAN として設定する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

addFilteredVlansToSpanSession

フィルタリング済み VLAN をローカル SPAN セッションに追加します。リモート SPAN はサポートされません。同様にデバイスに存在しない VLAN を追加できます(事前プロビジョニング)。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

フィルタリング済み VLAN をローカル SPAN に追加する場合、および特定のローカル SPAN セッションで送信元 VLAN が追加されている場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanRange:フィルタリング済み VLAN として設定する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

addPortsToSpanPermitList

新規ポートを SPAN 宛先許可リストに追加します。

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

neNameId がヌルであるか、AbstractNetworkElement の InstanceNameId ではない場合。

指定された AbstractNetworkElement が存在しない場合。

interfaceNameIds 内の要素の InstanceNameId のタイプが RoutedEtherChannelNetworkInterface または SwitchedEtherChannelNetworkInterface である場合。

パラメータ

opContext:動作コンテキスト

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

interfaceNameIds:NetworkInterface の InstanceNameId のリスト。

戻り値

void

addSourcesToSpanSession

送信元ポートやイーサネット チャネルをローカル SPAN セッションに追加します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

すでに宛先として使用されている NetworkInterface が SPAN 送信元として使用される場合。

Catalyst 6500 シリーズ スイッチで SwitchedEtherChannelNetworkInterface または RoutedEtherChannelNetworkInterface が SPAN 送信元として使用される場合。

Etherchannel メンバー ポートが SPAN 送信元として設定されている場合。

NetworkInterface が SPAN 送信元として追加される場合、Catalyst 6500 シリーズ スイッチにおいてセッションでフィルタリング済み VLAN がすでに設定されている場合。

NetworkInterface が SPAN 送信元として追加される場合、Catalyst 6500 シリーズ スイッチにおいてセッションで VLAN がすでに SPAN 送信元として設定されている場合。

VLAN が SPAN 送信元として追加される場合、Catalyst 6500 シリーズ スイッチにおいてセッションでインターフェイスがすでに SPAN 送信元として設定されている場合。

srcNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

direction がヌルの場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

srcNameIds:特定の SPAN セッションの送信元として設定する NetworkInterface または VLAN の InstanceNameId のリスト。

direction:トラフィック方向の SpanSourceDirection。

戻り値

void

addSourcesToSpanSessionByRange

送信元 VLAN をローカル SPAN セッションに追加します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

VLAN が SPAN 送信元として追加される場合、Catalyst 6500 シリーズ スイッチにおいてセッションでフィルタリング済み VLAN がすでに設定されている場合。

VLAN が SPAN 送信元として追加される場合、Catalyst 6500 シリーズ スイッチにおいてセッションでインターフェイスがすでに SPAN 送信元として設定されている場合。

vlanRange の VLAN ID に対応するオブジェクトが存在しない場合。

direction がヌルの場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanRange:SPAN 送信元として設定する VLAN ID の範囲。例:「2,7-9」。

direction:トラフィック方向の SpanSourceDirection。

戻り値

void

createSpanSessions

ネットワーク要素で SPAN セッションを作成します。このメソッドは、すべてのタイプの SPAN セッションの作成に使用できます。

このメソッドの呼び出し中に、NetworkElement 参照を、対応するセッションを作成する必要があるセッションに設定する必要があります。

サーバでは、このメソッドによって、セッション ID と NetworkElement に基づいて SPAN セッションの新規 InstanceNameId が作成されます。

ユーザは、SPAN セッションを作成するために、このセッションへの送信元または宛先アソシエーションを少なくとも 1 つ設定する必要があります。

次のアソシエーションが更新されます。

SpanSource ローカル SPAN 送信元:送信元インターフェイスおよび VLAN

VLAN ローカル SPAN 送信元:フィルタリング済み VLAN

NetworkInterfaceLocal SPAN 宛先:宛先インターフェイス

SPAN ステータス

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

RSPAN 送信元または宛先セッションが作成される場合。

spanSessionList がヌルまたは空であるか、リストの要素のタイプが LocalSpanSession ではない場合。

spanSessionList 内の LocalSpanSession オブジェクトに有効なセッション ID がないか、ヌルの AbstractNetworkElement 参照である場合。

指定された AbstractNetworkElement での SPAN セッション数の制限を超えた場合。

作成する SPAN セッションに送信元または宛先アソシエーションがない場合。

Catalyst 6500 シリーズ スイッチでは、作成する SPAN セッションに SPAN 送信元として NetworkInterface および VLAN がある場合。

作成する SPAN セッションに、すでに他のセッションでの SPAN 宛先である SPAN 宛先インターフェイスとして NetworkInterface がある場合。

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

spanSessionList コレクションで、いずれかの SpanSession アトリビュートが無効である場合。

例:

SpanSession の sessionId が範囲外です。

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

spanSessionList コレクションで、いずれかの SpanSession オブジェクトが指定された AbstractNetworkElement にすでに存在する場合。

パラメータ

opContext:動作コンテキスト

spanSessionList:(@link SpanSession) オブジェクトのリスト。

戻り値

新たに作成された SPAN セッションの InstanceNameId のリスト。

createSpanSessionsInNetworkElement

ネットワーク要素で SPAN セッションのリストを作成します。このメソッドは、すべてのタイプの SPAN セッションの作成に使用できます。セッション ID および NetworkElement InstanceNameId に基づいて、サーバで InstanceNameId が作成されます。

次のアソシエーションが更新されます。

SpanSource ローカル SPAN 送信元:送信元インターフェイスおよび VLAN

VLAN ローカル SPAN 送信元:フィルタリング済み VLAN

NetworkInterfaceLocal SPAN 宛先:宛先インターフェイス

SPAN ステータス

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

sessionInstanceNameIds が、SpanSession オブジェクトの有効な InstanceNameId ではない場合。

neNameId がヌルであるか、AbstractNetworkElement の InstanceNameId ではない場合。

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

RSPAN 送信元または宛先セッションが作成される場合。

spanSessionList がヌルまたは空であるか、リストの要素のタイプが LocalSpanSession ではない場合。

指定された AbstractNetworkElement が存在しない場合。

spanSessionList 内の LocalSpanSession オブジェクトに有効なセッション ID がないか、ヌルの AbstractNetworkElement 参照である場合。

指定された AbstractNetworkElement での SPAN セッション数の制限を超えた場合。

作成する SPAN セッションに送信元または宛先アソシエーションがない場合。

Catalyst 6500 シリーズ スイッチでは、作成する SPAN セッションに SPAN 送信元として NetworkInterface および VLAN がある場合。

作成する SPAN セッションに、すでに他のセッションでの SPAN 宛先である SPAN 宛先インターフェイスとして NetworkInterface がある場合。

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

spanSessionList コレクションで、いずれかの SpanSession アトリビュートが無効である場合。

例:

SpanSession の sessionId が範囲外です。

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

spanSessionList コレクションで、いずれかの SpanSession オブジェクトが指定された AbstractNetworkElement にすでに存在する場合。

パラメータ

opContext:動作コンテキスト

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

spanSessionList:作成する必要がある SpanSession のリスト。

戻り値

新たに作成された SPAN セッション インスタンス名 ID の順序付きリスト

deleteSpanSessions

InstanceNameId の特定のリストに対応する SPAN セッションを削除します。対応する SpanSession およびアソシエーションが削除されます。

次のセッションは削除を許可されています。

ローカル SPAN

RSPAN 送信元

RSPAN 宛先

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

sessionNameIds がヌルまたは空であるか、リストの要素が SpanSession の InstanceNameId ではない場合。

sessionNameIds コレクションで、sessionNameIds 内の InstanceNameId に対応するいずれかの SpanSession オブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameIds:削除する必要がある SPAN セッション InstanceNameId のリスト。

戻り値

void

disableInterfacesMonitor

1 つまたは複数のインターフェイスについてインターフェイス モニタをディセーブルにします。インターフェイスのインスタンス名 ID を指定すると、これらの要素で InterfacesMonitor はディセーブルになります。この API は、Cisco NX-OS デバイスの「InterfacesMonitor」をディセーブルにするためのもので、他の Cisco IOS デバイスには適用できません。

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

interfaceInstanceNameId のタイプが NetworkInterface ヌルである場合。

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

特定のインターフェイスが他の Cisco IOS で実行されている場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameId:情報が必要な NetworkInterface の InstanceNameId のリスト

戻り値

void

enableInterfacesMonitor

特定のインターフェイスのインターフェイス モニタをイネーブルにします。1 つまたは複数のインターフェイスのインスタンス名 ID を指定すると、「InterfacesMonitor」がこれらの要素でイネーブルになります。この API は、Cisco NX-OS デバイスの InterfacesMonitor をイネーブルにするためのもので、他の Cisco IOS デバイスには適用できません。

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

interfaceInstanceNameId がヌルの場合。

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

特定のインターフェイスが他の Cisco IOS で実行されている場合。

パラメータ

opContext:動作コンテキスト

interfaceInstanceNameId:情報が必要な NetworkInterface の InstanceNameId のリスト

戻り値

void

getLocalSpanSessionsInNetwork

ネットワーク要素リストのセッション ID リストに対応するローカル SPAN セッションを戻します。

次のアソシエーションが使用可能です。

送信元インターフェイスおよび VLAN

フィルタリング済み VLAN

宛先インターフェイス

SPAN ステータス

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

neNameIdList の要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

パラメータ

opContext:動作コンテキスト

sessionIds:セッション ID の範囲(たとえば、1-2、20、50-53)。ヌルの場合は、すべてのセッションを戻します。

neNameIdList:セッション ID を照会するネットワーク要素の (@link InstanceNameId) のリスト。ヌルまたは空の場合は、すべての管理対象ネットワーク要素からセッションを戻します。

戻り値

ローカル SPAN セッションの順序付きリスト

getSpanDestinationPorts

特定のセッション NameId の宛先ポートを戻します。

結果のインターフェイスでは次のアソシエーションが使用可能です。

15. インターフェイス名

16. インターフェイス ステータス

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

sessionNameId がヌルであるか、SpanSession の InstanceNameId ではない場合。

指定された SpanSession が存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:SPAN セッションの InstanceNameId。

戻り値

NetworkInterface オブジェクトのリスト。

getSpanPermitListSettingsInNetwork

ネットワーク要素のリストについて SPAN 宛先許可リストを戻します。

次のアソシエーションが使用可能です。

NetworkInterface 宛先インターフェイス

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

neNameIdList の要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

パラメータ

opContext:

neNameIdList:SpanPermitListSetting を照会するネットワーク要素の InstanceNameId のリスト。ヌルまたは空の場合は、すべての管理対象ネットワーク要素からセッションを戻します。

戻り値

アソシエーションが初期化されている SpanPermitListSetting のリスト。

getSpanSessions

SPAN セッションの特定のインスタンス名 ID リストに関するすべてのアソシエーションとともに、SPAN セッションのリストを戻します。

戻りタイプには次のセッション タイプがあります。

ローカル SPAN

RSPAN 送信元

RSPAN 宛先

次のアソシエーションが使用可能です。

SpanSource ローカル SPAN または RSPAN 送信元:送信元インターフェイスおよび VLAN

VLAN ローカル SPAN または RSPAN 送信元:フィルタリング済み VLAN

NetworkInterface ローカル SPAN または RSPAN 宛先:宛先インターフェイス

VlanRSPAN 送信元または RSPAN 宛先 VLAN:RSPAN VLAN

SPAN ステータス

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

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

sessionInstanceNameIds が、SpanSession オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

sessionInstanceNameIds:SPAN セッションの (@link InstanceNameId) のリスト。

戻り値

SpanSession オブジェクトの順序付きリスト。戻されるオブジェクトでは、すべてのアソシエーションが初期化されます。

getSpanSessionsAssociatedToVlan

特定の VLAN が SPAN 送信元として設定されている SPAN セッション オブジェクトを戻します。

SPAN セッションごとに、次のアソシエーションが使用可能です。

25. ローカル SPAN から VLAN へのアソシエーション

LocalSpanSessionAppliesToVlan のもう一方の端では次のアソシエーションが使用可能です。

26. VLAN への参照

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

vlanNameId がヌルであるか、VLAN の InstanceNameId ではない場合。

指定された VLAN が存在しない場合。

パラメータ

opContext:動作コンテキスト

vlanNameId:VLAN の InstanceNameId。

戻り値

特定の VLAN が SPAN 送信元として設定されている SpanSession オブジェクトのリスト。

getSpanSessionsInNetwork

ネットワーク要素リストのセッション ID リストに対応する SPAN セッションを戻します。

戻りタイプには次のセッション タイプがあります。

ローカル SPAN

RSPAN 送信元

RSPAN 宛先

次のアソシエーションが使用可能です。

SpanSource ローカル SPAN または RSPAN 送信元:送信元インターフェイスおよび VLAN

VLAN ローカル SPAN または RSPAN 送信元:フィルタリング済み VLAN

NetworkInterface ローカル SPAN または RSPAN 宛先:宛先インターフェイス

VLAN RSPAN 送信元または RSPAN 宛先 VLAN:RSPAN VLAN

SPAN ステータス

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

neNameIdList の要素が AbstractNetworkElement の InstanceNameId タイプではない場合。

パラメータ

opContext:動作コンテキスト

sessionIds:セッション ID の範囲(たとえば、1-2、20、50-53)。ヌルの場合は、すべてのセッションを戻します。

neNameIdList:セッション ID を照会するネットワーク要素の (@link InstanceNameId) のリスト。ヌルまたは空の場合は、すべての管理対象ネットワーク要素からセッションを戻します。

戻り値

SpanSession オブジェクトの順序付きリスト。戻されるオブジェクトでは、すべてのアソシエーションが初期化されます。

getSpanSources

ローカル SPAN セッションまたはリモート SPAN 送信元セッションに関連付けられたすべての送信元ポートまたは EtherChannel または VLAN を戻します。

戻りタイプには、ローカル SPAN セッションに対する次のオブジェクトのリストがあります。

19. インターフェイス アソシエーション

20. VLAN アソシエーション

LocalSpanSessionAppliesToNetworkInterface では次のアソシエーションが使用可能です。

21. インターフェイスへの参照

LocalSpanSessionAppliesToVlan では次のアソシエーションが使用可能です。

22. VLAN への参照

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

sessionNameId がヌルであるか、SpanSession の InstanceNameId ではない場合。

指定された SpanSession が存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:SPAN セッションの InstanceNameId

戻り値

特定の SPAN セッションの送信元のリスト

modifyFilteredVlanRangeForSpanSession

ローカル SPAN セッションに関連するフィルタリング済み VLAN を変更します。既存のフィルタリング済み VLAN は、特定の VLAN で置き換えられます。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

vlanInstanceNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

フィルタリング済み VLAN をローカル SPAN に追加する場合、および特定のローカル SPAN セッションで送信元 VLAN が追加されている場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

filteredVlans:フィルタリング済み VLAN として設定する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

modifyFilteredVlansByRangeForSpanSession

ローカル SPAN セッションに関連するフィルタリング済み VLAN を変更します。既存のフィルタリング済み VLAN は、特定の VLAN で置き換えられます。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

フィルタリング済み VLAN をローカル SPAN に追加する場合、および特定のローカル SPAN セッションで送信元 VLAN が追加されている場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanRange:フィルタリング済み VLAN として設定する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

modifyFilteredVlansForSpanSession

ローカル SPAN セッションに関連するフィルタリング済み VLAN を変更します。既存のフィルタリング済み VLAN は、特定の VLAN で置き換えられます。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

vlanInstanceNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

フィルタリング済み VLAN をローカル SPAN に追加する場合、および特定のローカル SPAN セッションで送信元 VLAN が追加されている場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanInstanceNameIds:フィルタリング済み VLAN として特定の SPAN セッションに置き換えられる VLAN の InstanceNameId のリスト。

戻り値

void

modifySpanPermitListSettingsInNetworkElement

特定のネットワーク要素の許可リストを変更します。このメソッドには、SpanPermitListSetting に関連する宛先ポートへの変更が含まれます。

次のアソシエーションが更新されます。

許可リストに関連する NetworkInterface 宛先インターフェイス

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

neNameId がヌルであるか、AbstractNetworkElement の InstanceNameId ではない場合。

指定された AbstractNetworkElement が存在しない場合。

modifiedPermitListSetting がヌルの場合。

ポートを許可リスト宛先ポートに関連付けることなく permitlist がイネーブルになっている場合。

設定されている NetworkInterface のタイプが RoutedEtherChannelNetworkInterface または SwitchedEtherChannelNetworkInterface である場合。

パラメータ

opContext:動作コンテキスト

neNameId:AbstractNetworkElement の InstanceNameId。

modifiedPermitListSetting:変更した SpanPermitListSetting オブジェクト。

戻り値

void

modifySpanSessions

既存の SPAN セッションを変更します。このメソッドは、SPAN セッションに対応するアソシエーションを変更しません。

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

modifiedSpanSessions がヌルまたは空であるか、リストの要素のタイプが SpanSession ではない場合。

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

SpanSession オブジェクト modifiedSpanSessions のすべてのアトリビュートが無効な場合。

例:

SpanSession の説明は、Cisco NX-OS プラットフォームだけに適用可能です。

SpanSession の sessionId が範囲外です。

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

modifiedSpanSessions コレクション SpanSession オブジェクト内のオブジェクトの誰かが存在しない場合。

パラメータ

opContext:動作コンテキスト

modifiedSpanSessions:変更する SpanSession オブジェクトのリスト。

戻り値

void

modifySpanSourceTrafficDirection

SPAN 送信元ポートまたは EtherChannel または VLAN から流れるトラフィックの方向を変更します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

srcNameId がヌルであるか、そうではない場合。

指定された送信元 VLAN または NetworkInterface が存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

srcNameId:ポートまたは EtherChannel または VLAN の InstanceNameId。

modifiedDirection:それぞれの SPAN 送信元の変更済み SpanSourceDirection。

戻り値

void

modifySpanSources

SpanSource アソシエーションのリストを変更します。これによって、ユーザは、既存の VLAN またはインターフェイスのリストのトラフィック方向を SPAN アソシエーションに変更できます。

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

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

spanSources で SpanSource に対応するオブジェクトが存在しない場合。

spanSources のすべてのオブジェクトが LocalSpanSessionAppliesToNetworkInterface または LocalSpanSessionAppliesToVlan ではない場合。

パラメータ

opContext:動作コンテキスト

spanSources:変更済み SpanSource アソシエーションのリスト。

戻り値

void

removeDestinationPortsFromSpanSession

宛先ポートまたは Etherchannel をローカル SPAN セッションまたはリモート SPAN 宛先セッションから削除します。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

NetworkInterface が完全に削除されるか、セッションに他のアソシエーション(フィルタリング済み VLAN または送信元)がない場合

dstPortNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

dstPortNameIds:特定の SPAN セッションから削除するインターフェイスの InstanceNameId のリスト。

戻り値

void

removeFilteredVlanRangeInSpanSession

フィルタリング済み VLAN をローカル SPAN セッションから削除します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

VLAN が完全に削除されるか、セッションに他のアソシエーション(送信元または宛先)がない場合

dstPortNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

filteredVlans:削除する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

removeFilteredVlansInSpanSession

フィルタリング済み VLAN をローカル SPAN セッションから削除します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

VLAN が完全に削除されるか、セッションに他のアソシエーション(送信元または宛先)がない場合

dstPortNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanRange:削除する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

removePortsFromSpanPermitList

ポートを SPAN 宛先許可リストから削除します。

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

neNameId がヌルであるか、AbstractNetworkElement の InstanceNameId ではない場合。

指定された AbstractNetworkElement が存在しない場合。

interfaceNameIds 内の要素の InstanceNameId が SPAN 宛先として SPAN セッションに関連付けられている場合。

検証:

14. 対応するデバイスのセッションの SPAN 宛先として使用される場合は、インターフェイスの削除は許可されません。

パラメータ

opContext:動作コンテキスト

neNameId:ネットワーク要素のインスタンス名 ID。

interfaceNameIds:ネットワーク インターフェイス インスタンス名 ID のリスト。

戻り値

void

removeSourcesFromSpanSession

送信元ポートまたは Etherchannel または VLAN をローカル SPAN セッションから削除します。リモート SPAN はサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

NetworkInterface または VLAN が完全に削除されるか、セッションに他のアソシエーション(フィルタリング済み VLAN または宛先ポート)がない場合

srcNameIds の InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

srcNameIds:VLAN または NetworkInterface の InstanceNameId のリスト。

戻り値

void

removeSourcesInSpanSession

送信元ポートまたは Etherchannel または VLAN をローカル SPAN セッションから削除します。リモート SPAN セッションはサポートされません。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

VLAN が完全に削除されるか、セッションに他のアソシエーション(フィルタリング済み VLAN または宛先ポート)がない場合

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

vlanRange:SPAN 送信元として設定する VLAN ID の範囲。例:「2,7-9」。

戻り値

void

unbindDestinationPortsFromSpanSession

宛先ポートまたは Etherchannel をローカル SPAN セッションまたはリモート SPAN 宛先セッションから削除します。

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

sessionNameId がヌルであるか、LocalSpanSession の InstanceNameId ではない場合。

指定された LocalSpanSession が存在しない場合。

VLAN が完全に削除されるか、セッションに他のアソシエーション(フィルタリング済み VLAN または宛先ポート)がない場合

dstPortNameIds で InstanceNameId に対応するオブジェクトが存在しない場合。

パラメータ

opContext:動作コンテキスト

sessionNameId:LocalSpanSession の InstanceNameId。

dstPortNameIds:特定の SPAN セッションから削除するインターフェイスの InstanceNameId のリスト。

戻り値

void