Cisco Fabric Manager Web Services プログラミ ング ガイド
Fabric Manager Web Services
Fabric Manager Web Services
発行日;2012/01/31 | 英語版ドキュメント(2009/08/21 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1MB) | フィードバック

目次

Fabric Manager Web Services

Fabric Manager Web Services の概要

Web Services の仕様

XML

SOAP

HTTP/HTTPS

WSDL

Logon サービス

requestToken

validateToken

認証またはトークン

IdentityManager

San Service

Service Endpoint Interface(SEI)

メソッド

getFabrics

getFabricByIP

getFabricByKey

getFabricBySwitchKey

getSwitchesByFabric

getSwitch

getSwitchByKey

getSwitchIPByName

getSwitchIPByKey

getNeighborSwitches

getVsans

getVsan

getIsls

discoverFabric

manageFabric

unManageFabric

closeFabric

purgeFabric

getEndports

getEnclosures

getEndPortByKey

getEndPortAttachedToSw

getEnclosureByName

getEnclosureByKey

getEnclosureByPWwn

updateEnclosure

updateEndportEnclosure

getHosts

getHost

getHostByFabric

getStorages

getStorageByFabric

getHostPorts

getDomainId

getVsanIp

getVsanDomains

getIvrEnfZoneSetName

getIvrEnfZoneSetNumber

getIvrEnfZoneSetActivateTime

getIvrEnfZoneSet

getIvrActiveZonesetChecksum

getAliases

useFcAlias

getEnfZoneSet

getEnfZoneSetName

getEnfZoneSetName

getFCAliases

getFCAliasesByVsan

getCFS

getCFSBySwitch

getFcipProfiles

getFcipProfilesBySwitch

getFcipTunnels

getFcipTunnelsBySwitch

getFcipTunnelErrors

getFcipTunnelErrorsBySwitch

getFcipTunnelErrorsBySwitch

getZoneMode

getZoneModeByVsan

getZoneAttributes

getZoneAttributesByVsan

getSwitchPorts

isIVREnabled

getSwitchDateAndTime

Cluster WS:SEI

メソッド

getSwitchesByFabricKey

getServerIpByFabricKey

getServerIpBySwitchKey

getFabricsByServerIp

getAllServers

getFabricByEnclosureKey

getServerIpByEnclosureKey

getServerIpByVsanKey

Event WS:SEI

メソッド

isCallHomeEnabled

getCallHomeDestProfile

getCallHomeSysInfo

getEmailMaxEntries

getEmailSetup

getSyslogServers

getSyslogMessageControl

getSyslogLoggingCfg

プロトコル WS:SEI

メソッド

getNtpPeers

getNtpInfo

getFspfConfig

queryInterfaceFspfConfig

セキュリティ WS:SEI

メソッド

getAaaMaxServer

getAaaMaxAppServer

isMSCHAPRequired

getAaaSetup

getAaaAppServerGroups

getAaaServerGroups

getSnmpUsers

getIPACLProfiles

getSSHConfig

getSSHEnabled

isTelnetEnabled

getPkiRsaKeys

getPkiTrustPointNames

getPkiTrustPointNames

getPkiCert

getPkiAction

getPkiTrustPoint

getFeatureControls

getIkeFailRecoveryCfg

getIkeCfgPolicies

getIkeCfgInitiators

getIkeTunnels

getIPsecGlobalCfg

getIPsecXformSets

getIPsecCryptoMaps

getIfsFromCryptoMap

getIPsecTunnels

エラー コード

Fabric Manager Web Services

この章では、Fabric Manager Web Services(FMWS)の Application Program Interface(API; アプリケーション プログラム インターフェイス)について説明します。この章の内容は、次のとおりです。

「Fabric Manager Web Services の概要」

「Web Services の仕様」

「Logon サービス」

「San Service」

「Service Endpoint Interface(SEI)」

「メソッド」

「エラー コード」

Fabric Manager Web Services の概要

