TunnelApp サービス
この章では、DCNM Web サービスの、TunnelApp サービスに対応する API メソッドについて説明します。
TunnelApp サービスについて
トンネリングでは任意のパケットを転送プロトコル内でカプセル化できます。この機能は、仮想インターフェイスとして実装され、簡単なインターフェイスで設定できるようになっています。トンネル インターフェイスは、任意の標準ポイントツーポイント カプセル化スキームを実装するために必要なサービスを準備するように設計されています。トンネルはポイントツーポイント リンクであるため、リンクごとに個別のトンネルを設定する必要があります。API カテゴリは次のとおりです。
•
Query/Get API:永続的なデータベースのデータを照会します。
•
Modify API:既存の IpGreTunnelNetworkInterface 設定を変更します。
•
Delete API:デバイスの既存のトンネル インターフェイスを削除します。
•
Apply API:一連のトンネル インターフェイス設定に設定を適用します。
bindKeepAliveSettingToNetworkInterfaces
1 つまたは複数のトンネル インターフェイスに対する KeepAliveSetting を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelInstanceIds がヌルまたは空か、タイプ InstanceNameId ではない場合。
•
tunnelInstanceIds が TunnelNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
•
keepAliveSetting がヌルの場合。
パラメータ
opContext:動作コンテキスト
tunnelInstanceIds:TunnelNetworkInterface の 1 つまたは複数の InstanceNameId のリスト。
keepAliveSetting:TunnelNetworkInterface オブジェクトに適用する KeepAliveSetting。
戻り値
void
bindPathMtuDiscoverySettingToNetworkInterfaces
1 つまたは複数のトンネル インターフェイスに対する PathDiscoverySetting を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelInstanceIds がヌルまたは空か、タイプ InstanceNameId ではない場合。
•
tunnelInstanceIds が TunnelNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
•
keepAliveSetting がヌルの場合。
パラメータ
opContext:動作コンテキスト
tunnelInstanceIds:TunnelNetworkInterface の 1 つまたは複数の InstanceNameId のリスト
pathMtuDiscoverySetting:TunnelNetworkInterface オブジェクトに適用する PathMtuDiscoverySetting
戻り値
void
createIpGreTunnelNetworkInterfaces
リストで指定されたトンネル インターフェイスをネットワーク要素に作成します。
指定された IpGreTunnelNetworkInterface に対する次のアソシエーションが規定されます。
•
指定された IpGreTunnelNetworkInterface AbstractNetworkElement reference に対応する AbstractNetworkElementReference
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelIfs がヌルまたは空か、有効な TunnelNetworkInterface オブジェクトではない場合。
•
IpGreTunnelNetworkInterface のインスタンスがデータベースに存在している場合。
パラメータ
opContext:動作コンテキスト
tunnelIfs:作成する TunnelNetworkInterface オブジェクトのリスト
戻り値
新規 IpGreTunnelNetworkInterface に対応する InstanceNameIds のリスト
deleteIpGreTunnelNetworkInterfaces
1 つまたは複数の Tunnel InterfaceObject を削除します。TunnelNetworkInterface の InstanceNameId を指定すると、対応するトンネル インターフェイス オブジェクトをサーバから削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelInstanceIds コレクションがヌル、または空の場合。
•
tunnelInstanceIds コレクションに含まれている要素がタイプ TunnelNetworkInterface InstanceNameId ではない場合。
•
tunnelInstanceIds コレクションに、データベースに存在しない TunnelNetworkInterface が含まれている場合。
パラメータ
opContext:動作コンテキスト
tunnelInstanceIds:TunnelNetworkInterface の InstanceNameId のリスト
戻り値
void
disableTunnelService
デバイスのトンネル サービスをディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、その要素でトンネル サービスをディセーブルにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
•
neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:トンネル サービスがイネーブルにされている AbstractNetworkElement の InstanceNameId のリスト
戻り値
void
enableTunnelService
デバイスでトンネル サービスをグローバルにイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、その要素でトンネルをイネーブルにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
•
neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:トンネル サービスがディセーブルにされている AbstractNetworkElement の InstanceNameId のリスト
戻り値
void
getAllTunnelInterfacesInNetworkElement
指定されたデバイスに設定されている TunnelNetworkInterface のリストを戻します。ネットワーク要素の InstanceNameId を指定すると、そのネットワーク要素にある TunnelNetworkInterface のコレクションを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameId:ネットワーク要素の InstanceNameId
戻り値
TunnelNetworkInterface のインスタンスのリスト
getTunnelDestinationInterface
指定したトンネル用に設定されている宛先 NetworkInterface のインスタンスを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelIf がヌルか、IpGreTunnelNetworkInterface の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
tunnelIf:IpGreTunnelNetworkInterface の InstanceNameId
戻り値
NetworkInterface のインスタンス
getTunnelGlobalSetting
指定された AbstractNetworkElement に対応する TunnelGlobalSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
•
neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:AbstractNetworkElement の 1 つまたは複数の InstanceNameId のリスト
戻り値
TunnelGlobalSetting のリスト
getTunnelNetworkInterfaces
InstanceNameId に対応するトンネル ネットワーク インターフェイスを戻します。単一の TunnelNetworkInterface の InstanceNameId を指定すると、対応するトンネル ネットワーク インターフェイス オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelIfInstanceNameIdCol がヌルまたは空か、タイプ InstanceNameId ではない場合。
•
tunnelIfInstanceNameIdCol が TunnelNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
tunnelIfInstanceNameIdCol:TunnelNetworkInterface オブジェクトの 1 つまたは複数の InstanceNameId のリスト。
戻り値
TunnelNetworkInterface のインスタンスのリスト。
getTunnelSourceNetworkInterface
指定したトンネル用に設定されているソース NetworkInterface のインスタンスを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
tunnelIf がヌルか、IpGreTunnelNetworkInterface の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
tunnelIf:IpGreTunnelNetworkInterface の InstanceNameId
戻り値
NetworkInterface のインスタンス
modifyIpGreTunnelNetworkInterfaces
1 つまたは複数のネットワーク要素で IpGreTunnelNetworkInterface オブジェクトを変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
modifiedTunnelIfs がヌルまたは空か、タイプ TunnelNetworkInterface ではない場合。
•
既存の IpGreTunnelNetworkInterface(データベース内に存在)だけを変更できます。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
•
modifiedTunnelIfs コレクションで、いずれかの TunnelNetworkInterface アトリビュートが有効ではない場合。
例:
•
トンネル インターフェイスの MTU が読み取り専用の場合。トンネル インターフェイスの MTU はデフォルト値を含んでおり、編集不可です。
パラメータ
opContext:動作コンテキスト
modifiedTunnelIfs:変更済み TunnelNetworkInterface オブジェクトのリスト
戻り値
void