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

目次

ObjectGroupApp サービス

ObjectGroupApp サービスについて

createIPv4AddressGroups

createIPv6AddressGroups

createPortGroups

deleteIPv4AddressGroups

deleteIPv6AddressGroups

deletePortGroups

getAddressGroups

getAddrGrpsWithoutEntriesInNetworkElement

getIPv4AddressGroups

getIPv4AddrGrpsInNetworkElement

getIPv4AddrGrpsWithoutEntriesInNetworkElement

getIPv6AddressGroups

getIPv6AddrGrpsInNetworkElement

getIPv6AddrGrpsWithoutEntriesInNetworkElement

getPortGroups

getPortGroupsInNetworkElement

getPortGrpsWithoutEntriesInNetworkElement

modifyIPv4AddressGroups

modifyIPv6AddressGroups

modifyPortGroups

ObjectGroupApp サービス

この章では、DCNM Web サービスの、ObjectGroupApp サービスに対応する API メソッドについて説明します。この API は、Cisco NX-OS Release 5.0(3) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

ObjectGroupApp サービスについて

このインターフェイスは、ObjectGroupApp サービスによって公開されるすべての API を定義します。

createIPv4AddressGroups

ネットワーク要素で 1 つまたは複数の IPv4AddressGroup オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

ipv4AddressGroupCol がヌルであるか、コレクションが空である場合。

ipv4AddressGroupCol に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが IPv4AddressGroup ではないオブジェクトが含まれている場合。

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

ipv4AddressGroupCol コレクションで、すべての IPv4AddressGroup アトリビュートが無効であるか、IPv4AddressGroup 内の IPv4AddressGroupEntry が無効である場合。

パラメータ

opContext:動作コンテキスト。

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

ipv4AddressGroupCol:データベースで作成される(1 つまたは複数の)IPv4AddressGroup オブジェクトのコレクション。

戻り値

新たに作成される IPv4AddressGroup オブジェクトのリスト。

createIPv6AddressGroups

ネットワーク要素で 1 つまたは複数の IPv6AddressGroup オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

ipv6AddressGroupCol がヌルであるか、コレクションが空である場合。

ipv6AddressGroupCol に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが IPv6AddressGroup ではないオブジェクトが含まれている場合。

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

ipv6AddressGroupCol コレクションで、すべての IPv4AddressGroup アトリビュートが無効であるか、IPv4AddressGroup 内の IPv4AddressGroupEntry が無効である場合。

パラメータ

opContext:動作コンテキスト。

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

ipv6AddressGroupCol:データベースで作成される(1 つまたは複数の)IPv4AddressGroup オブジェクトのコレクション。

areaRtSumm:OspfAreaSetting コレクションに追加される OspfAreaRouteSummary オブジェクトのリスト。

戻り値

新たに作成される IPv6AddressGroup オブジェクトのリスト。

createPortGroups

ネットワーク要素で 1 つまたは複数の PortGroup オブジェクトを作成します。

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

neInstanceNameId がヌルの場合。

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

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

portGroupCol がヌルであるか、コレクションが空である場合。

portGroupCol に 1 つまたは複数のヌル要素が含まれているか、コレクションにタイプが PortGroup ではないオブジェクトが含まれている場合。

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

ipv6AddressGroupCol コレクションで、すべての IPv6AddressGroup アトリビュートが無効であるか、IPv6AddressGroup 内の IPv6AddressGroupEntry が無効である場合。

パラメータ

opContext:動作コンテキスト。

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

ipv6AddressGroupCol:データベースで作成される(1 つまたは複数の)IPv6AddressGroup オブジェクトのコレクション。

戻り値

新たに作成される IPv6AddressGroup オブジェクト。

deleteIPv4AddressGroups

1 つまたは複数の IPv4 アドレス グループ オブジェクトを削除します。

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

ipv4AddressGrpInstanceNameIdCol コレクションがヌル、または空の場合。

ipv4AddressGrpInstanceNameIdCol コレクションに、タイプが IPv4AddressGroup InstanceNameId ではない要素が含まれている場合。

ipv4AddressGrpInstanceNameIdCol コレクションに、データベースに存在しない IPv4AddressGroup が含まれている場合。

パラメータ

opContext:動作コンテキスト。

ipv4AddressGrpInstanceNameIdCol:削除する必要がある 1 つまたは複数の IPv4AddressGroup オブジェクトの InstanceNameId が含まれているコレクション。

戻り値

void

deleteIPv6AddressGroups

1 つまたは複数の IPv6 アドレス グループ オブジェクトを削除します。

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

ipv6AddressGrpInstanceNameIdCol コレクションがヌル、または空の場合。

