Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
HsrpApp サービス
HsrpApp サービス
発行日;2012/02/02 | 英語版ドキュメント(2011/07/18 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

HsrpApp サービス

HsrpApp サービスについて

addHsrpGroupSetting

bindTrackingObjectToHsrpGroupSetting

disableHsrpService

enableHsrpService

getHsrpAuthenticationSetting

getHsrpGlobalSetting

getHsrpGroupSetting

getHsrpGroupSettingsInNetworkElement

getHsrpRouterStatus

getHsrpTimers

getIpInterfaceWithHsrpSettings

getTrackingObject

modifyAuthenticationSetting

modifyHsrpGroupSetting

modifyHsrpTimers

modifyIpInterfaceWithHsrpSettings

removeHsrpGroupSetting

unbindTrackingObjectFromHsrpGroupSetting

HsrpApp サービス

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

HsrpApp サービスについて

Hot Standby Router プロトコル(HSRP; ホットスタンバイ ルータ プロトコル)により、最初のホップ IP ルータでの透過的なフェールオーバーが可能になります。このプロトコルを使用すると、実際の最初のホップ ルータに障害が発生しても、ホストは単一ルータを使用して接続性を維持できます。HSRP により、仮想 IP アドレスおよび仮想 MAC アドレスを共有して、グループ内にある 2 台以上のデバイスを一緒に稼動させ、架空の仮想ルータ サービスを提供できます。HSRP グループの(プライオリティが最も高い)ルータが(プライオリティに基づいて)アクティブなルータとして 1 つ選択され、もう 1 つのルータがスタンバイとして選択されます。残りのルータはリスニング モードになります。

API は次のカテゴリで定義されます。

1. Query/Get API:永続的なデータベースからデータを照会します。

2. Modify API:既存の HSRP グループ設定を変更します。

3. Remove API:デバイス内の 1 つまたは複数のインターフェイスから HSRP グループ設定の関連付けを解除します。

addHsrpGroupSetting

HSRP グループ設定を 1 つまたは複数の IpNetworkInterface に追加します。

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

ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

setting がヌルの場合。

HsrpGroupSetting の virtualIpAddress または secondaryIpAddress が次のものと競合する場合。

IpNetworkInterface の IpAddress。

他の HsrpGroupSetting の virtualIpAddress。

他の HsrpGroupSetting の secondaryIpAddress。

HsrpGroupSetting の groupName が、デバイス内の他の HsrpGroup 設定の groupName と競合する場合。

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

ifInstanceNameIdCol に、デバイスに存在するインターフェイスの複数の instanceNameId が含まれる場合。

1. virtualIpAddress がヌルではない場合。

2. groupName がヌルではない場合。

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

hsrpGroupSetting オブジェクト内に、有効な HsrpGroupSetting アトリビュートがない場合。

例:

1. HsrpGroupSetting の hsrpGroupName にスペースが含まれている。

パラメータ

opContext:動作コンテキスト

setting:1 つまたは複数の IpNetworkInterface に適用する必要があるパラメータを持つ HsrpGroupSetting

hni:1 つまたは複数の IpNetworkInterface に適用する必要があるパラメータを持つ HsrpNetworkInterfaceSetting

ifInstanceNameIdCol:1 つまたは複数の IpNetworkInterface の InstanceNameId のリスト

戻り値

HsrpGroupSetting のリスト

bindTrackingObjectToHsrpGroupSetting

既存の HsrpGroup をバインドし、新しいオブジェクトを追跡します。

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

hsrpInstanceNameId がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

objectTrackingInstanceNameId が ObjectTrackingSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

objectTrackingInstanceNameIdCol:ObjectTrackingSetting オブジェクトの InstanceNameId のリスト。

decrementValue:減少する値

戻り値

void

disableHsrpService

デバイス内で HsrpService をディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で hsrp がディセーブルになります。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:hsrp がディセーブルになっている AbstractNetworkElement の InstanceNameId のリスト

戻り値

void

enableHsrpService

デバイス内で HsrpService をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、これらの要素で hsrp がイネーブルになります。この API はデバイス内で「hsrp サービス」オプションをグローバルにイネーブルにするためのものです。

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

neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。

neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:AbstractNetworkElement の InstanceNameId のリスト

戻り値

void

getHsrpAuthenticationSetting

1 つまたは複数の HSRP グループに対応する HsrpAuthenticationSetting のリストを戻します。HsrpGroupSetting に対応する InstanceNameId のリストを指定すると、API は HSRP グループに対応する HsrpAuthenticationSetting のリストを戻します。

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

hsrpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpSettingInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpSettingInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

戻り値

HsrpAuthenticationSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

HsrpAuthenticationSetting に対応する HSRP グループ設定

キー チェーン

getHsrpGlobalSetting

(@link HsrpGlobalSetting)オブジェクトのリストを戻します。各(@link HsrpGlobalSetting)オブジェクトには、読み込み済みのブール アトリビュート hsrpServiceEnable があります。これは、HSRP サービスがこのデバイスでイネーブルであるかディセーブルであるかを示します。

パラメータ

opContext:動作コンテキスト

neInstanceNameIdCol:

戻り値

HsrpGlobalSetting オブジェクトのリスト。

getHsrpGroupSetting

InstanceNameId のリストに対応する HsrpGroupSetting オブジェクトのリストを戻します。

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

hsrpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpSettingInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpSettingInstanceNameIdCol:HsrpGroupSetting に対応する InstanceNameId のリスト

戻り値

すべての読み込み済みアソシエーションが含まれている HsrpGroupSetting オブジェクトのリスト。

getHsrpGroupSettingsInNetworkElement

ネットワーク要素で設定されている HSRP グループに対応する HsrpGroupSetting のリストを戻します。

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

neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

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

戻り値

HsrpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。

HsrpGroupSetting に対応する IP ネットワーク インターフェイス

HSRP ルータ ステータス

getHsrpRouterStatus

1 つまたは複数の HSRP グループに対応する HsrpRouterStatus のリストを戻します。HsrpGroupSetting に対応する InstanceNameId のリストを指定すると、API は HSRP グループに対応する HsrpRouterStatus のリストを戻します。

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

hsrpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpSettingInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpSettingInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

戻り値

HsrpRouterStatus のリスト。

getHsrpTimers

1 つまたは複数の HSRP グループに対応する HsrpTimersSetting オブジェクトのリストを戻します。HsrpGroupSetting に対応する InstanceNameId のリストを指定すると、API は HSRP グループに対応する HsrpTimersSetting のリストを戻します。

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

hsrpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpSettingInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpSettingInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

戻り値

HsrpTimersSetting オブジェクトのリスト

getIpInterfaceWithHsrpSettings

IpNetworkInterface のリストを戻します。IpNetworkInterface に対応する InstanceNameId のリストを指定すると、API は読み込み済み HsrpNetworkInterfaceSettingHSRP が含まれる IpNetworkInterface のリストを戻します。

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

ipInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

ipInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

ipInstanceNameIdCol:IpNetworkInterface の InstanceNameId のリスト

戻り値

IpNetworkInterface のリスト。

getTrackingObject

1 つまたは複数の HSRP グループに対応する HsrpGroupTracksObject のリストを戻します。HsrpGroupSetting に対応する InstanceNameId のリストを指定すると、API は HSRP グループに対応する HsrpGroupTracksObject のリストを戻します。

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

hsrpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpSettingInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

hsrpSettingInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

戻り値

HsrpGroupTracksObject のリスト。

modifyAuthenticationSetting

1 つまたは複数の HsrpGroupSetting の HsrpAuthenticationSetting を変更します。また、KeyChain アソシエーションを HsrpAuthenticationSetting によって構築できます。

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

hsrpInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

setting がヌルの場合。

パラメータ

opContext:動作コンテキスト

hsrpInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

setting:HSRP グループに適用する HSRP 認証設定。

戻り値

void

modifyHsrpGroupSetting

1 つまたは複数のネットワーク要素の HsrpGroupSetting を変更します。

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

hsrpGroupSettingCol がヌルか空であるか、またはタイプ HsrpGroupSetting ではない場合。

既存の HsrpGroupSettingcan(データベースに存在)だけを変更できます。

HsrpGroupSetting の virtualIpAddress または secondaryIpAddress が次と競合する場合。

1. IpNetworkInterface の IpAddress。

2. 他の HsrpGroupSetting の virtualIpAddress。

3. 他の HsrpGroupSetting の secondaryIpAddress。

HsrpGroupSetting の groupName がデバイス内の他の HsrpGroup 設定の groupName と競合する場合。

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

hsrpGroupSettingCol のコレクションに、有効な HsrpGroupSetting アトリビュートがない場合。

例:

1. HsrpGroupSetting の hsrpGroupName にスペースが含まれている。

パラメータ

opContext:動作コンテキスト

hsrpGroupSettingCol:変更された HsrpGroupSetting オブジェクトのリスト。

戻り値

HsrpGroupSetting のリスト

modifyHsrpTimers

1 つまたは複数の HsrpGroupSetting の HsrpTimersSetting を変更します。

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

hsrpInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

hsrpInstanceNameIdCol が HsrpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。

hsrpTimers がヌルの場合。

パラメータ

opContext:動作コンテキスト

hsrpInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

hsrpTimers:HSRP グループに適用する HSRP タイマー設定。

戻り値

更新された HsrpTimersSetting オブジェクトのリスト

modifyIpInterfaceWithHsrpSettings

IpNetworkInterface および HsrpNetworkInterfaceSettingobject に対応する InstanceNameId のリストを指定すると、API は IpNetworkInterface に関連付けられている HsrpNetworkInterfaceSetting を変更します。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

ipInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

ipInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:動作コンテキスト

ipInstanceNameIdCol:IpNetworkInterface の InstanceNameId のリスト

hni:1 つまたは複数の IpNetworkInterface に適用する必要があるパラメータを持つ HsrpNetworkInterfaceSetting

戻り値

void

removeHsrpGroupSetting

IpNetworkInterface の Hsrp グループの HsrppGroupSetting のリストを削除します。

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

hsrpGroupIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。

neInstanceNameId が有効な IpNetworkInterface オブジェクトではない場合。

パラメータ

opContext:動作コンテキスト

hsrpGroupIdCol:HsrpGroupSetting の InstanceNameId のリスト

ifInstanceNameId:IpNetworkInterface オブジェクトの InstanceNameId

戻り値

void

unbindTrackingObjectFromHsrpGroupSetting

指定された追跡対象オブジェクトから HSRP グループのバインドを解除し、追跡対象オブジェクトのステータスによってグループのステータスが影響を受けないようにします。

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

hsrpInstanceNameId が HsrpGroupSetting の有効な InstanceNameId ではない場合。

objectTrackingInstanceNameId が ObjectTrackingSetting オブジェクトの有効な InstanceNameId ではない場合。

パラメータ

opContext:

hsrpInstanceNameIdCol:HsrpGroupSetting の InstanceNameId のリスト

objectTrackingInstanceNameIdCol:ObjectTrackingSetting の InstanceNameId のリスト

戻り値

void