Cisco MDS 9000 Family Fabric Manager コンフィ ギュレーション ガイド 、Release 4.x
Fabric Manager Web Service
Fabric Manager Web Service
発行日;2012/01/30 | 英語版ドキュメント(2009/03/02 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 42MB) | フィードバック

目次

Fabric Manager Web Service

Fabric Manager Web Service の概要

Web Service の仕様

XML

SOAP

HTTP/HTTPS

WSDL

Logon Service

requestToken

validateToken

認証またはトークン

IdentityManager

San Service

サービス エンドポイント インターフェイス(SEI)

メソッド

getFabrics

getFabricByIP

getFabricByKey

getFabricBySwitchKey

getSwitchesByFabric

getSwitch

getSwitchByKey

getSwitchIPByName

getSwitchIPByKey

getNeighborSwitches

getVsans

getVsan

getIsls

discoverFabric

manageFabric

unManageFabric

closeFabric

purgeFabric

getEndports

getEnclosures

getEndPortByFWwn

getEndPortByKey

getEndPortAttachedToSw

getEnclosureByName

getEnclosureByKey

getEnclosureByPWwn

updateEnclosure

updateEndportEnclosure

getHosts

getHost

getHostByFabric

getStorages

getStorageByFabric

getHostPorts

エラー コード

Fabric Manager Web Service

この章では、Fabric Manager Web Service(FMWS)Application Program Interface(API)について説明します。この章の内容は、次のとおりです。

「Fabric Manager Web Service の概要」

「Web Service の仕様」

「Logon Service」

「San Service」

「サービス エンドポイント インターフェイス(SEI)」

「メソッド」

「エラー コード」

Fabric Manager Web Service の概要

Cisco Fabric Manager Web Service(FMWS)を使用すると、サードパーティ ベンダーから、Fabric Manager コア ソフトウェアの機能にリモート プロシージャ コールとしてアクセスできます。Web サービスによってワールドワイド ウェブ インフラストラクチャが拡張され、ソフトウェアから他のソフトウェア アプリケーションに接続することができるようになります。アプリケーションは、HTTP、HTTPS、XML、SOAP など、さまざまなプロトコルおよびデータ フォーマットを使用して、Web サービスにアクセスします。Web サービスでは、コンポーネントベース開発の利点と Web の利点が一体化されます。Fabric Manager は企業レベルのアプリケーションとなり、他のソフトウェア プラットフォームとの相互運用が実現します。

この章では、Fabric Manager Web Service 機能で公開されている API を定義します。

Web Service の仕様

Web Service の仕様は、セキュリティ、通信、およびデータを表現する構文について、相互運用可能なプロトコルを提供するよう構成されています。

XML

XML は、メッセージの構造を定義するデータ フォーマットです。XML Web サービス アーキテクチャを利用すると、さまざまなプラットフォームで異なる言語を使用して記述されたプログラムが、標準ベースの方式で相互に通信できるようになります。XML Web サービスでは、標準 Web プロトコル(SOAP)を使用して、Web ユーザに対して有用な機能を公開します。

SOAP

Simple Object Access Protocol(SOAP)は、Web サービス用の通信プロトコルです。SOAP の仕様によって、メッセージの XML フォーマットが定義されます。SOAP の利点は、さまざまなハードウェアおよびソフトウェアのプラットフォームで実装されている点です。

HTTP/HTTPS

HTTP/HTTPS は、サービスのトランスポート レイヤです。HTTP/HTTPS を使用すると、データが簡単にネットワークを通過できます。これらのプロトコルは広く使用されています。また、プラットフォームには依存しません。すべての Fabric Manager Web Service の動作には、HTTP/HTTPS が使用されます。

WSDL

WSDL 定義は XML ドキュメントで、定義の root 要素は http://schemas.xmlsoap.org/wsdl/ 名前空間にあります。Fabric Manager Web Service は、WSDL ドキュメントを使用して、使用可能な Fabric Manager の操作を公開します。definitions 要素には、types、message、portType、binding、service など、他の複数の要素が含まれている場合があります。これらの要素はすべて、名前空間が基になっています。WSDL の公開場所は FMServer 上の http://localhost/LogonWSService/LogonWS?wsdl です。

Logon Service

LogonWS は、IdentityManager の操作を Web サービス コールとして公開します。LogonWS を使用すると、次の操作が可能になります。

requestToken

このメソッドは、SOAP メッセージのヘッダーとして渡す必要のあるトークン ストリングを返します。Fabric Manager の SecurityManager を使用してユーザ名とパスワードが認証されると、このトークンが生成され、expiration 引数で指定されたミリ秒の間、有効となります。

パラメータ

username:ユーザ名

password:ユーザのパスワード

expiration:時間(ミリ秒)

戻り値

セッション トークン

エラー

エラー コード:201(Web サービスの無効な引数の例外)

validateToken

