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

目次

PortProfileApp サービス

PortProfileApp サービスについて

bindInterfacesWithPortProfile

bindPortProfileWithBasePortProfile

createPortProfile

createPortProfileForNetworkElements

disablePortProfiles

deletePortProfiles

enablePortProfiles

getPortProfiles

getPortProfilesWithInheritedPorts

getPortProfilesWithInterfaceCount

getPortProfilesByTypeInNetworkElements

getPortProfilesInNetworkElements

modifyPortProfiles

modifyProfileModeToRouted

modifyProfileModeToSwitched

modifySwitchPortMode

unbindInterfacesWithPortProfile

unbindPortProfileWithBasePortProfile

PortProfileApp サービス

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

PortProfileApp サービスについて

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

PortProfileApp サービスを使用すると、繰り返されるインターフェイス設定をまとめて、インターフェイス範囲に適用できます。ポート プロファイルの設定後に、設定をインターフェイスまたはインターフェイスの範囲に継承できます。

API カテゴリは次のとおりです。

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

Create API:新しいポート プロファイルを作成します。

Modify API:既存のポート プロファイルの基本アトリビュート。

Delete API:既存のポート プロファイルを削除します。

bindInterfacesWithPortProfile

インスタンスのリストを、同じデバイスに存在する 1 つの PortProfile インスタンスに関連付けます。

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

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

niInstanceNameIds に無効な NetworkInterface InstanceNameId またはヌル値が含まれている場合。

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

niInstanceNameIds に特定の InstanceNameId があるすべての NetworkInterface オブジェクトが同じ AbstractNetworkElement に属していない場合。

PortProfile インスタンスの InstanceNameId がヌルまたは無効である場合。

profileInstanceNameId 内のいずれかの PortProfile インスタンスに対応する InstanceNameId が同じデバイスに属していない場合。

プロファイルおよびインターフェイス タイプが Nexus-7000 で同じではない場合。

プロファイルがインターフェイスを継承する場合、およびインターフェイス PortCapability で、プロファイルで実際に設定される特定の設定 PortSetting を行うことが許可されない場合。たとえば、プロファイルが速度を 10000 に設定し、プロファイルがイネーブル状態になっている場合。そのため、このプロファイルが 1 Gig インターフェイスによって継承される場合は、デバイスは例外をスローします。

パラメータ

opContext:現在の動作コンテキスト

niInstanceNameIds:プロファイルに関連付ける必要があるネットワーク インターフェイスの InstanceNameId のリスト。

profileInstanceNameId:PortProfile インスタンスの InstanceNameId。

戻り値

void

bindPortProfileWithBasePortProfile

PortProfile インスタンスを同じデバイス内の PortProfile インスタンスのリストに親として関連付けます。

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

baseProfileInstanceNameId がヌルであるか、無効である場合。

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

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

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

subProfileInstanceNameIds 内の各 PortProfile インスタンスに対応する InstanceNameId が、baseProfileInstanceNameId と同じデバイス属していない場合。

プロファイル タイプが Nexus-7000 で同じではない場合。

パラメータ

opContext:現在の動作コンテキスト。

baseProfileInstanceNameId:PortProfile インスタンスの InstanceNameId。

subProfileInstanceNameIds:PortProfile インスタンスの InstanceNameId のリスト。

戻り値

void

createPortProfile

それぞれのネットワーク要素で PortProfile オブジェクトを作成します。

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

渡された引数が profileInstanceNameIds でヌルであるか、有効なポート プロファイル InstanceNameId ではない場合。

プロファイルの名前が 80 文字を超える場合。

パラメータ

opContext:現在の動作コンテキスト

neInstanceNameIdCol:ネットワーク要素のインスタンス名 ID のリスト。

profiles:作成する必要がある PortProfile オブジェクトのリスト。

戻り値

新たに作成されたポート プロファイル オブジェクトのインスタンス名 ID。

createPortProfileForNetworkElements

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

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

渡された引数が neInstanceNameIdCol でヌルであるか、有効なネットワーク要素 InstanceNameId ではない場合。

渡された引数がプロファイルでヌルである場合。

プロファイルの名前が 80 文字を超える場合。

IntegrityException は、PortProfile がデータベースにすでに存在するときにスローされます。

パラメータ

opContext:現在の動作コンテキスト。

neInstanceNameIdCol:ネットワーク要素のインスタンス名 ID のリスト。

profiles:作成する必要がある PortProfile オブジェクトのリスト。

戻り値

新たに作成されたポート プロファイル オブジェクトのインスタンス名 ID。

disablePortProfiles

