SMI-S / Web サービス プログラミング ガイド、Cisco DCNM for SAN Cisco DCNM for SAN Release 6.x
DCNM for SAN Web サービス API
DCNM for SAN Web サービス API
発行日;2012/09/18 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

DCNM for SAN Web サービス API

Web サービスの仕様

XML

SOAP

HTTP/HTTPS

WSDL

ログオン サービス

requestToken

requestLogonRole

requestLogonToken

getCredentialByToken

validateToken

認証またはトークン

IdentityManager

San WS

getFabrics

getFabricByIP

getPmEntity

getPmChartData

getFabricByKey

getFabricBySwitchKey

getSwitchesByFabric

getNeighborSwitches

getActiveServerNodes

getFabricWithSnmpCredentail

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

getZoneMode

getZoneModeByVsan

getZoneAttributes

getZoneAttributesByVsan

getSwitchPorts

isIVREnabled

getSwitchDateAndTime

Zone Manager WS - SEI

activateZoneset

addZone

addZoneAlias

addZoneMemberToZone

addZoneMemberToZoneAlias

createZone

createZoneAlias

createZoneMemberInZone

createZoneMemberInZoneAlias

createZoneSet

deActivateZoneset

getEnfZoneSet

getEnfZoneSetName

getIvrActiveZonesetChecksum

getIvrEnfZoneNumber

getIvrEnfZoneSet

getIvrEnfZoneSetActivateTime

getIvrEnfZoneSetName

getZone

getZoneAlias

getZoneAliases

getZoneAttributes

getZoneAttributesByVsan

getZoneCapabilitiesByFabric

getZoneCapabilitiesByVsan

getZoneMode

getZoneModeByVsan

getZoneSet

getZoneSets

getZones

統計情報 WS

getEndDeviceStatistics

getEndDeviceStatisticsByAlias

getEthPortStatisticsByKey

getEthPortStatisticsBySwitch

getFcPortStatistics

getFcPortStatisticsByKey

getFcPortStatisticsBySwitch

getIPEndPointStatisticsByKey

getIPEndPointStatisticsBySwitch

getTCPEndPointStatisticsByKey

getTCPEndPointStatisticsBySwitch

セキュリティ WS

getAaaMaxServer

getAaaMaxAppServer

isClearAcctLogSet

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

isFipsModeEnabled

プロトコル WS

getNtpPeers

getNtpInfo

getFspfConfig

queryInterfaceFspfConfig

getFcipProfiles

getFcipProfilesBySwitch

getFcipTunnels

getFcipTunnelsBySwitch

getFcipTunnelByLinkIndex

getFcipTunnelByLinkIfIndex

getFcipTunnelErrors

getFcipTunnelErrorsBySwitch

getIpSettingsBySwitch

getIpSettings

getTcpSettingsBySwitch

getTcpSettings

クラスタ WS - SEI

getSwitchesByFabricKey

getServerIpByFabricKey

getServerIpBySwitchKey

getFabricsByServerIp

getAllServers

getFabricByEnclosureKey

getServerIpByEnclosureKey

getServerIpByVsanKey

イベント WS - SEI

isCallHomeEnabled

getCallHomeDestProfile

getCallHomeSysInfo

getEmailMaxEntries

getEmailSetup

getSyslogServers

getSyslogMessageControl

getSyslogLoggingCfg

インベントリ WS - SEI

getPowerSuppliesBySwitchWwnKey

getPowerSuppliesBySwitchSnKey

getPowerSuppliesBySwitchIP

getCardsBySwitchWwnKey

getCardsBySwitchSnkey

getCardsBySwitchIP

getFansBySwitchWwnKey

getFansBySwitchSnKey

getFansBySwitchIP

getChassisBySwitchWwnKey

getChassisBySwitchSnKey

getChassisBySwitchIP

getAllHbas

getHbaByWwn

getLicensesBySwitchWwnKey

getLicensesBySwitchIP

getLicenseFlags

getCardByPhysicalIndex

エラー コード

DCNM for SAN Web サービス API

この章では、DCNM for SAN(DCNM-SAN)Web サービスのアプリケーション プログラム インターフェイス(API)について説明します。この章では、Cisco DCNM for SAN Web サービス機能で公開されている API を定義します。

この章の内容は、次のとおりです。

「Web サービスの仕様」

「ログオン サービス」

「San WS」