このメソッドは、トークンの有効性に応じて true または false を返します。トークンの有効期限が切れている場合は false を返し、切れていない場合は true を返します。

パラメータ

token:セッション トークン

戻り値

ブール値。Fabric Manager がトークンを受け入れる場合は「True」

エラー

エラー コード:201(Web サービスの無効な引数の例外)

認証またはトークン

Fabric Manager Web Service とやり取りするには、ユーザは LogonWS 経由でトークンを取得し、このトークンをすべての SOAP リクエストのヘッダー メッセージに追加する必要があります。Fabric Manager Web Service は、LogonWS が管理する一意なトークン ストリングを使用して、ユーザ資格情報を確認します。どのような場合でも、HTTPS を配置して通信チャネルを保護する必要があります。次に、ヘッダー メッセージのフォーマット例を示します。

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<m:Token xmlns:m="http://www.w3schools.com/transaction/">
token string is put here
</m:Token></SOAP-ENV:Header>
<SOAP-ENV:Body>
<getFabrics xmlns="http://ep.jaxws.dcbu.cisco.com/"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

IdentityManager

IdentityManager はアイデンティティ サービスを提供し、Web サービスで必要なユーザ資格情報を管理します。つまり、トークンを管理および維持するトークン プロバイダーです。ユーザの認証およびトークンの生成を行い、定期的にキャッシュをチェックしてクリアし、トークンを検証したりトークンの有効期限を終了します。

San Service

San Service は Enterprise Java Beans(EJB)コンポーネントであり、SAN 関連のサービス リクエストを管理して、Fabric Manager にクエリーを実行して情報を取得します。SanWS は IdentityManager を確認して認証を行ってから、リクエストを実行します。有効なトークン ストリングの指示によって、San Service はユーザが Fabric Manager ユーザであることを認識し、リクエストを受け付けて実行します。必要な情報を取得したあとは、ユーザに結果を返します。SanWS のエラー ログは fms_ws.log に記録されます。

サービス エンドポイント インターフェイス(SEI)

SanWS の Service Endpoint Interface(SEI; サービス エンドポイント インターフェイス)は、サービスの操作を定義します。次のメソッドがエンド ユーザに公開されています。

メソッド

getFabrics

すべての接続ファブリックのリストを返します。

戻り値

接続ファブリックの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

getFabricByIP

指定したスイッチの IP アドレスに関連付けられたファブリックのリストを返します。

パラメータ

ipAddress:スイッチの IP アドレス

戻り値

特定の IP アドレスに関連付けられたすべてのファブリックのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getFabricByKey

指定したキーに関連付けられたファブリックのリストを返します。

パラメータ

key:ファブリックのキー

戻り値

指定したキーに関連付けられたすべてのファブリックのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getFabricBySwitchKey

指定したシード スイッチ キー(WWN)に関連付けられたファブリックのリストを返します。

パラメータ

swkey:ファブリックのシード スイッチ キー

戻り値

指定したシード スイッチ キーに関連付けられたすべてのファブリックのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getSwitchesByFabric

指定したファブリック キーに関連付けられたスイッチのリストを返します。

パラメータ

key:ファブリックのキー

戻り値

指定したファブリック キーに関連付けられたすべてのファブリックのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

getSwitch

すべてのファブリック上のスイッチのリストを返します。

パラメータ

key:ファブリックのキー

戻り値

指定したファブリック キーに関連付けられたすべてのファブリックのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

getSwitchByKey

指定したスイッチ キー オブジェクトに関連付けられたスイッチを返します。

パラメータ

key:ファブリックのキー

戻り値

指定したスイッチ キーに関連付けられたスイッチ

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getSwitchIPByName

指定したシステム名またはスイッチ名に関連付けられた IP アドレスを返します。

パラメータ

sysname:システムまたはスイッチ

戻り値

指定したシステム名に関連付けられた IP アドレス

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getSwitchIPByKey

指定した WwnKey オブジェクトに関連付けられたスイッチの IP アドレスを返します。

パラメータ

key:WWN キー オブジェクト

戻り値

指定した WwnKey オブジェクトに関連付けられた IP アドレス

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getNeighborSwitches

指定した WwnKey に関連付けられた近接スイッチのリストを返します。

パラメータ

key:Wwn キー オブジェクト

戻り値

指定した WwnKey に関連付けられた近接スイッチのリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

エラー コード:302(クエリー キーで SAN がオブジェクトを検出できない場合の例外)

getVsans

指定したファブリック キーに関連付けられたファブリック内にある VSAN のリストを返します。

パラメータ

key:ファブリック キー オブジェクト

戻り値

指定したファブリック キーに関連付けられたファブリック内にある VSAN のリスト

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getVsan

指定した VSAN キー オブジェクトに関連付けられたファブリック内にある VSAN を返します。

パラメータ

key:VSAN キー オブジェクト