Cisco Fabric Manager Web Services(FMWS)を使用すると、サードパーティのベンダーは Fabric Manager のコア ソフトウェア機能にリモート プロシージャ コールとしてアクセスできます。Web Services は、World Wide Web インフラストラクチャを拡張して、ソフトウェアが他のソフトウェア アプリケーションに接続する方法を実現します。アプリケーションは、Hyper Text Transfer Protocol(HTTP)、Hypertext Transfer Protocol Security(HTTPS)、Extensible Markup Language(XML)、Simple Object Access Protocol(SOAP)などのさまざまなプロトコルとデータ形式を使用して Web Services にアクセスします。Web Services は、コンポーネントベース開発と Web の最も優れた面を組み合わせます。Web Services により Fabric Manager はエンタープライズ クラスのアプリケーションとなり、他のソフトウェア プラットフォームと相互運用できるようになります。

この章では、Fabric Manager Web Services 機能で公開された API を定義します。

Web Services の仕様

複数の Web Services の仕様が組み合わされて、セキュリティ、通信、およびデータを表す構文に関する相互運用可能なプロトコルが提供されます。

XML

XML はメッセージの構造を定義するデータ形式です。XML Web Services のアーキテクチャにより、異なるプラットフォームにおいて異なる言語で記述されたプログラムが標準に基づいて相互に通信できるようになります。XML Web Services は、標準的な Web プロトコル(SOAP)を使用して役に立つ機能を Web ユーザに公開します。

SOAP

Simple Object Access Protocol(SOAP)は、Web Services の通信プロトコルです。SOAP は、メッセージの XML 形式を定義する仕様です。SOAP の利点は、さまざまな数多くのハードウェアおよびソフトウェア プラットフォームに実装されていることです。

HTTP/HTTPS

HTTP/HTTPS はサービスのトランスポート レイヤです。HTTP/HTTPS によりデータはネットワークを容易に移動できるため、幅広く利用されています。HTTP/HTTPS は、プラットフォーム非依存と見なされます。各 Fabric Manager Web Services 操作は HTTP/HTTPS を介して実行されます。

WSDL

Web Services Description Language(WSDL)定義は、http://schemas.xmlsoap.org/wsdl/ 名前空間からのルート定義要素を持つ XML 文書です。Fabric Manager Web Services は WSDL 文書を使用して、利用可能な Fabric Manager の操作を公開します。この定義要素には、タイプ、メッセージ、portType、バインディング、サービス(これらすべては名前空間から取得されます)などの他の複数の要素を含めることができます。WSDL は FMServer(http://localhost/LogonWSService/LogonWS?wsdl)で公開されます。

Logon サービス

LogonWS を使用すると、IdentityManager の操作が Web Service コールとして利用可能になります。LogonWS により、次の操作が可能になります。

requestToken

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

パラメータ

username:ユーザの名前

password:ユーザのパスワード

expiration:ミリ秒単位の時間

戻り値

セッション トークン

エラー

エラー コード:201:Web Service 例外の無効な引数

validateToken

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

パラメータ

token:セッション トークン

戻り値

ブール値「True」(Fabric Manager がトークンを受け入れた場合)

エラー

エラー コード:201:Web Service 例外の無効な引数

認証またはトークン

Fabric Manager Web Services と対話するために、ユーザは LogonWS を介してトークンを取得し、各 SOAP 要求のヘッダー メッセージにトークンを添付する必要があります。Fabric Manager Web Services は、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 は、ID サービスを提供し、Web Services が必要なユーザ証明書を管理します。IdentityManager は、トークンを管理および保守するトークン プロバイダーです。定期的にキャッシュをチェックおよび消去することにより、ユーザを認証し、トークンを生成し、トークンを検証するか、またはトークンを有効期限切れにします。

San Service

San Service は、Storage Area Network(SAN; ストレージ エリア ネットワーク)に関連するサービス要求を管理し、情報のために Fabric Manager に対するクエリーを実行する Enterprise Java Beans(EJB)コンポーネントです。SanWS は、要求を実行する前に IdentityManager で認証をチェックします。有効なトークン ストリングは、ユーザが Fabric Manager ユーザであり、要求を受け入れ実行する必要があることを San Service に通知します。必要な情報を取得したら、結果がユーザに返されます。SanWS はエラーを fms_ws.log に記録します。

Service Endpoint Interface(SEI)

