Cisco DCNM Web Services API ガイド Release 4.0
TrafficStormControlApp サービス
TrafficStormControlApp サービス
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

TrafficStormControlApp サービス

TrafficStormControlApp サービスの概要

disableBroadcastStormControlInInterfaces

disableMulticastStormControlInInterfaces

disableStormControlInInterfaces

disableUnicastStormControlInInterfaces

enableBroadcastStormControlInInterfaces

enableMulticastStormControlInInterfaces

enableUnicastStormControlInInterfaces

getInterfacesWithTrafficStormControlSettingInNetworkElement

getTrafficStormControlDisabledInterfacesInNetworkElement

getTrafficStormControlSettingInInterfaces

getTrafficStormControlledInterfacesInNetworkElement

modifyStormControlInInterfaces

TrafficStormControlApp サービス

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

TrafficStormControlApp サービスの概要

この章では、トラフィック ストーム制御サービス機能によって公開される API を定義します。

disableBroadcastStormControlInInterfaces

インターフェイスの収集でブロードキャスト ストーム制御をディセーブルにし、インターフェイスの InstanceNameID を指定します。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIdsis がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― ブロードキャスト ストーム制御をディセーブルにする必要のあるインターフェイスの InstanceNameId の収集

戻り値

void

disableMulticastStormControlInInterfaces

インターフェイスの収集でマルチキャスト ストーム制御をディセーブルにし、インターフェイスの InstanceNameId を指定します。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIdsis がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― マルチキャスト ストーム制御をディセーブルにする必要のあるインターフェイスの InstanceNameId の収集

戻り値

void

disableStormControlInInterfaces

インターフェイスの指定収集で全 3 タイプのトラフィック(ユニキャスト、ブロードキャスト、マルチキャスト)のストーム制御をディセーブルにします。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数を渡した interfaceInstanceNameIds がヌルか空の場合

interfaceInstanceNameIdsis の要素が有効な interfaceInstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

パラメータ

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

interfaceInstanceNameId ― 全 3 トラフィック タイプ(ユニキャスト、ブロードキャスト、マルチキャスト)のストーム制御を無効にするインターフェイスの InstanceNameId

戻り値

void

disableUnicastStormControlInInterfaces

インターフェイスの収集でユニキャスト ストーム制御をディセーブルにし、インターフェイスの InstanceNameID を指定します。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIdsis がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― ユニキャスト ストーム制御をディセーブルにする必要のあるインターフェイスの InstanceNameId の収集

戻り値

void

enableBroadcastStormControlInInterfaces

指定のしきい値を持つインターフェイスの収集で、ブロードキャスト ストーム制御をイネーブルにします。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、これらのインターフェイスがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIds がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

しきい値が 100 で他のタイプ(ユニキャストまたはマルチキャスト)のトラフィック ストーム制御もすでにイネーブルの場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― ブロードキャスト をイネーブルにする必要のあるインターフェイスの InstanceNameId の収集

threshold ― ストーム制御しきい値の値を示すフロート オブジェクト。このオブジェクトには 100 未満で 0 を越えるフロート値があります。これはオプションの引数です。この引数がヌルに設定されている場合、インターフェイス内にすでに設定済みのしきい値が保持されます。

戻り値

void

enableMulticastStormControlInInterfaces

指定のしきい値を持つインターフェイスの収集で、マルチキャスト ストーム制御をイネーブルにします。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、これらのインターフェイスがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIds がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

しきい値が 100 で他のタイプ(ユニキャストまたはブロードキャスト)のトラフィック ストーム制御もすでにイネーブルの場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― マルチキャストをイネーブルにする必要のあるインターフェイスの InstanceNameId の収集

threshold ― ストーム制御しきい値の値を示すフロート オブジェクト。このオブジェクトには 100 未満で 0 を越えるフロート値があります。これはオプションの引数です。この引数がヌルに設定されている場合、インターフェイス内にすでに設定済みのしきい値が保持されます。

戻り値

void

enableUnicastStormControlInInterfaces

指定のしきい値を持つインターフェイスの収集で、ユニキャスト ストーム制御をイネーブルにします。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。トラフィック ストーム制御のイネーブル/ディセーブルは、これらのインターフェイスで行うことができません。

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

引数が渡された interfaceInstanceNameIds がヌルか有効な インターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

しきい値が 100 で他のタイプ(ブロードキャストまたはマルチキャスト)のトラフィック ストーム制御もすでにイネーブルの場合

指定インターフェイスの BroadcastSuppression 機能が None の場合に PropertiesException がスローされます。

パラメータ

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

interfaceInstanceNameIds ― ユニキャスト をイネーブルにする必要のあるインターフェイスの InstanceNameId の収集

threshold ― ストーム制御しきい値の値を示すフロート オブジェクト。このオブジェクトには 100 未満で 0 を越えるフロート値があります。これはオプションの引数です。この引数がヌルに設定されている場合、インターフェイス内にすでに設定済みのしきい値が保持されます。

戻り値

void

getInterfacesWithTrafficStormControlSettingInNetworkElement