「Zone Manager WS - SEI」

「統計情報 WS」

「セキュリティ WS」

「プロトコル WS」

「イベント WS - SEI」

「クラスタ WS - SEI」

「インベントリ WS - SEI」

「エラー コード」

Web サービスの仕様

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

「XML」

「SOAP」

「HTTP/HTTPS」

「WSDL」

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 を使用すると、データが簡単にネットワークを通過できます。これらのプロトコルは広く使用されています。また、プラットフォームには依存しません。Cisco DCNM-SAN Web サービスの操作はすべて、HTTP/HTTPS 経由で実行されます。

WSDL

WSDL 定義は XML ドキュメントで、定義の root 要素は http://schemas.xmlsoap.org/wsdl/ 名前空間にあります。Cisco DCNM-SAN Web サービスは、WSDL ドキュメントを使用して、DCNM-SAN のどの操作が使用可能かを公開します。definitions 要素には、types、message、portType、binding、service など、他の複数の要素が含まれている場合があります。これらの要素はすべて、名前空間が基になっています。WSDL は、FMServer の次の場所で公開されています。

http://localhost/LogonWSService/LogonWS?wsdl

ログオン サービス

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

「requestToken」

「validateToken」

requestToken

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

パラメータ

username:ユーザ名

password:ユーザのパスワード

expiration:時間(ミリ秒)

戻り値

セッション トークン

エラー

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

requestLogonRole

パラメータ

username:ユーザ名

password:ユーザのパスワード

expiration:時間(ミリ秒)

戻り値

セッション トークン

エラー

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

requestLogonToken

パラメータ

username:ユーザ名

password:ユーザのパスワード

expiration:時間(ミリ秒)

戻り値

セッション トークン

エラー

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

getCredentialByToken

パラメータ

username:ユーザ名

password:ユーザのパスワード

expiration:時間(ミリ秒)

戻り値

セッション トークン

エラー

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

validateToken

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

パラメータ

token:セッション トークン

戻り値

ブール値。DCNM-SAN がトークンを受け入れる場合は True。

エラー

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

認証またはトークン

DCNM-SAN Web サービスを操作するには、ログオン WS を通してトークンを取得し、このトークンをすべての SOAP 要求のヘッダー メッセージに添付する必要があります。DCNM-SAN Web サービスは、ログオン WS によって管理されている一意のトークン ストリングを使用してユーザ クレデンシャルを確認します。どのような場合でも、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 サービスが必要なユーザ クレデンシャルを管理します。IdentityManager は、トークンを管理および保守するトークン プロバイダーです。ユーザの認証およびトークンの生成を行い、定期的にキャッシュをチェックしてクリアし、トークンを検証したりトークンの有効期限を終了します。

San WS

San サービスは、SAN 関連のサービス要求を管理し、DCNM-SAN にクエリーを実行して情報を取得する Enterprise Java Beans(EJB)コンポーネントです。San WS は、要求を実行する前に IdentityManager に確認して認証を行います。有効なトークン ストリングは、San サービスに対して、そのユーザが DCNM-SAN ユーザであること、および要求を受け付けて実行する必要があることを示します。必要な情報を取得したら、その結果をユーザに戻します。SanWS のエラー ログは fms_ws.log に記録されます。SanWS のサービス エンドポイント インターフェイス(SEI)によってサービスの操作が定義され、エンド ユーザに送信されます。

getFabrics

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

戻り値

接続ファブリックの配列

エラー

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

getFabricByIP

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

パラメータ

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

戻り値

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

エラー

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

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

getPmEntity

データベースから PM エンティティを返します。

戻り値

データベースからの PM エンティティ

エラー

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

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

getPmChartData

特定の RRD ファイルの PM 統計情報を返します。

戻り値

特定の RRD ファイルの PM 統計情報

エラー

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

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

getFabricByKey

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

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

getFabricBySwitchKey

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

パラメータ

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

戻り値

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

エラー

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

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

getSwitchesByFabric

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

パラメータ

key:ファブリックのキー

戻り値

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

エラー

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

getNeighborSwitches

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

パラメータ

key:WwnKey オブジェクト

戻り値

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

エラー

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

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

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

getActiveServerNodes

SAN サーバのすべてのアクティブな DCNM のリストを返します。

パラメータ

key:ファブリックのキー

戻り値

アクティブであるすべてのファブリック サーバのリスト

エラー

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

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

