ページの先頭行へ戻る
Systemwalker Software Configuration Manager V14g リファレンスガイド API編
Systemwalker
第4章 CFMG APIリファレンス > 4.6 仮想システムの操作 > 4.6.7 ListNetworkInfo
前次

4.6.7 ListNetworkInfo

対象システムのネットワーク情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

固定。「ListNetworkInfo」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

型

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

型

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

正常に終了した場合に「200 OK」を返します。


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vnets>
    <vnet>
      <networkId>[ネットワークID]</networkId>
      <name>[ネットワーク名]</name>
      <networkCategory>[ネットワーク種別]</networkCategory>
      <addressSet>
        <name>[アドレスセット名]</name>
        <subnet>[アドレスセットのサブネットアドレス]</subnet>
        <mask>[アドレスセットのネットマスク]</mask>
        <start>[アドレスセットの開始アドレス]</start>
        <end>[アドレスセットの終了アドレス]</end>
      </addressSet>
      <excludeaddressrenges>
        <excludeaddressrange>
          <start>[除外アドレスの開始アドレス]</start>
          <end>[除外アドレスの終了アドレス]</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <addressSetStatus>
        <num>[アドレスセットのアドレス総数]</num>
        <used>[アドレスセットの予約済みアドレス個数]</used>
        <avail>[アドレスセットの空きアドレス個数]</avail>
      </addressSetStatus>
    </vnet>
  </vnets>
</ListNetworkInfoResponse>

《要素》

要素名

項目

項目説明

ListNetworkInfoResponse

説明

レスポンスの情報を持つ要素

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録B レスポンスステータス・エラーコード一覧」を参照してください。

型

string ASCII

出現回数

1

vnets

説明

ネットワーク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vnet

説明

ネットワーク情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

vnetの数分(それぞれに対して0または1)

name

説明

システム名

型

string UTF-8

出現回数

vnetの数分(それぞれに対して0または1)

networkCategory

説明

ネットワーク種別。管理LANの場合は「MANAGEMENT」、業務LANの場合は「BUSINESS」です。登録されていない場合は空文字になります。

型

string ASCII

出現回数

vnetの数分(それぞれに対して0または1)

addressSet

説明

アドレスセット情報の一式

型

なし

出現回数

vnetの数分(それぞれに対して0または1)

name

説明

アドレスセット名

型

string UTF-8

出現回数

addressSetの数分(それぞれに対して0または1)

subnet

説明

アドレスセットのサブネットアドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

mask

説明

アドレスセットのネットマスク

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

start

説明

アドレスセットの開始アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

end

説明

アドレスセットの終了アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

excludeaddressranges

説明

除外アドレス情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

excludeaddressrange

説明

除外アドレス情報の一式

型

なし

出現回数

0以上

start

説明

除外アドレスの開始アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

end

説明

除外アドレスの終了アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

addressSetStatus

説明

アドレスセットのステータス情報の一式

型

なし

出現回数

0または1

num

説明

アドレスセットのアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)

used

説明

アドレスセットの予約済みアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)

avail

説明

アドレスセットの空きアドレス個数

型

int

出現回数

addressSetStatusの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vnets>
    <vnet>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set10</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>138</avail>
        <num>140</num>
        <used>2</used>
      </addressSetStatus>
      <networkCategory>BUSINESS</networkCategory>
      <networkId>testorg-vsys-3-N-INTRANET</networkId>
    </vnet>
    <vnet>
      <addressSet>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set20</name>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>116</avail>
        <num>120</num>
        <used>4</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <end>192.xxx.xxx.xxx</end>
          <start>192.xxx.xxx.xxx</start>
        </excludeaddressrange>
      </excludeaddressranges>
      <networkCategory>MANAGEMENT</networkCategory>
      <networkId>testorg-vsys-3-N-INTERNET</networkId>
    </vnet>
  </vnets>
</ListNetworkInfoResponse>

前次
Copyright 2011 FUJITSU LIMITED