指定のネットワーク要素内にあるすべてのトラフィック ストーム制御がイネーブルまたはディセーブルのインターフェイスを返します。1 つまたは複数のトラフィック タイプ(ユニキャスト、マルチキャスト、ブロードキャスト)のストーム制御がイネーブルの場合、インターフェイスでトラフィック ストーム制御がイネーブルであるとみなされます。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。

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

引数が渡された neInstanceNameId がヌルか有効なネットワーク要素 InstanceNameId でない場合

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

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

トラフィック ストーム制御がイネーブルの NetworkInterface と、トラフィック ストーム制御がディセーブルの NetworkInterface の収集。インターフェイスのタイプは SwitchedNetworkInterface または RoutedNetworkInterface のいずれかです。返されたリストには、次のアソシエーションのみが表示され、その他のアソシエーションはクリアされます。

トラフィック ストーム制御アソシエーション

ネットワーク インターフェイス アソシエーション

getTrafficStormControlDisabledInterfacesInNetworkElement

指定のネットワーク要素内でトラフィック ストーム制御がディセーブルの全インターフェイスを返します。全 3 タイプのトラフィック(ユニキャスト、ブロードキャスト、マルチキャスト)のどれもがイネーブルではなくしきい値が 100 の場合に、インターフェイスでのトラフィック ストーム制御がディセーブルとみなされます。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ
SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。BroadcastSupressionCapability が None のインターフェイスは、この API で返されるリストに含まれません。

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

引数が渡された neInstanceNameId がヌルか有効なネットワーク要素 InstanceNameId でない場合

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

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

トラフィック ストーム制御がディセーブルになっているインターフェイスの InstanceNameIds の収集。返されたリストには、ネットワーク インターフェイス名アソシエーションが表示され、その他のアソシエーションはクリアされます。

getTrafficStormControlSettingInInterfaces

インターフェイスの収集におけるトラフィック ストーム制御設定を返します。ブロードキャスト抑制機能が None に設定されているインターフェイスの場合、この API でヌル値が返されます。

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

渡された引数がヌルか有効なインターフェイス InstanceNameId でない場合

インターフェイスがデータベースに存在しない場合

パラメータ

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

interfaceInstanceIds ― インターフェイスの InstanceNameId の収集

戻り値

このインターフェイスと関係する TrafficStormControlSetting オブジェクトの収集

getTrafficStormControlledInterfacesInNetworkElement

指定のネットワーク要素内にあるすべてのトラフィック ストーム制御がイネーブルのインターフェイスを返します。1 つまたは複数のトラフィック タイプ(ユニキャスト、マルチキャスト、ブロードキャスト)のストーム制御がイネーブルの場合、インターフェイスでトラフィック ストーム制御がイネーブルであるとみなされます。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ
SwitchedNetworkInterface または RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。

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

引数が渡された neInstanceNameId がヌルか有効なネットワーク要素 InstanceNameId でない場合

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

パラメータ

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

neInstanceNameId ― ネットワーク要素の InstanceNameId

戻り値

トラフィック ストーム制御がイネーブルの NetworkInterface の収集。インターフェイスのタイプは SwitchedNetworkInterface または RoutedNetworkInterface のいずれかです。返されたリストには、次のアソシエーションのみが表示され、その他のアソシエーションはクリアされます。

トラフィック ストーム制御アソシエーション

ネットワーク インターフェイス アソシエーション

modifyStormControlInInterfaces

インターフェイスの特定の収集におけるトラフィック ストーム制御設定を返します。この API は、特定のトラフィック制御をイネーブルまたはディセーブルにするのにも使用できます。全 3 種類(ユニキャスト、ブロードキャスト、マルチキャスト)のトラフィック ストーム制御をディセーブルにする場合、しきい値は 100 になります。渡された TrafficStormControlSetting オブジェクトでは、ユーザは 100% のしきい値を設定せず、1 トラフィック タイプに対してイネーブル ステートを指定しません。BroadcastSuppressionCapability がインターフェイスの Portcapability オブジェクト内で None に指定されている場合、それらがタイプ SwitchedNetworkInterface または
RoutedNetworkInterface であっても、これらのインターフェイスにはトラフィック ストーム制御機能はありません。

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

引数を渡した interfaceInstanceNameIds がヌルか空の場合

収集 trafficStromControlSettings のいずれかの要素がタイプ TrafficStormControlSetting でない場合

収集 trafficStromControlSettings のいずれかの要素がデータベースに存在しない場合

収集 trafficStromControlSettings のいずれかの要素のアトリビュートが有効でない場合

3 種類のトラフィック タイプ(ユニキャスト、ブロードキャスト、マルチキャスト)のいずれかのストーム制御がイネーブルの場合、帯域幅のしきい値が 100 です。

全 3 種類のトラフィック タイプのストーム制御がディセーブルの場合、帯域幅のしきい値は 100 ではありません。

帯域幅しきい値が 0 ~ 100 の間にない場合 PropertiesException がスローされます。

パラメータ

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

trafficStormControlSetting ― 修正されたストーム制御設定オブジェクトの収集

戻り値

void