getFabricWithSnmpCredentail

SNMP クレデンシャルを含むファブリック(ステータスがオープン中であるファブリックを除く)のリストを返します。

パラメータ

key:ファブリックのキー

戻り値

SNMP クレデンシャルを含むすべてのファブリックのリスト

エラー

エラー コード: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:WwnKey オブジェクト

戻り値

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

エラー

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

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

getNeighborSwitches

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

パラメータ

key:WwnKey オブジェクト

戻り値

指定された 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

この関数は、指定されたファブリック データを DCNM-SAN キャッシュとデータベースの両方から消去します。

パラメータ

key:ファブリック キー

戻り値

なし

エラー

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

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

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

getEndports

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

戻り値

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

エラー

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

getEnclosures

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

戻り値

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

エラー

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

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:エンド ポート キーの値

enclosureKey:ラック キーの値

戻り値

なし

エラー

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

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

getHosts

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

戻り値

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

エラー

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

getHost

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

パラメータ

key:VSAN の名前

戻り値

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

エラー

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

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

getHostByFabric

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

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

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

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

パラメータ

key:ファブリックの名前

戻り値

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

エラー

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

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

getStorages

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

戻り値

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

エラー

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

getStorageByFabric

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

パラメータ

key:ファブリックの名前

戻り値

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

エラー

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

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

getHostPorts

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

パラメータ

key:ファブリックの名前

戻り値

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

エラー

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

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

getDomainId

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

パラメータ

key:Wwn

vsanid:VSAN の固有識別子

戻り値

ドメイン IP アドレス

エラー

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

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

getVsanIp

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

パラメータ

key:Wwn

vsanid:VSAN の固有識別子

戻り値

VSAN の IP アドレス

エラー

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

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

getVsanDomains

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

パラメータ

Key:Wwnkey

戻り値

スイッチの VSAN ドメイン

エラー

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

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

getIvrEnfZoneSetName

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

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名

エラー

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

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

getIvrEnfZoneSetNumber

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

パラメータ

key:ファブリック キー

戻り値

ゾーン番号

エラー

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

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

getIvrEnfZoneSetActivateTime

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

getIvrEnfZoneSet

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

getIvrActiveZonesetChecksum

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

パラメータ

key:ファブリック キー

戻り値

チェックサム値

エラー

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

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

getAliases

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

useFcAlias

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

getEnfZoneSet

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

パラメータ

key:ファブリック キー

戻り値

ゾーンのリスト

エラー

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

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

getEnfZoneSetName

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

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名のリスト

エラー

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

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

getEnfZoneSetName

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

パラメータ

key:ファブリック キー

戻り値

ゾーン セット名のリスト

エラー

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

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

getFCAliases

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

パラメータ

key:ファブリック キー

戻り値

エイリアスのリスト

エラー

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

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

getFCAliasesByVsan

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

パラメータ

key:ファブリック キー

戻り値

VSAN のエイリアスのリスト

エラー

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

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

getCFS

CFS を返します。

パラメータ

key:ファブリック キー

戻り値

CFS 機能のリスト

エラー

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

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

getCFSBySwitch

CFS を返します。

パラメータ

Key:スイッチ キー

戻り値

CFS 機能のリスト

エラー

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

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

getZoneMode

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

getZoneModeByVsan

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

パラメータ

key:VSAN キー

戻り値

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

エラー

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

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

getZoneAttributes

ゾーン属性を返します。

パラメータ

key:ファブリック キー

戻り値

ゾーン属性

エラー

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

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

getZoneAttributesByVsan

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

パラメータ

key:VSAN キー

戻り値

VSAN のゾーン属性

エラー

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

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

getSwitchPorts

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

isIVREnabled

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

パラメータ

Key:スイッチ キー

戻り値

ブール値

エラー

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

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

getSwitchDateAndTime

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

パラメータ

Key:スイッチ キー

戻り値

ブール値

エラー

エラー コード:400:SnmpException

Zone Manager WS - SEI

activateZoneset

ゾーン セットをアクティブにします。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン セットの動作ステータス

エラー

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

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

addZone

ゾーンのリストに新しいゾーンを追加します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン オブジェクト

エラー

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

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

addZoneAlias

ゾーン エイリアスを追加します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン オブジェクト

エラー

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

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

addZoneMemberToZone

新しいゾーン メンバを特定のゾーンに追加します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン メンバの ID