ipv6AddressGrpInstanceNameIdCol コレクションに、タイプが IPv6AddressGroup InstanceNameId ではない要素が含まれている場合。

ipv6AddressGrpInstanceNameIdCol コレクションに、データベースに存在しない IPv4AddressGroup が含まれている場合。

パラメータ

opContext:動作コンテキスト。

ipv6AddressGrpInstanceNameIdCol:削除する必要がある 1 つまたは複数の IPv6AddressGroup オブジェクトの InstanceNameId が含まれているコレクション。

戻り値

新たに作成される IPv6AddressGroup オブジェクト。

deletePortGroups

1 つまたは複数のポート グループ オブジェクトを削除します。

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

ipv6AddressGrpInstanceNameIdCol コレクションがヌル、または空の場合。

ipv6AddressGrpInstanceNameIdCol コレクションに、タイプが IPv6AddressGroup InstanceNameId ではない要素が含まれている場合。

ipv6AddressGrpInstanceNameIdCol コレクションに、データベースに存在しない IPv4AddressGroup が含まれている場合。

パラメータ

opContext:動作コンテキスト。

ipv6AddressGrpInstanceNameIdCol:削除する必要がある 1 つまたは複数の IPv6AddressGroup オブジェクトの InstanceNameId が含まれているコレクション。

戻り値

void

getAddressGroups

InstanceNameIds から IPv4 および Ipv6 AddressGroups を戻します。

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

addrGrpInstanceNameIdCol がヌル、または空の場合。

addrGrpInstanceNameIdCol に、IPv4AddressGroup および IPv6AddressGroup の無効な InstanceNameId またはヌル値が含まれている場合。

addrGrpInstanceNameIdCol に特定の InstanceNameId がある同等の IPv4 AddressGroup オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

addrGrpInstanceNameIdCol:IPv4AddressGroup および IPv6AddressGroup の InstanceNameId のコレクション。

戻り値

InstanceNameId の特定のコレクションに対応する IPv4AddressGroup および IPv6AddressGroupobjects のリスト。戻される IPv4 および Ipv6 アドレス グループ オブジェクト リストには、次のアソシエーションだけが存在します。

戻されるアドレス グループ オブジェクトの関連するすべてのアドレス グループ エントリ。

IPv4AddressGroupEntry および IPv6AddressGroup 内のすべてのエントリ(存在する場合)の ExtendedAccessControlList アソシエーション。

getAddrGrpsWithoutEntriesInNetworkElement

ネットワーク要素で設定されているすべての IPv4 および IPv6 アドレス グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

IPv4AddressGroup および IPv6AddressGroup オブジェクトのリスト。

getIPv4AddressGroups

InstanceNameIds から IPv4 AddressGroups を戻します。

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

ipv4addrGrpInstanceNameIdCol がヌル、または空の場合。

ipv4addrGrpInstanceNameIdCol に、IPv4AddressGroup の無効な InstanceNameId またはヌル値が 含まれている場合。

ipv4addrGrpInstanceNameIdCol に特定の InstanceNameId がある同等の IPv4 AddressGroup オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

ipv4addrGrpInstanceNameIdCol:IPv4AddressGroup の InstanceNameId のコレクション。

戻り値

InstanceNameId の特定のコレクションに対応する IPv4AddressGroupobjects のリスト。戻される IPv4 アドレス グループ オブジェクト リストには、次のアソシエーションだけが存在します。

戻されるアドレス グループ オブジェクトの関連するすべてのアドレス グループ エントリ。

IPv4AddressGroupEntry 内のすべてのエントリ(存在する場合)の ExtendedAccessControlList アソシエーション。

getIPv4AddrGrpsInNetworkElement

ネットワーク要素で設定されているすべての IPv4Address グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

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

getIPv4AddrGrpsWithoutEntriesInNetworkElement

ネットワーク要素で設定されているすべての IPv4 アドレス グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

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

getIPv6AddressGroups

InstanceNameIds から IPv6 AddressGroups を戻します。

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

ipv6addrGrpInstanceNameIdCol がヌル、または空の場合。

ipv6addrGrpInstanceNameIdCol に、IPv4AddressGroup の無効な InstanceNameId またはヌル値が 含まれている場合。

ipv6addrGrpInstanceNameIdCol に特定の InstanceNameId がある同等の IPv6 AddressGroup オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

ipv6addrGrpInstanceNameIdCol:IPv6AddressGroup の InstanceNameId のコレクション。

戻り値

InstanceNameId の特定のコレクションに対応する IPv6AddressGroupobjects のリスト。戻される IPv6 アドレス グループ オブジェクト リストには、次のアソシエーションだけが存在します。