SanWS の Service Endpoint Interface(SEI)は、サービスの操作を定義します。これらのメソッドは、エンド ユーザに公開されます。

メソッド

getFabrics

すべての開いたファブリックのリストを返します。

戻り値

開いたファブリックのアレイ

エラー

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

getFabricByIP

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFabricByKey

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFabricBySwitchKey

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getSwitchesByFabric

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

getSwitch

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

getSwitchByKey

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getSwitchIPByName

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getSwitchIPByKey

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

パラメータ

key:WWN キー オブジェクト

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getNeighborSwitches

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

パラメータ

key:WWN キー オブジェクト

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

エラー コード:302:SAN はクエリー キー例外によりオブジェクトを見つけることができません。

getVsans

指定されたファブリック キーに関連付けられたファブリックの Virtual SAN(VSAN; 仮想 SAN)のリストを返します。

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getVsan

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

パラメータ

key:VSAN キー オブジェクト

戻り値

指定された VSAN キー オブジェクトに関連付けられたファブリックの VSAN

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIsls

指定された VSAN キーに関連付けられた VSAN の Inter-Switch Link(ISL; スイッチ間リンク)のリストを返します。

パラメータ

key:VSAN キー

戻り値

指定された VSAN キーに関連付けられた VSAN の ISL オブジェクトのアレイ

エラー

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

エラー コード:201:Web Service 例外の無効な引数

discoverFabric

この API は、ファブリックを開きます。この関数には、シード スイッチの IP アドレスと Simple Network Management Protocol(SNMP; 簡易ネットワーク管理プロトコル)証明書が必要です。

パラメータ

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

user:SNMP 証明書

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

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

エラー コード:101:無効な証明書例外

manageFabric

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

パラメータ

key:ファブリック キー

戻り値

ファブリックを識別または管理できる場合は、true を返します。ファブリックを識別または管理できない場合は、false を返します。

エラー

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

エラー コード:201:Web Service 例外の無効な引数

unManageFabric

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

パラメータ

key:ファブリック キー

戻り値

なし

エラー

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

エラー コード:201:Web Service 例外の無効な引数

closeFabric

この関数は、ファブリックを管理対象外にし、閉じるために使用します。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

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

エラー コード:201:Web Service 例外の無効な引数

purgeFabric

この関数は、指定されたファブリック データを Fabric Manager キャッシュおよびデータベースから破棄するために使用します。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

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

エラー コード:201:Web Service 例外の無効な引数

エラー コード:302:SAN はクエリー キー例外によりオブジェクトを見つけることができません。

getEndports

Fabric Manager に既知のすべてのエンド ポートのリストを返します。

戻り値

すべてのエンド ポートのアレイ

エラー

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

getEnclosures

Fabric Manager に既知のすべてのラックのリストを返します。

戻り値

ラック オブジェクトのアレイ

エラー

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

getEndPortByKey

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

パラメータ

key:ノードの WWN

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEndPortAttachedToSw

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnclosureByName

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnclosureByKey

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

パラメータ

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

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnclosureByPWwn

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

パラメータ

wwn:スイッチの物理的な WWN

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

updateEnclosure

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

パラメータ

value:ラックを更新する値

戻り値

なし

エラー

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

エラー コード:201:Web Service 例外の無効な引数

updateEndportEnclosure

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

パラメータ

endportKey:endportKey の値

enclosureKey:enclosureKey の値

戻り値

なし

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getHosts

Fabric Manager に既知のすべてのホスト ラックのリストを返します。

戻り値

Fabric Manager に既知のすべてのホスト ラックのリストを返します。

エラー

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

getHost

VSAN のホストの名前を返します。

パラメータ

key:VSAN の名前

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getHostByFabric

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

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

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

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

パラメータ

key:ファブリックの名前

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getStorages

Fabric Manager に既知のすべてのストレージ デバイス ラックのリストを返します。

戻り値

Fabric Manager に既知のすべてのストレージ デバイス ラックのアレイ

エラー

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

getStorageByFabric

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

パラメータ

key:ファブリックの名前

戻り値

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

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getHostPorts

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

パラメータ

key:ファブリックの名前

戻り値

