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

7.3.2 仮想システムの操作

仮想システムの操作に関連するCFMG APIについて説明します。

7.3.2.1 CreateVSYS

テンプレートを元にシステムを作成します。テンプレートに定義されているすべての仮想マシンを「PowerOn」し、システムを自動的に起動します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内

vsysDescriptorId

説明

システムテンプレートID

型

string ASCII

設定内容

32文字以内

vsysName

説明

システム名

型

string UTF-8

設定内容

85文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysId>[システムID]</vsysId>
</CreateVSYSResponse>

《要素》

要素名

項目

項目説明

CreateVSYSResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vsysId

説明

システムID

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CreateVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysId>VSYS000001</vsysId>
</CreateVSYSResponse>

7.3.2.2 ListVSYS

仮想データセンター内にあるシステムの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

8文字以内


レスポンス

《ステータスコード》

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


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsyss>
    <vsys>
      <baseDescriptor>[システムの元になったテンプレートID]</baseDescriptor>
      <creator>[システム作成者の組織ID]</creator>
      <description>[システムの説明]</description>
      <vsysId>[システムID]</vsysId>
      <vsysName>[システム名]</vsysName>
    </vsys>
  </vsyss>
</ListVSYSResponse>

《要素》

要素名

項目

項目説明

ListVSYSResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vsyss

説明

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

型

なし

出現回数

0または1

vsys

説明

システム情報の一式

型

なし

出現回数

0以上

baseDescriptor

説明

システムの元になったテンプレートID

型

string ASCII

出現回数

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

creator

説明

システム作成者の組織ID

型

string ASCII

出現回数

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

description

説明

システムの説明

型

string UTF-8

出現回数

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

vsysId

説明

システムID

型

string ASCII

出現回数

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

vsysName

説明

システム名

型

string UTF-8

出現回数

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


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsyss>
    <vsys>
      <baseDescriptor>testTemplate000</baseDescriptor>
      <creator>testorg</creator>
      <description>Linux2階層</description>
      <vsysId>testorg-vsys-3</vsysId>
      <vsysName>正常</vsysName>
    </vsys>
  </vsyss>
</ListVSYSResponse>

7.3.2.3 DestroyVSYS

システムを返却します。システム内にあるリソースはすべて削除され、無効となります。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<DestroyVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</DestroyVSYSResponse>

《要素》

要素名

項目

項目説明

DestroyVSYSResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<DestroyVSYSResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroyVSYSResponse>

7.3.2.4 GetVSYSStatus

システムの状態情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<GetVSYSStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsysStatus>[システムの状態]</vsysStatus>
</GetVSYSStatusResponse>

《要素》

要素名

項目

項目説明

GetVSYSStatusResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vsysStatus

説明

システムの状態。以下のどれかになります。
・「NORMAL」: 正常稼動中
・「RECONFIG_ING」: 構成変更中
・「DEPLOYING」: 配備中
・「ERROR」: システムエラー

型

string ASCII

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSStatusResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsysStatus>NORMAL</vsysStatus>
</GetVSYSStatusResponse>

7.3.2.5 GetVSYSConfiguration

システムの構成情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?> 
<GetVSYSConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsys>
    <baseDescriptor>[システムの元になったシステムテンプレートID]</baseDescriptor>
    <creator>[システム作成者の組織ID]</creator>
    <description>[システムの説明]</description>
    <vnets>
      <vnet>
        <networkId>[VNETのID]</networkId>
        <networkCategory>[ネットワーク種別]</networkCategory>
      </vnet>
    </vnets>
    <vservers>
      <vserver>
        <creator>[仮想マシン作成者の組織ID]</creator>
        <diskimageId>[ディスクイメージID]</diskimageId>
        <diskimageName>[ディスクイメージ名]</diskimageName>
        <vdisks>
          <vdisk>
            <attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
            <creator>[増設ディスクの作成者の組織ID]</creator>
            <size>[増設ディスクサイズ]</size>
            <vdiskId>[増設ディスクID]</vdiskId>
            <vdiskName>[増設ディスク名]</vdiskName>
            <storagePool>[ストレージプールのリソース名]</storagePool>
          </vdisk>
        </vdisks>
        <vnics>
          <vnic>
            <networkId>[ネットワークID]</networkId>
            <nicNo>[NIC連番]</nicNo>
            <privateIp>[IPアドレス]</privateIp>
            <management>[制御NIC]</management>
          </vnic>
        </vnics>
        <vserverId>[仮想マシンID]</vserverId>
        <vserverName>[仮想マシン名]</vserverName>
        <vmType>[VM種別]</vmType>
        <vmPool>[VMプールのリソース名]</vmPool>
        <storagePool>[ストレージプールのリソース名]</storagePool>
        <cpuPerf>[CPU性能]</cpuPerf>
        <numOfCpu>[CPU数]</numOfCpu>
        <cpuReserve>[CPU予約性能]</cpuReserve>
        <cpuShare>[CPU配分比]</cpuShare>
        <memorySize>[メモリ量]</memorySize>
        <memoryReserve>[メモリ予約容量]</memoryReserve>
        <memoryShare>[メモリ配分比]</memoryShare>
        <vserverType>[仮想マシンのタイプ]</vserverType>
      </vserver>
    </vservers>
    <vsysId>[システムID]</vsysId>
    <vsysName>[システム名]</vsysName>
  </vsys>