戻り値

指定した VSAN キー オブジェクトに関連付けられたファブリック内にある VSAN

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getIsls

指定した VSAN キーに関連付けられた VSAN 内にある ISL のリストを返します。

パラメータ

key:VSAN キー

戻り値

指定した VSAN キーに関連付けられた VSAN 内にある ISL オブジェクトの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

discoverFabric

この API によってファブリックに接続します。この関数にはシード スイッチの IP アドレスと SNMP 資格情報が必要です。

パラメータ

seed:シード スイッチの IP アドレス

user:SNMP 資格情報

戻り値

ブール値。検出に成功した場合は True

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

エラー コード:100(認証失敗の例外)

エラー コード:101(無効な資格情報の例外)

manageFabric

ファブリックの管理可能性に応じて true または false を返します。

パラメータ

key:ファブリック キー

戻り値

ファブリックを識別または管理可能な場合は true を返します。ファブリックを識別または管理不可能な場合は false を返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

unManageFabric

この関数を使用して、ファブリックを管理対象外にします。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

closeFabric

この関数を使用して、ファブリックを管理対象外にしてクローズします。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

purgeFabric

この関数を使用して、指定したファブリック データを Fabric Manager のキャッシュおよびデータベースから消去します。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

エラー コード:302(クエリー キーで SAN がオブジェクトを検出できない場合の例外)

getEndports

Fabric Manager が認識しているすべてのエンド ポートのリストを返します。

戻り値

すべてのエンド ポートの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

getEnclosures

Fabric Manager が認識しているすべてのラックのリストを返します。

戻り値

ラック オブジェクトの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

getEndPortByFWwn

F ポート WWN に基づいて、エンド ポートを返します。

パラメータ

wwn:F ポートの WWN

戻り値

F ポート WWN に基づいてエンド ポートの配列を返します。F ポートに関連付けられたエンド ポートがない場合は、ヌルを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getEndPortByKey

スイッチ WWN に基づいて、エンド ポートを返します。

パラメータ

key:ノードの WWN

戻り値

スイッチ WWN に基づいて、エンド ポートを返します。スイッチに関連付けられたエンド ポートがない場合は、ヌルを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getEndPortAttachedToSw

スイッチに関連付けられたエンド ポートを返します。

パラメータ

key:スイッチの IP アドレス

戻り値

スイッチに基づいてエンド ポートを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getEnclosureByName

名前に基づいてラックを返します。

パラメータ

name:ラック オブジェクトの名前

戻り値

ラック オブジェクトを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getEnclosureByKey

名前に基づいてラックを返します。

パラメータ

name:ラック オブジェクトの名前

戻り値

ラック オブジェクトを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getEnclosureByPWwn

物理 WWN に関連付けられたラックを返します。

パラメータ

wwn:スイッチの物理 WWN

戻り値

物理 WWN に基づいてラックを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

updateEnclosure

パラメータとして渡された値を使用して、ラックを更新します。

パラメータ

value:ラックを更新するための値

戻り値

なし

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

updateEndportEnclosure

パラメータとして渡された値を使用して、エンド ポート ラックを更新します。

パラメータ

endportKey:endportKey の値

enclosureKey:enclosureKey の値

戻り値

なし

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getHosts

Fabric Manager が認識しているすべてのホスト ラックのリストを返します。

戻り値

Fabric Manager が認識しているすべてのホスト ラックのリストを返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

getHost

VSAN に含まれるホストの名前を返します。

パラメータ

key:VSAN の名前

戻り値

指定した VSAN に含まれるホストの名前を返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getHostByFabric

ファブリック内のホストの名前を返します。

次のいずれかの状況が発生すると、ValidationException がスローされます。

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

引数に有効なキーが含まれていない場合

パラメータ

key:ファブリックの名前

戻り値

指定した VSAN に含まれるホストの名前を返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getStorages

Fabric Manager が認識しているすべてのストレージ デバイス ラックのリストを返します。

戻り値

Fabric Manager が認識しているすべてのストレージ デバイス ラックの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

getStorageByFabric

ファブリック内のストレージ デバイス ラックの名前を返します。

パラメータ

key:ファブリックの名前

戻り値

指定したファブリック内のストレージの名前を返します。

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

getHostPorts

ファブリック内のすべてのホスト エンド ポートのリストを返します。

パラメータ

key:ファブリックの名前

戻り値

ファブリック内のすべてのホスト ポートの配列

エラー

エラー コード:300(一般的な SAN サービスの例外)

エラー コード:201(Web サービスの無効な引数の例外)

エラー コード

エラー コード
説明

100

認証失敗

101

無効な資格情報

102

無効な権限

103

無効なトークン

200

Web サービス エラー

201

Web サービス関数の無効な引数

202

Web サービス サーバに到達不能

300

SAN サービス エラー

301

SAN サービスの無効なクエリー キー