GlbpApp サービス
この章では、DCNM Web サービスの、GlbpApp サービスに対応する API メソッドについて説明します。
GlbpApp サービスについて
Gateway Load Balancing Protocol(GLBP; ゲートウェイ ロード バランシング プロトコル)は、ゲートウェイ冗長性とロード バランシングを提供する第 1 ホップ ルーティング プロトコルです。GLBP はアクティブ ゲートウェイとスタンバイ ゲートウェイに冗長性を提供します。GLBP グループのメンバーは、そのグループの Active Virtual Gateway(AVG; アクティブ仮想ゲートウェイ)になる 1 つのゲートウェイを選択します。GLBP グループの他のメンバーは、既存のゲートウェイに障害が発生した場合にアクティブになる冗長 GLBP デバイスとして機能できます。API カテゴリは次のとおりです。
•
Query/Get API:永続的なデータベースのデータを照会します。
•
Modify API:既存の GLBP グループ設定を変更します。
•
Remove API:デバイス内の 1 つまたは複数のインターフェイスから GLBP グループ設定の関連付けを解除します。
addGlbpGroupSetting
GLBP グループ設定を 1 つまたは複数の IpNetworkInterface に追加します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
•
setting がヌルまたは次の場合。
1. GlbpGroupSetting の virtualIpAddress または secondaryIpAddress が次のものと競合する場合。
–
IpNetworkInterface の IpAddress。
–
他の GlbpGroupSetting の virtualIpAddress。
–
他の GlbpGroupSetting の secondaryIpAddress。
–
NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。
2. GlbpGroupSetting の groupName がデバイス内の他の GlbpGroupSettings の groupName と競合する場合。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
•
ifInstanceNameIdCol に、デバイスに存在するインターフェイスの複数の instanceNameId が含まれる場合。
•
virtualIpAddress がヌルではない場合。
•
groupName がヌルではない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupSettingCol のコレクションに、有効な GlbpGroupSetting アトリビュートがない場合。
例:
•
GlbpGroupSettting の glbpGroupName にスペースが含まれる場合。
パラメータ
opContext:動作コンテキスト
setting:1 つまたは複数の IpNetworkInterface に適用する必要があるパラメータを持つ GlbpGroupSetting
ifInstanceNameIdCol:1 つまたは複数の IpNetworkInterface の InstanceNameId のリスト
戻り値
GlbpGroupSetting の InstanceNameId のリスト
bindTrackingObjectsToGlbpGroupSetting
既存の GlbpGroup をバインドし、新しいオブジェクトを追跡します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
objectTrackingSetting:ObjectTrackingSetting オブジェクト。
glbpInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
void
createGlbpGroupSettings
異なるネットワーク要素で GlbpGroupSetting のリストを作成します。
次のアソシエーションが特定の GlbpGroupSetting に提供されます。
•
指定したグループ IpNetworkInterface 参照に対応する NetworkInterfaceReference
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupSettingCol がヌルか空であるか、またはタイプ GlbpGroupSetting ではない場合。
•
GlbpGroupSetting の virtualIpAddress または secondaryIpAddress が次のものと競合する場合。
•
IpNetworkInterface の IpAddress。
•
他の GlbpGroupSetting の virtualIpAddress。
•
他の GlbpGroupSetting の secondaryIpAddress。
•
NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。
•
GlbpGroupSetting の groupName がデバイス内の他の GlbpGroupSettings の groupName と競合する場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupSettingCol のコレクションに、有効な GlbpGroupSetting アトリビュートがない場合。
例:
•
GlbpGroupSettting の glbpGroupName にスペースが含まれる場合。
パラメータ
opContext:動作コンテキスト
glbpGroupSettingCol:GlbpGroupSetting オブジェクトのリスト。
戻り値
GlbpGroupSetting の InstanceNameId のリスト
disableService
デバイス内の GlbpService をディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、GLBP はこれらの要素でディセーブルになります。ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
•
neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:GLBP がディセーブルになっている AbstractNetworkElement の InstanceNameId のリスト
戻り値
void
enableService
デバイス内の GlbpService をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、GLBP はこれらの要素でイネーブルになります。この API は、デバイスで「GLBP サービス」オプションをグローバルにイネーブルにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
•
neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:AbstractNetworkElement の InstanceNameId のリスト
戻り値
void
getActiveTimers
1 つまたは複数の GLBP グループに対応する ActiveTimers オブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する ActiveTimers のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
ActiveTimers オブジェクトのリスト
getAllGlbpGroupSettings
すべての管理対象ネットワーク要素に設定されている GLBP グループに対応する GlbpGroupSetting のリストを戻します。
パラメータ
opContext:動作コンテキスト
戻り値
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpGroupSetting に対応する IP ネットワーク インターフェイス
•
GLBP ゲートウェイ ステータス
•
GLBP フォワーダ ステータス
getAllGlbpGroupsInNetwork
ネットワークに設定されているすべての GLBP グループを戻します。GlbpGroup のリストを戻します。GlbpGroup には、GLBP グループ ID および GLBP グループ メンバーに対応する GlbpGroupSetting のコレクションが含まれます。
パラメータ
opContext:動作コンテキスト
戻り値
GlbpGroup のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpGroupSetting に対応する IP ネットワーク インターフェイス
•
GLBP ゲートウェイ ステータス
•
GLBP フォワーダ ステータス
getForwarderStatus
ネットワーク要素の指定された GLBP グループの GlbpForwarderStatus のリストを戻します。GlbpGroupSetting の InstanceNameId を指定すると、GlbpForwarderStatus のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpForwarderStatus のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpForwarderStatus に対応する GLBP グループ設定
getGlbpAuthenticationSetting
1 つまたは複数の GLBP グループに対応する GlbpAuthenticationSetting のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpAuthenticationSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpAuthenticationSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpAuthenticationSetting に対応する GLBP グループ設定
•
キー チェーン
getGlbpGatewayStatus
1 つまたは複数の GLBP グループに対応する GlbpGatewayStatus のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpGatewayStatus のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpGatewayStatus のリスト。
getGlbpGlobalSettting
GlbpGlobalSetting オブジェクトのリストを戻します。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:ネットワーク要素の InstanceNameId
戻り値
GlbpGlobalSetting オブジェクトのリスト。
getGlbpGroupIdsInNetworkInterface
IpNetworkInterface に設定されている GlbpGroupSetting の groupId のリストを戻します。
パラメータ
opContext:動作コンテキスト
ifInstanceNameIdCol:IpNetworkInterface の InstanceNameId
戻り値
GlbpGroupSetting のグループ ID のリスト
getGlbpGroupSetting
InstanceNameId のリストに対応する GlbpGroupSetting オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting に対応する InstanceNameId のリスト
戻り値
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpGroupSetting に対応する IP ネットワーク インターフェイス
•
GLBP ゲートウェイ ステータス
•
GLBP フォワーダ ステータス
getGlbpGroupSettingsInNetworkElement
ネットワーク要素に設定されている GLBP グループに対応する GlbpGroupSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameId:ネットワーク要素の InstanceNameId
戻り値
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpGroupSetting に対応する IP ネットワーク インターフェイス
•
GLBP ゲートウェイ ステータス
•
GLBP フォワーダ ステータス
getGlbpGroupSettingsInNetworkElements
ネットワーク要素の特定のリストに設定されている GLBP グループに対応する GlbpGroupSetting のリストのリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
neInstanceNameIdCol:ネットワーク要素の InstanceNameId のリスト
戻り値
GlbpGroupSetting オブジェクトのリストのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpGroupSetting に対応する IP ネットワーク インターフェイス
•
GLBP ゲートウェイ ステータス
•
GLBP フォワーダ ステータス
getGlbpGroupSettingsInNetworkInterface
IpNetworkInterface に設定されている GlbpGroupSetting の groupId のリストを戻します。
パラメータ
opContext:動作コンテキスト
ifInstanceNameIdCol:IpNetworkInterface の InstanceNameId
戻り値
インターフェイスに設定されている GroupSettings のリスト
getGlbpTimers
1 つまたは複数の GLBP グループに対応する GlbpTimers オブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpTimers のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpTimers オブジェクトのリスト
getGlbpVirtualForwarderSetting
ネットワーク要素の GLBP グループの GlbpForwarderSetting のリストを戻します。GlbpGroupSetting の InstanceNameId を指定すると、グループに対応する GlbpForwarderSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
注:
•
フォワーダ ID、フォワーダ プライオリティ、および ForwarderMacAddress は Cat-6k に設定できません。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpForwarderSetting のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
GlbpForwarderSetting に対応する GLBP グループ設定
getGlbpWeightingSetting
1 つまたは複数の GLBP グループに対応する GlbpWeightingSetting のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpWeightingSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpWeightingSetting オブジェクトのリスト。
getTrackedObjects
GLBP グループによって追跡されたオブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId を指定すると、GlbpGroupTracksNetworkInterface のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
戻り値
GlbpGroupTracksNetworkInterface オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
•
ObjectTrackingSetting は GlbpGroupTracksNetworkInterface を使用して取得できます。追跡されるネットワーク インターフェイスは、関連付けられた ObjectTrackingSetting から取得できます。
modifyAuthenticationSetting
1 つまたは複数の GlbpGroupSetting の GlbpAuthenticationSetting を変更します。また、KeyChain アソシエーションは GlbpAuthenticationSetting を使用して構築することもできます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
•
setting がヌルの場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
glbpTimers:GLBP グループに適用する GLBP 認証設定。
戻り値
void
modifyGlbpGroupSetting
1 つまたは複数のネットワーク要素の GlbpGroupSetting を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupSettingCol がヌルか空であるか、またはタイプ GlbpGroupSetting ではない場合。
•
既存の GlbpGroupSetting(データベースに存在)だけを変更できます。
•
GlbpGroupSetting の virtualIpAddress または secondaryIpAddress が次のものと競合する場合。
•
IpNetworkInterface の IpAddress。
•
他の GlbpGroupSetting の virtualIpAddress。
•
他の GlbpGroupSetting の secondaryIpAddress。
•
NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。
•
GlbpGroupSetting の groupName がデバイス内の他の GlbpGroupSettings の groupName と競合する場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupSettingCol のコレクションに、有効な GlbpGroupSetting アトリビュートがない場合。
例:
•
GlbpGroupSettting の glbpGroupName にスペースが含まれる場合。
パラメータ
opContext:動作コンテキスト
glbpGroupSettingCol:変更された GlbpGroupSetting オブジェクトのリスト。
戻り値
void
modifyTimers
1 つまたは複数の GlbpGroupSetting の GlbpTimers を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
•
glbpTimers がヌルの場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
glbpTimers:GLBP グループに適用する GLBP タイマー設定。
戻り値
void
modifyWeightingSetting
1 つまたは複数の GlbpGroupSetting の GlbpWeightingSetting を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
•
setting がヌルの場合。
パラメータ
opContext:動作コンテキスト
glbpSettingInstanceNameIdCol:GlbpGroupSetting の InstanceNameId のリスト
setting:GLBP グループに適用する GLBP 重み付け設定。
戻り値
void
removeGlbpGroupSetting
1 つまたは複数の IpNetworkInterface のすべての GlbpGroupSetting を削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
ifInstanceNameIdCol:IpNetworkInterface の InstanceNameId のリスト
戻り値
void
removeGlbpGroupSettingByGroupId
1 つまたは複数の NetworkInterface の GLBP グループ ID の GlbpGroupSetting を削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpGroupId がヌルの場合。
•
ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
•
ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpGroupId:GLBP グループ ID
ifInstanceNameIdCol:GLBP グループ設定を削除する必要がある IpNetworkInterface の InstanceNameId のリスト。
戻り値
void
unbindTrackingObjectsFromGlbpGroupSetting
追跡された指定オブジェクトから GLBP グループのバインドを解除し、追跡されたオブジェクトのステータスによってグループのステータスが影響されないようにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
•
glbpInstanceNameId が GlbpGroupSetting の有効な InstanceNameId ではない場合。
•
objectTrackingInstanceNameIdCol が ObjectTrackingSetting オブジェクトの有効な InstanceNameId ではない場合。
パラメータ
opContext:動作コンテキスト
glbpInstanceNameId:GlbpGroupSetting の InstanceNameId
objectTrackingInstanceNameIdCol:ObjectTrackingSetting の InstanceNameId のリスト。
戻り値
void