</GetVSYSConfigurationResponse>

《要素》

要素名

項目

項目説明

GetVSYSConfigurationResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vsys

説明

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

型

なし

出現回数

0または1

baseDescriptor

説明

システムの元になったテンプレートID

型

string ASCII

出現回数

0または1

creator

説明

システム作成者の組織ID

型

string ASCII

出現回数

0または1

description

説明

システムの説明

型

string UTF-8

出現回数

0または1

vnets

説明

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

型

なし

出現回数

0または1

vnet

説明

ネットワーク情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

networkCategory

説明

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

型

string ASCII

出現回数

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

vservers

説明

仮想マシン情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vserver

説明

仮想マシン情報の一式

型

なし

出現回数

0以上

creator

説明

仮想マシン作成者の組織ID

型

string ASCII

出現回数

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

diskimageId

説明

ディスクイメージID

型

string ASCII

出現回数

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

diskimageName

説明

ディスクイメージ名

型

string ASCII

出現回数

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

vdisks

説明

増設ディスク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

vdisk

説明

増設ディスク情報の一式

型

なし

出現回数

0以上

attachedTo

説明

増設ディスクが取り付けられている仮想マシンID

型

string ASCII

出現回数

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

creator

説明

増設ディスク作成者の組織ID

型

string ASCII

出現回数

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

size

説明

増設ディスクサイズ。「GB」単位で指定します。

型

decimal

出現回数

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

vdiskId

説明

増設ディスクID

型

string ASCII

出現回数

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

vdiskName

説明

増設ディスク名

型

string UTF-8

出現回数

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

storagePool

説明

ストレージプールのリソース名

型

string ASCII

出現回数

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

vnics

説明

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

型

なし

出現回数

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

vnic

説明

VNIC情報の一式

型

なし

出現回数

0以上

networkId

説明

ネットワークID

型

string ASCII

出現回数

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

nicNo

説明

NIC連番

型

int

出現回数

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

privateIp

説明

IPアドレス

型

string ASCII

出現回数

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

management

説明

制御NIC。制御NICの場合は1、そうでない場合は0になります。

型

int

出現回数

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

vserverId

説明

仮想マシンID

型

string ASCII

出現回数

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

vserverName

説明

仮想マシン名

型

string UTF-8

出現回数

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

vmType

説明

VM種別。以下のどれかになります。
・「VMware」:VMware
・「RHEL-Xen」: RHEL-Xen
・「Hyper-V」:Hyper-V

型

string ASCII

出現回数

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

vmPool

説明

VMプールのリソース名

型

string UTF-8

出現回数

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

storagePool

説明

ストレージプールのリソース名

型

string UTF-8

出現回数

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

cpuPerf

説明

CPU性能

型

decimal

出現回数

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

numOfCpu

説明

CPU数

型

int

出現回数

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

cpuReserve

説明

CPU予約性能

型

decimal

出現回数

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

cpuShare

説明

CPU配分比

型

int

出現回数

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

memorySize

説明

メモリ量

型

decimal

出現回数

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

memoryReserve

説明

メモリ予約容量

型

decimal

出現回数

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

memoryShare

説明

メモリ配分比

型

int

出現回数

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

vserverType

説明

仮想マシンのタイプ

型

string ASCII

出現回数

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

vsysId

説明

システムID

型

string ASCII

出現回数

0または1

vsysName

説明