エラー

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

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

addZoneMemberToZoneAlias

ゾーン エイリアスにゾーン メンバを追加します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン メンバ

エラー

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

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

createZone

新しいゾーンを作成します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン オブジェクト

エラー

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

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

createZoneAlias

ゾーン エイリアスを作成します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン エイリアス オブジェクト

エラー

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

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

createZoneMemberInZone

指定されたゾーン内にゾーン メンバを作成します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

メンバ ID

エラー

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

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

createZoneMemberInZoneAlias

指定されたゾーン エイリアス内にゾーン メンバを作成します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

メンバ ID

エラー

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

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

createZoneSet

ゾーン セットを作成します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン セットの ID

エラー

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

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

deActivateZoneset

ゾーン セットの動作ステータスを返します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン セットの動作ステータス

エラー

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

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

getEnfZoneSet

適用されたゾーン セットを返します。

パラメータ

key:WwnKey

key:VSAN の名前

戻り値

ゾーン セットの ID

エラー

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

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

getEnfZoneSetName

適用されたゾーン セットの名前を返します。

パラメータ

Key:Wwnkey

key:VSAN の名前

戻り値

ゾーン セットの ID

エラー

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

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

getIvrActiveZonesetChecksum

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

パラメータ

key:FabricKey

戻り値

チェックサム値

エラー

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

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

getIvrEnfZoneNumber

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

パラメータ

key:FabricKey

戻り値

ゾーン番号

エラー

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

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

getIvrEnfZoneSet

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

パラメータ

key:FabricKey

戻り値

ゾーン セット ID

エラー

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

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

getIvrEnfZoneSetActivateTime

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

パラメータ

key:FabricKey

戻り値

1970 年 1 月 1 日 00:00:00 UT の UNIX 時間の起点から経過した秒数としてのシステム時刻

エラー

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

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

getIvrEnfZoneSetName

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

パラメータ

key:WWNKey

戻り値

ゾーン ID

エラー

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

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

getZone

ゾーン ID の配列を返します。

パラメータ

Key:Wwnkey

戻り値

ゾーン オブジェクト

エラー

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

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

getZoneAlias

ゾーン エイリアスを返します。

パラメータ

Key:Wwnkey

key:VSAN キー

戻り値

ゾーン エイリアス オブジェクト

エラー

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

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

getZoneAliases

ゾーン エイリアスの配列を返します。

パラメータ

Key:Wwnkey

key:VSAN キー

戻り値

ゾーン エイリアスのリスト

エラー

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

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

getZoneAttributes

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

パラメータ

Key:Wwnkey

key:VSAN キー

戻り値

ゾーン属性のリスト

エラー

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

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

getZoneAttributesByVsan

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

パラメータ

Key:Wwnkey

戻り値

VSAN のゾーン属性のリスト

エラー

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

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

getZoneCapabilitiesByFabric

指定されたファブリック キーに関連付けられたゾーン情報を返します。

パラメータ

key:ファブリック キー

戻り値

ZoneCapabilities オブジェクト

エラー

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

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

getZoneCapabilitiesByVsan

VSAN のすべてのゾーン情報を返します。

パラメータ

Key:Wwnkey

戻り値

ZoneCapabilities オブジェクト

エラー

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

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

getZoneMode

ゾーン モードのリストを返します。

パラメータ

Key:Wwnkey

戻り値

ゾーン情報

エラー

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

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

getZoneModeByVsan

VSAN のゾーン モードのリストを返します。

パラメータ

key:VSAN キー

戻り値

VSAN のゾーン情報

エラー

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

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

getZoneSet

ゾーン セットを返します。

パラメータ

Key:Wwnkey

戻り値

ゾーン セット

エラー

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

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

getZoneSets

ゾーン セットのリストを返します。

パラメータ

Key:Wwnkey

戻り値

ゾーン セットのリスト

エラー

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

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

getZones

ゾーンのリストを返します。

パラメータ

Key:Wwnkey

戻り値

ゾーンのリスト

エラー

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

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

統計情報 WS

getEndDeviceStatistics

エンド デバイスの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

エンド デバイスの統計情報

エラー

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

getEndDeviceStatisticsByAlias

デバイス エイリアスによってエンド デバイスの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

エンド デバイスの統計情報

エラー

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

getEthPortStatisticsByKey

イーサネット ポートの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