ファブリックのすべてのホスト ポートのアレイ

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getDomainId

ドメイン アドレスを返します。

パラメータ

key:Wwn

vsanid:VSAN の一意の ID

戻り値

ドメイン IP アドレス

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getVsanIp

VSAN の IP アドレスを返します。

パラメータ

key:Wwn

vsanid:VSAN の一意の ID

戻り値

VSAN の IP アドレス

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getVsanDomains

スイッチのすべての VSAN ドメインを返します。

パラメータ

Key:Wwnkey

戻り値

スイッチの VSAN ドメイン

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIvrEnfZoneSetName

ファブリック Interactive Voice Response(IVR)が適用されたゾーン セットの名前を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIvrEnfZoneSetNumber

ファブリック IVR が適用されたゾーン番号を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン番号

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIvrEnfZoneSetActivateTime

ファブリック IVR が適用されたゾーン セット アクティブ化時間を返します。

パラメータ

key:ファブリック キー

戻り値

長整数形式のタイム スタンプ

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIvrEnfZoneSet

ファブリック IVR が適用されたゾーン セットを返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン オブジェクトのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getIvrActiveZonesetChecksum

IVR がアクティブなゾーン セット チェックサムを返します。

パラメータ

key:ファブリック キー

戻り値

チェックサム値

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getAliases

ファブリックにより使用されたすべてのエイリアスを返します。

パラメータ

key:ファブリック キー

戻り値

ファブリックにより使用されたエイリアス

エラー

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

エラー コード:201:Web Service 例外の無効な引数

useFcAlias

ファブリックにより使用されたすべての Fibre Channel(FC; ファイバ チャネル)エイリアスを返します。

パラメータ

key:ファブリック キー

戻り値

ファブリックにより使用された FC エイリアス

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnfZoneSet

VSAN が適用されたすべてのゾーン セットを返します。

パラメータ

key:ファブリック キー

戻り値

ゾーンのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnfZoneSetName

VSAN が適用されたすべてのゾーン セット名を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名のリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getEnfZoneSetName

VSAN が適用されたすべてのゾーン セット名を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名のリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFCAliases

ファブリックのすべての FC エイリアスを返します。

パラメータ

key:ファブリック キー

戻り値

エイリアスのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFCAliasesByVsan

VSAN のすべての FC エイリアスを返します。

パラメータ

key:ファブリック キー

戻り値

VSAN のエイリアスのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getCFS

Cisco Fabric Services(CFS)を返します。

パラメータ

key:ファブリック キー

戻り値

CFS 機能のリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getCFSBySwitch

CFS を返します。

パラメータ

Key:スイッチ キー

戻り値

CFS 機能のリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipProfiles

FCIP(Fibre Channel over IP)プロファイルを返します。

パラメータ

key:ファブリック キー

戻り値

FCIP プロファイルのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipProfilesBySwitch

スイッチに基づいて FCIP プロファイルを返します。

パラメータ

Key:スイッチ キー

戻り値

FCIP プロファイルのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipTunnels

FCIP トンネルを返します。

パラメータ

key:ファブリック キー

戻り値

FCIP トンネルのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipTunnelsBySwitch

スイッチに基づいて FCIP トンネルを返します。

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネルのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipTunnelErrors

FCIP トンネル エラーを返します。

パラメータ

key:ファブリック キー

戻り値

FCIP トンネル エラーのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipTunnelErrorsBySwitch

スイッチに基づいて FCIP トンネル エラーを返します。

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネル エラーのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getFcipTunnelErrorsBySwitch

スイッチに基づいて FCIP トンネル エラーを返します。

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネル エラーのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getZoneMode

ゾーン操作モードを返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン操作モードのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getZoneModeByVsan

VSAN のゾーン操作モードを返します。

パラメータ

key:VSAN キー

戻り値

ゾーン操作モードのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getZoneAttributes

ゾーン属性を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン属性

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getZoneAttributesByVsan

VSAN のゾーン属性を返します。

パラメータ

key:VSAN キー

戻り値

VSAN のゾーン属性

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getSwitchPorts

スイッチのポートを返します。

パラメータ