戻されるアドレス グループ オブジェクトの関連するすべてのアドレス グループ エントリ。

IPv6AddressGroupEntry 内のすべてのエントリ(存在する場合)の ExtendedAccessControlList アソシエーション。

getIPv6AddrGrpsInNetworkElement

ネットワーク要素で設定されているすべての IPv6 アドレス グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

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

getIPv6AddrGrpsWithoutEntriesInNetworkElement

ネットワーク要素で設定されているすべての IPv6 アドレス グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

IPv6AddressGroup オブジェクトのリスト。戻されたオブジェクト リストでは、すべてのアソシエーションがクリアされます。戻されるアドレス グループは、名前アドレス グループで順序付けられます。

getPortGroups

InstanceNameIds から PortGroups を戻します。

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

addrGrpInstanceNameIdCol がヌル、または空の場合。

portGrpInstanceNameIdCol に、PortGroup の無効な InstanceNameId またはヌル値が含まれている場合。

addrGrpInstanceNameIdCol に特定の InstanceNameId がある同等の IPv4 AddressGroup オブジェクトがない場合。

パラメータ

opContext:動作コンテキスト。

portGrpInstanceNameIdCol:PortGroup の InstanceNameId のコレクション。

戻り値

InstanceNameId の特定のコレクションに対応する PortGroup オブジェクトのリスト。

getPortGroupsInNetworkElement

ネットワーク要素で設定されている IPv4 および IPv6 のすべてのポート グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

戻り値

PortGroup オブジェクトのリスト。戻されるオブジェクト リストには次のすべてのアソシエーションがあります。

PortGroup オブジェクト内の関連するすべての PortGroupEntries(存在する場合)。

PortGroup の関連するすべての ExtendedAccessControlList および PortGroup オブジェクトの関連するすべての Ipv6AccessControlList。

getPortGrpsWithoutEntriesInNetworkElement

ネットワーク要素で設定されている IPv4 および IPv6 のすべてのポート グループを戻します。

InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。

パラメータ

opContext:動作コンテキスト。

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

戻り値

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

modifyIPv4AddressGroups

1 つまたは複数の既存の IPv4AddressGroup オブジェクトを変更します。

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

ipv4AddressGroupCol コレクションがヌル、または空の場合。

ipv4AddressGroupCol コレクションに、タイプが IPv4AddressGroup ではないオブジェクトが含まれている場合。

ipv4AddressGroupCol コレクションに、データベースに存在しない IPv4AddressGroup が含まれている場合。

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

ipv4AddressGroupCol コレクションで、IPv4AddressGroup のいずれかのアトリビュートが無効であるか、IPv4 アドレス グループ内のいずれかの IPv4AddressGroup が無効である場合。

パラメータ

opContext:動作コンテキスト。

ipv4AddressGroupCol:データベースで既存の IPv4AddressGroup オブジェクトを置き換える IPv4AddressGroup オブジェクトのコレクション。

戻り値

void

modifyIPv6AddressGroups

1 つまたは複数の既存の IPv6AddressGroup オブジェクトを変更します。

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

ipv6AddressGroupCol コレクションがヌル、または空の場合。

ipv6AddressGroupCol コレクションに、タイプが IPv6AddressGroup ではないオブジェクトが含まれている場合。

ipv6AddressGroupCol コレクションに、データベースに存在しない IPv6AddressGroup が含まれている場合。

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

ipv6AddressGroupCol コレクションで、IPv6AddressGroup のいずれかのアトリビュートが無効であるか、IPv6Address グループ内のいずれかの IPv6AddressGroupEntry が無効である場合。

パラメータ

opContext:動作コンテキスト。

ipv6AddressGroupCol:データベースで既存の IPv6AddressGroup オブジェクトを置き換える IPv6AddressGroup オブジェクトのコレクション。

戻り値

void

modifyPortGroups

1 つまたは複数の既存の PortGroup オブジェクトを変更します。

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

portGroupCol コレクションがヌル、または空の場合。

portGroupCol コレクションに、タイプが PortGroup ではないオブジェクトが含まれている場合。

portGroupCol コレクションに、データベースに存在しない PortGroup が含まれている場合。

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

portGroupCol コレクションで、PortGroup のいずれかのアトリビュートが無効であるか、ポート グループ内のいずれかの PortGroupEntry が無効である場合。

パラメータ

opContext:動作コンテキスト。

portGroupCol:データベースで既存の PortGroup オブジェクトを置き換える(1 つまたは複数の)PortGroup オブジェクトのコレクション。

戻り値

void