イーサネット ポートの統計情報

エラー

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

getEthPortStatisticsBySwitch

スイッチに基づいて、イーサネット ポートの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

スイッチに基づいたイーサネット ポートの統計情報

エラー

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

getFcPortStatistics

ファイバ チャネル ポートの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

ファイバ チャネル ポートの統計情報

エラー

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

getFcPortStatisticsByKey

スイッチ WWN に基づいて、ファイバ チャネル ポートの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

ファイバ チャネル ポートの統計情報

エラー

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

getFcPortStatisticsBySwitch

スイッチに基づいて、ファイバ チャネル ポートの統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

ファイバ チャネル ポートのポート統計情報

エラー

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

getIPEndPointStatisticsByKey

スイッチ WWN に基づいて、IPEndPoint の統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

IPEndPoint の統計情報

エラー

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

getIPEndPointStatisticsBySwitch

スイッチに基づいて、IPEndPoint の統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

IPEndPoint の統計情報

エラー

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

getTCPEndPointStatisticsByKey

スイッチ WWN に基づいて、TCPEndPoint の統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

TCPEndPoint の統計情報

エラー

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

getTCPEndPointStatisticsBySwitch

スイッチに基づいて、TCPEndPoint の統計情報を返します。

パラメータ

Key:Wwnkey

戻り値

スイッチ上の TCPEndPoint の統計情報

エラー

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

セキュリティ WS

getAaaMaxServer

AAA 設定のサーバ グループ内のサーバ エントリの最大数の値を返します。

パラメータ

Key:Wwnkey

戻り値

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

エラー

エラー コード:400:SnmpException

getAaaMaxAppServer

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

パラメータ

Key:Wwnkey

戻り値

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

エラー

エラー コード:400:SnmpException

isClearAcctLogSet

アカウンティング ログのクリアが設定されているかどうかをチェックします。

パラメータ

Key:Wwnkey

戻り値

アカウンティング ログのクリアが設定されているかどうかをチェックします。

エラー

エラー コード:400:SnmpException

isMSCHAPRequired

ユーザを認証するために 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

キー ペア名、失効メソッドのリスト、および証明書失効のための外部の 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

isFipsModeEnabled

FIPS モードに関する情報を返します。

パラメータ

Key:Wwnkey

戻り値

FIPS モードに関する情報

エラー

エラー コード:400:SnmpException

プロトコル WS

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

getFcipProfiles

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

パラメータ

key:ファブリック キー

戻り値

FCIP プロファイルのリスト

エラー

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

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

getFcipProfilesBySwitch

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

パラメータ

Key:スイッチ キー

戻り値

FCIP プロファイルのリスト

エラー

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

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

getFcipTunnels

FCIP トンネルを返します。

パラメータ

key:ファブリック キー

戻り値

FCIP トンネルのリスト

エラー

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

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

getFcipTunnelsBySwitch

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

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネルのリスト

エラー

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

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

getFcipTunnelByLinkIndex

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

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネルのリスト

エラー

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

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

getFcipTunnelByLinkIfIndex

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

パラメータ

Key:スイッチ キー

戻り値

FCIP トンネルのリスト

エラー

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

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

getFcipTunnelErrors

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

パラメータ

key:ファブリック キー

戻り値

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

エラー

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

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

getFcipTunnelErrorsBySwitch

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

パラメータ

Key:スイッチ キー

戻り値

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

エラー

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

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

getIpSettingsBySwitch

スイッチからの IP 設定を返します。

パラメータ

Key:スイッチ キー

戻り値

スイッチからの IP 設定

エラー

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

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

getIpSettings

スイッチとポートからの IP 設定を返します。

パラメータ

key:ポート キー

戻り値

スイッチとポートからの IP 設定

エラー

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

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

getTcpSettingsBySwitch

スイッチからの TCP 設定を返します。

パラメータ

Key:スイッチ キー

戻り値

スイッチからの TCP 設定

エラー

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

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

getTcpSettings

スイッチからの TCP 設定を返します。

パラメータ

Key:スイッチ キー

戻り値

スイッチからの TCP 設定

エラー

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

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

クラスタ WS - SEI