key:ファブリック キー

戻り値

該当するスイッチのポートのリスト

エラー

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

エラー コード:201:Web Service 例外の無効な引数

isIVREnabled

IVR がスイッチで有効であるかどうかに応じてブール値を返します。

パラメータ

Key:スイッチ キー

戻り値

ブール値

エラー

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

エラー コード:201:Web Service 例外の無効な引数

getSwitchDateAndTime

スイッチの時刻および日付を返します。

パラメータ

Key:スイッチ キー

戻り値

ブール値

エラー

エラー コード:400:SnmpException

Cluster WS:SEI

Cluster WS の Service Endpoint Interface(SEI)は、サービスの操作を定義します。これらのメソッドは、エンド ユーザに公開されます。

メソッド

getSwitchesByFabricKey

ファブリック キーに関連するすべてのスイッチを返します。

パラメータ

key:ファブリックの名前

戻り値

ファブリックに関連付けられたすべてのスイッチ

エラー

エラー コード:400:SnmpException

getServerIpByFabricKey

ファブリック キーから管理サーバの IP アドレスを返します。

パラメータ

key:ファブリックの名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

getServerIpBySwitchKey

スイッチ キーから管理サーバの IP アドレスを返します。

パラメータ

key:スイッチの名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

getFabricsByServerIp

サーバ IP アドレス別にファブリックの名前を返します。

パラメータ

key:IP アドレス

戻り値

ファブリックの名前

エラー

エラー コード:400:SnmpException

getAllServers

このフェデレーションのすべてのサーバを返します。

パラメータ

key:

戻り値

フェデレーションのすべてのサーバ

エラー

エラー コード:400:SnmpException

getFabricByEnclosureKey

ラック キーからファブリック キーを返します。

パラメータ

key:ラックの名前

戻り値

ファブリックの名前

エラー

エラー コード:400:SnmpException

getServerIpByEnclosureKey

ラック キーからサーバ IP アドレスを返します。

パラメータ

key:ファブリックの名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

getServerIpByVsanKey

VSAN キーからサーバ IP アドレスを返します。

パラメータ

key:VSAN の名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

Event WS:SEI

Event WS の Service Endpoint Interface(SEI)は、サービスの操作を定義します。これらのメソッドは、エンド ユーザに公開されます。

メソッド

isCallHomeEnabled

callhome 機能のアクティベーションに基づいてブール値を返します。

パラメータ

Key:Wwnkey

戻り値

ブール値

エラー

エラー コード:400:SnmpException

getCallHomeDestProfile

callhome 宛先プロファイルを返します。

パラメータ

Key:Wwnkey

戻り値

エラー

エラー コード:400:SnmpException

getCallHomeSysInfo

callhome 機能に関するシステム情報を返します。

パラメータ

Key:Wwnkey

戻り値

callhome 機能に関するシステム情報

エラー

エラー コード:400:SnmpException

getEmailMaxEntries

callhome 機能の電子メール アドレス エントリの最大数を返します。

パラメータ

Key:Wwnkey

戻り値

callhome 機能の電子メール アドレス エントリの数

エラー

エラー コード:400:SnmpException

getEmailSetup

callhome 機能の電子メール セットアップ詳細を返します。

パラメータ

Key:Wwnkey

戻り値

callhome 機能の電子メール セットアップ詳細

エラー

エラー コード:400:SnmpException

getSyslogServers

Syslog サーバのリストを返します。

パラメータ

Key:Wwnkey

戻り値

Syslog サーバのリスト

エラー

エラー コード:400:SnmpException

getSyslogMessageControl

Syslog メッセージ設定のリストを返します。

パラメータ

Key:Wwnkey

戻り値

Syslog メッセージ設定のリスト

エラー

エラー コード:400:SnmpException

getSyslogLoggingCfg

Syslog ロギング設定を返します。

パラメータ

Key:Wwnkey

戻り値

Syslog 証明書に関する設定情報

エラー

エラー コード:400:SnmpException

プロトコル WS:SEI

メソッド

getNtpPeers

Network Timing Protocol(NTP)ピア情報を返します。

パラメータ

Key:Wwnkey

戻り値

