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

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

注意

対象のL-Platform内にSolarisコンテナのサーバが存在する場合、本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
	設定内容	以下のどちらかを指定します。・Physical：物理サーバ・Virtual：仮想サーバ省略した場合はVirtualが指定されたものとして動作します。
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)までの値を指定してください。 RHEL-KVMを利用する場合は指定しても無視され、プールの最大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

コマンド

CreateLServer -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverName サーバの名前 -serverType サーバのタイプ
 [-lserverType サーバの種別] -diskImageId ディスクイメージID -controlNetworkId 制御NICのネットワークID
 [-networkId 制御NIC以外のネットワークID] [-pool VMプールのリソース名] [-storagePool ストレージプールのリソース名]
 [-cpuPerf CPU性能] [-numOfCpu CPU数] [-cpuReserve CPU予約性能]  [-cpuShare CPU配分比] [-memorySize メモリ容量]
 [-memoryReserve メモリ予約容量] [-memoryShare メモリ配分比] [-macAddress MACアドレスのアドレスセットリソース名]
 [-priority 電源起動優先度]

レスポンス

《ステータスコード》

正常に終了した場合に「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	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 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>