Cisco DCNM Web Services API ガイド Release 4.0
SpanApp サービス
SpanApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章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

SpanApp サービス

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

SpanApp サービスの概要

スイッチでは、Switched 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 が存在しない場合

interfaceNameId にある要素の 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 ソースとして設定されている場合

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

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

Catalyst 6500 シリーズ スイッチで セッションに SPAN ソースとしてインターフェイスがすでに設定されていて、VLAN が 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 が存在しない場合

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

Catalyst 6500 シリーズ スイッチで セッションに SPAN ソースとしてインターフェイスがすでに設定されていて、VLAN が 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 セッションを作成するのにこのメソッドを使用できます。InstanceNameId は、セッション ID と NetworkElement 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 がスローされます。

sessionNameId がヌルか空であるか、リスト内の要素が SpanSession の InstanceName ではない場合

sessionNameIds 収集で、sessionNameIds 内の InstanceNameId に対応しているいずれかの SpanSession オブジェクトが存在していない場合

パラメータ

opContext ― 動作可能なコンテキスト

sessionNameIds ― 削除する必要のある SpanSession のリスト

戻り値

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 の宛先ポートを返します。

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

インターフェイス名

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

次のいずれかの状況が発生した場合に 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/SPAN ソース ― 送信元インターフェイスおよび 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 セッションで次のアソシエーションが使用可能です。

ローカル SPAN の VLAN へのアソシエーション

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

VLAN への参照

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

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

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

パラメータ

opContext ― 動作可能なコンテキスト

vlanNameId ― VLAN の InstanceNameId

戻り値

指定の VLAN が SPAN ソースとして設定されている SpanSession オブジェクトのリスト

getSpanSessionsInNetwork

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

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

ローカル SPAN

RSPAN ソース

RSPAN 宛先

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

SpanSource ローカル SPAN/SPAN ソース ― 送信元インターフェイスおよび 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 セッションの次のオブジェクト リストがあります。

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

VLAN アソシエーション

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

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

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

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 がヌルの場合

許可リスト宛先ポートとしてのポートの関連付けなしに許可リストがイネーブルになった場合

許可リスト宛先ポートとしてのポートの関連付けなしに許可リストがイネーブルになった場合

設定された 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

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

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

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

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

セッションに他のアソシエーション(フィルタリングされた VLAN/ソース)がなく、NetworkInterface が完全に削除された場合

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 が存在しない場合

interfaceNameId にある要素の InstanceNameId が SPAN セッションへの SPAN 宛先として関連付けされている場合

検証

対応するデバイスでセッションの SPAN 宛先として使用されている場合インターフェイスを削除することができません。

パラメータ

opContext ― 動作可能なコンテキスト

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

interfaceNameIds ― ネットワーク インスタンス名 ID のリスト

戻り値

void

removeSourcesFromSpanSession

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

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

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

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

セッションに他のアソシエーション(フィルタリングされた VLAN/宛先ポート)がなく、NetworkInterface や 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