NTP ピア情報

エラー

エラー コード:400:SnmpException

getNtpInfo

NTP システム情報を返します。

パラメータ

Key:Wwnkey

戻り値

NTP システム情報

エラー

エラー コード:400:SnmpException

getFspfConfig

Fabric Shortest Path First(FSPF)プロトコル設定を返します。

パラメータ

Key:Wwnkey

戻り値

FSPF プロトコルの設定

エラー

エラー コード:400:SnmpException

queryInterfaceFspfConfig

指定された VSAN に関連するインターフェイスに関する FSPF 設定を返します。

パラメータ

Key:Wwnkey

vsanid:VSAN の一意の ID

戻り値

指定された VSAN のインターフェイスに関する FSPF 設定

エラー

エラー コード:400:SnmpException

セキュリティ WS:SEI

メソッド

getAaaMaxServer

Authentication, Authorization, and Accounting(AAA; 認証、認可、アカウンティング)設定のサーバ グループ内にあるサーバ エントリの最大数値を返します。

パラメータ

Key:Wwnkey

戻り値

AAA 設定のサーバ グループ内にあるサーバ エントリの最大数

エラー

エラー コード:400:SnmpException

getAaaMaxAppServer

アプリケーション タイプに対する AAA 設定のサーバ エントリの最大数値を返します。

パラメータ

Key:Wwnkey

戻り値

AAA 設定のサーバ グループ内にあるサーバ エントリの最大数

エラー

エラー コード:400:SnmpException

isMSCHAPRequired

ユーザを認証するのに Microsoft Challenge Handshake Authentication Protocol(MSCHAP)認証メカニズムが必要かどうかを示すブール値を返します。

パラメータ

Key:Wwnkey

戻り値

ユーザを認証するのに MSCHAP 認証メカニズムが必要かどうかを示すブール値

エラー

エラー コード:400:SnmpException

getAaaSetup

AAA 設定を返します。

パラメータ

Key:Wwnkey

戻り値

AAA の設定

エラー

エラー コード:400:SnmpException

getAaaAppServerGroups

特定のアプリケーション タイプの AAA サーバ グループを返します。

パラメータ

Key:Wwnkey

戻り値

特定のアプリケーション タイプの AAA サーバ グループ

エラー

エラー コード:400:SnmpException

getAaaServerGroups

すべての AAA サーバ グループ エントリを返します(サーバ グループは同じ AAA プロトコルを実装する複数の AAA サーバから構成されます)。

パラメータ

Key:Wwnkey

戻り値

AAA サーバ グループ エントリ

エラー

エラー コード:400:SnmpException

getSnmpUsers

SNMP ユーザに関する情報を返します。

パラメータ

Key:Wwnkey

戻り値

SNMP ユーザに関する情報

エラー

エラー コード:400:SnmpException

getIPACLProfiles

すべての IP Access Control List(ACL; アクセス コントロール リスト)プロファイルを返します。

パラメータ

Key:Wwnkey

戻り値

すべての IP ACL プロファイル

エラー

エラー コード:400:SnmpException

getSSHConfig

Secure Shell(SSH)設定情報を返します。

パラメータ

Key:Wwnkey

戻り値

SSH 設定情報

エラー

エラー コード:400:SnmpException

getSSHEnabled

SSH が有効であるかどうかを示すブール値を返します。

パラメータ

Key:Wwnkey

戻り値

SSH が有効であるかどうかを示すブール値

エラー

エラー コード:400:SnmpException

isTelnetEnabled

telnet が有効であるかどうかを示すブール値を返します。

パラメータ

Key:Wwnkey

戻り値

telnet が有効であるかどうかを示すブール値

エラー

エラー コード:400:SnmpException

getPkiRsaKeys

PKI RSA キーペア エントリを返します。

パラメータ

Key:Wwnkey

戻り値

PKI RSA キーペア エントリ

エラー

エラー コード:400:SnmpException

getPkiTrustPointNames

PKI トラストポイント名のリストを返します。

パラメータ

Key:Wwnkey

戻り値

PKI トラストポイント名のリスト

エラー

エラー コード:400:SnmpException

getPkiTrustPointNames