システム名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsys>
    <baseDescriptor>testTemplate000</baseDescriptor>
    <creator>testorg</creator>
    <description>Linux2階層</description>
    <vnets>
      <vnet>
        <networkCategory>INTRANET</networkCategory>
        <networkId>testorg-vsys-3-N-INTRANET</networkId>
      </vnet>
      <vnet>
        <networkCategory>INTRANET</networkCategory>
        <networkId>testorg-vsys-3-N-INTERNET</networkId>
      </vnet>
    </vnets>
    <vservers>
      <vserver>
        <cpuPerf>1.3</cpuPerf>
        <creator>testorg</creator>
        <diskimageId>image_id_1</diskimageId>
        <diskimageName>image-1</diskimageName>
        <memorySize>8.9</memorySize>
        <memoryReserve>0.5</memoryReserve>
        <memoryShare>1000</memoryShare>
        <numOfCpu>2</numOfCpu>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <storagePool>/sp_3</storagePool>
        <vdisks>
          <vdisk>
            <attachedTo>testorg-vsys-3-S-0001</attachedTo>
            <creator>testorg</creator>
            <size>12.2</size>
            <storagePool>/sp_3</storagePool>
            <vdiskId>testorg-vsys-3-D-0001</vdiskId>
            <vdiskName>DISK1</vdiskName>
          </vdisk>
          <vdisk>
            <attachedTo>testorg-vsys-3-S-0001</attachedTo>
            <creator>testorg</creator>
            <size>15.5</size>
            <storagePool>/sp_6</storagePool>
            <vdiskId>testorg-vsys-3-D-0002</vdiskId>
            <vdiskName>DISK2</vdiskName>
          </vdisk>
        </vdisks>
        <vmPool>/vp_3</vmPool>
        <vmType>RHEL-Xen</vmType>
        <vnics>
          <vnic>
            <management>0</management>
            <networkId>testorg-vsys-3-N-INTRANET</networkId>
            <nicNo>1</nicNo>
            <privateIp>10.xx.xx.xx</privateIp>
          </vnic>
          <vnic>
            <management>0</management>
            <networkId>testorg-vsys-3-N-INTRANET</networkId>
            <nicNo>2</nicNo>
            <privateIp>10.xx.xx.xx</privateIp>
          </vnic>
        </vnics>
        <vserverId>testorg-vsys-3-S-0001</vserverId>
        <vserverName>ap2</vserverName>
        <vserverType>island12_100</vserverType>
      </vserver>
      <vserver>
        <cpuPerf>1.6</cpuPerf>
        <creator>testorg</creator>
        <diskimageId>ROR-manager_382</diskimageId>
        <diskimageName>image-2</diskimageName>
        <memorySize>4.1</memorySize>
        <memoryReserve>0.5</memoryReserve>
        <memoryShare>1000</memoryShare>
        <numOfCpu>4</numOfCpu>
        <cpuReserve>0.5</cpuReserve>
        <cpuShare>10</cpuShare>
        <storagePool>/sp_6</storagePool>
        <vdisks>
          <vdisk>
            <attachedTo>testorg-vsys-3-S-0002</attachedTo>
            <creator>testorg</creator>
            <size>16.6</size>
            <storagePool>/sp_7</storagePool>
            <vdiskId>testorg-vsys-3-D-0003</vdiskId>
            <vdiskName>DISK3</vdiskName>
          </vdisk>
        </vdisks>
        <vmPool>/vp_6</vmPool>
        <vmType>RHEL-Xen</vmType>
        <vnics>
          <vnic>
            <management>0</management>
            <networkId>testorg-vsys-3-N-INTRANET</networkId>
            <nicNo>1</nicNo>
            <privateIp>10.xx.xx.xx</privateIp>
          </vnic>
        </vnics>
        <vserverId>testorg-vsys-3-S-0002</vserverId>
        <vserverName>ap1</vserverName>
        <vserverType>island12_100</vserverType>
      </vserver>
    </vservers>
    <vsysId>testorg-vsys-3</vsysId>
    <vsysName>正常</vsysName>
  </vsys>
</GetVSYSConfigurationResponse>

7.3.2.6 GetVSYSAttributes

システムの属性情報を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

型

string ASCII

設定内容

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

Locale

説明

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

型

string ASCII

設定内容

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

Action

説明

実行するCFMG APIの名称

型

string ASCII

設定内容

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

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"?>
<GetVSYSAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <vsys>
    <baseDescriptor>[システムの元になったテンプレートID]</baseDescriptor>
    <creator>[システム作成者の組織ID]</creator>
    <description>[システムの説明]</description>
    <vsysId>[システムID]</vsysId>
    <vsysName>[システム名]</vsysName>
  </vsys>
</GetVSYSAttributesResponse>

《要素》

要素名

項目

項目説明

GetVSYSAttributesResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

vsys

説明

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

型

なし

出現回数

0または1

baseDescriptor

説明

システムの元になったテンプレートID

型

string ASCII

出現回数

0または1

creator

説明

システム作成者の組織ID

型

string ASCII

出現回数

0または1

description

説明

システムの説明

型

string UTF-8

出現回数

0または1

vsysId

説明

システムID

型

string ASCII

出現回数

0または1

vsysName

説明

システム名

型

string UTF-8

出現回数

0または1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetVSYSAttributesResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <vsys>
    <baseDescriptor>testTemplate000</baseDescriptor>
    <creator>testorg</creator>
    <description>Linux2階層</description>
    <vsysId>testorg-vsys-3</vsysId>
    <vsysName>正常</vsysName>
  </vsys>
</GetVSYSAttributesResponse>

7.3.2.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

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、『メッセージ集』の「CFMG APIが出力するメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

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 2010-2011 FUJITSU LIMITED