- はじめに
- 概要
- AaaApp サービス
- AclApp サービス
- ClusterApp サービス
- CollectorApp サービス
- CollectorExtendedApp サービス
- ConfigTemplateApp サービス
- ConfigArchiveApp サービス
- ConfigDeliveryApp サービス
- DaiApp サービス
- DataPurgingApp サービス
- DeviceGroupApp サービス
- DeviceListApp サービス
- DhcpSnoopingApp サービス
- Dot1xApp サービス
- EtherChannelApp サービス
- EventApp サービス
- FabricPathResourcesApp サービス
- FabricPathTopologyApp サービス
- FcApp サービス
- FcoeApp サービス
- FeatureSetApp サービス
- FexApp サービス
- FipSnoopingApp サービス
- GlbpApp サービス
- HsrpApp サービス
- IgmpSnoopingApp サービス
- ImageInstallApp サービス
- InterfacesApp サービス
- InventoryApp サービス
- IpSourceGuardApp サービス
- KeyChainApp サービス
- Interface L2IsisApp サービス
- LicensingApp サービス
- LogApp サービス
- LstApp サービス
- NacLpIpApp サービス
- ObjectGroupApp サービス
- ObjectTrackingApp サービス
- PollerApp サービス
- PortProfileApp サービス
- PortSecurityApp サービス
- RbacApp サービス
- RepositoryApp サービス
- SecurityApp サービス
- ServerAdminApp サービス
- ServerApp サービス
- SoftwareApp サービス
- SpanApp サービス
- StpApp サービス
- SvsConnectionApp サービス
- SvsDomainApp サービス
- ThresholdActionApp サービス
- TrafficStormControlApp サービス
- TunnelApp サービス
- UserApp サービス
- VdcApp サービス
- VlanApp サービス
- VpcApp サービス
- VrfApp サービス
Cisco DCNM Web サービス API ガイド リリース 5.1(1a)
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年8月2日
章のタイトル： GlbpApp サービス
- GlbpApp サービスについて
- addGlbpGroupSetting
- bindTrackingObjectsToGlbpGroupSetting
- createGlbpGroupSettings
- disableService
- enableService
- getActiveTimers
- getAllGlbpGroupSettings
- getAllGlbpGroupsInNetwork
- getForwarderStatus
- getGlbpAuthenticationSetting
- getGlbpGatewayStatus
- getGlbpGlobalSettting
- getGlbpGroupIdsInNetworkInterface
- getGlbpGroupSetting
- getGlbpGroupSettingsInNetworkElement
- getGlbpGroupSettingsInNetworkElements
- getGlbpGroupSettingsInNetworkInterface
- getGlbpTimers
- getGlbpVirtualForwarderSetting
- getGlbpWeightingSetting
- getTrackedObjects
- modifyAuthenticationSetting
- modifyGlbpGroupSetting
- modifyTimers
- modifyWeightingSetting
- removeGlbpGroupSetting
- removeGlbpGroupSettingByGroupId
- unbindTrackingObjectsFromGlbpGroupSetting
GlbpApp サービス
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 ではない場合。
1. GlbpGroupSetting の virtualIpAddress または secondaryIpAddress が次のものと競合する場合。
– IpNetworkInterface の IpAddress。
– 他の GlbpGroupSetting の virtualIpAddress。
– 他の GlbpGroupSetting の secondaryIpAddress。
– NetworkInterface が Voice VLAN がイネーブルになっているインターフェイス。
2. GlbpGroupSetting の groupName がデバイス内の他の GlbpGroupSettings の groupName と競合する場合。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• ifInstanceNameIdCol に、デバイスに存在するインターフェイスの複数の instanceNameId が含まれる場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• glbpGroupSettingCol のコレクションに、有効な GlbpGroupSetting アトリビュートがない場合。
• GlbpGroupSettting の glbpGroupName にスペースが含まれる場合。
setting：1 つまたは複数の IpNetworkInterface に適用する必要があるパラメータを持つ GlbpGroupSetting
ifInstanceNameIdCol：1 つまたは複数の IpNetworkInterface の InstanceNameId のリスト
bindTrackingObjectsToGlbpGroupSetting
既存の GlbpGroup をバインドし、新しいオブジェクトを追跡します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
objectTrackingSetting：ObjectTrackingSetting オブジェクト。
glbpInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
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 にスペースが含まれる場合。
disableService
デバイス内の GlbpService をディセーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、GLBP はこれらの要素でディセーブルになります。ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
• neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
neInstanceNameIdCol：GLBP がディセーブルになっている AbstractNetworkElement の InstanceNameId のリスト
enableService
デバイス内の GlbpService をイネーブルにします。1 つまたは複数のネットワーク要素のインスタンス名 ID を指定すると、GLBP はこれらの要素でイネーブルになります。この API は、デバイスで「GLBP サービス」オプションをグローバルにイネーブルにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIdCol がヌルまたは空の場合、あるいはタイプ InstanceNameId ではない場合。
• neInstanceNameIdCol が有効な AbstractNetworkElement の InstanceNameId ではない場合。
neInstanceNameIdCol：AbstractNetworkElement の InstanceNameId のリスト
getActiveTimers
1 つまたは複数の GLBP グループに対応する ActiveTimers オブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する ActiveTimers のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
getAllGlbpGroupSettings
すべての管理対象ネットワーク要素に設定されている GLBP グループに対応する GlbpGroupSetting のリストを戻します。
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getAllGlbpGroupsInNetwork
ネットワークに設定されているすべての GLBP グループを戻します。GlbpGroup のリストを戻します。GlbpGroup には、GLBP グループ ID および GLBP グループ メンバーに対応する GlbpGroupSetting のコレクションが含まれます。
GlbpGroup のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getForwarderStatus
ネットワーク要素の指定された GLBP グループの GlbpForwarderStatus のリストを戻します。GlbpGroupSetting の InstanceNameId を指定すると、GlbpForwarderStatus のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
GlbpForwarderStatus のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpAuthenticationSetting
1 つまたは複数の GLBP グループに対応する GlbpAuthenticationSetting のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpAuthenticationSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
GlbpAuthenticationSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpGatewayStatus
1 つまたは複数の GLBP グループに対応する GlbpGatewayStatus のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpGatewayStatus のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
getGlbpGlobalSettting
GlbpGlobalSetting オブジェクトのリストを戻します。
getGlbpGroupIdsInNetworkInterface
IpNetworkInterface に設定されている GlbpGroupSetting の groupId のリストを戻します。
getGlbpGroupSetting
InstanceNameId のリストに対応する GlbpGroupSetting オブジェクトのリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting に対応する InstanceNameId のリスト
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpGroupSettingsInNetworkElement
ネットワーク要素に設定されている GLBP グループに対応する GlbpGroupSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。
neInstanceNameId：ネットワーク要素の InstanceNameId
GlbpGroupSetting オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpGroupSettingsInNetworkElements
ネットワーク要素の特定のリストに設定されている GLBP グループに対応する GlbpGroupSetting のリストのリストを戻します。このメソッドは、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合、またはネットワーク要素の有効な InstanceNameId ではない場合。
neInstanceNameIdCol：ネットワーク要素の InstanceNameId のリスト
GlbpGroupSetting オブジェクトのリストのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpGroupSettingsInNetworkInterface
IpNetworkInterface に設定されている GlbpGroupSetting の groupId のリストを戻します。
getGlbpTimers
1 つまたは複数の GLBP グループに対応する GlbpTimers オブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpTimers のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
getGlbpVirtualForwarderSetting
ネットワーク要素の GLBP グループの GlbpForwarderSetting のリストを戻します。GlbpGroupSetting の InstanceNameId を指定すると、グループに対応する GlbpForwarderSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
• フォワーダ ID、フォワーダ プライオリティ、および ForwarderMacAddress は Cat-6k に設定できません。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
GlbpForwarderSetting のリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
getGlbpWeightingSetting
1 つまたは複数の GLBP グループに対応する GlbpWeightingSetting のリストを戻します。GlbpGroupSetting に対応する InstanceNameId のリストを指定すると、API は GLBP グループに対応する GlbpWeightingSetting のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
getTrackedObjects
GLBP グループによって追跡されたオブジェクトのリストを戻します。GlbpGroupSetting に対応する InstanceNameId を指定すると、GlbpGroupTracksNetworkInterface のリストを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
GlbpGroupTracksNetworkInterface オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• ObjectTrackingSetting は GlbpGroupTracksNetworkInterface を使用して取得できます。追跡されるネットワーク インターフェイスは、関連付けられた ObjectTrackingSetting から取得できます。
modifyAuthenticationSetting
1 つまたは複数の GlbpGroupSetting の GlbpAuthenticationSetting を変更します。また、KeyChain アソシエーションは GlbpAuthenticationSetting を使用して構築することもできます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
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 にスペースが含まれる場合。
modifyTimers
1 つまたは複数の GlbpGroupSetting の GlbpTimers を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
modifyWeightingSetting
1 つまたは複数の GlbpGroupSetting の GlbpWeightingSetting を変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpSettingInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• glbpSettingInstanceNameIdCol が GlbpGroupSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpSettingInstanceNameIdCol：GlbpGroupSetting の InstanceNameId のリスト
removeGlbpGroupSetting
1 つまたは複数の IpNetworkInterface のすべての GlbpGroupSetting を削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
ifInstanceNameIdCol：IpNetworkInterface の InstanceNameId のリスト
removeGlbpGroupSettingByGroupId
1 つまたは複数の NetworkInterface の GLBP グループ ID の GlbpGroupSetting を削除します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ifInstanceNameIdCol がヌルか空であるか、またはタイプ InstanceNameId ではない場合。
• ifInstanceNameIdCol が IpNetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
ifInstanceNameIdCol：GLBP グループ設定を削除する必要がある IpNetworkInterface の InstanceNameId のリスト。
unbindTrackingObjectsFromGlbpGroupSetting
追跡された指定オブジェクトから GLBP グループのバインドを解除し、追跡されたオブジェクトのステータスによってグループのステータスが影響されないようにします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• glbpInstanceNameId が GlbpGroupSetting の有効な InstanceNameId ではない場合。
• objectTrackingInstanceNameIdCol が ObjectTrackingSetting オブジェクトの有効な InstanceNameId ではない場合。
glbpInstanceNameId：GlbpGroupSetting の InstanceNameId
objectTrackingInstanceNameIdCol：ObjectTrackingSetting の InstanceNameId のリスト。
フィードバック