特定のプロファイル InstanceNameIds の PortProfile の状態をディセーブルにします。

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

渡された引数がヌルの場合。

profileInstanceNameIds コレクションが空であるか、有効なポート プロファイル InstanceNameId ではないオブジェクトがコレクションに含まれている場合。

パラメータ

opContext:現在の動作コンテキスト。

profileInstanceNameIds:ポート プロファイルに対応する InstanceNameId のリスト。

戻り値

void

deletePortProfiles

1 つまたは複数の既存のポート プロファイル オブジェクトを削除します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

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

渡された引数がヌルの場合。

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

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

削除するプロファイルが他のプロファイル インスタンスによって継承されるか、他のインターフェイスによって継承される場合。

パラメータ

opContext:現在の動作コンテキスト。

portProfileIds:PortProfile オブジェクトのインスタンス名 ID のリスト。

deleteChildProfiles:すべての子プロファイルをその子とともに削除するには、TRUE を設定します。

戻り値

void

enablePortProfiles

特定のプロファイル InstanceNameIds の PortProfile の状態をイネーブルにします。

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

渡された引数がヌルの場合。

profileInstanceNameIds コレクションが空であるか、有効なポート プロファイル InstanceNameId ではないオブジェクトがコレクションに含まれている場合。

プロファイルがインターフェイスを継承する場合、およびインターフェイス PortCapability で、プロファイルで実際に設定される特定の設定 PortSetting を行うことが許可されない場合。たとえば、プロファイルが速度を 10000 に設定し、このプロファイルが 1 Gig インターフェイスによって継承される場合は、プロファイル状態をイネーブルにすると、デバイスは例外をスローします。

パラメータ

opContext:現在の動作コンテキスト。

profileInstanceNameIds:ポート プロファイルに対応する InstanceNameId のリスト。

戻り値

void

getPortProfiles

ポート プロファイル オブジェクトのコレクションを戻します。

ValidationException は、渡された引数が profileInstanceNameIds でヌルであるか、有効なポート プロファイル InstanceNameId ではないときにスローされます。

パラメータ

opContext:現在の動作コンテキスト

profileInstanceNameIds:ポート プロファイルに対応する InstanceNameId のリスト

戻り値

デバイスに存在する PortProfile インスタンスのリスト。戻されるオブジェクト リストでは、次のアソシエーションだけが使用可能です。

NetworkInterfaceName

PortSetting

PortCapability

BasePortProfileRef

継承されるネットワーク インターフェイス リンクのコレクション。

getPortProfilesWithInheritedPorts

継承されるインターフェイス インスタンスとともにポート プロファイル オブジェクトのコレクションを戻します。ポート プロファイルのインスタンス名 ID を指定すると、それぞれポート プロファイル オブジェクトのコレクションを戻します。インターフェイスがプロファイルに関連付けられていない場合は、アソシエーションなしでポート プロファイル インスタンスだけを戻します。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

ValidationException は、渡された引数が profileInstanceNameIds でヌルであるか、有効なポート プロファイル InstanceNameId ではないときにスローされます。.

パラメータ

opContext:現在の動作コンテキスト

profileInstanceNameIds:ポート プロファイルに対応する InstanceNameId のリスト

戻り値

デバイスに存在する PortProfile インスタンスのリスト。戻されるオブジェクト リストでは、次のアソシエーションだけが使用可能で、その他のアソシエーションはすべてクリアされます。

NetworkInterfaceName

継承されるネットワーク インターフェイス リンクのコレクション。

getPortProfilesWithInterfaceCount

ネットワーク要素に存在するポート プロファイル オブジェクトのコレクションおよび継承されるインターフェイス カウントを戻します。ネットワーク要素のインスタンス名 ID のリストを指定すると、それぞれポート プロファイル オブジェクトのコレクションが含まれているリストを戻します。ポート プロファイル インスタンスには、PortSetting 参照が読み込まれます。プロファイルの設定の場合のデフォルトはないため、ポート プロファイルに何も設定されていないときはヌルになることがあります。また、プロファイルにはポート プロファイル機能が読み込まれます。インターフェイスがプロファイルと関連付けられていない場合は、そのタイプのプロファイルで可能な機能をすべて戻します。neInstanceNameIdCol がヌルの場合は、検出されたすべてのデバイスで PortProfile が戻されます。このメソッドは、Cisco NX-OS Release 5.1(1) 以降を実行する Cisco Nexus 7000 シリーズ スイッチで使用可能です。

ValidationException は、渡された引数が profileInstanceNameIds でヌルであるか、有効なポート プロファイル InstanceNameId ではないときにスローされます。

パラメータ

