Cisco Fabric Manager Web Services プログラミ ング ガイド
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年6月4日
章のタイトル： Fabric Manager Web Services
- 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
- 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 の概要」
• 「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 はエンタープライズ クラスのアプリケーションとなり、他のソフトウェア プラットフォームと相互運用できるようになります。
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 引数で指定されたミリ秒間の間有効になります。
validateToken
このメソッドは、トークンの有効性に応じて true または false を返します。トークンの有効期限が切れている場合は、false を返し、それ以外の場合は true を返します。
認証またはトークン
Fabric Manager Web Services と対話するために、ユーザは LogonWS を介してトークンを取得し、各 SOAP 要求のヘッダー メッセージにトークンを添付する必要があります。Fabric Manager Web Services は、LogonWS により管理された一意のトークン ストリングを使用してユーザ証明書を検証します。通信チャネルをセキュアにするために常に HTTPS を導入する必要があります。次に、ヘッダー メッセージの形式の例を示します。
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
getFabricByIP
該当するスイッチの IP アドレスに関連付けられたファブリックのリストを返します。
getFabricByKey
getFabricBySwitchKey
指定されたシード スイッチ キー（World Wide Name（WWN））に関連付けられたファブリックのリストを返します。
getSwitchesByFabric
指定されたファブリック キーに関連付けられたスイッチのリストを返します。
getSwitch
getSwitchByKey
getSwitchIPByName
getSwitchIPByKey
指定された WwnKey オブジェクトに関連付けられたスイッチの IP アドレスを返します。
getNeighborSwitches
指定された WwnKey に関連付けられた近接スイッチのリストを返します。
指定された WwnKey に関連付けられた近接スイッチのリスト
getVsans
指定されたファブリック キーに関連付けられたファブリックの Virtual SAN（VSAN; 仮想 SAN）のリストを返します。
getVsan
指定された VSAN キー オブジェクトに関連付けられたファブリックの VSAN を返します。
getIsls
指定された VSAN キーに関連付けられた VSAN の Inter-Switch Link（ISL; スイッチ間リンク）のリストを返します。
discoverFabric
この API は、ファブリックを開きます。この関数には、シード スイッチの IP アドレスと Simple Network Management Protocol（SNMP; 簡易ネットワーク管理プロトコル）証明書が必要です。
manageFabric
ファブリックの管理性に応じて true または false を返します。
ファブリックを識別または管理できる場合は、true を返します。ファブリックを識別または管理できない場合は、false を返します。
unManageFabric
closeFabric
purgeFabric
この関数は、指定されたファブリック データを Fabric Manager キャッシュおよびデータベースから破棄するために使用します。
getEndports
getEnclosures
getEndPortByKey
スイッチ WWN に基づいてエンド ポートを返します。スイッチに関連付けられたエンド ポートが存在しない場合はヌルを返します。
getEndPortAttachedToSw
getEnclosureByName
getEnclosureByKey
getEnclosureByPWwn
updateEnclosure
updateEndportEnclosure
getHosts
Fabric Manager に既知のすべてのホスト ラックのリストを返します。
getHost
getHostByFabric
getStorages
Fabric Manager に既知のすべてのストレージ デバイス ラックのリストを返します。
getStorageByFabric
getHostPorts
getDomainId
getVsanIp
getVsanDomains
getIvrEnfZoneSetName
ファブリック Interactive Voice Response（IVR）が適用されたゾーン セットの名前を返します。
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
Cluster WS の Service Endpoint Interface（SEI）は、サービスの操作を定義します。これらのメソッドは、エンド ユーザに公開されます。
メソッド
getSwitchesByFabricKey
getServerIpByFabricKey
getServerIpBySwitchKey
getFabricsByServerIp
getAllServers
getFabricByEnclosureKey
getServerIpByEnclosureKey
getServerIpByVsanKey
Event WS：SEI
Event WS の Service Endpoint Interface（SEI）は、サービスの操作を定義します。これらのメソッドは、エンド ユーザに公開されます。
メソッド
isCallHomeEnabled
getCallHomeDestProfile
getCallHomeSysInfo
getEmailMaxEntries
getEmailSetup
getSyslogServers
getSyslogMessageControl
getSyslogLoggingCfg
プロトコル WS：SEI
メソッド
getNtpPeers
getNtpInfo
getFspfConfig
queryInterfaceFspfConfig
指定された VSAN に関連するインターフェイスに関する FSPF 設定を返します。
セキュリティ WS：SEI
メソッド
getAaaMaxServer
Authentication, Authorization, and Accounting（AAA; 認証、認可、アカウンティング）設定のサーバ グループ内にあるサーバ エントリの最大数値を返します。
getAaaMaxAppServer
アプリケーション タイプに対する AAA 設定のサーバ エントリの最大数値を返します。
isMSCHAPRequired
ユーザを認証するのに Microsoft Challenge Handshake Authentication Protocol（MSCHAP）認証メカニズムが必要かどうかを示すブール値を返します。
getAaaSetup
getAaaAppServerGroups
getAaaServerGroups
すべての AAA サーバ グループ エントリを返します（サーバ グループは同じ AAA プロトコルを実装する複数の AAA サーバから構成されます）。
getSnmpUsers
getIPACLProfiles
すべての IP Access Control List（ACL; アクセス コントロール リスト）プロファイルを返します。
getSSHConfig
getSSHEnabled
isTelnetEnabled
getPkiRsaKeys
getPkiTrustPointNames
getPkiTrustPointNames
getPkiCert
getPkiAction
getPkiTrustPoint
キーペア名、リスト失効メソッド、および証明書失効に対する外部の Online Certificate Status Protocol（OCSP）サーバの連絡用 HTTP URL から構成される PKI トラストポイント情報を返します。
getFeatureControls
getIkeFailRecoveryCfg
getIkeCfgPolicies
getIkeCfgInitiators
getIkeTunnels
getIPsecGlobalCfg
getIPsecXformSets
getIPsecCryptoMaps
getIfsFromCryptoMap
getIPsecTunnels
エラー コード
|
|
|
|---|---|
（注） Fabric Manager Web Services は、サーバ フェデレーションをサポートします。SanWS、SecurityWS、ProtocolWS、EventWS、および InventoryWS へのサービス要求により、フェデレーション内の適切なサーバにコールが自動的にディスパッチされます。サーバ フェデレーションを使用している場合、次のメソッドはフェデレーション内の該当するサーバに対して自動的に調停されません。
SanWS:
getEnclosures()
getEndports()
getFabricByIP()
getHosts()
getStorages()
getSwitchIPByName()
getSwitches()
InventoryWS:
getAllHbas()
getLicenseFlags()
これらの特定のインスタンスでは、要求を送信するサーバを決定するために Cluster WS に依存しなければならないことがあります。
フィードバック