ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.2 リファレンスガイド (API編)
FUJITSU Software

2.3.4 CreateLServer (サーバを新規作成)

L-Platform内にサーバを作成します。起動ディスクに必要な初期コンテンツとして使用するディスクイメージIDは、必ず指定しなければなりません。リクエストメッセージはUTF-8を用いてエンコードされます。

本APIは、非同期で実行されます。本APIの実行に成功すると、処理の実行中はL-Platformの状態が構成変更中(RECONFIG_ING)に遷移し、処理が完了すると、L-Platformの状態が正常稼働中(NORMAL)に戻ります。
L-Platformの状態が構成変更中の場合は、L-Platformに対する操作ができません。
L-Platformの状態をGetLPlatformStatusで監視し、正常稼働中に遷移するのを待ってから次の操作を行ってください。

以下の場合、本APIは実行できません。

注意

物理サーバを作成する場合、設定するハードウェア装置の制約により、本APIは同時に2つまで実行できます。
2つ以上の物理サーバを作成する場合、時間間隔をあけて本APIを実行してください。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

L-Platform APIのバージョンID

string ASCII

設定内容

固定。"2.0"を指定してください。

Locale

説明

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

string ASCII

設定内容

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

Action

説明

実行するL-Platform APIの名称

string ASCII

設定内容

固定。"CreateLServer"を指定してください。

userId

説明

L-Platform APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

string ASCII

設定内容

32文字以内

lserverName

説明

サーバ名

string UTF-8

設定内容

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

serverType

説明

サーバタイプ

string ASCII

設定内容

32文字以内

[lserverType]

説明

サーバ種別

string ASCII

設定内容

本パラメーターは指定不要です。

diskImageId

説明

ディスクイメージID

string ASCII

設定内容

32文字以内

controlNetworkId

説明

制御NICを接続するネットワークID

string ASCII

設定内容

物理サーバを作成する場合には、管理LANのネットワークIDを指定する必要があります。
制御NICのIPアドレスを指定して配備する場合には、以下の形式で指定します。
controlNetworkId=network_id'xxx:xxx:xxx:xxx

[networkId]

説明

制御NIC以外のネットワークID

string ASCII

設定内容

複数のNICがある場合は、以下の形式で指定します。
networkId=network_1''network_2

また、IPアドレスを指定して配備する場合には、以下の形式で指定します。
networkId=network_1'xxx:xxx:xxx:xxx''network_2'xxx:xxx:xxx:xxx

[pool]

説明

VMプールまたはサーバプールのリソース名

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。
RHEL-KVMを利用する場合は指定必須です。
例:/tenantA/pool

[storagePool]

説明

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

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。
RHEL-KVMを利用する場合は指定必須です。
例:/tenantA/pool

[cpuPerf]

説明

CPU性能。GHz単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。
OVM for SPARCを利用する場合は指定しても無視され、配備されたVMホストのCPU性能値が設定されます。

decimal

設定内容

0.1~99999.9

[numOfCpu]

説明

CPU数

int

設定内容

1以上。最大値はイメージごとに指定された値(指定していない場合はINTの最大値)です。

[cpuReserve]

説明

CPU予約性能。0.0以上、cpuPerfまたはイメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

decimal

設定内容

0.0~99999.9

[cpuShare]

説明

[VM種別がVMwareの場合] CPUシェア

[VM種別がHyper-Vの場合] CPU割当優先度

物理サーバの場合は指定しても無視されます。

int

設定内容

[VM種別がVMwareの場合] 1~1000000

[VM種別がHyper-Vの場合] 1~10000

[memorySize]

説明

メモリ量。GByte単位で小数点第一位まで指定します。0.1以上、イメージで指定した最大値(指定していない場合は99999.9)までの値を指定してください。

decimal

設定内容

0.1~99999.9

[memoryReserve]

説明

[VM種別がVMwareの場合]
メモリ予約容量。0.0以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください。

[VM種別がHyper-Vの場合]
メモリ予約容量。0.1以上、memorySizeまたはイメージで指定した最大値のどちらか小さい方(指定していない場合は99999.9)までの値を指定してください。

物理サーバの場合は指定しても無視されます。

decimal

設定内容

[VM種別がVMwareの場合] 0.0~99999.9

[VM種別がHyper-Vの場合] 0.1~99999.9

[memoryShare]

説明

[VM種別がVMwareの場合] メモリ配分比

[VM種別がHyper-Vの場合] メモリ割当優先度

物理サーバの場合は指定しても無視されます。

int

設定内容

[VM種別がVMwareの場合] 0~1000000

[VM種別がHyper-Vの場合] 0~10000

[macAddress]

説明

MACアドレスのアドレスセットリソース名。RHEL5-Xenの場合に指定可能です。省略時は設定ファイルで指定したデフォルト値が使用されます。その他の場合は指定しても無効になります。

string ASCII

設定内容

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

[priority]

説明

一括電源制御時の起動優先度。この値が小さなサーバから起動されます。
本パラメーターを省略した場合は、"128" が設定されます。

int

設定内容

1~256

[diskResourceId]

説明

システムディスクに利用する既存ディスクのリソースIDを指定します。
本パラメーターはRHEL-KVMまたはOVM for SPARCのサーバを作成する場合にだけ指定可能です。
ただし、RHEL-KVMのサーバであっても、diskImageIdで指定するイメージの格納先種別が”Virtual Disk”の場合はこのパラメーターを指定できません。
本パラメーターを指定する場合、RHEL-KVMのサーバであっても、ストレージプールの指定が任意になります。
本パラメーターとストレージプールを同時に指定する場合、指定したストレージプール内に既存ディスクが存在している必要があります。

int

設定内容

0または1


レスポンス

《ステータスコード》

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


《XML》

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

《要素》

要素名

項目

項目説明

CreateLServerResponse

説明

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

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第15章 PAPIで始まるメッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

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

string ASCII

出現回数

1

lserverId

説明

サーバID

string ASCII

出現回数

0または1


サンプルレスポンス

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