opContext:現在の動作コンテキスト

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId のリスト

戻り値

デバイスに存在する PortProfile が含まれているペアのリストと継承されるインターフェイス カウント。戻される PortProfile オブジェクト リストでは、次のアソシエーションだけが使用可能で、その他のアソシエーションはすべてクリアされます。

NetworkInterfaceName

PortSetting

PortCapability

getPortProfilesByTypeInNetworkElements

ネットワーク要素に存在するタイプ PortProfileType のポート プロファイル オブジェクトのコレクションを戻します。

ValidationException は、渡された引数が neInstanceNameIdCol でヌルであるか、有効なネットワーク要素 InstanceNameId ではないときにスローされます。

パラメータ

opContext:現在の動作コンテキスト

profileType:取得する必要があるプロファイルのタイプを指します。

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId のリスト。

戻り値

デバイスに存在する PortProfile インスタンスのリスト。戻されるオブジェクト リストでは、次のアソシエーションだけが使用可能です。

NetworkInterfaceName

PortSetting

PortCapability

BasePortProfileRef

継承されるネットワーク インターフェイス リンクのコレクション。

getPortProfilesInNetworkElements

ネットワーク要素に存在するポート プロファイル オブジェクトのコレクションを戻します。

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

パラメータ

opContext:現在の動作コンテキスト

neInstanceNameIdCol:ネットワーク要素に対応する InstanceNameId のリスト。

戻り値

デバイスに存在する PortProfile インスタンスのリスト。戻されるオブジェクト リストでは、次のアソシエーションだけが使用可能です。

NetworkInterfaceName

PortSetting

PortCapability

BasePortProfileRef

継承されるネットワーク インターフェイス リンクのコレクション。

modifyPortProfiles

1 つまたは複数のポート プロファイル オブジェクトを変更します。

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

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

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

modifiedProfileCol に、AbstractNetworkElement アソシエーションなしの PortProfile オブジェクトが 1 つまたは複数含まれている場合。

パラメータ

opContext:現在の動作コンテキスト

modifiedProfileCol:変更される PortProfile インスタンスのリスト。

戻り値

void

modifyProfileModeToRouted

特定のポート プロファイルで、ポート モードをスイッチドからルーテッドに変更します。

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

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

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

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

パラメータ

opContext:現在の動作コンテキスト

switchedProfileNameIdCol:スイッチ プロファイルのインスタンス名 ID のリスト。

戻り値

新規ルーテッド ポートのリスト。

modifyProfileModeToSwitched

特定のポート プロファイルで、ポート モードをルーテッドからスイッチドに変更します。

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

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

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

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

パラメータ

opContext:現在の動作コンテキスト。

routedProfileNameIdCol:ルーテッド ポートのインスタンス名 ID のリスト。

switchProfileMode:スイッチポート モード。

trunkMode:トランク ポート モード。このモードに基づいて、トランクのカプセル化と非ネゴシエーションは対応するデフォルトに設定されます。

戻り値

新たに作成されたスイッチ プロファイルのリスト。

modifySwitchPortMode

特定のスイッチ プロファイル リストでスイッチ ポート モードを変更します。

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

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

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

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

パラメータ

opContext:現在の動作コンテキスト

switchedProfileNameIdCol:スイッチ プロファイルのインスタンス名 ID のリスト

switchProfileMode:新規のスイッチポート モード

trunkMode:トランク ポート モード。これは、モードをトランク モードに変更する場合に限り適用できます。このモード セットに基づいて、トランクのカプセル化と非ネゴシエーションは対応するデフォルトに設定されます。

戻り値

void

unbindInterfacesWithPortProfile

同じデバイスに存在する PortProfile インスタンスに関連付けられたインスタンスの関連付けを解除します。ValidationException は、次のいずれかの状況が発生した場合にスローされます。

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

niInstanceNameIds に無効な NetworkInterface InstanceNameId またはヌル値が含まれている場合。

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

パラメータ

opContext:現在の動作コンテキスト

niInstanceNameIds:プロファイルへの関連付けを解除する必要があるネットワーク インターフェイスの InstanceNameId のリスト。

戻り値

void

unbindPortProfileWithBasePortProfile

同じデバイスに存在する PortProfile インスタンスに親として関連付けられた PortProfile インスタンスの関連付けを解除します。

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

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

subProfileInstanceNameIds に無効な PortProfile InstanceNameId またはヌル値が含まれている場合。

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

パラメータ

opContext:現在の動作コンテキスト

subProfileInstanceNameIds:親プロファイルから関連付けを解除する必要があるポート プロファイルの InstanceNameId のリスト。

戻り値

void