PKI トラストポイント名のリストを返します。

パラメータ

Key:Wwnkey

戻り値

PKI トラストポイント名のリスト

エラー

エラー コード:400:SnmpException

getPkiCert

PKI トラストポイントの証明書情報を返します。

パラメータ

Key:Wwnkey

戻り値

PKI トラストポイントの証明書情報

エラー

エラー コード:400:SnmpException

getPkiAction

トラストポイントの PKI サポート アクションを返します。

パラメータ

Key:Wwnkey

戻り値

トラストポイントの PKI サポート アクション

エラー

エラー コード:400:SnmpException

getPkiTrustPoint

キーペア名、リスト失効メソッド、および証明書失効に対する外部の Online Certificate Status Protocol(OCSP)サーバの連絡用 HTTP URL から構成される PKI トラストポイント情報を返します。

パラメータ

Key:Wwnkey

戻り値

PKI トラストポイント情報

エラー

エラー コード:400:SnmpException

getFeatureControls

すべての機能コントロール名とその個々のステータスを返します。

パラメータ

Key:Wwnkey

戻り値

機能コントロール名とステータス

エラー

エラー コード:400:SnmpException

getIkeFailRecoveryCfg

Internet Key Exchange(IKE; インターネット キー交換)設定を返します。

パラメータ

Key:Wwnkey

戻り値

IKE 設定

エラー

エラー コード:400:SnmpException

getIkeCfgPolicies

IKE トンネルを設定するために使用するポリシーを返します。

パラメータ

Key:Wwnkey

戻り値

IKE トンネルを設定するために使用するポリシー

エラー

エラー コード:400:SnmpException

getIkeCfgInitiators

IKE イニシエータ設定情報を返します。

パラメータ

Key:Wwnkey

戻り値

IKE イニシエータ設定情報

エラー

エラー コード:400:SnmpException

getIkeTunnels

IKE トンネル情報を返します。

パラメータ

Key:Wwnkey

戻り値

IKE トンネル情報

エラー

エラー コード:400:SnmpException

getIPsecGlobalCfg

IP Security(IPsec)トンネル設定情報を返します。

パラメータ

Key:Wwnkey

戻り値

IPsec トンネル設定情報

エラー

エラー コード:400:SnmpException

getIPsecXformSets

IPsec トランスフォーム セット情報を返します。

パラメータ

Key:Wwnkey

戻り値

IPsec トランスフォーム セット情報

エラー

エラー コード:400:SnmpException

getIPsecCryptoMaps

IPsec cryptomap セットを返します。

パラメータ

Key:Wwnkey

戻り値

IPsec cryptomap セット

エラー

エラー コード:400:SnmpException

getIfsFromCryptoMap

IPsec cryptomap からのインターフェイス名を返します。

パラメータ

Key:Wwnkey

戻り値

IPsec cryptomap からのインターフェイス名

エラー

エラー コード:400:SnmpException

getIPsecTunnels

IPsec トンネルに関する情報を返します。

パラメータ

Key:Wwnkey

戻り値

IPsec トンネルに関する情報

エラー

エラー コード:400:SnmpException

エラー コード

エラー コード
説明

100

認証失敗

101

無効な証明書

102

無効な権限

103

無効なトークン

200

Web Service エラー

201

Web Service 関数の無効な引数

202

到達不可能な Web Service サーバ

300

SAN サーバ エラー

301

無効なクエリー キー

400

Snmp エラー

201

無効な引数


) Fabric Manager Web Services は、サーバ フェデレーションをサポートします。SanWS、SecurityWS、ProtocolWS、EventWS、および InventoryWS へのサービス要求により、フェデレーション内の適切なサーバにコールが自動的にディスパッチされます。サーバ フェデレーションを使用している場合、次のメソッドはフェデレーション内の該当するサーバに対して自動的に調停されません。
SanWS:
getEnclosures()
getEndports()
getFabricByIP()
getHosts()
getStorages()
getSwitchIPByName()
getSwitches()

InventoryWS:
getAllHbas()
getLicenseFlags()

これらの特定のインスタンスでは、要求を送信するサーバを決定するために Cluster WS に依存しなければならないことがあります。