Cluster WS のサービス エンド ポイント インターフェイス(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:IP アドレス

戻り値

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

エラー

エラー コード:400:SnmpException

getFabricByEnclosureKey

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

パラメータ

key:ラックの名前

戻り値

ファブリックの名前

エラー

エラー コード:400:SnmpException

getServerIpByEnclosureKey

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

パラメータ

key:ファブリックの名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

getServerIpByVsanKey

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

パラメータ

key:VSAN の名前

戻り値

サーバの IP アドレス

エラー

エラー コード:400:SnmpException

イベント WS - SEI

イベント WS のサービス エンド ポイント インターフェイス(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

インベントリ WS のサービス エンド ポイント インターフェイス(SEI)によって、インベントリ Web サービスのためのサービス エンド ポイント インターフェイスが定義されます。次のメソッドがエンド ユーザに公開されています。

getPowerSuppliesBySwitchWwnKey

スイッチによって電源の名前を返します。

パラメータ

Key:Wwnkey

戻り値

電源名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getPowerSuppliesBySwitchSnKey

スイッチによって電源の名前を返します。

パラメータ

key:swKey

戻り値

電源名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getPowerSuppliesBySwitchIP

スイッチ IP アドレスによって電源の名前を返します。

パラメータ

key:swKey

戻り値

電源名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getCardsBySwitchWwnKey

スイッチ キーからのカードの名前を返します。

パラメータ

key:swKey

戻り値

カード名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getCardsBySwitchSnkey

スイッチ キーからのカードの名前を返します。

パラメータ

key:swKey

戻り値

カード名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getCardsBySwitchIP

スイッチ IP アドレスによってカードの名前を返します。

パラメータ

key:swKey

戻り値

カード名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getFansBySwitchWwnKey

スイッチ キーによってファンの名前を返します。

パラメータ

key:swKey

戻り値

ファン名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getFansBySwitchSnKey

スイッチ キーによってファンの名前を返します。

パラメータ

key:swKey

戻り値

ファン名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getFansBySwitchIP

スイッチ IP アドレスによってファンの名前を返します。

パラメータ

key:swKey

戻り値

ファン名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getChassisBySwitchWwnKey

スイッチ キーによってシャーシの名前を返します。

パラメータ

key:swKey

戻り値

シャーシ名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getChassisBySwitchSnKey

スイッチ キーによってシャーシの名前を返します。

パラメータ

key:swKey

戻り値

シャーシ名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getChassisBySwitchIP

スイッチ IP アドレスによってシャーシの名前を返します。

パラメータ

key:swKey

戻り値

シャーシ名のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getAllHbas

ホスト IP アドレスによってホストの名前を返します。

パラメータ

key:hba WWN

戻り値

HBA のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getHbaByWwn

ホスト IP アドレスによってホストの名前を返します。

パラメータ

key:hba WWN

戻り値

HBA のリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getLicensesBySwitchWwnKey

スイッチで使用されているライセンスの名前を返します。

パラメータ

key:swKey

戻り値

ライセンスのリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getLicensesBySwitchIP

スイッチで使用されているライセンスの名前を返します。

パラメータ

key:swKey

戻り値

ライセンスのリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getLicenseFlags

スイッチで使用されているライセンスの名前を返します。

パラメータ

key:swKey

戻り値

ライセンスのリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

getCardByPhysicalIndex

物理およびスイッチ インデックスを返します。

パラメータ

key:swKey

戻り値

インデックスのリスト

エラー

エラー コード:300 または 201(SAN サービス エラーまたは無効な引数)

エラー コード

エラー コード
説明

100

認証失敗

101

無効なクレデンシャル

102

無効な特権

103

無効なトークン

200

Web サービス エラー

201

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

202

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

300

SAN サービス エラー

301

無効なクエリー キー

400

SNMP エラー

201

無効な引数


) DCNM-SAN Web サービスは、サーバ フェデレーションをサポートしています。SanWS、セキュリティ WS、プロトコル WS、イベント WS、およびインベントリ WS へのサービス要求により、フェデレーション内の適切なサーバにコールが自動的にディスパッチされます。サーバ フェデレーションを使用している場合、次のメソッドはフェデレーション内の該当するサーバに対して自動的に調停されません。

SanWS:
getEnclosures()
getEndports()
getFabricByIP()
getHosts()
getStorages()
getSwitchIPByName()
getSwitches()

インベントリ WS:
getAllHbas()
getLicenseFlags()

これらの特定のインスタンスでは、要求を送信する必要のあるサーバを決定するためにクラスタ WS に依存することが必要になる場合があります。