Cisco DCNM Web サービス API ガイド リリース 5.1(1a)

TrafficStormControlApp サービス

---

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

TrafficStormControlApp サービスについて

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

disableBroadcastStormControlInInterfaces

インターフェイスの InstanceNameId を指定すると、インターフェイスのコレクションでブロードキャスト ストーム制御をディセーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：ブロードキャスト ストーム制御をディセーブルにする必要があるインターフェイスの InstanceNameId のコレクション。

戻り値

void

disableMulticastStormControlInInterfaces

インターフェイスの InstanceNameId を指定すると、インターフェイスのコレクションでマルチキャスト ストーム制御をディセーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：マルチキャスト ストーム制御をディセーブルにする必要があるインターフェイスの InstanceNameId のコレクション。

戻り値

void

disableStormControlInInterfaces

インターフェイスの特定のコレクションで 3 つすべてのタイプのトラフィック（ユニキャスト、ブロードキャスト、またはマルチキャスト）でストーム制御をディセーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

• 渡された引数 interfaceInstanceNameIds がヌル、または空の場合。

• interfaceInstanceNameIds のすべての要素が有効な interfaceInstanceNameId ではない場合。

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

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameId：3 つすべてのトラフィック タイプ（ユニキャスト、ブロードキャスト、およびマルチキャスト）のストーム制御をディセーブルにするインターフェイスの InstanceNameId。

戻り値

void

disableUnicastStormControlInInterfaces

インターフェイスの InstanceNameId を指定すると、インターフェイスのコレクションでユニキャスト ストーム制御をディセーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：ユニキャスト ストーム制御をディセーブルにする必要があるインターフェイスの InstanceNameId のコレクション。

戻り値

void

enableBroadcastStormControlInInterfaces

特定のしきい値を使用してインターフェイスのコレクションでブロードキャスト ストーム制御をイネーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

• しきい値が 100 で、他のタイプ（ユニキャストまたはマルチキャスト）のトラフィック ストーム制御もまだイネーブルにされていなかった場合。

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：ブロードキャストをイネーブルにするインターフェイスの InstanceNameId のコレクション。

threshold：ストーム制御しきい値の値を示す浮動オブジェクト。このオブジェクトには、100 未満で 0 よりも大きい浮動小数点値が指定されます。これは任意指定の引数です。この引数をヌルに設定すると、インターフェイスですでに設定されているしきい値が保持されます。

戻り値

void

enableMulticastStormControlInInterfaces

特定のしきい値を使用してインターフェイスのコレクションでマルチキャスト ストーム制御をイネーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

• しきい値が 100 で、他のタイプ（ユニキャストまたはブロードキャスト）のトラフィック ストーム制御もまだイネーブルにされていなかった場合。

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：* マルチキャストをイネーブルにするインターフェイスの InstanceNameId のコレクション。

threshold：ストーム制御しきい値の値を示す浮動オブジェクト。このオブジェクトには、100 未満で 0 よりも大きい浮動小数点値が指定されます。これは任意指定の引数です。この引数をヌルに設定すると、インターフェイスですでに設定されているしきい値が保持されます。

戻り値

void

enableUnicastStormControlInInterfaces

特定のしきい値を使用してインターフェイスのコレクションでユニキャスト ストーム制御をイネーブルにします。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。これらのインターフェイスでは、トラフィック ストーム制御のイネーブル化またはディセーブル化を行うことはできません。

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

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

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

• しきい値が 100 で、他のタイプ（ブロードキャストまたはマルチキャスト）のトラフィック ストーム制御もまだイネーブルにされていなかった場合。

PropertiesException は、特定のインターフェイスの BroadcastSuppression 機能が None である場合にスローされます。

パラメータ

opContext：動作コンテキスト。

interfaceInstanceNameIds：ユニキャストをイネーブルにするインターフェイスの InstanceNameId のコレクション。

threshold：ストーム制御しきい値の値を示す浮動オブジェクト。このオブジェクトには、100 未満で 0 よりも大きい浮動小数点値が指定されます。これは任意指定の引数です。この引数をヌルに設定すると、インターフェイスですでに設定されているしきい値が保持されます。

戻り値

void

getInterfacesWithTrafficStormControlSettingInNetworkElement

特定のネットワーク要素でトラフィック ストーム制御がイネーブルおよびディセーブルにされているすべてのインターフェイスを戻します。1 つまたは複数のトラフィック タイプ（ユニキャスト、ブロードキャスト、またはマルチキャスト）のストーム制御がイネーブルにされている場合、インターフェイスでは、トラフィック ストーム制御がイネーブルにされていると見なされます。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。

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

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

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

パラメータ

opContext：動作コンテキスト。

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

戻り値

トラフィック ストーム制御がイネーブルおよびトラフィック ストーム制御がディセーブルにされた NetworkInterface のコレクション。インターフェイスのタイプは、SwitchedNetworkInterface または RoutedNetworkInterface です。戻されるリストでは、次のアソシエーションだけが存在し、その他のアソシエーションはクリアされます。

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

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

getTrafficStormControlDisabledInterfacesInNetworkElement

特定のネットワーク要素でトラフィック ストーム制御がディセーブルにされたすべてのインターフェイスを戻します。3 つのトラフィック タイプ（ユニキャスト、ブロードキャスト、またはマルチキャスト）のいずれもイネーブルになっておらず、しきい値が 100 の場合は、インターフェイスでは、トラフィック ストーム制御がディセーブルにされていると見なされます。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。BroadcastSupressionCapability が None であるインターフェイスは、戻されるこの API リストに含められません。

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

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

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

パラメータ

opContext：動作コンテキスト。

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

戻り値

トラフィック ストーム制御がディセーブルになっているインターフェイスの InstanceNameIds のコレクション。戻されるリストでは、ネットワーク インターフェイス名アソシエーションが存在し、その他のアソシエーションはクリアされます。

getTrafficStormControlSettingInInterfaces

インターフェイスのコレクションでトラフィック ストーム制御設定を戻します。ブロードキャスト抑制機能が [None] に設定されているインターフェイスでは、この API によってヌル値が戻されます。

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

• 渡された引数がヌルの場合、または有効なインターフェイス InstanceNameId ではない場合。

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

パラメータ

opContext：動作コンテキスト。

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

戻り値

インターフェイスに関係する TrafficStormControlSetting オブジェクトのコレクション。

getTrafficStormControlledInterfacesInNetworkElement

特定のネットワーク要素でトラフィック ストーム制御がイネーブルにされたすべてのインターフェイスを戻します。1 つまたは複数のトラフィック タイプ（ユニキャスト、ブロードキャスト、またはマルチキャスト）のストーム制御がイネーブルにされている場合、インターフェイスでは、トラフィック ストーム制御がイネーブルにされていると見なされます。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。

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

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

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

パラメータ

opContext：動作コンテキスト。

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

戻り値

トラフィック ストーム制御がイネーブルにされた NetworkInterface のコレクション。インターフェイスのタイプは、SwitchedNetworkInterface または RoutedNetworkInterface です。戻されるリストでは、次のアソシエーションだけが存在し、その他のアソシエーションはクリアされます。

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

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

modifyStormControlInInterfaces

インターフェイスの特定のコレクションでトラフィック ストーム制御設定を変更します。この API は、指定のトラフィック制御をイネーブルまたはディセーブルにするためにも使用できます。3 つ（ユニキャスト、ブロードキャスト、マルチキャスト）すべてのトラフィック ストーム制御をディセーブルにする場合は、しきい値は 100 にする必要があります。渡される TrafficStormControlSetting オブジェクトで、ユーザは 100 % のしきい値を指定して、いずれかのトラフィック タイプにイネーブル状態を指定する必要はありません。インターフェイスの Portcapability オブジェクトで BroadcastSuppressionCapability が None に指定されている場合は、これらのインターフェイスでは、タイプが SwitchedNetworkInterface または RoutedNetworkInterface であるのにもかかわらず、トラフィック ストーム制御設定は指定されません。

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

• 渡された引数 trafficStormControlSettings がヌル、または空の場合。

• コレクション trafficStromControlSettings のすべての要素のタイプが TrafficStormControlSetting ではない場合。

• コレクション trafficStormControlSettings のすべての要素がデータベースに存在しない場合。

• コレクション trafficStromControlSettings のすべての要素のアトリビュートが無効な場合。

例：

• 3 つのトラフィック タイプ（ユニキャスト、ブロードキャスト、マルチキャスト）のいずれかでストーム制御がイネーブルになっている場合は、帯域幅しきい値は 100 です。

• 3 つすべてのトラフィック タイプでストーム制御がディセーブルになっている場合は、帯域幅しきい値は 100 ではありません。

PropertiesException は、帯域幅しきい値が範囲 0 ～ 100 内にないときにスローされます。

パラメータ

opContext：動作コンテキスト。

trafficStormContolSettings：変更したトラフィック ストーム制御設定オブジェクトのコレクション。

戻り値

void