uCosminexus Service Director リファレンス

文法書

3020-3-V16-10

目　　次

前書き

変更内容

はじめに

1.　運用コマンド

1.1　コマンドの概要

1.1.1　コマンドの種類

1.1.2　コマンドの一覧

1.1.3　エラーからの回復

1.1.4　コマンド実行可能status

1.1.5　コマンドの説明で使用する見出し

1.1.6　コマンドの共通仕様

1.1.7　コマンド使用時の注意事項

1.2　コマンドの機能

csdsetup（uCSD運用環境のセットアップ）

csdunsetup（uCSD運用環境のアンセットアップ）

csdtmpregister（テンプレートの登録）

csdtmpdelete（テンプレートの削除）

csdtmpcontrol（テンプレートの属性設定）

csdtmpupdate（テンプレートの更新）

csdtmpls（テンプレートの表示）

csdmiregister（マスターイメージの登録）

csdmidelete（マスターイメージの削除）

csdmiupdate（マスターイメージの更新）

csdmils（マスターイメージの表示）

csdmiexport（マスターイメージのエクスポート）

csdmipos（物理配置候補の算出）

csdmireserve（物理リソースの予約）

csdmirelease（物理リソースの予約解除）

csdrscls（物理リソース情報の出力）

csdrscstatus（物理リソースの状態変更）

csdrscupdate（物理構成情報の更新）

csdmideploy（マスターイメージのデプロイ）

csdmiundeploy（マスターイメージのアンデプロイ）

csdmistopdeploy（デプロイ処理の中断）

csdmivmstatus（仮想ホスト，ミドルウェアのステータス変更）

csdmisetpassword（仮想ホストのパスワード設定）

csdsetaccount（アカウント情報の登録）

csdinfoget（トラブルシュート情報の収集）

csddbcopy（データベースのバックアップ）

csddbrstr（データベースのリストア）

csdinstlin（ミドルウェアインストール）

2.　uCosminexus Service Directorで使用するファイル

2.1　定義ファイルの項目

2.1.1　構文要素

2.2　uCSDのシステム定義

2.2.1　セットアップ定義ファイル

2.2.2　システム定義ファイル

2.2.3　IPアドレス設定ファイル

2.2.4　物理構成定義ファイル

2.2.5　物理容量定義ファイル

2.2.6　負荷分散機接続設定プロパティファイル

2.2.7　リソース制約定義ファイル

2.3　テンプレート操作で使用するファイル

2.3.1　構成パターンテンプレートファイル

2.3.2　サイジングUOC

2.3.3　コンポーネントテンプレートファイル

2.3.4　ミドルウェア定義用テンプレートファイル

2.3.5　ミドルウェア定義用パラメータファイル

2.3.6　OS設定用テンプレートファイル

2.3.7　OS設定用パラメータファイル

2.3.8　ミドルウェアセットアップスクリプト

2.3.9　hosts_templateファイル

2.4　マスターイメージ操作で使用するファイル

2.4.1　マスターイメージ定義ファイル

2.4.2　UOC

2.4.3　マスターイメージ構成ファイル

2.4.4　物理配置制約ファイル

2.4.5　リソース定義ファイル

2.4.6　OSパッチ

2.4.7　ミドルウェアパッチ

3.　UOC

3.1　UOC概要

3.2　UOCの種類

3.2.1　サイジングUOC

3.2.2　ミドルセットアップUOC

3.3　UOC作成時の注意点

3.4　UOC詳細

SizingUocクラス

SizingParameterクラス

SizingResultクラス

CsdUocExceptionクラス

IMiddleSetupUocクラス

IMiddleSetupクラス

IMiddleSetupInformationクラス

IVmPropertyクラス

IMiPropertyクラス

IHostPropertyクラス

IRemoteHostConnectorクラス

IRemoteHostConnectManagerクラス

IUocLockTableクラス

IUocLockManagerクラス

付録

付録A　このマニュアルの参考情報

付録A.1　関連マニュアル

付録A.2　このマニュアルでの表記

付録A.3　英略語

付録A.4　KB（キロバイト）などの単位表記について

付録B　用語解説

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.

前書き

■ 対象製品

P-2A61-1194　 uCosminexus Service Director　 09-52（適用OS：Windows Server 2008 R2，Windows Server 2012 R2）

■ 輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。
なお、不明な場合は、弊社担当営業にお問い合わせください。

■ 商標類

BSAFEは，EMC Corporationの米国およびその他の国における登録商標または商標です。
Linuxは，Linus Torvalds 氏の日本およびその他の国における登録商標または商標です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
MS-DOSは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
Red Hatは，米国およびその他の国でRed Hat, Inc. の登録商標もしくは商標です。
RSAは，EMC Corporationの米国およびその他の国における登録商標または商標です。
VMwareは，米国およびその他の地域における VMware, Inc. の登録商標または商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。
uCosminexus Service Directorは，米国EMC コーポレーションのRSA BSAFE(R)ソフトウェアを搭載しています。
This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP
server project.
Portions of this software were developed at the National Center for Supercomputing
Applications (NCSA) at the University of Illinois at Urbana-Champaign.
This product includes software developed by the University of California, Berkeley
and its contributors.
This software contains code derived from the RSA Data Security Inc. MD5
Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie
Mellon University, and Bell Communications Research, Inc (Bellcore).
Regular expression support is provided by the PCRE library package, which is open
source software, written by Philip Hazel, and copyright by the University of
Cambridge, England. The original software is available from
ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
This product includes software developed by Ralf S. Engelschall <rse@engelschall.com>
for use in the mod_ssl project (http://www.modssl.org/).
This product includes software developed by the Apache Software Foundation
(http://www.apache.org/).
This product includes software developed by IAIK of Graz University of Technology.
This product includes software developed by the Java Apache Project for use in the
Apache JServ servlet engine project (http://java.apache.org/).
This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi
(http://relaxngcc.sf.net/).
This product includes software developed by Andy Clark.

■ マイクロソフト製品の表記について

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記 | 製品名
Windows | Windows Server 2008 R2 | Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版
Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本語版
Microsoft(R) Windows Server(R) 2008 R2 Datacenter 日本語版
Windows Server 2012 R2 | Microsoft(R) Windows Server(R) 2012 R2 Standard 日本語版
Microsoft(R) Windows Server(R) 2012 R2 Datacenter 日本語版
MS-DOS | Microsoft(R) MS-DOS(R)

■ 発行

2014年 3月 3020-3-V16-10

■ 著作権

All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.

変更内容

変更内容(3020-3-V16-10)　uCosminexus Service Director　09-52

追加・変更内容 | 変更個所
マスターイメージの情報をまとめて取得する機能を追加しました（csdmilsコマンドに-mオプションを追加しました）。これに伴い，機能の説明を追加，変更しました。 | csdmils（マスターイメージの表示）
uCSDは管理LANおよび業務LANでの構成を前提としていましたが，管理LANだけで構成できる機能をサポートしました。これに伴い，機能の説明を追加，変更しました。 | csdmils（マスターイメージの表示），表1-19，表2-6，表2-7，表2-9，表2-12，表2-13，表2-14，表2-15，2.3.9(1)
Cosminexusを含む業務システムをデプロイするときの注意事項を追加しました。 | csdmideploy（マスターイメージのデプロイ）
hosts転送失敗後に，再度csdmideployコマンドを実行する場合，自動的にhostsを再転送する機能を追加しました。これに伴い，機能の説明を追加，変更しました。 | 2.3.9(4)

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルはプログラムプロダクトP-2A61-1194　uCosminexus Service Directorのコマンド，定義ファイル，およびUOCについて説明するものです。なお，このマニュアルでは，uCosminexus Service DirectorをuCSDと表記します。

対象読者

uCSDのコマンド，定義ファイルおよびUOCを使用する方を対象としています。

コマンド，定義ファイルおよびUOCを管理，または利用する際に必要となる，次の内容を理解していることを前提としています。

クラウドコンピューティングに関する知識

Windowsに関する基本的な知識

JP1のITリソース管理に関する基本的な知識

ミドルウェア製品に関する基本的な知識

このマニュアルで使用している記号について

このマニュアルで使用している記号について次に示します。

記号
意味

|
この記号で区切られた項目は選択できることを示します。

（例）disk=A|B

A，またはBを指定できることを示します。

{ }
この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目と項目の区切りは「|」で示します。

（例） {A|B|C}

AとBとCのどれかを指定することを示します。

[ ]
この記号で囲まれている項目は省略してもよいことを示します。

…
この記号の直前に示された項目を繰り返し複数個指定できることを示します。

1.　運用コマンド

この章ではuCosminexus Service Director（以下，uCSD）で使用するコマンドの種類，機能，入力形式，文法などの記述形式について説明します。

＜この章の構成＞

1.1　コマンドの概要

1.2　コマンドの機能

1.1　コマンドの概要

この節ではuCSDで使用するコマンドの概要を説明します。各コマンドの機能の詳細については「1.2　コマンドの機能」を参照してください。

＜この節の構成＞

1.1.1　コマンドの種類

1.1.2　コマンドの一覧

1.1.3　エラーからの回復

1.1.4　コマンド実行可能status

1.1.5　コマンドの説明で使用する見出し

1.1.6　コマンドの共通仕様

1.1.7　コマンド使用時の注意事項

1.1.1　コマンドの種類

ここではuCSDで使用するコマンドの種類について説明します。uCSDではコマンドを機能別に次のように分類します。

表1-1　コマンドの分類

分類名 | 機能
セットアップ | uCSDのセットアップ・アンセットアップを行います。
テンプレート操作 | テンプレートの操作を行います。
マスターイメージ操作 | マスターイメージの操作を行います。
リソース管理 | uCSDが管理するリソースの操作を行います。
デプロイ | マスターイメージのデプロイ・アンデプロイなどを行います。
仮想ホスト管理 | デプロイした仮想ホストに対する操作を行います。
ユーザ管理 | 管理者の登録を行います。
トラブルシュート | トラブルシュート情報を収集します。
データベース管理 | データベースのバックアップ・リストアを行います。
インストール操作 | ミドルウェアをインストールします。

また各コマンドは，同期コマンドと非同期コマンドに分類されます。同期コマンドと非同期コマンドの説明を次に示します。

表1-2　同期コマンドと非同期コマンド

分類名 | 説明
同期コマンド | 同期コマンドではデータの更新やUOCの実行を行います。コマンドを実行すると，処理を完了させたあと，結果が返ります。
非同期コマンド | 非同期コマンドではVMのデプロイ/アンデプロイなどを行います。コマンドを実行すると，バックグラウンドで処理を行います。処理の完了はメッセージログで確認してください。

1.1.2　コマンドの一覧

各コマンドの一覧を次の表に示します。

表1-3　uCSDをインストールしたホスト上で実行するコマンド一覧

分類名
コマンド名
（.batや.exeの拡張子は省略）
機能
実行可能ユーザ
uCSD稼働中の実行可否
同期/非同期

PaaS提供者※1
PaaS利用者

セットアップ
csdsetup
uCSD運用環境のセットアップ
○
×
×
同期

csdunsetup
uCSD運用環境のアンセットアップ
○
×
×
同期

テンプレート操作
csdtmpregister
テンプレートの登録
○
×
○
同期

csdtmpdelete
テンプレートの削除
○
×
○
同期

csdtmpcontrol
テンプレートの属性設定
○
×
○
同期

csdtmpupdate
テンプレートの更新
○
×
○
同期

csdtmpls
テンプレートの表示
○
○
○
同期

マスターイメージ操作
csdmiregister
マスターイメージの登録
○
○
○
同期

csdmidelete
マスターイメージの削除
○
○
○
同期

csdmiupdate
マスターイメージの更新
○
○
○
同期
非同期※2

csdmils
マスターイメージの表示
○
○
○
同期

csdmiexport
マスターイメージのエクスポート
○
○
○
同期

リソース管理
csdmipos
物理配置候補の算出
○
○
○
同期

csdmireserve
物理リソースの予約
○
○
○
同期

csdmirelease
物理リソースの予約解除
○
○
○
同期

csdrscls
物理リソース情報の出力
○
○
○
同期

csdrscstatus
物理リソースの状態変更
○
×
○
同期

csdrscupdate
物理構成情報の更新
○
×
○
同期

デプロイ
csdmideploy
マスターイメージのデプロイ
○
○
○
非同期

csdmiundeploy
マスターイメージのアンデプロイ
○
○
○
非同期

csdmistopdeploy
デプロイ処理の中断
○
○
○
非同期

仮想ホスト管理
csdmivmstatus
仮想ホスト，ミドルウェアのステータス変更
○
○
○
同期

csdmisetpassword
仮想ホストのパスワード設定
○
○
○
同期

ユーザ管理
csdsetaccount
アカウント情報の登録
○
×
○
同期

トラブルシュート
csdinfoget
トラブルシュート情報の収集
○
×
○
同期

データベース管理
csddbcopy
データベースのバックアップ
○
×
×
同期

csddbrstr
データベースのリストア
○
×
×
同期

注※1　uCSDにおけるPaaS提供者はAdministratorアカウントとなります。

注※2　マスターイメージのデプロイが完了している場合は非同期で更新処理を実行します。

表1-4　構築した仮想ホスト上で実行するコマンド一覧

分類名 | コマンド名 | 機能 | 実行可能ユーザ
PaaS提供者 | PaaS利用者
インストール操作 | csdinstlin | Linux用ミドルウェアをインストールします。 | ○ | ○

1.1.3　エラーからの回復

uCSDでは同期コマンドと非同期コマンドが存在します。同期コマンド，非同期コマンドではエラーからの回復方法が異なります。

同期コマンドのエラーからの回復
同期コマンド実行時にエラーが発生した場合，ログを参照し，エラーメッセージを確認の上，メッセージマニュアル記載の対処方法に従ってエラー原因を取り除いてください。
エラー原因を取り除いた後，再度同期コマンドを実行してください。

非同期コマンドのエラーからの回復
まずエラー発生時に，コマンドでuCSDがDB上で管理するデプロイ処理状況を確認してください。
エラーが発生した場合の状況は次の2つがあります。

DBの状態は「VM未作成」で，JP1/ITRMがエラーとした（VMは作成されている）。

DBの状態は「VM作成済み」で，OSやミドルウェアの設定でエラーが発生している。

1の場合

JP1/ITRMまたはvCenterを利用してVMを削除してください。

2の場合

uCSDが提供するVMのcsdmiundeployコマンドを実行し，VMを削除してください。

DBのVM作成の状態と実際のVM作成済み・未作成が一致していない場合，uCSDが提供するcsdmivmstatusコマンドを実行してDBの状態を変更できます。このコマンドを利用する場合，ユーザは手動でVMを正常状態にしてください。

1.1.4　コマンド実行可能status

次の表にuCSDに登録したマスターイメージの状態による実行可能コマンドを示します。

なお，表に記載されていないコマンドの実行可否はマスターイメージの状態には関係ありません。

表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)

項番 | 運用コマンド | 業務システムのStatus
未登録 | registered | registered（partially configured） | configured | configured（partially reserved） | ready | deploying | deploying（wait(N)） | deploying（pause） | deploying（stopping） | deploying（stopped） | deployed
1 | csdmiregister | -cなし | ○ | － | － | － | － | － | － | － | － | － | － | －
2 | -cあり | ○ | ○※1 | ○※1 | ○※1 | ○※1 | ○※1 | ×※1 | ×※1 | ×※1 | ×※1 | ○※1 | ○※1
3 | csdmipos | － | ○ | ○ | ○ | ○ | × | × | × | × | × | × | ×
4 | csdmireserve | － | × | × | ○ | ○ | × | × | × | × | × | × | ×
5 | csdmirelease | － | × | ○※2 | × | ○※2 | ○ | × | × | × | × | × | ×
6 | csdmideploy | － | × | × | × | × | ○ | × | × | ○ | × | ○ | ×
7 | csdmiundeploy | － | × | ○※3 | × | ○※3 | ○※3 | × | × | ○ | × | ○ | ○
8 | csdmistopdeploy | － | × | × | × | × | × | ○ | ○ | × | × | × | ×
9 | csdmiupdate | -sなし | － | ○ | ○ | ○ | ○ | ○ | × | × | × | × | × | ○
10 | -sあり | － | ○ | ○※4 | ○ | × | × | × | × | × | × | × | ×
11 | csdmisetpassword | － | × | × | × | × | ○ | × | × | × | × | ○ | ○
12 | csdmidelete | － | ○ | ○※4 | ○ | × | × | × | × | × | × | × | ×
13 | csdmils | -pなし | － | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
14 | -pあり | － | × | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
15 | -rなし | － | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
16 | -rあり | － | × | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
17 | csdmiexport | － | ○ | ○ | ○ | ○ | ○ | × | × | × | × | ○ | ○
18 | csdmivmstatus | -g vmdeployed | － | × | × | × | × | ○ | × | × | × | × | ○ | ×
19 | -g undeployed | － | × | × | × | × | ○ | × | × | × | × | ○ | ○
20 | -g alldeployed | － | × | × | × | × | ○ | × | × | × | × | ○ | ×

表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)

項番 | 運用コマンド | 業務システムのStatus
failed(deploy) | undeploying | undeploying(wait(N)) | undeploying(stopping) | undeploying(stopped) | failed(undeploy) | updating | updating(wait(N)) | updating(stopping) | updating(stopped) | failed(update)
1 | csdmiregister | -cなし | － | － | － | － | － | － | － | － | － | － | －
2 | -cあり | ○※1 | ×※1 | ×※1 | ×※1 | ○※1 | ○※1 | ×※1 | ×※1 | ×※1 | ○※1 | ○※1
3 | csdmipos | × | × | × | × | × | × | × | × | × | × | ×
4 | csdmireserve | × | × | × | × | × | × | × | × | × | × | ×
5 | csdmirelease | ○ | × | × | × | × | × | × | × | × | × | ×
6 | csdmideploy | ○ | × | × | × | ○ | ○ | × | × | × | × | ×
7 | csdmiundeploy | ○ | × | × | × | ○ | ○ | × | × | × | ○ | ○
8 | csdmistopdeploy | × | ○ | ○ | × | × | × | ○ | ○ | × | × | ×
9 | csdmiupdate | -sなし | × | × | × | × | × | × | × | × | × | ○ | ○
10 | -sあり | × | × | × | × | × | × | × | × | × | × | ×
11 | csdmisetpassword | ○ | × | × | × | ○ | ○ | × | × | × | ○ | ○
12 | csdmidelete | × | × | × | × | × | × | × | × | × | × | ×
13 | csdmils | -pなし | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
14 | -pあり | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
15 | -rなし | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
16 | -rあり | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○
17 | csdmiexport | ○ | × | × | × | ○ | ○ | × | × | × | ○ | ○
18 | csdmivmstatus | -g vmdeployed | ○ | × | × | × | ○ | ○ | × | × | × | × | ×
19 | -g undeployed | ○ | × | × | × | ○ | ○ | × | × | × | ○ | ○
20 | -g alldeployed | ○ | × | × | × | ○ | ○ | × | × | × | ○ | ○

（凡例）

○：実行可能

×：実行不可

－：該当しない

注※1　コピー元の業務システムのStatusを示します。

注※2　リソース予約済みのホストが存在する場合に実行可能です。

注※3　デプロイ済みのホストが存在する場合に実行可能です。

注※4　リソース予約済みのホストが存在しない場合に実行可能です。

1.1.5　コマンドの説明で使用する見出し

形式
コマンドの入力形式を示します。

機能
コマンドの機能について説明します。

実行可能ユーザ
コマンドを実行する権限を持つユーザを示します。

オプション
コマンドのオプションについて説明します。

戻り値
コマンドの戻り値について説明します。

実行例
コマンドを実行した際の入力例，出力例について説明します。

注意事項
コマンドを実行する上での注意事項について説明します。

1.1.6　コマンドの共通仕様

＜この項の構成＞

(1)　文法記述記号

(2)　構文要素

(3)　コマンドで表示するOS名について

(1)　文法記述記号

コマンド形式およびユーザ指定値の範囲の説明で使用する記号について説明します。各記号の意味を次の表に示します。

表1-7　記号の説明

文法記述記号
意味

|
この記号で区切られた項目を選択できることを示します。
（例）disk=A|B
AまたはBを指定できることを示します。

{ }
この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目と項目の区切りは「|」で示します。
(例) {A|B|C}
AとBとCのどれかを指定することを示します。

[ ]
この記号で囲まれている項目は省略してもよいことを示します。

…
この記号の直前に示された項目を繰り返し複数個指定できることを示します。

～
この記号のあとにユーザ指定値の属性を示します。

<<　>>
ユーザ指定値の省略値を示します。

<　>
ユーザ指定値の構文要素記号を示します。

(2)　構文要素

ユーザ指定値で使用できる文字・記号を次の表に示します。

表1-8　コマンド形式の構文要素

構文要素
意味

英字
半角アルファベット（A～Z，a～z）

英字記号
英字，半角記号（#，-，@，(，)，_）

英数字
英字と半角数字（0～9）

英数字記号
英字記号と半角数字（0～9）

符号なし整数
半角数字（0～9）

文字列
任意の文字の配列

ドライブ
英字1文字＋:（半角コロン）（例：C:）

相対パス名
次の要素で構成される文字列
英数字
_（半角下線）
.（半角ピリオド）
△（半角空白）
(（半角左括弧）
)（半角右括弧）
パス区切りの¥（半角円マーク）
ネットワークドライブ，UNC形式の指定はできません。
次に示すWindows，およびMS-DOSの予約語をディレクトリ名，ファイル名に含むことはできません。

　CON, PRN, AUX, CLOCK$, NUL,
　COM0, COM1, COM2, COM3,COM4, COM5, COM6,COM7, COM8, COM9,
　LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7,LPT8, LPT9

ショートファイル名は指定できません。
半角空白を含むパス情報について"(ダブルクォーテーション)でパス情報を囲む必要があります。
パスにピリオドまたは空白で終端するディレクトリを含むことはできません。

絶対パス名
ドライブで始まり，次の要素で構成される文字列
英数字
_（半角下線）
.（半角ピリオド）
△（半角空白）
(（半角左括弧）
)（半角右括弧）
パス区切りの¥（半角円マーク）
ドライブだけの指定はできません。
ネットワークドライブ，UNC形式の指定はできません。
次に示すWindows，およびMS-DOSの予約語をディレクトリ名，ファイル名に含むことはできません。

CON, PRN, AUX, CLOCK$, NUL,
COM0, COM1, COM2, COM3,COM4, COM5, COM6,COM7, COM8, COM9,
LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7,LPT8, LPT9

ショートファイル名は指定できません。
半角空白を含むパス情報について"(ダブルクォーテーション)でパス情報を囲む必要があります。
パスにピリオドまたは空白で終端するディレクトリを含むことはできません。

パス名
相対パス名と絶対パス名（1～247文字）

ポート番号
指定可能な値は，半角数字で1～65535の範囲

注意

すでにほかのアプリケーションで使用されているポート番号を指定した場合，セットアップは完了しますが，uCSDのサービス起動に失敗します（1～1023のwell-knownポート，および，49152～65535の既定の動的ポートを指定した場合，使用済みポートに該当しやすいため注意してください）。

(3)　コマンドで表示するOS名について

コマンドで表示するOS名はコンポーネントテンプレートに指定したOS種別によって，次のOS名を表示します。これらのOS名はDFMTが定めているCIM_OperatingSystemクラスの分類と同じ名称です。

表1-9　コマンドで表示するOS名

項番 | OS種別 | OS名
1 | 79 | RedHat Enterprise Linux
2 | 80 | RedHat Enterprise Linux 64-Bit
3 | 103 | Microsoft Windows Server 2008 R2

1.1.7　コマンド使用時の注意事項

コマンド使用時の注意事項を説明します。

＜この項の構成＞

(1)　コマンドに指定するファイルサイズの注意事項

(1)　コマンドに指定するファイルサイズの注意事項

コマンドに指定するファイル（ディレクトリを指定する場合は格納されているすべてのファイル）のサイズは合計でシステム定義ファイルのsend.all.filesizeプロパティ指定値以内にする必要があります。複数のコマンドオプションでファイルやディレクトリを指定する場合は，すべてのコマンドオプションに指定したファイルサイズの合計でsend.all.filesizeプロパティ指定値以内にしてください。send.all.filesizeプロパティ指定値を超過した場合はKFUD90017-Eメッセージを出力してコマンドの実行に失敗します。

テンプレートファイル（csdtmpregisterコマンドおよびcsdtmpupdateコマンドの-fオプションで指定するファイル）のサイズは最大1MBです。1MBを超過した場合はKFUD90006-Eメッセージを出力してコマンドの実行に失敗します。

1.2　コマンドの機能

運用コマンドのヘルプ表示

コマンドのオプションとして-hを指定すると，そのコマンドの使用方法を示すヘルプメッセージを出力します。なお，ヘルプメッセージを出力する場合は，-hオプションだけを指定してください。ほかのオプション，オプション引数を指定した場合，ヘルプメッセージが表示されないことがあります。

また，次のコマンドは，-hオプションによるヘルプメッセージ出力機能はありません。

csdsetup

csdunsetup

csdinfoget

csddbcopy

csddbrstr

＜この節の構成＞

csdsetup（uCSD運用環境のセットアップ）

csdunsetup（uCSD運用環境のアンセットアップ）

csdtmpregister（テンプレートの登録）

csdtmpdelete（テンプレートの削除）

csdtmpcontrol（テンプレートの属性設定）

csdtmpupdate（テンプレートの更新）

csdtmpls（テンプレートの表示）

csdmiregister（マスターイメージの登録）

csdmidelete（マスターイメージの削除）

csdmiupdate（マスターイメージの更新）

csdmils（マスターイメージの表示）

csdmiexport（マスターイメージのエクスポート）

csdmipos（物理配置候補の算出）

csdmireserve（物理リソースの予約）

csdmirelease（物理リソースの予約解除）

csdrscls（物理リソース情報の出力）

csdrscstatus（物理リソースの状態変更）

csdrscupdate（物理構成情報の更新）

csdmideploy（マスターイメージのデプロイ）

csdmiundeploy（マスターイメージのアンデプロイ）

csdmistopdeploy（デプロイ処理の中断）

csdmivmstatus（仮想ホスト，ミドルウェアのステータス変更）

csdmisetpassword（仮想ホストのパスワード設定）

csdsetaccount（アカウント情報の登録）

csdinfoget（トラブルシュート情報の収集）

csddbcopy（データベースのバックアップ）

csddbrstr（データベースのリストア）

csdinstlin（ミドルウェアインストール）

csdsetup（uCSD運用環境のセットアップ）

形式

csdsetup

機能

uCSD運用環境のセットアップを行います。

セットアップ後に再セットアップすることで設定を変更します。

実行可能ユーザ

PaaS提供者

オプション

なし

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdsetup
KFUD90330-I uCosminexus Service Director - Manager DB Serviceのセットアップを開始します。
KFUD90331-I uCosminexus Service Director - Manager DB Serviceのセットアップが完了しました。
KFUD90330-I uCosminexus Service Directorのセットアップを開始します。
KFUD90331-I uCosminexus Service Directorのセットアップが完了しました。
KFUD90330-I uCosminexus Service Director - Managerのセットアップを開始します。
KFUD90331-I uCosminexus Service Director - Managerのセットアップが完了しました。
KFUD90300-I セットアップが正常に完了しました。

注意事項

uCSDの運用環境設定を変更する場合はセットアップ定義ファイルを書き換え，csdsetupコマンドを実行します。セットアップ定義ファイルの記述形式は「2.2.1　セットアップ定義ファイル」を参照してください。

csdsetupコマンド実行時にセットアップ定義ファイルが存在しない場合，デフォルトの設定値でセットアップ定義ファイルが作成されます。

csdsetupコマンドを実行するときは次のサービスが“停止”状態である必要があります。

uCosminexus Service Director

uCosminexus Service Director - Manager

また，次のサービスが“停止”または“開始”状態である必要があります。

uCosminexus Service Director - Manager DB Service

セットアップ中に，ウィンドウを閉じるなどの操作で，セットアップを強制的に中断しないでください。異常が発生した場合も，csdsetupコマンドが終了するまで待ってください。

このコマンドはuCSDの他コマンド実行中に実行しないでください。
また，このコマンド実行中にこのコマンドを含むほかのコマンドは実行しないでください。

このコマンドはuCSDのインストール・アンインストール実行中に実行しないでください。
また，このコマンド実行中にuCSDのインストール・アンインストールは実行しないでください。

このコマンドがエラーで中断した場合，トラブルシュートのために，次のログファイルを採取してください。

uCSDのインストール先ディレクトリ¥mgr¥log¥csdsetup.log

セットアップの完了後に次の手順でuCosminexus Service Director - Managerサービスを実行するユーザの設定を行ってください。
上書きセットアップでもサービスは初期化されるため再設定してください。

(a) Windowsの［スタート］ボタン→［管理ツール］→［サービス］を選択します。

［サービス］ダイアログボックスが表示されます。

(b) uCosminexus Service Director - Managerサービスを右クリックして，［プロパティ］を選択します。

［プロパティ］ダイアログボックスが表示されます。

(c) ［ログオン］タブを表示して［アカウント］を選択します。
(d) Administratorsグループに所属するユーザ名とパスワードを入力します。
Administratorsグループに所属していないユーザを設定した場合，サービスの起動時にKFUD21118-Eメッセージを出力して失敗します。
また，ユーザの設定をしないでローカルシステムアカウント（SYSTEM）でサービスを起動した場合，同一サーバ上のJP1/ITRMに対してコマンドプロンプトなどから実行したコマンドがKNAR81210-Eメッセージを出力して失敗する場合があります。

csdunsetup（uCSD運用環境のアンセットアップ）

形式

csdunsetup

機能

uCSDを運用するための実行環境をアンセットアップします。

実行可能ユーザ

PaaS提供者

オプション

なし

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin¥>csdunsetup
KFUD90308-Q アンセットアップを開始してもよいですか？(y/n)
y
KFUD90332-I uCosminexus Service Directorのアンセットアップを開始します。
KFUD90333-I uCosminexus Service Directorのアンセットアップが完了しました。
KFUD90332-I uCosminexus Service Director - Managerのアンセットアップを開始します。
KFUD90333-I uCosminexus Service Director - Managerのアンセットアップが完了しました。
KFUD90332-I uCosminexus Service Director - Manager DB Serviceのアンセットアップを開始します。
KFUD90333-I uCosminexus Service Director - Manager DB Serviceのアンセットアップが完了しました。
KFUD90301-I アンセットアップが正常に完了しました。

注意事項

csdunsetupコマンドを実行すると，uCSDのデータベースが削除されます。再セットアップ時など，以前の蓄積データを引き継ぎたい場合は，csdunsetupコマンド実行前にデータベースをバックアップしておく必要があります。

csdunsetupコマンドを実行するときは次のサービスが“停止”状態である必要があります。

uCosminexus Service Director

uCosminexus Service Director - Manager

また，次のサービスが“停止”または“開始”状態である必要があります。

uCosminexus Service Director - Manager DB Service

アンセットアップ中に，ウィンドウを閉じるなどの操作で，アンセットアップを強制的に中断しないでください。異常が発生した場合も，アンセットアップコマンドが終了するまで待ってください。

このコマンドはuCSDの他コマンド実行中に実行しないでください。
また，このコマンド実行中にこのコマンドを含むほかのコマンドは実行しないでください。

このコマンドはuCSDのインストール・アンインストール実行中に実行しないでください。
また，このコマンド実行中にuCSDのインストール・アンインストールは実行しないでください。

このコマンドがエラーで中断した場合，トラブルシュートのために，次のログファイルを採取してください。

uCSDのインストール先ディレクトリ¥mgr¥log¥csdunsetup.log

csdtmpregister（テンプレートの登録）

形式

csdtmpregister -f テンプレートファイル [-d ディレクトリ名]

機能

テンプレートファイルをuCSDに登録します。新規に登録したテンプレートは非公開，上書き可の属性で登録されます。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-f

テンプレートファイルを指定します。

テンプレートファイル：～<パス名>

-fオプションで指定するファイルの内容は「2.3　テンプレート操作で使用するファイル」を参照してください。

-d

テンプレートに付属するファイルを格納したディレクトリを指定します。

ディレクトリ名：～<パス名>

-dオプションで指定するディレクトリは「図1-1　構成パターンテンプレートの場合の-dオプションで指定するディレクトリの構成例」，「図1-2　コンポーネントテンプレートの場合の-dオプションで指定するディレクトリの構成例」を参考に指定してください。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpregister -f tmp01.xml -d tmp01dir
KFUD13000-I テンプレートの登録が完了しました。テンプレート名=tmp01，ID=1

注意事項

引数で指定したディレクトリ以下に任意のディレクトリを作成することができます。ディレクトリは作成せずファイルだけを指定ディレクトリ直下に配置することもできます。テンプレートファイルに記述したファイルを配置してください。

-dオプションで指定されたディレクトリの構成例を次に示します。

構成パターンテンプレートの場合とコンポーネントテンプレートの場合を説明します。

なお，表番号と項番は「表2-13　構成パターンテンプレートファイルのXML記述文法」および「表2-16　コンポーネントテンプレートファイルのXMLファイル要素の文法」の項番と対応しているため，その値を設定します。

図1-1　構成パターンテンプレートの場合の-dオプションで指定するディレクトリの構成例

図1-2　コンポーネントテンプレートの場合の-dオプションで指定するディレクトリの構成例

各ファイル・ディレクトリに記述した番号はテンプレートファイルの項目との対応を表しています。

-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。

テンプレートファイル名，およびディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名を指定する場合，ディレクトリ名の絶対パス長を87文字以下とすることを推奨します。

csdtmpdelete（テンプレートの削除）

形式

csdtmpdelete {-i テンプレートID|-n テンプレート名} [-y]

機能

指定したテンプレートを削除します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-i

テンプレートIDを指定します。

テンプレートID：<符号なし整数>1～99999999の範囲

-n

テンプレート名を指定します。

テンプレート名：～<英数字記号> 1～32文字

-y

実行時（y/n）の問い合わせを抑止します。y応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpdelete -n tmp01
KFUD93021-Q 指定したテンプレートの削除処理を続行してもよいですか？(y/n)y
KFUD13001-I テンプレートの削除が完了しました。

注意事項

操作対象のテンプレートを使用しているマスターイメージが1つでもある場合，csdtmpdeleteコマンドによるテンプレート操作はできません。

csdtmpcontrol（テンプレートの属性設定）

形式

csdtmpcontrol {-i テンプレートID|-n テンプレート名} {-a {public | private}|-w {on|off}}

機能

指定したテンプレートの属性を変更します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-i

テンプレートIDを指定します。

テンプレートID：<符号なし整数>1～99999999の範囲

-n

テンプレート名を指定します。

テンプレート名：～<英数字記号> 1～32文字

-a

公開(public)／非公開（private）属性を指定します。

-w

上書き可(on)／不可（off）属性を指定します。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

csdtmpcontol実行後のcsdtmpls結果

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpcontrol -n tmp01 -a private
KFUD13002-I 正常に属性の変更が完了しました。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpls
Pattern template:
ID  Date              Name   User           Mode
-------------------------------------------------------------
3   2012/10/02 11:29  tmp01  Administrator  private, writable

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpcontrol -n tmp01 -w off
KFUD13002-I 正常に属性の変更が完了しました。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpls
Pattern template:
ID  Date              Name   User           Mode
--------------------------------------------------------------
3   2012/10/02 11:29  tmp01  Administrator  private, read-only

注意事項

属性を上書き不可（off）に変更すると，csdtmpupdateコマンドによるテンプレート操作はできません。

操作対象のテンプレートを使用しているマスターイメージが1つでもある場合，csdtmpcontrolコマンドによるテンプレート操作はできません。

csdtmpupdate（テンプレートの更新）

形式

csdtmpupdate {-i テンプレートID|-n テンプレート名} -f テンプレートファイル [-d ディレクトリ名] [-y]

機能

指定したテンプレートを更新します。

テンプレートファイル内の，「テンプレート名」を変更して実行した場合，名前が重複しているテンプレートが登録されていなければ，テンプレート名を指定した名前に変更できます。その際にテンプレートIDは変わりません。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-i

テンプレートIDを指定します。

テンプレートID：<符号なし整数>1～99999999の範囲

-n

テンプレート名を指定します。

テンプレート名：～<英数字記号>1～32文字

-f

テンプレートファイルを指定します。

テンプレートファイル：～<パス名>

-d

テンプレートに付属するファイルを格納したディレクトリを指定します。

ディレクトリ名：～<パス名>

-dで指定するディレクトリの説明は「csdtmpregister（テンプレートの登録）」の注意事項を参照してください。

-fオプションで指定するテンプレートファイルの内容は「2.3　テンプレート操作で使用するファイル」，-dオプションで指定するディレクトリの内容は「csdtmpregister（テンプレートの登録）」を参照してください。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpupdate -n tmp01 -f tmp02.xml -d tmp02dir
KFUD93020-Q 指定したテンプレートの更新処理を続行してもよいですか？(y/n)y
KFUD13003-I テンプレートの更新が完了しました。

注意事項

テンプレートに付属するファイルがある場合は，必ず-dオプションで格納ディレクトリを指定してください。また，登録済みの付属ファイルを消したい場合は-dオプションを省略してください。

操作対象のテンプレートを使用しているマスターイメージが1つでもある場合，csdtmpupdateコマンドによるテンプレート操作はできません。

-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。

テンプレートファイル名，およびディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名を指定する場合，ディレクトリ名の絶対パス長を87文字以下とすることを推奨します。

csdtmpls（テンプレートの表示）

形式

(1) テンプレートを一覧表示する場合

csdtmpls

(2) テンプレートを個別表示する場合

csdtmpls {-i テンプレートID |-n テンプレート名} [-o ファイル名] [-d ディレクトリ名]

機能

(1) テンプレートの情報の一覧を表示します。

(2) 指定したテンプレートの情報を表示します。-oオプションでテンプレートファイルを出力します。-dオプションでテンプレートに登録されているファイルを出力します。PaaS利用者が使用する場合には，公開属性が付けられているテンプレートだけを表示します。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

テンプレートIDを指定します。

テンプレートID：<符号なし整数>1～99999999の範囲

-n

テンプレート名を指定します。

テンプレート名：～<英数字記号>1～32文字

-o

テンプレートファイルを出力するファイル名を指定します。

指定したファイルにテンプレートファイルを出力します。

ファイル名：～<パス名>

-d

テンプレートに登録されているファイルを出力するディレクトリ名を指定します。

指定したディレクトリにテンプレートに登録されているファイルを出力します。

ディレクトリ名：～<パス名>

-dオプションで出力するファイル，ディレクトリの内容は「csdtmpregister（テンプレートの登録）」のディレクトリ構成例を参照してください。

-o，-dオプションは同時に指定することもできます。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

(1) 一覧表示（オプションなし）

PaaS提供者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpls
Pattern template:
ID  Date              Name           User           Mode
---------------------------------------------------------------------
4   2012/10/02 14:42  webejbpattern  Administrator  public, read-only
1   2012/10/02 14:42  webdbpattern   Administrator  private, writable

Component template:
ID  Date              Name           User           Mode                HVType
------------------------------------------------------------------------------
3   2012/10/02 14:42  linux55cosmi   Administrator  public, read-only   HVM
2   2011/10/02 14:42  linux53hirdb   Administrator  private, read-only  HVM

PaaS利用者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdtmpls
Pattern template:
ID  Date              Name
-----------------------------------
4   2012/10/02 14:42  webejbpattern

Component template:
ID  Date              Name          HVType
------------------------------------------
3   2012/10/02 14:42  linux55cosmi  HVM

表1-10　表示項目の説明

項番
項目
説明

1
Pattern template
構成パターンテンプレート一覧

2
Component template
コンポーネントテンプレート一覧

3
ID
テンプレートID

4
Date
テンプレート最終更新日付

5
Name
テンプレート名称

6
User※
テンプレートの所有者

7
Mode※
テンプレートの属性
公開／非公開：public／private
上書き可／不可：writable／read-only

8
HVType
ハイパーバイザ種別
VMwareの場合：VMware
HVMの場合：HVM

注※　PaaS利用者の場合は表示しません。

(2) 個別のテンプレート情報表示（-n）

(a) 構成パターンテンプレート

PaaS提供者が実行した場合の表示例を示します。

C:¥hvmmmsample>csdtmpls -n templateA
ID           : 1
Name         : templateA
User         : Administrator
Type         : Pattern
Mode         : public, read-only
Create       : 2012/10/02 14:51
Modify       : 2012/10/02 14:51
Tier         : [AppServer] [Db]

Used by      : webjb(1)
            : webjb.dev(5)
            : webjb2(17)

(b) コンポーネントテンプレート

PaaS提供者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin> csdtmpls -n templateB
ID           : 12
Name         : templateB
User         : Administrator
Type         : Component
Mode         : private, writable
Create       : 2012/10/02 15:00
Modify       : 2012/10/02 15:00
OS           : RedHat Enterprise Linux 64-Bit
Middleware   : Cosminexus
VM template  : redhat5
HVType       : HVM

Used by      : webejb(1)
            : webejb.dev(5)
            : webejb2(17)

表1-11　表示項目の説明

項番
項目
説明

1
ID
テンプレートID

2
Name
テンプレート名称

3
User※
テンプレートの所有者

4
Type
テンプレートの種別
Pattern：構成パターン
Component：コンポーネント

5
Mode※
テンプレートの属性
公開／非公開：public／private
上書き可／否：writable／read-only

6
Create
テンプレート作成日付

7
Modify
テンプレート最終更新日付

8
Tier
構成パターンの場合に表示します。
パターンを構成する要素ごとに[ ]で示し，要素に定義したティアをコンマで区切って示します。

9
OS
コンポーネントの場合に表示します。
OSを表します。

10
Middleware
コンポーネントの場合に表示します。
ミドルウェアを表します。複数ある場合にはコンマで区切って表示します。

11
VM template
仮想ホストを表すコンポーネントの場合に，JP1/ITRMに登録した仮想イメージテンプレート名を表示します。

12
HVType
ハイパーバイザ種別
VMwareの場合：VMware
HVMの場合：HVM

13
Used by
このテンプレートが使われているマスターイメージ名とマスターイメージID（括弧内）との組の一覧を表します。
PaaS利用者がコマンドを実行した場合には，コマンド実行ユーザが作成したマスターイメージだけを表示します。
存在しない場合には「***」を出力します。

注※　PaaS利用者の場合は表示しません。

注意事項

-oオプション，および-dオプションで指定するパスについて

あらかじめ出力ファイル名，出力ディレクトリ名の上位ディレクトリを作成しておく必要があります。上位ディレクトリが存在しないパスを指定した場合，csdtmplsコマンドはエラー終了します。

指定したパスと同名のファイルまたはディレクトリが存在する場合，csdtmplsコマンドはエラー終了します。別のパスを指定するか，同名のファイルまたはディレクトリを削除してからコマンドを実行してください。

-dオプションで指定するパス長について
-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。

相対パスでの指定について
テンプレートファイル名，およびディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名指定時の推奨値について
ディレクトリ名を指定する場合，ディレクトリ名の絶対パス長を87文字以下とすることを推奨します。

ディレクトリ名指定パスのパス長超過時の動作について
指定したディレクトリ下に，サーバからダウンロードしたテンプレートの関連情報を保存する際，一部ファイル，ディレクトリのパス長が計算上，Windowsの制限260文字を超える場合でも，Windowsが一部ディレクトリ名をショートディレクトリ名（~(チルダ)入りの8文字のディレクトリ名）と扱い，情報保存を行えるときは，パス長超過のエラーになりません。テンプレート関連情報を保存し，コマンドは正常終了します。なお，一部ディレクトリ名をショートディレクトリ名に変換し関連情報を保存した場合，当該情報をテンプレート登録時または更新時に使用する場合には，ショートディレクトリ名のディレクトリがパス内に含まれないディレクトリ下に移動させた後に使用してください。

csdmiregister（マスターイメージの登録）

形式

テンプレートを基にマスターイメージを新規登録する場合

csdmiregister -f マスターイメージ定義ファイル [-d ディレクトリ名] [-s]

マスターイメージのスナップショットを基にマスターイメージを新規登録する場合

csdmiregister -f マスターイメージ定義ファイル [-d ディレクトリ名] -m

マスターイメージのスナップショット [-s]

既存のマスターイメージをコピーしてマスターイメージを新規登録する場合

csdmiregister -f マスターイメージ定義ファイル [-d ディレクトリ名]

{-i マスターイメージID |-n マスターイメージ名[.セクション]} -c [-s]

機能

マスターイメージ定義ファイルからマスターイメージを新規登録します。

マスターイメージ定義ファイルには，マスターイメージ名，使用するテンプレート，UOC，固定化パラメータなどを定義します。

詳細は「2.4.1　マスターイメージ定義ファイル」を参照してください。

-cオプションを指定した場合，コピー元の業務システムの状態によって実行できないこともあります。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

業務システムのstatusはcsdmilsコマンドで確認できます。以降のコマンドについても同様です。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-f

マスターイメージ定義ファイルを指定します。

マスターイメージ定義ファイル：～<パス名>

-fオプションで指定するマスターイメージ定義ファイルの内容は「2.4.1　マスターイメージ定義ファイル」を参照してください。

-d

UOCを使用する場合に指定します。

マスターイメージ定義ファイル内で指定したUOCを格納したディレクトリを指定します。

ディレクトリ名：～<パス名>

-dオプションで指定するディレクトリは「csdtmpregister（テンプレートの登録）」の「注意事項」を参照してください。

-s

サイジングを実行します。

-m

スナップショットを格納したディレクトリを指定します。

マスターイメージのスナップショットを基にマスターイメージを新規登録します。スナップショットはcsdmiexportコマンドで作成できます。

マスターイメージのスナップショット：～<パス名>

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-c

既存のマスターイメージをコピーしてマスターイメージを新規登録します。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmiregister -f mi01.xml -d mi01dir -s
CID  Num  CPU   Core  Memory  Tier
---------------------------------------
1    3    1.60  2     4.00    AppServer
2    1    2.60  4     8.00    DB
KFUD13100-I マスターイメージの登録が完了しました。マスターイメージ名=webdb2.dev，ID=5

表示項目の説明は「csdmils（マスターイメージの表示）」を参照してください。

注意事項

-mオプションを指定する場合
エクスポートしたマスターイメージのスナップショットに含まれるマスターイメージ定義ファイルを任意のディレクトリにコピーして※，必要に応じて編集し，csdmiregisterコマンド(-fオプション指定)を実行します。
また，マスターイメージのスナップショットに，マスターイメージ定義ファイルから指定して登録した付属ファイルが含まれている場合には，別ディレクトリにコピーし※，マスターイメージ定義ファイルに合わせて必要に応じて編集し，マスターイメージ定義ファイルと同時にcsdmiregisterコマンド(-dオプション指定)を実行します。

注※　スナップショットに含まれるマスターイメージ定義ファイルあるいは付属ファイルを直接編集することも可能ですが，スナップショットを再利用することも考慮して，コピーしてから編集することを推奨します。

コピーしたマスターイメージ定義ファイルにおいて編集できる情報は次のとおりです。

表1-12　マスターイメージ定義ファイルの追加・変更・削除可否

項番
項目
追加
変更
削除

1
マスターイメージ名
×
○
×

2
セクション
○※2
○
○

3
バージョン
×
○
×

4
マスターイメージの説明
○※2
○
○

5
構成パターンテンプレート名※1
×
×
×

6
UOCクラス名
jarファイル名
○※2
○
○

7
UOCパラメータ名
UOCパラメータ値
○
○
○

8
コンポーネントID※1
コンポーネントテンプレート名※1
×
×
×

9
ミドルウェア識別子
○
○
○

10
ミドルパラメータ名
OSパラメータ名
パラメータ値
○
○
○

11
パッチ名
パッチ・ディレクトリ
適用順序
○
○
○

12
VLAN
○※3
○※3
○※3

注※1

項番5，8，およびマスターイメージのスナップショットに含まれるファイルを編集した場合には，インポート後の動作を保証しません。項番5，8がマスターイメージのスナップショット出力後のファイルと異なる場合，マスターイメージの登録に失敗します。

注※2

編集前のマスターイメージ定義ファイルに記載がない場合は追加できます。

注※3

マスターイメージのスナップショット指定，または-cオプションを指定し別のマスターイメージを基に新たなマスターイメージを登録する場合だけ追加・変更・削除ができます。csdmiupdateコマンド実行時の追加・変更・削除はできません。

-cオプションを指定する場合
元となるマスターイメージのマスターイメージ定義ファイルをcsdmilsコマンド(-oオプション指定)で出力して，必要に応じて編集し，csdmiregisterコマンド(-fオプション)に指定してください。
マスターイメージ定義ファイルにおいて編集できる情報は「表1-12　マスターイメージ定義ファイルの追加・変更・削除可否」と同様です。
また，元となるマスターイメージに付属するファイルが登録されている場合には，csdmilsコマンド(-dオプション指定)で出力し必要に応じて編集し，マスターイメージ定義ファイルと同時にcsdmiregisterコマンド(-dオプション指定)を実行します。-dオプションを指定しなかった場合には，元となるマスターイメージに登録されているファイルがそのまま使用されます。

-dオプション，および-mオプションで指定するパス長について
-dオプション，および-mオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。

相対パスでの指定について
ファイル名，ディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名指定時の推奨値について
ディレクトリ名を指定する場合，ディレクトリ名のパス長を87文字以下とすることを推奨します。

csdmidelete（マスターイメージの削除）

形式

csdmidelete {-i マスターイメージID |-n マスターイメージ名[.セクション]} [-y]

機能

指定したマスターイメージを削除します。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-y

実行時（y/n）の問い合わせを抑止します。y応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmidelete -i 5
KFUD93120-Q 指定したマスターイメージの削除処理を続行してもよいですか？(y/n)y
KFUD13101-I マスターイメージを削除しました。

注意事項

なし

csdmiupdate（マスターイメージの更新）

形式

csdmiupdate -f マスターイメージ定義ファイル [-d ディレクトリ名]

{-i マスターイメージID |-n マスターイメージ名[.セクション]}

[-s] [-k パスワードアクセスキー] [-y]

機能

指定したマスターイメージをマスターイメージ定義ファイルの内容に従って更新します。

マスターイメージの更新によって，次のことが実行できます。

マスターイメージ情報(マスターイメージ名など)の更新

サイジング実行

OS・ミドルウェアの定義パラメータ変更

OS・ミドルウェアへのパッチ適用

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-f

マスターイメージ定義ファイルを指定します。

マスターイメージ定義ファイル：～<パス名>

-fオプションで指定するマスターイメージ定義ファイルの内容は「2.4.1　マスターイメージ定義ファイル」を参照してください。

-d

UOCを追加・変更・削除する場合に指定します。

マスターイメージ定義ファイル内で指定したUOCを格納したディレクトリを指定します。

ディレクトリ名：～<パス名>

-dオプションで指定するディレクトリの詳細は「csdtmpregister（テンプレートの登録）」のディレクトリ構成例を参照してください。

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-s

サイジングを実行します。

-k

csdmisetpasswordコマンドで指定したパスワードアクセスキーを指定します。

仮想ホストのパスワードを，コンポーネントテンプレートファイルに記載済みの初期パスワードからcsdmisetpasswordコマンドで変更した場合に指定してください。仮想ホストにアクセスする際に，csdmisetpasswordコマンドで登録したパスワードを復号するために必要となります。

同一業務システム内では同一の値を指定してください。

パスワードアクセスキー：<英数字, #-@()>1～255文字

-y

実行時（y/n）の問い合わせを抑止します。y応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

(1) マスターイメージ情報の更新／定義パラメータの変更／パッチ適用

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmiupdate -f mi02.xml -n mi01
KFUD93121-Q 指定したマスターイメージの更新処理を続行してもよいですか？(y/n)y
KFUD13102-I マスターイメージの更新が完了しました。

(2) サイジング実行

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmiupdate -f mi02.xml -n mi01 -d mi03Dir -s
KFUD93121-Q 指定したマスターイメージの更新処理を続行してもよいですか?(y/n)y
CID  Num  CPU   Core  Memory  Tier
---------------------------------------
1    1    2.50  2     4.00    AppServer
2    1    2.50  2     3.65    Db
KFUD13102-I マスターイメージの更新が完了しました。

注意事項

マスターイメージ定義ファイル

-fオプションで指定するマスターイメージ定義ファイルは，csdmilsコマンドの-oオプションで出力したファイルを編集して指定してください。

デプロイ済みのホストにパッチを適用済みの場合※は，マスターイメージ定義ファイルに書かれたパッチ（パッチ名，パッチ・ディレクトリ，適用順序）は，変更・削除することができません。また，VLAN IDについても，csdmiupdateコマンドでの追加・変更・削除はできません。
注※　業務システムのステータスがregistered（partially configured），configured（partially reserved），readyなどで，一部のホストにパッチを適用済みの状態も含みます。

-dオプションを指定する場合
-dオプションで指定するディレクトリには，更新しないファイルも含めてマスターイメージ定義ファイルに書かれた全ファイルが含まれている必要があります。
また空のディレクトリを指定することで登録した付属ファイルを削除することができます。

相対パス指定について
ファイル名，およびディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

-dオプションのパス長について
-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。また，ディレクトリ名を指定する場合，ディレクトリのパス長を87文字以下とすることを推奨します。

アップデート処理でのOS更新・ミドルウェア更新処理について
アップデート処理でのOS更新・ミドルウェア更新処理を次に示します。

表1-13　アップデート処理でのOS更新・ミドルウェア更新処理

カテゴリ | 処理実行順※3 | 機能 | uCSDの動作 | 実行条件 | 補足
OS更新 | 1 | OS定義転送 | OS定義転送 | コンポーネントテンプレートで記載しているOS定義ファイルを転送先ディレクトリ※1配下へ転送 | OS更新パッチで未適用のパッチが1つ以上存在する場合 | OS更新パッチ適用だけを実施したい場合でも定義は必ず転送します。
2 | OS更新 | OS定義配置 | 転送済みOS定義をディレクトリへコピー | －
3 | OS更新パッチ適用 | OS更新用パッチを実行 | －
ミドル更新 | 4 | ミドルウェア定義転送 | ミドルウェア定義転送※2 | 転送先ディレクトリ※1配下へミドルウェア定義ファイルを転送 | ミドルウェア更新パッチで未適用のパッチが1つ以上存在する場合 | ミドルウェア更新パッチ適用だけを実施したい場合でも定義は必ず転送します。
5 | ミドルウェア更新 | ミドルウェア定義配置※2 | 転送済みミドルウェア定義をディレクトリへコピー | －
6 | ミドルウェア更新パッチ適用 | ミドルウェア更新用パッチを実行 | －

注※1

定義“deploy.remote.tmppath”または“deploy.remote.tmppath.win”で示したディレクトリパス

ミドルウェアがCosminexus時のミドル定義転送(#4)は仮想サーバマネージャで決められたディレクトリパスへ仮想サーバマネージャによって転送されます。

注※2

対象のミドルウェアがCosminexusの場合には，仮想サーバマネージャで定義の転送および配置を行います。

注※3

複数のホストに対してアップデート処理を行う場合は，ホスト間のOS更新処理の実行順序は不定です。

複数のホストに対してアップデート処理を行う場合は，すべてのホストのOS更新処理が完了した後に，ミドル更新処理を開始します。複数ホストのミドルウェア間の処理実行順序，およびホスト内の複数ミドルウェア間の処理実行順序は不定です。

csdmils（マスターイメージの表示）

形式

(1) マスターイメージを一覧表示する場合

csdmils

(2) マスターイメージを個別表示する場合

csdmils {-i マスターイメージID |-n マスターイメージ名[.セクション]}

[{-s | -l | -p | -r | -e | [-o ファイル名] [-d ディレクトリ名]}]

(3) マスターイメージの情報をファイル出力する場合

csdmils [{-i マスターイメージID |-n マスターイメージ名[.セクション]}] -m マスターイメージ情報ファイル名

機能

(1) マスターイメージの情報を表示します。PaaS利用者が使用する場合には，コマンド実行ユーザが登録したマスターイメージだけを表示します。

(2) 指定したマスターイメージの情報を表示します。-oオプションでマスターイメージ定義ファイルを出力します。-dオプションでcsdmiregisterコマンド(-dオプション)によって登録したファイルを出力します。

(3) マスターイメージの情報を-mオプションで指定したファイルに出力します。PaaS利用者が使用する場合には，コマンド実行ユーザが登録したマスターイメージだけを出力します。-iオプションまたは-nオプションを指定した場合は指定したマスターイメージの情報を出力します。出力したマスターイメージ情報ファイルは，ワークフローなどで次に示す用途のアプリケーションを作成する場合に入力情報として使用できます。

構築した業務システムの仮想ホストやネットワーク構成などを入力情報とするアプリケーション

すべての業務システムの情報を一括で解析するアプリケーション

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-f

マスターイメージ定義ファイルを指定します。

マスターイメージ定義ファイル：～<パス名>

-fオプションで指定するマスターイメージ定義ファイルの内容は「2.4.1　マスターイメージ定義ファイル」を参照してください。

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-s

サイジング結果の構成情報を出力します。

-l

業務システムで稼働しているホストとミドルウェア一覧を表示します。

-p

マスターイメージの物理配置候補を表示します。

-r

マスターイメージの物理配置候補の詳細情報を表示します。

-o

マスターイメージ定義ファイルを出力するファイル名を指定します。

指定したファイルにマスターイメージ定義ファイルを出力します。

ファイル名：～<パス名>

-d

マスターイメージ定義ファイルに書かれたファイルを出力するディレクトリ名を指定します。

指定したディレクトリにマスターイメージ定義ファイルに書かれたファイルを出力します。

ディレクトリ名：～<パス名>

-dオプションで指定するディレクトリの詳細は「csdtmpregister（テンプレートの登録）」の「注意事項」を参照してください。

-e

マスターイメージのすべての仮想NIC情報を出力します。

-m

マスターイメージ情報を出力するファイル名を指定します。

指定したファイルにマスターイメージ情報を出力します。

マスターイメージ情報ファイル名：～<パス名>

-mオプションで指定するファイルに出力するマスターイメージ情報の詳細は実行例の「(9) マスターイメージ情報ファイル出力（-m）」を参照してください。

-o，-dオプションは同時に指定することもできます。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

(1) マスターイメージ一覧表示（オプションなし）

PaaS提供者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils
ID  Status       Date              Name        User  
------------------------------------------------------------
7   undeploying  2012/10/02 15:23  webdb2.dev  csduser
5   deployed     2012/10/02 15:23  web4        csduser
1   deployed     2012/10/02 14:53  webdb1      Administrator

PaaS利用者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils
ID  Status     Date              Name
-------------------------------------------
7   deploying  2012/10/02 15:23  webdb2.dev
5   deployed   2012/10/02 15:23  web4

表1-14　表示項目の説明

項番
項目
説明

1
ID
マスターイメージID

2
Status
業務システムの状態
詳細は，「表1-16　業務システムのStatus一覧」を参照してください。

3
Date
マスターイメージの最終更新日付

4
Name
マスターイメージ名[.セクション]

5
User
業務システム構築者
PaaS利用者の場合は表示しません。

(2) 個別のマスターイメージ表示（-i）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils -i 5

ID                 : 5
Name               : webdb2.dev
Version            : 01-03
User               : admin
Status             : deployed
Create             : 2012/10/02 15:23
Modify             : 2012/10/02 15:48
Pattern template   : template1
Component template : tmplA
                    tmplB
                    tmplC
UOC status         : succeeded(deploy)

Parent             : webdb(1)
Version            : 01-02

Child              : webdb5(11)
                    webdb6(14)
                    webdb7(17)

表1-15　表示項目の説明

項番
項目
説明

1
ID
マスターイメージID

2
Name
マスターイメージ名[.セクション]

3
Version
（Nameの下の行）
マスターイメージのバージョン

4
User
業務システム構築者

5
Status
業務システムの状態
詳細は，「表1-16　業務システムのStatus一覧」を参照してください。

6
Create
マスターイメージの作成日付

7
Modify
マスターイメージの最終更新日付

8
Pattern template
マスターイメージ作成に使用した構成パターンテンプレート

9
Component template
マスターイメージ作成に使用したコンポーネントテンプレート

10
UOC status
ミドルセットアップUOCの状態を表示します。

11
Parent
親のマスターイメージ名とマスターイメージID（括弧内）
ほかのマスターイメージ，またはマスターイメージのスナップショットを基に登録した場合に表示します。uCSDに親が登録されていない場合には「***」を表示します。

12
Version
（Parentの下の行）
親のマスターイメージのバージョン
ほかのマスターイメージ，またはマスターイメージのスナップショットを基に登録した場合に表示します。uCSDに登録されていない場合には「***」を出力します。

13
Child
自身のマスターイメージを基に作成したマスターイメージ名とマスターイメージID（括弧内）を表示します。存在しない場合には「***」を出力します。

表1-16　業務システムのStatus一覧

項番
Status
説明

1
registered
マスターイメージを登録した状態（サイジング後※1）

2
registered(partially configured)
物理配置算出を1回以上実施した後で，物理配置が未確定のホストが存在する状態。
リソース予約済み，デプロイ済みのホストが存在する場合があります※2。

3
configured
物理配置が確定した状態

4
configured(partially reserved)
物理配置が確定した状態で，部分的にリソース予約している状態
デプロイ済みのホストが存在する場合があります※2。

5
ready
デプロイ可能状態（サイジング，物理配置，リソース予約完了状態）
デプロイ済みのホストが存在する場合があります※2。

6
deploying
デプロイ中

7
deploying(wait(N))
デプロイ実行待ち状態※3
Nは現在のデプロイ／アンデプロイ待ちVM数を表します。

8
deploying(pause)
デプロイ一時停止

9
deploying(stopping)
デプロイ中止中※4

10
deploying(stopped)
デプロイ中止状態

11
deployed
デプロイ完了状態

12
failed(deploy)
デプロイ失敗状態

13
undeploying
アンデプロイ中

14
undeploying(wait(N))
アンデプロイ実行待ち状態※3
Nは現在のデプロイ／アンデプロイ待ちVM数を表します。

15
undeploying(stopping)
アンデプロイ中止中※4

16
undeploying(stopped)
アンデプロイ中止状態

17
failed(undeploy)
アンデプロイ失敗状態

18
updating
更新中

19
updating(wait(N))
更新実行待ち状態※3
Nは現在のアップデート待ちVM数を表します。

20
updating(stopping)
更新中止中※4

21
updating(stopped)
更新中止状態

22
failed(update)
更新失敗状態

注※1

csdmiregisterコマンドで-sオプションを省略した場合は，サイジングは未実施の状態となります。

注※2

csdmiundeploy（-pオプション付き），csdmirelease（-pオプション付き），csdmipos（-rオプション付き）などで特定のホストの状態だけを変えた場合にこの状態になります。各ホストの状態をcsdmils（-lオプション付き）で確認してください。

注※3

実行待ち状態とは，他業務の要求実行中によって，自身の要求が実行待ちの状態です。

注※4

csdmistopdeployコマンドを入力し，中止処理を実行している状態です。

表1-17　ミドルセットアップUOCのStatus一覧

項番 | Status | 説明
1 | - | 定義にミドルセットアップUOCが指定されていないため，UOCを実行できない状態
2 | executable | UOCを実行できる状態
3 | executing(deploy) | デプロイコマンドの延長で，ミドルセットアップUOCが実行中の状態
4 | succeeded(deploy) | デプロイコマンドの延長で，ミドルセットアップUOCの実行に成功した状態
5 | failed(deploy) | デプロイコマンドの延長で，ミドルセットアップUOCの実行に失敗した状態
6 | executing(undeploy) | アンデプロイコマンドの延長で，ミドルセットアップUOCが実行中の状態
7 | failed(undeploy) | アンデプロイコマンドの延長で，ミドルセットアップUOCの実行に失敗した状態

(3) マスターイメージのサイジング結果の構成情報の表示（-i，-s）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils -i 5 -s
CID  Num  CPU   Core  Memory  Tier
---------------------------------------
1    3    1.60  2     4.00    AppServer
2    1    2.60  4     8.00    DB

表1-18　表示項目の説明

項番 | 項目 | 説明
1 | CID | 構成パターンテンプレートのコンポーネントID
2 | Num | サイジングで確定した台数
3 | CPU | サイジングで確定したCPUクロック[GHz]
4 | Core | サイジングで確定したCPUコア数[個]
5 | Memory | サイジングで確定したメモリ容量[GB]
6 | Tier | 構成パターンテンプレートのティア

(4) マスターイメージの物理配置情報の出力（-i，-p）

表示形式はcsdmiposコマンドと同様です。

(5) マスターイメージ定義ファイル出力（-i，-o）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils -i 5 -o myservice.xml

(6) 業務システムで稼働しているホストとミドルウェアの一覧表示（-i，-l）

出力形式は次の形式でミドルウェアごとに出力します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils -i 5 -l
Host  Host   Host                                                Middleware  Middleware
ID    Name   Status    CID  IPAddress                            Name        Status
---------------------------------------------------------------------------------------
1     host1  deployed  1    10.208.173.110(M),[2](B)             Cosminexus  updated
2     host2  deployed  1    10.208.173.111(M),10.208.174.111(B)  Cosminexus  updated
3     host3  deployed  2    10.208.173.112(M),10.208.174.112(B)  Cosminexus  updated
4     host4  deployed  3    10.208.173.113(M),10.208.174.113(B)  HiRDB       updated
5     host5  deployed  4    10.208.173.114(M),10.208.174.114(B)  HAMonitor   updated
6     host6  deployed  5    10.208.173.115(M),[0](B)             Cosminexus  updated

リソース予約前は次の形式で出力します

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmils -i 5 -l
Host  Host  Host                            Middleware  Middleware
ID    Name  Status          CID  IPAddress  Name        Status
------------------------------------------------------------------
1     *     notconfigured  1    *          Cosminexus  notsetup
2     *     notconfigured  1    *          Cosminexus  notsetup
3     *     notconfigured  2    *          Cosminexus  notsetup
4     *     notconfigured  3    *          HiRDB       notsetup
5     *     notconfigured  4    *          HAMonitor   notsetup
6     *     notconfigured  5    *          Cosminexus  notsetup

注　未決定の項目は「*」を出力します。

表1-19　表示項目の説明

項番
項目
説明

1
Host ID
uCSDが生成するホストID

2
Host Name
仮想ホスト名

3
Host Status
ホストの状態
詳細は，「表1-20　仮想ホストのStatus一覧」を参照してください。

4
CID
ホストのひな形となった構成パターンテンプレートのコンポーネントID

5
IPAddress
ホストのIPアドレス
複数ある場合には,(コンマ)で区切って表示します。
IPアドレスの後ろが(M)：管理IPアドレスを表します。
IPアドレスの後ろが(B)：業務IPアドレスを表します。
仮想NICが複数存在する場合は[x](x:仮想NIC数)を表示します。すべての仮想NICの情報を表示する場合はcsdmilsコマンドに-eオプションを指定して実行します。
業務IPアドレスが存在しない場合は[0]を表示します。

6
Middleware Name
ミドルウェアの名称
1つのホストに複数ミドルが存在する場合は，ミドルごとに複数行表示します。

7
Middleware Status
ミドルウェアの状態
詳細は，「表1-21　ミドルウェアのStatus一覧」を参照してください。

表1-20　仮想ホストのStatus一覧

項番 | Status | 説明
1 | notconfigured | 物理配置算出が完了していない状態
2 | configured | 物理配置算出が完了している状態
3 | reserved | リソースが予約されている状態
4 | deployed | ホストのデプロイに成功した状態
5 | failed(deploy) | ホストのデプロイに失敗した状態
6 | updated | ホストのデプロイに成功してOS設定の更新が完了した状態
7 | failed(update) | ホストのデプロイは成功したがOS設定の更新が失敗した状態
8 | failed(undeploy) | ホストのアンデプロイに失敗した状態

表1-21　ミドルウェアのStatus一覧

項番 | Status | 説明
1 | notsetup | ミドルウェアがセットアップされていない状態
2 | succeeded(setup) | ミドルウェアがセットアップされている状態
3 | failed(setup) | ミドルウェアのセットアップに失敗した状態
4 | updated | ミドルウェアのセットアップに成功して更新が完了した状態
5 | failed(update) | ミドルウェアのセットアップは成功したが更新に失敗した状態

(7) マスターイメージの物理配置情報の詳細出力（-i，-r）

出力形式は次の形式でマスターイメージ内の仮想ホストの詳細な物理配置候補を出力します。

表1-22　表示項目の説明（物理配置情報の詳細出力）

項番
項目
説明

1
Host ID
uCSDが生成するホストID。

2
Result
物理配置候補算出結果。
次のどれかを出力します。

Succeeded

Failed

3
OS Name
仮想ホストにインストールされているOS名。
表示されるOS名は「表1-9　コマンドで表示するOS名」を参照してください。
注　DFMTが定めているCIM_OperatingSystemクラスの分類と同じ名称とします。

4
Tmplate Name
仮想ホストのコンポーネント・テンプレート名。

5
Pattern
仮想ホストの構成パターン（ティア）。

6
Physical Host Group Name
物理配置候補として選出された物理ホストグループ名。物理配置候補算出に失敗した場合は「-」を表示します。

7
Physical Host IP Address
物理配置候補として選出された物理ホストのIPアドレス。物理配置候補算出に失敗した場合は「-」を表示します。

8
Lb Setting File Name
仮想ホストが接続する負荷分散機への接続設定を記載した負荷分散機接続設定プロパティファイル。負荷分散機を使用するミドルウェアが存在しない場合，または物理配置候補算出に失敗した場合は「-」を表示します。

9
Storage
物理配置候補として選出されたストレージ名。
VMwareの場合：データストア名。
HVMの場合：ストレージのリソース名，ストレージプール名を2行で出力。
物理配置候補算出に失敗した場合は「-」を表示します。

10
Resource Pool
物理配置候補として選出されたリソースプール名。
VMwareの場合：リソースプール名を表示します。
リソースプールを持たない物理ホストの場合は「-」を表示します。
HVMの場合：「-」を表示します。
物理配置候補算出に失敗した場合は「-」を表示します。

11
Error Reason
物理配置候補算出の失敗原因。
失敗原因が複数ある場合は複数行で出力します。表示される失敗原因については「csdmipos（物理配置候補の算出）」を参照してください。物理配置候補算出に成功した場合は「-」を表示します。

(8) マスターイメージで定義している仮想NICの情報表示（-i，-e）

出力形式は次の形式で仮想ホストごとに出力する。

Host ID        : 1

VNIC           : Network Adapter 1
Type           : management
Purpose        : Manage
IPAddress      : 10.208.173.110
VLAN ID        : 401

VNIC           : Network Adapter 2
Type           : business
Purpose        : Business1
IPAddress      : 10.208.174.110
VLAN ID        : 402

VNIC           : Network Adapter 3
Type           : business
Purpose        : HeartBeat
IPAddress      : 20.208.173.110
VLAN ID        : 402

VNIC           : Network Adapter 4
Type           : Not Use
Purpose        : -
IPAddress      : -
VLAN ID        : -

Host ID        : 2

VNIC           : Network Adapter 1
Type           : management
Purpose        : Manage
IPAddress      : 10.208.173.111
VLAN ID        : 411

VNIC           : Network Adapter 2
Type           : business
Purpose        : Business1
IPAddress      : 10.208.174.111
VLAN ID        : 412

表1-23　表示項目の説明（仮想NIC情報）

項番
項目
説明

1
VNIC
仮想NIC名

2
Type
IPアドレス種別
management：管理用
business：業務用
Not Use ：未使用

3
Purpose
仮想ネットワークデバイス用途
構成パターンテンプレートで指定した文字列を表示します。構成パターンテンプレートで用途が指定されなかった場合は「-」を表示します。

4
IPAddress
仮想NICに割り当てられたIPアドレス
種別が未使用の場合は「-」を表示します。
リソース予約前の場合は「*」を表示します。

5
VLAN ID
VLAN IDリソース予約前の場合は「*」を表示します。

(9) マスターイメージ情報ファイル出力（-m）

マスターイメージ情報ファイルは次に示すXML形式で出力します。

<?xml version="1.0" encoding="UTF-8"?>
<MasterImageInformation
   xmlns="http://www.hitachi.co.jp/soft/xml/csd/service/masterimage_information">
   <MasterImage
       id="1"
       name="Image1.Section1"
       version="01-00"
       status="deployed"
       uocstatus="succeeded(deploy)"
       createuser="User1"
       createdate="2013/10/30 08:00"
       modifydate="2013/10/30 09:00"
       deployuser="User1"
       deploydate="2013/10/30 10:00">
       <HostInformation>
           <Host
               componentid="1"
               id="1"
               name="Host1"
               status="updated"
               hvtype="VMware"
               osname="RedHat Enterprise Linux 64-Bit"
               cpu="2.00"
               core="2"
               memory="4.00"
               vmsize="4096"
               physicalhostgroupname="PhysicalHostGroup1"
               physicalhostipaddress="1.1.1.10"
               storage="DataStore1"
               pool="Pool1"
               lbsettingfilename="lb.properties"
               lbipaddress="1.1.1.50">
               <MiddlewareInformation>
                   <Middleware
                       tier="AppServer"
                       type="combined-tier"
                       name="Cosminexus"
                       status="updated">
                       <MiddlewarePatchInformation>
                           <MiddlewarePatch
                               name="middlepatch.sh"
                               path="C:¥patch"
                               order="1"
                               status="applied"/>
                           ・・・(ミドルウェアパッチ数)
                       </MiddlewarePatchInformation>
                   </Middleware>
                   ・・・（仮想ホストのミドルウェア(ティア)数）
               </MiddlewareInformation>
               <NetworkInformation>
                   <Network
                       name="Adapter1"
                       type="management"
                       purpose="mng1"
                       ipaddress="1.1.1.100"
                       subnetmask="255.255.255.0"
                       defaultgateway="1.1.1.1"
                       vlanid="0"/>
                   ・・・（仮想ホストのネットワーク(未使用含む)数）
               </NetworkInformation>
               <OSPatchInformation>
                   <OSPatch
                       name="ospatch.sh"
                       path="C:¥patch"
                       order="1"
                       status="applied"/>
                   ・・・(OSパッチ数)
               </OSPatchInformation>
           </Host>
           ・・・（仮想ホスト数（リソース未割り当ても含む））
       </HostInformation>
   </MasterImage>
   ・・・（マスターイメージ数）
</MasterImageInformation>

マスターイメージ情報ファイルの文字コードはUTF-8，改行コードは¥r¥nとなります。

また，各属性の値は次の特殊文字を置換して出力します。

表1-24　置換対象文字

項番 | 置換対象文字 | 置換後の文字列
1 | & | &amp;
2 | < | &lt;
3 | > | &gt;
4 | " | &quot;
5 | ' | &apos;

マスターイメージ情報ファイルの構成を次に示します。

表1-25　マスターイメージ情報ファイルのXML文法

項番
タグ名
属性
出現回数
説明

1
MasterImageInformation
－
1
ルート要素を表します。

2
xmlns
1
XML名前空間を表します。以下の文字列を出力します。
"http://www.hitachi.co.jp/soft/xml/csd/service/masterimage_information"

3

MasterImage
－
0-3000※1
マスターイメージの情報を表します。マスターイメージごとに出力します。
マスターイメージが未登録，またはコマンド実行ユーザが参照可能なマスターイメージがない場合は出力しません。
出力順はマスターイメージID順です。

4
id
1
マスターイメージIDを表します。

5
name
1
マスターイメージ名を表します。
"マスターイメージ名[.セクション]"の形式で出力します。

6
version
1
マスターイメージのバージョンを表します。

7
status
1
業務システムの状態を表します。
詳細は「表1-16　業務システムのStatus一覧」を参照してください。
ただし，deploying，undeploying ，updatingの実行待ちVM数(wait(N))の出力は行いません。

8
uocstatus
1
ミドルセットアップUOCの状態を表します。
詳細は「表1-17　ミドルセットアップUOCのStatus一覧」を参照してください。
ミドルセットアップUOCを未使用の場合は"-"を出力します。

9
createuser
1
マスターイメージを登録したユーザ名を表します。

10
createdate
1
マスターイメージの登録時刻を表します。

11
modifydate
1
マスターイメージの最終更新時刻を表します。
次の契機で更新します。※2

csdmiregisterコマンド実行時

csdmiupdateコマンド実行時

csdmiposコマンド実行時

csdmireserveコマンド実行時

csdmireleaseコマンド実行時

12
deployuser※3
1
デプロイ要求，またはデプロイ開始以降の状態に変更を行ったユーザ名を表します。
次の契機で更新します。

csdmideployコマンド実行時

csdmivmstatusコマンド実行時
（-gオプションにvmdeployedまたはalldeployedを指定した場合）

一度もデプロイ要求を行っていない場合は"*"を出力します。

13
deploydate※3
1
デプロイを完了，またはデプロイ済みの状態に変更した時刻を表します。
"YYYY/MM/DD hh:mm"の形式で出力します。
次の契機で更新します。

デプロイ完了時（マスターイメージステータスをdeployedに更新する契機）

csdmivmstatusコマンド実行時
（-gオプションにalldeployedを指定し，実行した結果マスターイメージステータスがdeployedになる場合）

デプロイを完了していない場合（失敗，一時中止，csdmistopdeployコマンドによる中断）は時刻を更新しません。
一度もデプロイを完了していない場合は"*"を出力します。

14

HostInformation
－
1
仮想ホストの一覧を表します。

15

Host
－
1-3000※1
仮想ホストの情報を表します。仮想ホストごとに出力します。
出力順はコンポーネントID順，同一の場合は仮想ホストID順です

16
componentid
1
仮想ホストの雛形となった構成パターンテンプレートのコンポーネントIDを表します。

17
id
1
仮想ホストIDを表します。

18
name
1
仮想ホスト名を表します。
リソース予約前の場合は"*"を出力します。

19
status
1
仮想ホストの状態を表します。
詳細は「表1-20　仮想ホストのStatus一覧」を参照してください。

20
hvtype
1
ハイパーバイザ種別を表します。
VMwareの場合：VMware
HVMの場合：HVM

21
osname
1
仮想ホストにインストールされているOS名を表します。
詳細は「表1-9　コマンドで表示するOS名」を参照してください。

22
cpu
1
仮想ホストが使用するCPUクロックを表します。[GHz]

23
core
1
仮想ホストが使用するコア数を表します。

24
memory
1
仮想ホストが使用するメモリ容量を表します。[GB]

25
vmsize
1
仮想ホストのVMサイズを表します。[MB]
コンポーネントテンプレートに指定したVMサイズを出力します。

26
physicalhostgroupname
1
仮想ホストを配置する物理ホストの所属する物理ホストグループ名を表します。
物理配置候補算出前の場合は"*"を出力します。

27
physicalhostipaddress
1
仮想ホストを配置する物理ホストのIPアドレスを表します。
物理配置候補算出前の場合は"*"を出力します。

28
storage
1
仮想ホストを配置するストレージ名を表します。
VMwareの場合：データストア名
HVMの場合：ストレージのリソース名
物理配置候補算出前の場合は"*"を出力します。

29
pool
1
仮想ホストを配置するプール名を表します。
VMwareの場合：リソースプール名
HVMの場合：ストレージのプール名
物理配置候補算出前の場合は"*"を出力します。
プールを未使用の場合は"-"を出力します。

30
lbsettingfilename
1
仮想ホストが接続する負荷分散機の負荷分散機接続設定プロパティファイル名を表します。
物理配置候補算出前の場合は"*"を出力します。
負荷分散機を未使用の場合は"-"を出力します。

31
lbipaddress
1
仮想ホストが接続する負荷分散機の管理用IPアドレスを表します。
物理配置候補算出前の場合は"*"を出力します。
負荷分散機を未使用の場合は"-"を出力します。

32

MiddlewareInformation
－
1
ミドルウェアの一覧を表します。

33

Middleware
－
1-5※1
ミドルウェアの情報を表します。ミドルウェアごとに出力します。
出力順はティア名称順です。

34
tier
1
このミドルウェアを対応づけたティア名称を表します。

35
type
1
ミドルウェアを対応づけたティアの種別を表します。
Cosminexus以外のミドルウェアの場合は"-"を出力します。

36
name
1
ミドルウェアの名称を表します。

37
status
1
ミドルウェアの状態を表します。
詳細は「表1-21　ミドルウェアのStatus一覧」を参照してください。

38

MiddlewarePatchInformation
－
1
ミドルウェアパッチの一覧を表します。

39

MiddlewarePatch
－
0-120※1
ミドルウェアパッチの情報を表します。パッチごとに出力します。
出力順は適用順です。

40
name
1
ミドルウェアパッチ名を表します。
パッチを格納しているディレクトリからの相対パスを出力します。

41
path
1
パッチを格納しているディレクトリを表します。

42
order
1
パッチの適用順序を表します。

43
status
1
パッチの適用状態を表します。
notapplied：未適用
applied：適用済み

44
NetworkInformation
－
1
ネットワークの一覧を表します。

45

Network
－
1-16※1
ネットワークの情報を表します。仮想NICごとに出力します。
出力順は仮想NIC名順です。

46
name
1
仮想NIC名を表します。

47
type
1
IPアドレス種別を表します。
詳細は「表1-23　表示項目の説明（仮想NIC情報）」のType項目を参照

48
purpose
1
仮想ネットワークデバイス用途を表します。
構成パターンテンプレートで指定した文字列を出力します。
IPアドレス種別が未使用の場合，および用途を未指定の場合は"-"を出力します。

49
ipaddress
1
仮想NICに割り当てたIPアドレスを表します。
IPアドレス種別が未使用の場合は"-"を出力します。
リソース予約前の場合は"*"を出力します。

50
subnetmask
1
仮想NICに割り当てたIPアドレスのサブネットマスクを表します。
IPアドレス種別が未使用の場合は"-"を出力します。
リソース予約前の場合は"*"を出力します。

51
defaultgateway
1
仮想NICに割り当てたIPアドレスのデフォルトゲートウェイを表します。
IPアドレス種別が未使用，またはデフォルトゲートウェイ未指定の場合は"-"を出力します。
リソース予約前の場合は"*"を出力します。

52
vlanid
1
仮想NICに割り当てたVLAN IDを表します。
IPアドレス種別が未使用の場合は"-"を出力します。
リソース予約前の場合は"*"を出力します。

53
OSPatchInformation
－
1
OSパッチの一覧を表します。

54

OSPatch
－
0-120※1
OSパッチの情報を表します。パッチごとに出力します。
出力順は適用順です。

55
name
1
OSパッチ名を表します。
パッチを格納しているディレクトリからの相対パスを出力します。

56
path
1
パッチを格納しているディレクトリを表します。

57
order
1
パッチの適用順序を表します。

58
status
1
パッチの適用状態を表します。
notapplied：未適用
applied：適用済み

注※1

uCSDの登録数の制限値です。上限値，下限値はプログラムで制限はしません。

注※2

最終更新時刻はマスターイメージの設定や使用リソースを更新した時刻を出力します。そのため，デプロイ，アンデプロイを実行した契機では更新しません。

注※3

09-51以前から上書きでバージョンアップした場合，バージョンアップ時にデプロイ済みの仮想ホストは一度アンデプロイして再デプロイするまで"*"を出力します。

注意事項

-oオプション，-dオプション，および-mオプションで指定するパスについて

あらかじめ出力ファイル名，出力ディレクトリ名の上位ディレクトリを作成しておく必要があります。上位ディレクトリが存在しないパスを指定した場合，csdmilsコマンドはエラー終了します。

指定したパスと同名のファイルまたはディレクトリが存在する場合，csdmilsコマンドはエラー終了します。別のパスを指定するか，同名のファイルまたはディレクトリを削除してからコマンドを実行してください。

-dオプションで指定するパス長について
-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長を247文字以下となるよう指定してください。

相対パスでの指定について
ファイル名，およびディレクトリ名を相対パスで指定する場合，指定したファイル，およびディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名指定時の推奨値について
ディレクトリ名を指定する場合，ディレクトリ名の絶対パス長が87文字以下とすることを推奨します。

ディレクトリ名指定パスのパス長超過時の動作について
指定したディレクトリ下に，サーバからダウンロードしたマスターイメージの関連情報を保存する際，一部ファイル，ディレクトリのパス長が計算上，Windowsの制限260文字を超える場合でも，Windowsが一部ディレクトリ名をショートディレクトリ名（~(チルダ)入りの８文字のディレクトリ名）と扱い，情報保存を行えるときは，パス長超過のエラーにはなりません。マスターイメージ関連情報を保存し，コマンドは正常終了します。なお，一部ディレクトリ名をショートディレクトリ名に変換し関連情報を保存した場合，当該情報をマスターイメージ登録時または更新時に使用するときには，ショートディレクトリ名のディレクトリがパス内に含まれないディレクトリ下に移動させた後に使用してください。

csdmiexport（マスターイメージのエクスポート）

形式

csdmiexport {-i マスターイメージID |-n マスターイメージ名[.セクション]}

-d ディレクトリ名

機能

指定したディレクトリを新規作成して，マスターイメージのスナップショットを作成します。

作成したスナップショットを基に，csdmiregisterコマンドで新たなマスターイメージを作成することができます。

また，マスターイメージのバックアップ手段としても使用できます。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

マスターイメージのスナップショットを構成するファイル／ディレクトリ構成と一覧を次に示します。

表1-26　マスターイメージのスナップショットのファイル・ディレクトリ構成

項番 | ファイル・ディレクトリ構成 | 説明
1 | -dで指定したディレクトリ名 | masterimage.ovf | マスターイメージ構成ファイル
2 | usr | masterimage_define.xml | マスターイメージ定義ファイル
3 | masterimage_define.xml.bak | 項番2のバックアップ
4 | position.xml | 物理配置制約ファイル
5 | position.xml.bak | 項番4のバックアップ
6 | resource.csv | リソース定義ファイル
7 | resource.csv.bak | 項番6のバックアップ
8 | data | UOC格納ディレクトリ
9 | data.bak | 項番8のバックアップ
10 | sys | hostsファイル，ミドルウェア定義ファイル，OS設定ファイルなどが格納されます。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-d

マスターイメージのスナップショットの出力先ディレクトリを指定します。

ディレクトリ名：～<パス名>

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmiexport -n mi01 -d mymi01dir
KFUD93110-I エクスポートが正常に完了しました。

注意事項

-dオプションで指定するパスについて

あらかじめ出力ディレクトリ名の上位ディレクトリを作成しておく必要があります。上位ディレクトリが存在しないパスを指定した場合，csdmiexportコマンドはエラー終了します。

指定したパスと同名のファイルまたはディレクトリが存在する場合，csdmiexportコマンドはエラー終了します。別のパスを指定するか，同名のファイルまたはディレクトリを削除してからコマンドを実行してください。

-dオプションで指定するパス長について
-dオプションで指定するディレクトリのパス長については，ディレクトリ下のすべてのファイル，およびサブディレクトリが絶対パス長で247文字以下となるよう指定してください。

相対パスでの指定について
ディレクトリ名を相対パスで指定する場合，指定したディレクトリの絶対パス長が247文字以下となるよう指定してください。

ディレクトリ名指定時の推奨値について
ディレクトリ名を指定する場合，ディレクトリ名の絶対パス長を87文字以下とすることを推奨します。

ディレクトリ名指定パスのパス長超過時の動作について
指定したディレクトリ下に，Serverからダウンロードしたマスターイメージのスナップショットを保存する際，一部ファイル，ディレクトリのパス長が計算上，Windowsの制限260文字を超える場合でも，Windowsが一部ディレクトリ名をショートディレクトリ名（~(チルダ)入りの８文字のディレクトリ名）と扱い，情報保存を行えるときは，パス長超過のエラーにはなりません。マスターイメージのスナップショットを保存し，コマンドは正常終了します。なお，一部ディレクトリ名をショートディレクトリ名に変換しスナップショットを保存した場合，当該スナップショットをマスターイメージ登録時または更新時に使用するときには，ショートディレクトリ名のディレクトリがパス内に含まれないディレクトリ下に移動させた後に使用してください。

csdmipos（物理配置候補の算出）

形式

csdmipos {-i マスターイメージID|-n マスターイメージ名[.セクション]}

[-f 物理配置制約ファイルパス] [-r]

機能

物理配置制約ファイルに定義された制約条件を基に，指定した業務システムを構成する仮想ホストの物理配置候補を算出します。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

詳細な物理配置候補算出結果を参照する場合は，csdmiposコマンド実行後，csdmilsコマンド(-rオプション指定)を実行してください。詳細は，「csdmils（マスターイメージの表示）」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-f

物理配置制約ファイルを指定します。

物理配置制約ファイルの詳細は「2.4.4　物理配置制約ファイル」を参照してください。

-fオプションを省略した場合は，制約条件のチェックを行いません。

物理配置制約ファイルパス：～<パス名>

-r

状態がリソース予約以降の仮想ホストを考慮して，物理配置候補の再算出を行う。

-rオプションを指定した場合と，指定していない場合の物理配置候補算出の算出結果の例を次に示します。

図1-3　-rオプション指定/未指定時の物理配置候補算出

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

(1) 正常に物理配置候補算出が完了した場合

(2) 物理配置候補が決定していない仮想ホストがある場合

表1-27　表示項目の説明

項番
項目
説明

1
VMID
物理配置候補算出対象のホストID

2
Result
物理配置候補を選出できたかどうか（Succeeded／Failed）

3
OSName
仮想ホストにインストールされているOS名
マスターイメージ構成ファイルに記述されているOS識別子を表示します。

4
TemplateName
物理配置候補算出対象の仮想ホストのコンポーネントテンプレート名

5
Pattern
物理配置候補算出対象の仮想ホストの構成パターン（ティア）

6
PhysicalHostGroupName
物理配置候補として選出された物理ホストグループ名

7
PhysicalHostIPAddress
物理配置候補として選出された物理ホストの物理IPアドレス

8
LbSettingFileName
負荷分散機接続設定プロパティファイル名

9
Error Reason
物理配置候補の選出に失敗した原因
詳細は，「表1-28　Error Reason一覧」を参照してください。

表1-28　Error Reason一覧

項番
項目
説明

1
CPU Clock Shortage: Request Clock aa, free Clock bb
サイジングで決定したCPUクロック数を満たす物理ホストが存在しません。

aa：配置の際に要求したクロック数

bb：空きクロック数

物理構成情報が存在しない場合は「***」を出力

2
Memory Shortage: Request Size cc, Free Size dd
サイジングで決定したメモリ容量を満たす物理ホストが存在しません。

cc：配置の際に不足したサイズ[MB]

dd：空きメモリ容量[MB]

物理構成情報が存在しない場合は「***」を出力

3
Phisicalhost Group Not Available - Physicalhost Group Name:name
物理ホストグループを候補にできません。

name：候補にできなかった物理ホストグループの名称

4
Physicalhost Not Available - Physicalhost IP Address

:ipaddress

IPアドレスで指定された物理ホストを候補にできません。

ipaddress：候補にできなかった物理ホストのIPアドレス

5
Storage Size Shortage: Request Size dd, Free Size ee
仮想ホストを配置できるストレージが関連づけられている物理ホストが存在しません。

dd：配置の際に要求した仮想ホストの容量[MB]

ee：空きストレージ容量[MB]

物理構成情報が存在しない場合は「***」を出力

6
Share LB Not Found
共有LBを割り当てようとしましたが，共有LBが存在しません。

7
Physicalhost Shortage:name
仮想ホストを割り当てるための物理ホストの台数が不足しています。

name：失敗の要因となった制約条件，次のどれかを出力

physicalhost_besides
指定したホストIDの数が利用可能な物理ホスト数を超えた場合

physicalhost_with
同一物理ホストに配置するためのリソース（CPUクロック，メモリ容量，ストレージ容量）が不足した場合

physicalhost_exclusion
指定した物理ホストを除外した結果，利用可能な物理ホストがなくなってしまった場合

8
Physicalhost Group Shortage:name
仮想ホストを割り当てるための物理ホストが所属する物理ホストグループの数が不足しています。

name：失敗の要因となった制約条件，次のどれかを出力

physicalhost_group_besides
指定したホストIDの数が利用可能な物理ホストグループ数を超えた場合

physicalhost_group_with
同一物理ホストグループに配置するためのリソース（CPUクロック，メモリ容量，ストレージ容量）が不足した場合

physicalhost_group_exclusion
指定した物理ホストグループを除外した結果，利用可能な物理ホストグループがなくなってしまった場合

9
Not Match HVType - HVType:type
仮想ホストのハイパーバイザ種別と一致する物理ホストが存在しません。

type：仮想ホストのハイパーバイザ種別

物理ホストのハイパーバイザ種別はcsdrsclsコマンドで確認します。

10
Not Match VirtualNetworkDevice:name
仮想ホストが必要とする仮想ネットワークデバイスを保持した物理ホストが存在しません。

name：マスターイメージ登録時に指定した構成パターンテンプレート名

このエラー原因が表示された場合，PaaS提供者に連絡します。PaaS提供者は，実際の物理構成および，物理構成定義ファイル・構成パターンテンプレートの仮想ネットワークデバイスに関する記載，リソース制約定義ファイルの内容を確認します。

11
Not Match IPAddressRange
PaaS利用者に許可されたIPアドレスで使用可能な物理ホストが存在しません。
このエラー原因が表示された場合，PaaS提供者に連絡します。PaaS提供者は，実際の物理構成および，リソース制約定義ファイルの内容を確認します。

12
Storage Not Available
仮想ホストのシステム要件（CPUクロック数など）のチェックやほかの制約条件のチェックによって，すでに物理配置候補から除外されているため，物理配置制約ファイルに指定したデータストアまたはストレージプールを持つ物理ホストを候補にできません。
このエラー原因が出力された場合，PaaS利用者は物理配置制約ファイルに指定した制約条件の見直しを行います。解決しない場合はPaaS提供者に連絡し，物理構成定義ファイルおよび実際の物理構成を確認します。

13
Resource Pool Not Available
仮想ホストのシステム要件（CPUクロック数など）のチェックやほかの制約条件のチェックによって，すでに物理配置候補から除外されているため，物理配置制約ファイルに指定したリソースプールを持つ物理ホストを候補にできません。
このエラー原因が出力された場合，PaaS利用者は物理配置制約ファイルに指定した制約条件の見直しを行います。解決しない場合はPaaS提供者に連絡し，物理構成定義ファイルおよび実際の物理構成を確認します。

14
LB Not Available
共有LBを割り当てようとしたが，使用可能な共有LBが存在しません。
このエラー原因が表示された場合，PaaS提供者に連絡します。PaaS提供者は，実際の物理構成および，リソース制約定義ファイルの内容を確認します。

注意事項

-rオプションを指定する場合

物理ホスト上への構築に失敗した仮想ホストはcsdmilsコマンドで確認できます。

物理配置候補の再算出は，物理ホスト上への構築に失敗した仮想ホストに対してcsdmireleaseコマンドでリソース予約解除を行った後に実行してください。

相対パスでの指定について

ファイル名を相対パスで指定する場合，ファイルの絶対パス長が247文字以下となるよう指定してください。

csdmireserve（物理リソースの予約）

形式

csdmireserve {-i マスターイメージID|-n マスターイメージ名[.セクション]}

[-f リソース定義ファイルパス] [-s]

機能

リソース定義ファイルに定義した内容に従って，業務システムが使用するリソースの予約を行います。

リソース予約で決定したIPアドレスと仮想ホスト名を利用してhostsファイルを作成します。作成したhostsファイルは，csdmideployコマンドによるデプロイ処理で，仮想ホストへ配置されます。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-f

リソース定義ファイルパスを指定します。

リソース定義ファイル：～<パス名>

-fオプションで指定するリソース定義ファイルの内容は「2.4.5　リソース定義ファイル」を参照してください。

-s

hostsファイルを作成しない場合に指定します。

このオプションを指定した場合，デプロイ処理でhostsファイルの仮想ホストへの自動配置も行いません。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmireserve -n mi01 -s
KFUD14403-I リソース予約が完了しました。マスターイメージID=3

注意事項

相対パスでの指定について

ファイル名を相対パスで指定する場合，ファイルの絶対パス長が247文字以下となるよう指定してください。

一部の仮想ホストに対して，リソース解放を実行したあとにリソース予約を再実行した場合のhostsファイル作成については，最後に実行したcsdmireserveのオプションに従うものとします。

（例）

hostsファイルの作成，およびデプロイ処理で仮想ホストへ自動で配置するケース

（次の手順で実行した場合）

csdmireserve -s指定あり　実行

csdmirelease -pホストID　実行

csdmireserve -s指定なし　実行

hostsファイルの作成を行わないケース

（次の手順で実行した場合）

csdmireserve -s指定なし　実行

csdmirelease -pホストID　実行

csdmireserve -s指定あり　実行

転送するhostsファイルの内容については，「2.3.9　hosts_templateファイル」を参照してください。

csdmirelease（物理リソースの予約解除）

形式

csdmirelease {-i マスターイメージID|-n マスターイメージ名[.セクション]}

[-p ホストID] [-y]

機能

業務システムのリソース予約を解除します。

一度“使用中”にしたIPアドレスのステータスを再度“利用可能”に変更することができます。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

指定したマスターイメージIDに割り当てられているすべてのVMのリソース予約を解除します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

指定した業務システム名に割り当てられているすべてのVMのリソース予約を解除します。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-p

ホストIDを指定します。

指定されたホストだけリソース予約を解除します。

ホストID：<符号なし整数>1～999999の範囲

-y

非対話形式でコマンドを実行する場合に指定します。

対話形式にyで応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmirelease -i 1
KFUD94009-Q 指定したマスターイメージのリソース予約の解除処理を続行してもよいですか？(y/n)y
KFUD14404-I リソース予約解除が完了しました。マスターイメージID=1

注意事項

解除するVMのリソースを次に示します。

IPアドレス

IPアドレスグループ番号

VLAN ID

仮想ホスト名

サブネットマスク

デフォルトゲートウェイ

仮想ネットワークデバイス名

csdrscls（物理リソース情報の出力）

形式

物理ホストグループまたは物理ホストの情報を出力ファイルまたは標準出力に出力する場合

csdrscls {-g 物理ホストグループ名|-p 物理ホストのIPアドレス} {-f 出力ファイルパス|-d}

IPアドレスの利用状況を表示する場合

csdrscls -l

利用可能なLBの情報を表示する場合

csdrscls -b

リソース予約中の仮想ホスト一覧を表示する場合

csdrscls -v

機能

uCSDが管理する物理リソース情報を表示あるいは出力します。出力するファイル形式はCSV形式です。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-g

物理ホストグループ名を指定します。

指定した物理ホストグループの情報を出力します。

物理ホストグループ名：～</,¥を含まない文字列>1～64文字

-p

物理ホストのIPアドレスを指定します。

指定した物理ホストの情報だけを出力します。

物理ホストのIPアドレス：～<文字列>IPv4形式

-f

物理リソース情報を出力する出力ファイル名を指定します。

出力ファイル名：～<パス名>

-l

uCSDが管理するIPアドレスの利用状況を表示します。

-b

uCSDが管理する利用可能なLBの情報を表示します。

-d

uCSDが管理する出力結果を標準出力に表示します。

-v

指定した物理ホストにリソース予約中の仮想ホスト一覧を表示します。

物理ホストのIPアドレス：～<文字列>IPv4形式

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

(1) 物理構成情報の出力例（-gオプションを指定した場合）

(a) ファイル出力時の出力例（-fオプションを指定した場合）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscls -g PhysicalhostGroup1 -f Allrsc.csv
KFUD94008-I 物理構成情報を出力しました。

Allrsc.csvの内容

PhysicalhostGroupName,Status,Status(Details)
PhysicalhostGroup0001,available,- - -

(b) 標準出力時の出力例（-dオプションを指定した場合）

PhysicalhostGroupName : PhysicalhostGroup0001
Status                : available
Status(Details)       : - - -

表1-29　物理ホストグループ情報の表示項目の説明

項番
項目
説明

1
PhysicalhostGroupName
物理ホストグループ名

2
Status
物理ホストグループの状態が出力されます。
次のどちらかの項目が出力されます。

available・・・利用可能
（すべての操作が利用可能な物理ホストが1つ以上ある）

unavailable・・対象外
（すべての操作が利用可能な物理ホストが1つもない）

3
Status(Details)
物理ホストグループへの各操作の状態を出力します。※
許可されていない操作の頭文字を物理配置候補算出，リソース予約，デプロイの順に表示します。許可されている操作には「-」を表示します。
P：物理配置候補算出が許可されていない
R：リソース予約が許可されていない
D：デプロイが許可されていない
-：操作が許可されている

注※　物理ホストグループのStatus欄とStatus(Details)欄の対応関係

Status欄がavailableの場合，Status(Details)欄はすべて「-」を表示します。

Status欄がunavailableの場合，Status(Details)欄は所属する物理ホストのうち1つでも操作が許可されていなければ，その操作の頭文字を表示します。

(2) 物理構成情報の出力例（-pオプションを指定した場合）

(a) ファイル出力時の出力例（-fオプションを指定した場合）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscls -p 10.208.173.110 -f Allrsc.csv
KFUD94008-I 物理構成情報を出力しました。

Allrsc.csvの内容

PhysicalhostName,PhysicalhostIPAddress,DeployedVMNumber,ReservedVMNumber,AllCPUClock,AllMemory[MB],AvailableCPUClock,AvailableMemory[MB],Status,HVType,DataStore,StorageResource,StoragePool,ResourcePool,ResourcePoolAllCPUClock,ResourcePoolAllMemory[MB],ResourcePoolAvailableCPUClock,ResourcePoolAvailableMemory[MB],Status(Details)
Physicalhost0001,10.208.173.110,0,2,32000,8000,20000,5000,available,VMware,DSTR001,,,,,,,,- - -
Physicalhost0001,10.208.173.110,0,2,32000,8000,20000,5000,available,VMware,DSTR002,,,,,,,,- - -
Physicalhost0001,10.208.173.110,0,2,32000,8000,20000,5000,available,VMware,DSTR003,,,,,,,,- - -
Physicalhost0001,10.208.173.110,0,2,32000,8000,20000,5000,available,VMware,,,,Csd_Resource1,20000,4000,15000,3000,- - -
Physicalhost0001,10.208.173.110,0,2,32000,8000,20000,5000,available,VMware,,,,Csd_Resource2,12000,4000,5000,2000,- - -

(b) 標準出力時の出力例（-dオプションを指定した場合）

PhysicalhostName         : Physicalhost0001
PhysicalhostIPAddress    : 10.208.173.110
DeployedVMNumber         : 0
ReservedVMNumber         : 2
AllCPUClock              : 32000
AllMemory[MB]            : 8000
AvailableCPUClock        : 20000
AvailableMemory[MB]      : 5000
Status                   : available
HVType                   : VMware
DataStore                : DSTR001
                          DSTR002
                          DSTR003
Status(Details)          : - - -
ResourcePool information :
ResourcePool   ResourcePoolAllCPUClock   ResourcePoolAllMemory[MB]
-------------------------------------------------------------------
Csd_Resource1  12000                     4000
Csd_Resource2  12000                     4000
(ResourcePool informationのつづき)
ResourcePoolAvailableCPUClock  ResourcePoolAvailableMemory[MB]
--------------------------------------------------------------
15000                          3000
5000                           2000

表1-30　物理ホスト情報の表示項目の説明

項番
項目
説明

1
PhysicalhostName
物理ホストの名前
下記情報を出力します。
VMware：
仮想化構成ツリーのパスをスラッシュ（/）区切りのパス形式で出力します。JP1/ITRMのjirminfolistコマンドの出力結果の仮想化構成ツリーパス（VMMTREEPATH）に出力される形式と同じです。
HVM：
JP1/ITRMで管理するリソース名を出力します。jirminfolistコマンドのリソース名（RESOURCENAME）に出力される形式と同じです。

2
PhysicalhostIPAddress
物理ホストに割り当てられている物理IPアドレス

3
DeployedVMNumber
物理ホスト上に構築されている仮想ホストの数
下記仮想ホストステータスの仮想ホスト数をカウントします。

deployed

updated

failed(update)

failed(deploy)

failed(undeploy)

4
ReservedVMNumber
物理ホストにリソースを予約した仮想ホストの数

5
AllCPUClock
物理ホストに搭載されている全CPUクロック数

6
AllMemory[MB]
物理ホストに搭載されている全メモリ容量

7
AvailableCPUClock
物理ホスト上で利用可能なCPUクロック数

8
AvailableMemory[MB]
物理ホスト上で利用可能なメモリ容量

9
Status
物理ホストの状態が出力されます。
次のどちらかの項目が出力されます。

available・・・利用可能

unavailable・・対象外

10
HVType
物理ホストのハイパーバイザ種別が出力されます。次のどちらかの項目が出力されます。

VMware

HVM

11
DataStore
物理ホストが持つデータストア名
ハイパーバイザ種別がVMwareの場合だけ出力します。
複数のデータストアを持つ場合は複数行にわたって出力します。

12
StorageResource
物理ホストが持つストレージのリソース名
ハイパーバイザ種別がHVMの場合だけ出力します。
複数のストレージを持つ場合は複数行にわたって出力します。

13
StoragePool
物理ホストが持つストレージプール名
ハイパーバイザ種別がHVMの場合だけ出力します。
複数のストレージプールを持つ場合は複数行にわたって出力します。

14
ResourcePool
物理ホストが持つリソースプール名
ハイパーバイザ種別がVMwareの場合のだけ出力します。
複数のリソースプールを持つ場合は複数行にわたって出力します。

15
ResourcePoolAllCPUClock
物理ホストが持つリソースプールの全CPUクロック数
残量管理を行わないリソースプールの場合出力しません。

16
ResourcePoolAllMemory[MB]
物理ホストが持つリソースプールの全メモリ容量
残量管理を行わないリソースプールの場合出力しません。

17
ResourcePoolAvailableCPUClock
物理ホストが持つリソースプールの空きCPUクロック数
残量管理を行わないリソースプールの場合出力しません。

18
ResourcePoolAvailableMemory[MB]
物理ホストが持つリソースプールの空きメモリ容量
残量管理を行わないリソースプールの場合出力しません。

19
Status(Details)
物理ホストへの各操作の状態を出力します。※
許可されていない操作の頭文字を物理配置候補算出，リソース予約，デプロイの順に表示します。許可されている操作には「-」を表示します。
P：物理配置候補算出が許可されていない
R：リソース予約が許可されていない
D：デプロイが許可されていない
-：操作が許可されている

注※　物理ホストのStatus欄とStatus(Details)欄の対応関係

Status欄は物理配置候補算出，リソース予約，デプロイすべての操作が許可されている場合だけavailableとし，1つでも許可されていない項目があればunavailableとします。

各操作の状態とStatus欄およびStatus(Details)欄の対応を次に示します。

表1-31　Status欄およびStatus(Details)欄の対応

操作の許可 | csdrsclsの表示内容
物理配置候補算出 | リソース予約 | デプロイ | Status | Status(Details)
○ | ○ | ○ | available | - - -
○ | ○ | × | unavailable | - - D
○ | × | ○ | unavailable | - R -
× | ○ | ○ | unavailable | P - -
○ | × | × | unavailable | - R D
× | ○ | × | unavailable | P - D
× | × | ○ | unavailable | P R -
× | × | × | unavailable | P R D

（凡例）

○：利用可能

×：対象外

(3) IPアドレスの利用状況の表示例（-lオプションを指定した場合）

PaaS提供者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscls -l
IPAddress       Status     UsedResource  IPAddressGroup
-------------------------------------------------------
10.208.173.101  Used       Virtual host  20
10.208.173.102  Available  -             10
10.208.173.103  Used       Virtual host  10
10.208.173.104  Available  -             0

PaaS利用者が実行した場合の表示例を示します。

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscls -l
IPAddress       Status     IPAddressGroup
-----------------------------------------
10.208.173.102  Available  10
10.208.173.104  Available  0

表1-32　表示項目の説明

項番
項目
説明

1
IPAddress
uCSDで管理しているIPアドレス

2
Status
uCSDで管理しているIPアドレスの利用状況を表示します。
次のどちらかを表示します。

Used・・・・使用中

Available・・利用可能

3
UsedResource
IPアドレスが利用されているリソースの種別を表示します。
PaaS利用者の場合は表示しません。
次のとおりに表示します。

Virtual host・・仮想ホスト

4
IPAddressGroup
uCSDで管理しているIPアドレスをグループ化するための番号を表示します。

(4) 利用可能なLBの表示例（-bオプションを指定した場合）

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscls -b
LBSettingFileName  IPAddress       LBModelName  Type     Count
--------------------------------------------------------------
abc.properties     10.208.173.105  BIG-IPv9     with     5
xxx.properties     10.208.173.200  ACOS         with     0
xyz.properties     10.208.173.131  BIG-IPv10.2  with     1
lb.properties      10.208.173.91   BIG-IP10.1   with     2

表1-33　表示項目の説明

項番
項目
説明

1
LBSettingFileName
uCSDで管理しているLBの負荷分散機接続設定プロパティファイル名

2
IPAddress
uCSDで管理しているLBのIPアドレス

3
LBModelName
uCSDで管理しているLBの機種名
負荷分散機接続設定プロパティファイルに記載したlb.typeの情報を表示します。

4
Type
uCSDで管理しているLBが共有であることを示す種別
次のとおりに表示します。

with・・・共有

5
Count
LBで負荷分散を行っている業務システム数
csdmireserveコマンドでカウントアップし，csdmireleaseコマンドでカウントダウンします。

(5) 指定した物理ホストにリソース予約中の仮想ホスト一覧を表示（-vオプションを指定した場合）

PaaS提供者が実行した場合の表示例を示します。

C:¥>csdrscls -v 10.208.173.110
MasterImage  MasterImage  MasterImage  Host  Host   Host      User
ID           Name         Status       ID    Name   Status
---------------------------------------------------------------------------
1            mi1          deployed     1     host1  deployed  Administrator
2            mi2          ready        1     host2  reserved  user1
2            mi2          ready        2     host3  updated   user1
4            mi4          deploying    3     host4  reserved  user2

PaaS利用者が実行した場合の表示例を示します。

C:¥>csdrscls -v 10.208.173.110
MasterImage  MasterImage  MasterImage  Host  Host   Host
ID           Name         Status       ID    Name   Status
-----------------------------------------------------------
2            mi2          ready        1     host2  ready
2            mi2          ready        2     host3  updated

表1-34　表示項目の説明

項番
項目
説明

1
MasterImage ID
マスターイメージID

2
MasterImage Name
マスターイメージ名称[.セクション]

3
MasterImage Status
業務システムの状態
詳細は，「表1-16　業務システムのStatus一覧」を参照してください。

4
Host ID
uCSDが生成するホストID

5
Host Name
仮想ホスト名

6
Host Status
ホストの状態
詳細は，「表1-20　仮想ホストのStatus一覧」を参照してください。

7
User
業務システム構築者

注意事項

-fオプションで指定するパスについて

あらかじめ出力ファイル名，出力ディレクトリ名の上位ディレクトリを作成しておく必要があります。上位ディレクトリが存在しないパスを指定した場合，csdsrclsコマンドはエラー終了します。

指定したパスと同名のファイルまたはディレクトリが存在する場合，csdsrclsコマンドはエラー終了します。別のパスを指定するか，同名のファイルまたはディレクトリを削除してからコマンドを実行してください。

相対パスでの指定について

ファイル名を相対パスで指定する場合，指定したファイルの絶対パス長が247文字以下となるよう指定してください。

オプションで指定した情報が存在しない場合の動作は次のとおりです。

-gオプションで指定した物理ホストグループがuCSDに登録されていない場合
-fオプション指定時：ヘッダ情報だけのファイルを作成
-dオプション指定時：KFUD94007-Eを出力しエラー

-pオプションで指定した物理ホストがuCSDに登録されていない場合
-fオプション指定時：ヘッダ情報だけのファイルを作成
-dオプション指定時：KFUD94006-Eを出力しエラー

csdrscstatus（物理リソースの状態変更）

形式

csdrscstatus {-g 物理ホストグループ名 | -p 物理ホストのIPアドレス} {-b|-c}

[-s 変更対象の操作]

機能

指定した物理ホストグループに所属する物理ホストの物理配置候補算出時の選出状態を変更します。

またはIPアドレスで指定した物理ホストの物理配置候補算出時の選出状態を変更します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-g

物理ホストグループ名を指定します。

指定した物理ホストグループの情報とその物理ホストグループに所属する物理ホストの状態を変更します。

物理ホストグループ名：～<¥,/を含まない文字列>1～64文字

-p

物理ホストのIPアドレスを指定します。

指定した物理ホストの状態だけを変更します。

物理ホストのIPアドレス：～<文字列>IPv4形式

-b

物理リソースの状態を“対象外”にします。

“対象外”状態の場合csdmiposコマンドによる物理配置候補算出時に選出対象外となります。

-c

物理リソースの状態を“利用可能”にします。

“利用可能”状態の場合csdmiposコマンドによる物理配置候補算出時に選出対象となります。

-s

このオプションを指定すると，指定した操作だけ「対象外」または「利用可能」に状態を変更します。このオプションを省略した場合に，このオプションの引数でP（物理配置候補算出）とR（リソース予約）が指定された場合と同様の動作をします。

このオプションを指定した場合の変更対象を次に示します。

-sオプション | 操作状態変更対象
文字列 | 物理配置候補算出 | リソース予約 | デプロイ
-s省略 | ○ | ○ | ×
P | ○ | × | ×
R | × | ○ | ×
D | × | × | ○
PR | ○ | ○ | ×
PD | ○ | × | ○
RD | × | ○ | ○
PRD | ○ | ○ | ○

（凡例）

○：「対象外」または「利用可能」に状態を変更する

×：状態変更なし

物理ホストグループの状態を変更した場合は，状態を変更した物理ホストグループに所属する物理ホストの状態も変更されます。

resource.permission.admin定義がYの場合，PaaS提供者は「対象外」となっている操作が実行可能です。

変更対象の操作：～<文字列，1～3文字>

操作の頭文字の英字を組み合わせて指定します。指定できる英字と操作の対応を次に示します。

指定可能な英字 | 操作
P | 物理配置候補算出
R | リソース予約
D | デプロイ

注　大文字と小文字を区別します。指定する操作の重複はできません。順不同です。

例：IP 1.1.1.1の物理ホストへのリソース予約およびデプロイ操作を「対象外」にする場合のコマンドライン。

C:¥> csdrscstatus -p 1.1.1.1 -b -s RD
KFUD14103-I 指定した物理ホストの状態を変更しました。IPアドレス=1.1.1.1

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscstatus -g PhysicalHostGroup1 -b
KFUD14104-I 指定した物理ホストグループの状態を変更しました。物理ホストグループ名=PhysicalHostGroup1

注意事項

なし

csdrscupdate（物理構成情報の更新）

形式

resource.vmotion.useプロパティにnを指定，または省略した場合

csdrscupdate

resource.vmotion.useプロパティにyを指定した場合

csdrscupdate -vmotion force

機能

uCSDが管理する物理構成情報を更新します。

物理構成情報の更新は起動時に行われますが，任意のタイミングで物理構成情報を更新する際にcsdrscupdateコマンドを使用します。

resource.vmotion.useプロパティにyを指定し，-vmotionオプションを指定した場合，vMotionによる仮想ホストの移動を検出し，物理構成情報を更新します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-vmotion force

vMotionによる仮想ホストの移動を検出し，物理構成情報を更新します。

注　データストアや仮想ネットワークデバイスなどが，uCSDで管理する構成や制約に合わない場合でも物理構成情報を更新します。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdrscupdate
KFUD14705-I 物理構成情報の更新が完了しました。

注意事項

uCSDではcsdrscupdateコマンドを契機にJP1/ITRMが管理する物理構成情報を取得し，管理しています。

そのため，JP1/ITRMが管理する物理構成情報が実際の物理構成と異なっていた場合，uCSDで正しい物理配置候補を算出できない可能性があります。

物理構成情報が変更された場合は，uCSDの起動，および，csdrscupdateコマンド実行の前に，JP1/ITRMが管理する物理構成情報の更新（jirminfocollectコマンドまたはGUIによる物理構成情報の再収集）を行ってください。

JP1/ITRMが管理する物理構成情報の更新は，JP1/ITRMの管理対象の構成に影響を与える操作が完了したことを確認してから行ってください。例えば，jirminfocollectコマンドを実行中にvMotionや，ESXの再起動を行った場合，JP1/ITRMが管理している物理構成情報を正しく更新できないことがあります。

csdmideploy（マスターイメージのデプロイ）

形式

csdmideploy {-i マスターイメージID|-n マスターイメージ[.セクション]} [-k パスワードアクセスキー]

機能

指定したマスターイメージに属する仮想ホストのデプロイ，および仮想ホストにインストールされているミドルウェアのセットアップを行い，業務システムを構築します。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-k

csdmisetpasswordコマンドで指定したパスワードアクセスキーを指定します。

仮想ホストのパスワードを，コンポーネントテンプレートファイルに記載済みの初期パスワードからcsdmisetpasswordコマンドで変更した場合に指定してください。仮想ホストにアクセスする際に，csdmisetpasswordコマンドで登録したパスワードを復号するために必要となります。

同一業務システム内では同一の値を指定してください。

パスワードアクセスキー：<英数字と#-@()>1～255文字

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmideploy -n mi01
KFUD15054-I 業務システムの構築を受け付けました。マスターイメージID=3

注意事項

このコマンドは非同期で実行されるため，このコマンドの実行状態はcsdmilsコマンドで業務システムstatusを確認してください。業務システムstatusは，「表1-16　業務システムのStatus一覧」を参照してください。
また，このコマンドの完了状態を確認する場合は，メッセージログを参照してください。
メッセージログの詳細については，マニュアル「uCosminexus Service Director メッセージ」を参照してください。

＜メッセージログ例＞

一時ディレクトリ作成
このコマンド実行時に，仮想ホストに作業用の一時ディレクトリを作成します。
ディレクトリ構成は次のようになります。

表1-35　作業用の一時ディレクトリの構成

ディレクトリ名/ファイル名
説明

/tmp/※1
csd_tmp/
def/
定義格納ディレクトリ/※2
OS・ミドルウェア定義兼用の格納ディレクトリ

patch/
パッチファイルディレクトリ/※2
OS・ミドルパッチ兼用の格納ディレクトリ

setup/
セットアップスクリプトディレクトリ/※2
ミドルセットアップスクリプト用の格納ディレクトリ

jp1im-agt/
JP1/IM連携機能用格納ディレクトリ/
JP1/IM連携機能で使用する格納ディレクトリ
ミドルセットアップUOCで転送を行います。

Linuxの場合：csd_hosts_copy.sh
Windowsの場合：csd_hosts_copy.bat
Linuxの場合：hostsコピー用シェルスクリプト
Windowsの場合：hostsコピー用バッチファイル

注

Linuxの場合のディレクトリ構成です。Windowsの場合は，パス区切り文字を"¥"に読み替えてください。

注※1

定義deploy.remote.tmppath（Windowsの場合はdeploy.remote.tmppath.win）によって変更できます。なお，Windowsの場合は，"%SystemRoot%¥Temp¥"です。

注※2

コンポーネントテンプレートファイル，またはマスターイメージ定義ファイルで指定したディレクトリ

定義deploy.remote.tmppathまたはdeploy.remote.tmppath.winで指定したディレクトリ下にuCSDは作業ディレクトリ”csd_tmp”を作成します。作業ディレクトリと同一名称のファイル，ディレクトリを作成しないでください。また，deploy.remote.tmppath.win配下にはファイル名が”csd_”からはじまるファイルまたはディレクトリを作成しないでください。作成した場合，uCSDによって削除されます。uCSDによって削除できなかった場合にはuCSD処理が失敗します。

uCSD処理中にエラーとなった場合，作業ディレクトリ“<deploy.remote.tmppathまたはdeploy.remote.tmppath.winの指定値>/csd_tmp”が残る場合があります。次にcsdmideployコマンドまたはcsdmiupdateコマンドを入力したときに，uCSDが作業ディレクトリを削除してコマンド処理を続行します。該当業務システムが処理中の場合は，作業ディレクトリを削除しないでください。該当業務システムが処理中かどうかは，csdmilsコマンドを実行することで調べることができます。

Cosminexusを含む業務システムデプロイ時の注意事項
Cosminexusを含む業務システムに対してcsdmideployコマンドを実行した際に，uCSDに仮想サーバマネージャ管理者アカウントが未登録の場合，「表1-36　デプロイ処理の流れ」のVMデプロイの前にKFUD25082-Eメッセージを出力し，コマンドがエラー終了します。エラー終了した場合の対策については，マニュアル「uCosminexus Service Director メッセージ」の「KFUD25082-E」に記載の対処を参照してください。

デプロイ処理の流れを次に示します。

表1-36　デプロイ処理の流れ

カテゴリ
処理実行順※3
機能
uCSDの動作
実行条件
補足

デプロイ
1
VMデプロイ
－
－
－
ハイパーバイザ種別がVMwareで，かつ，デプロイ対象の仮想ホストに複数のNICが存在する場合，そのうちのどれか1つのIPアドレスがhostsファイル※4に記載されます。
どのNICのIPアドレスが記載されるかは不定です。
ハイパーバイザ種別がHVMの場合は，hostsファイルの更新は行いません。

OS更新
2
OS定義転送
OS定義転送
コンポーネントテンプレートで記載しているOS定義を転送先ディレクトリ※1配下へ転送
OS更新パッチで未適用のパッチが1つ以上存在する場合
OS更新パッチ適用だけを実施したい場合でも定義は必ず転送します。

3
OS更新
（OS更新パッチ）
（ファイルセット転送，OS更新用パッチ実行）
OS定義配置
転送済みOS定義をディレクトリへコピー
－

4
OS更新パッチ適用
OS更新用パッチを実行
－

hosts
5
hostsファイル転送
hostsファイルのバックアップ
詳細は「2.3.9　hosts_templateファイル」を参照してください。
－
－

hostsファイルの作成
－
－

hostsファイルの転送
－
－

ミドルセットアップ
6
ミドル定義転送
ミドル定義転送※2
コンポーネントテンプレートで記載しているミドルウェア定義を転送先ディレクトリ※1配下へ転送
ミドルセットアップステータスが“notsetup”，“failed(setup)”，“failed(update)”の場合
－

7
ミドルセットアップ
ミドル定義配置※2
転送済みミドル定義をディレクトリへコピー
－

8
ミドルセットアップ
ミドルセットアップスクリプトを実行
－

ミドル更新
9
ミドル定義転送
ミドル定義転送※2
転送先ディレクトリ※1配下へミドルウェア定義ファイルを転送
ミドル更新パッチで未適用のパッチが1つ以上存在する場合
ミドル更新パッチ適用だけを実施したい場合でも定義は必ず転送します

10
ミドル更新（ミドル更新パッチ）
（ファイルセット転送，ミドル更新用パッチ実行）
ミドル定義配置※2
転送済みミドル定義をディレクトリへコピー
－

11
ミドル更新パッチ適用
ミドル更新用パッチを実行
－

注※1　定義“deploy.remote.tmppath.win”で示したディレクトリパス

ミドルウェアがCosminexus時のミドル定義転送（#6，#9）は仮想サーバマネージャで決められたディレクトリパスへ仮想サーバマネージャによって転送されます。

注※2　対象のミドルウェアがCosminexusの場合には，仮想サーバマネージャで定義の転送および配置を行います。

注※3　複数のホストに対してデプロイ処理を行う場合は，次の処理が完了するタイミングで処理の待ち合わせを行います。

カテゴリ：hosts　処理実行順：5

カテゴリ：ミドル更新　処理実行順：11

注※4　仮想ホストを構築するための仮想イメージテンプレートに付随するhostsファイル（Linuxの場合：/etc/hosts，Windowsの場合：%SystemRoot%¥System32¥drivers¥etc¥hosts）を指します。

デプロイおよび仮想サーバセットアップ時の注意事項

csdmideployコマンド実行によって作成される仮想サーバマネージャの管理ユニット名は「”u”+マスターイメージID（0，左8桁詰め）+コンポーネントID（0，左5桁詰め）」というルールで作成されます。※
例：マスターイメージIDが111でコンポーネントIDが11の仮想ホストをデプロイする場合で作成する管理ユニット名は「u0000011100011」となります。
注※　http-tier + j2ee-tier構成の場合は，http-tierのコンポーネントIDが使用されます。

ミドルセットアップスクリプト，パッチスクリプトなどのシェルスクリプトには応答待ちとなるようなコマンド形式を記述することはできません。ただし，mvコマンドの場合，-fオプションを付けて応答待ちにならないコマンド形式であれば記述できます。

hostsファイル作成を行うデプロイを実行した場合の実行結果確認方法は，「2.3.9　hosts_templateファイル」を参照してください。

仮想サーバマネージャで配布するファイル構成
仮想サーバマネージャが配布用に必要とするアプリケーションサーバの定義ディレクトリ構成の一部を次に示します。定義ディレクトリ構成の詳細はCosiminexusのマニュアルを参照してください。
PaaS提供者は，このファイル構成を作ってコンポーネントテンプレートに登録します。

<定義ディレクトリ>

 ├vmi
 │ ├tier.properties※1
 │ └tierlb.properties※2
 ├hook
 │ └pre-setup
 │

注※1　LBを使用する場合は，このファイル中に「lb.use = :unit:」を指定する必要があります。
注※2　uCSDのミドルウェア定義ファイル生成で作成されるファイルです。このファイルをPaaS提供者が配置した場合，ミドルウェア定義ファイル生成時にuCSDが上書きします。

csdmiundeploy（マスターイメージのアンデプロイ）

形式

csdmiundeploy [-c] {-i マスターイメージID|-n マスターイメージ名[.セクション]}

[-p ホストID] [-y]

機能

指定した業務システムの仮想ホストを削除します。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-c

デプロイ・アップデート・アンデプロイに失敗した仮想ホストを削除する場合に指定します。なお，仮想ホストの状態はcsdmilsコマンド（-i，-lオプション）で確認できます。

対象となる仮想ホストステータスは，”failed(deploy)”，”failed(undeploy)”，”failed(update)”です。

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-p

ホストIDを指定します。指定されたホストIDで識別されている仮想ホストだけを削除します

ホストID：<符号なし整数>1～999999の範囲

-y

実行時(y/n)の問い合わせを抑止します。y応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmiundeploy -c -n mi01
KFUD95013-Q 指定したマスターイメージの仮想ホスト削除処理を続行してもよいですか？(y/n)y
KFUD15055-I 業務システムの構築解放を受け付けました。マスターイメージID=3

注意事項

このコマンドは非同期で実行されるため，このコマンドの実行状態はcsdmilsコマンドで業務システムstatusを確認してください。業務システムstatusは，「表1-16　業務システムのStatus一覧」を参照してください。
また，このコマンドの完了状態を確認する場合は，メッセージログを参照してください。
メッセージログの詳細については，マニュアル「uCosminexus Service Director メッセージ」を参照してください。

＜メッセージログ例＞

マスターイメージに登録された仮想ホスト以外はcsdmiundeployコマンドでは削除できません。

csdmistopdeploy（デプロイ処理の中断）

形式

csdmistopdeploy {-i マスターイメージID|-n マスターイメージ名[.セクション]}

機能

csdmiupdate，csdmideploy，csdmiundeployコマンドの処理を中止します。処理を中止した場合は，処理の再開や処理を開始前の状態に戻すことができます。詳細は注意事項3.を参照してください。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmistopdeploy -n mi01
KFUD15057-I 業務システムの構築停止を受け付けました。マスターイメージID=3

注意事項

このコマンドは非同期で実行されるため，このコマンドの実行状態はcsdmilsコマンドで業務システムstatusを確認してください。業務システムstatusは，「表1-16　業務システムのStatus一覧」を参照してください。
また，このコマンドの完了状態を確認する場合は，メッセージログを参照してください。
メッセージログの詳細については，マニュアル「uCosminexus Service Director メッセージ」を参照してください。

＜メッセージ出力例＞

csdmistopdeployコマンドを実行した際に，構築中の仮想ホスト，セットアップ中のミドルウェア，削除中の仮想ホスト，アップデート中の仮想ホストが存在する場合は，実行途中の処理が終了してから，処理が中止されます。

csdmistopdeployコマンドで処理を中断した場合，次のコマンドを実行できます。

csdmideploy中止→csdmideployでデプロイ再開，csdmiundeployでデプロイ前の状態に戻します。

csdmiundeploy中止→csdmideployでデプロイ再開，csdmiundeployでデプロイ前の状態に戻します。

csdmiupdate中止→csdmiupdateで更新再開，csdmiundeployでデプロイ前の状態に戻します。

csdmivmstatus（仮想ホスト，ミドルウェアのステータス変更）

形式

csdmivmstatus {-i マスターイメージID|-n マスターイメージ名[.セクション]} -p ホストID -g 変更パターン

機能

指定したホストIDに対する業務システムのstatus，仮想ホストのstatus，ミドルウェアのstatusを変更します。業務システムのstatus，仮想ホストのstatus，ミドルウェアのstatusの詳細は「csdmils（マスターイメージの表示）」を参照してください。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-p

ホストIDを指定します。

ホストID：<符号なし整数>1～999999の範囲

-g

ステータスの変更パターンを指定します。

変更パターン：”vmdeployed”，”undeployed”，”alldeployed”のどれかを指定します。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmivmstatus -i 5 -p 1 -g alldeployed
KFUD15058-I 仮想ホストに対するステータス変更が完了しました。マスターイメージID=5，ホストID=1

csdmivmstatusを実行した後のcsdmilsの結果

注意事項

-g指定による変更パターンについて

(a) vmdeployed

仮想ホストが確保された状態に変更する場合に指定します。（ミドルウェアのセットアップ以降は行われていない状態）

次の条件を満たした場合に業務システムstatusを”deploying(pause)”に変更します。

・マスターイメージ配下の仮想ホストステータスがすべて”updated（OS更新（パッチ適用）を行う仮想ホストのステータス）”または”deployed（OS更新（パッチ適用）を行わない仮想ホストのステータス）”である。

(b) undeployed

仮想ホストが削除された状態に変更する場合に指定します（仮想ホストが配置されていない状態）。

業務システムstatusを”ready”に変更します。

(c) alldeployed

仮想ホストが確保されて，ミドルウェアのセットアップ，更新が完了している状態に変更する場合に指定します（csdmideployコマンドが正常に終了した状態）。

次の条件をすべて満たした場合に業務システムstatusを”deployed”に変更します。

マスターイメージ配下の仮想ホストステータスすべてが”updated（OS更新（パッチ適用）を行う仮想ホストのステータス）”または”deployed（OS更新（パッチ適用）を行わない仮想ホストのステータス）”である。

仮想ホストに対するミドルウェアステータスが”update（ミドルウェア更新（パッチ適用）を行うミドルウェアのステータス）”または”succeeded(setup)（ミドルウェア更新（パッチ適用）を行わないミドルウェアのステータス）”である。

-gオプションを指定したcsdmivmstatusコマンド実行後の仮想ホストステータス，ミドルウェアステータス，およびミドルセットアップUOCステータスを次に示します。

表1-37　-gオプションを指定したcsdmivmstatusコマンド実行後の仮想ホストステータス

-gオプションで指定した変更パターン | OS更新
する | しない
(a) vmdeployed | "updated" | "deployed"
(b) undeployed | "reserved"
(c) alldeployed | "updated" | "deployed"

表1-38　-gオプションを指定したcsdmivmstatusコマンド実行後のミドルウェアステータス

-gオプションで指定した変更パターン | ミドルウェア更新
する | しない
(a) vmdeployed | "notsetup"
(b) undeployed | "notsetup"
(c) alldeployed | "updated" | "succeeded(setup)"

表1-39　-gオプションを指定したcsdmivmstatusコマンド実行後のミドルセットアップUOCステータス

-gオプションで指定した変更パターン | csdmivmstatus実行前のミドルセットアップUOCステータス
"succeeded(deploy)" | "succeeded(deploy)"以外
(a) vmdeployed | "succeeded(deploy)" | "executable"
(b) undeployed | "executable"
(c) alldeployed | "succeeded(deploy)"

csdmivmstatusコマンド実行時の動作について
csdmivmstatusコマンドを実行することで業務システムstatusを”deploying(pause)”，“ready”，”deployed”に変更できますが，csdmivmstatusコマンドを実行してもデプロイ処理，アンデプロイ処理は動作しません。
csdmideployコマンドなどで失敗した際，JP1/ITRM(またはvCenter)を直接操作して状態を元に戻すとcsdmideployまたはcsdmiundeployコマンドによって業務システムstatusを変更する契機がなくなるため，代わりにcsdmivmstatusコマンドで業務システムstatusを変更することができます。

csdmisetpassword（仮想ホストのパスワード設定）

形式

csdmisetpassword {-i マスターイメージID|-n マスターイメージ名[.セクション]} {[-p ホストID] -w 仮想ホストパスワード -k パスワードアクセスキー | -f [-y]}

機能

PaaS提供者またはPaaS利用者が変更した仮想ホストのパスワードをuCSDに登録するコマンドです。

パスワード登録済みの状態で，再度このコマンドを実行した場合は登録済みのパスワードに対して上書き登録します。

このコマンドで仮想ホストのパスワードを変更することはできません。

このコマンドを実行可能な業務システムのstatusについては，「表1-5　業務システムのStatusと実行可能な運用コマンドの関係(1/2)」，および「表1-6　業務システムのStatusと実行可能な運用コマンドの関係(2/2)」を参照してください。

実行可能ユーザ

PaaS提供者，PaaS利用者が実行できます。

オプション

-i

マスターイメージIDを指定します。

マスターイメージID：<符号なし整数>1～99999999の範囲

-n

マスターイメージ名を指定します。セクションを定義している場合には同時に指定してください。

マスターイメージ名：～<英数字記号>1～32文字

セクション：～<英数字記号>1～32文字

-p

ホストIDを指定します。

ホストID：<符号なし整数>1～999999の範囲

-w

-pで指定した仮想ホストのパスワードを指定します。

仮想ホストパスワード：～<英数字, ->1～255文字

設定済みの状態で再度指定した場合，新しい値で上書きします。

-k

仮想ホストパスワードを暗号化するためのパスワードアクセスキーを指定します。

同一業務システム内では同一の値を指定してください。

パスワードアクセスキー：<英数字, #-@()>1～255文字

設定済みの状態で再度指定した場合，新しい値で上書きします。

-f

暗号化パスワードを削除し，コンポーネントテンプレートに記載されている初期パスワードを設定します。

-y

実行時 (y/n)の問い合わせを抑止します。y応答したときと同じ動きになります。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdmisetpassword -i 5 -w adminpassword -k accesskey
KFUD15052-I 仮想ホストパスワードを設定しました。

注意事項

なし

csdsetaccount（アカウント情報の登録）

形式

csdsetaccount -vcosmi -u ユーザID -w パスワード

機能

Cosminexus のセットアップを行うために，仮想サーバマネージャ管理者のアカウント情報を登録します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

-vcosmi

このコマンドを実行する場合は必ず指定します。

Cosminexusのセットアップおよび仮想サーバマネージャ管理者のアカウント情報を登録する場合に指定します。

-u

仮想サーバマネージャ管理者のユーザIDを指定します。

ユーザID：</,¥を含まない文字列>

仮想サーバマネージャに設定したユーザIDと同じものを指定してください。

-w

仮想サーバマネージャ管理者のパスワードを指定します。

パスワード：</,¥を含まない文字列>

仮想サーバマネージャに設定したパスワードと同じものを指定してください。

設定済みの状態で再度指定した場合，新しい値で上書きします。

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdsetaccount -vcosmi -u admin -w admin
KFUD15053-I 仮想サーバマネージャ管理者アカウントを設定しました。

注意事項

アカウント登録済みの状態で，再度このオプションで登録した場合は登録済みのアカウントに対して上書き登録します。仮想サーバマネージャ上では仮想サーバマネージャのパスワードを省略できますが，uCSDとしてはcsdsetaccountコマンド実行時のパラメータとしてパスワードを必須入力とします。

csdinfoget（トラブルシュート情報の収集）

形式

csdinfoget

機能

uCSDを構成するPPのトラブルシュート情報を収集します。

実行可能ユーザ

PaaS提供者が実行できます。

オプション

なし

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csdinfoget

注意事項

このコマンドは，トラブルシュートに必要な情報である，uCSDの定義ファイルおよびログファイルを収集し，zip形式で出力します。出力先は，このコマンド実行時のカレントディレクトリで，
出力ファイル名はcsdinfoget.zipになります。

出力先ディレクトリにこのコマンドが実行中に作成する一時ディレクトリ（csdinfoget_work）または出力ファイル（csdinfoget.zip）と同名のファイル／ディレクトリが存在すると，このコマンドは異常終了します。その場合，そのファイル／ディレクトリを手動で削除する必要があります。

このコマンドが正常終了した場合は，画面にメッセージは出力されません。

「Ctrl+C」キーを押してこのコマンド実行を中断した場合，不完全なファイルや一時ディレクトリがこのコマンド実行時に指定したディレクトリ下に作成されている可能性があるので，当該ファイル／ディレクトリを削除してください。

このコマンドは，一度もセットアップが完了していない状態では実行できません。また，アンセットアップ後の状態では実行しないでください。実行しても，トラブルシュート情報を取得することはできません。

このコマンドをコマンドプロンプトでダブルクォーテーションが必要な特殊文字「&()[]{}^=;!'+,`~@」をフルパスに含むカレントディレクトリで実行しないでください。実行した場合，コマンドはRAS情報の採取に失敗します。このとき戻り値は不定となります。また，特殊文字をフルパスに含むカレントディレクトリでコマンドを実行した場合，csdinfoget_workディレクトリが，カレントディレクトリではないディレクトリ配下に作成され，コマンド実行後も残ることがありますので，csdinfoget_workディレクトリをエクスプローラなどで探し出し，削除してください。

このコマンドの引数に，コマンドプロンプトでダブルクォーテーションが必要な特殊文字「&()[]{}^=;!'+,`~<>@| (半角スペース)」，および全角スペースを含む文字列を指定すると，コマンドプロンプトの構文エラーメッセージが出力され，コマンドが終了することがあります。このとき戻り値は不定となります。

csddbcopy（データベースのバックアップ）

形式

csddbcopy“バックアップファイル名“

機能

uCSDで使用するデータベースのバックアップファイルを出力します。

実行可能ユーザ

PaaS提供者が実行できます。

コマンド引数

バックアップファイル名：～<絶対パス名>

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csddbcopy "C:¥Users¥Administrator¥Desktop¥db¥CSDBK01"
KFUD90400-I The csddbcopy command ended.

注意事項

このコマンドにおいて指定するバックアップファイル名はダブルクォーテーションで囲む必要があります。

このコマンドにおいて指定するバックアップファイルの出力先ディレクトリが存在しない場合コマンドはエラーで終了します。あらかじめバックファイルを出力するディレクトリを作成の上，実行してください。

このコマンドにおいて指定するバックアップファイルがすでにある場合にこのコマンドを実行すると，出力されるバックアップファイルで，既存のバックアップファイルが上書きされます。

このコマンドはuCSDの他コマンド実行中に実行しないでください。
また，このコマンド実行中にこのコマンドを含む他コマンドは実行しないでください。

このコマンドは，一度もセットアップを実施したことがない状態では実行できません。また，アンセットアップ後の状態では実行しないでください。実行した場合，コマンドが異常終了します。

「Ctrl+C」キーを押してこのコマンド実行を中断した場合，不完全なバックアップファイルがこのコマンド実行時に指定したディレクトリ下に作成されている可能性があるので，当該ファイルを削除の上，uCosminexus Service Director - Manager DB Serviceを再起動してください。

バックアップファイル名に，コマンドプロンプトでダブルクォーテーションが必要な特殊文字「&()[]{}^=;!'+,`~<>@|」を含む文字列を指定すると，コマンドプロンプトの構文エラーメッセージが出力され，コマンドが終了することがあります。このとき，戻り値は不定となります。また，バックアップファイル名以外に不正にコマンド引数を指定した場合，不正なコマンド引数に全角スペース，半角スペースを含む特殊文字が含まれる文字列を指定すると，コマンドプロンプトの構文エラーメッセージが出力され，コマンドが終了することがあります。このとき，戻り値は不定となります。

csddbrstr（データベースのリストア）

形式

csddbrstr “バックアップファイル名“

機能

uCSDのデータベースバックアップファイルから，uCSDのデータベースをリストアします。

実行可能ユーザ

PaaS提供者が実行できます。

コマンド引数

バックアップファイル名：～<絶対パス名>

戻り値

値 | 意味
0 | 正常終了しました。
0以外 | 異常終了しました。

実行例

C:¥Program Files¥Hitachi¥uCSD¥mgr¥bin>csddbrstr "C:¥Users¥Administrator¥Desktop¥db¥CSDBK01"
KFUD90400-I The csddbrstr command ended.

注意事項

このコマンドにおいて指定するバックアップファイル名はダブルクォーテーションで囲む必要があります。

このコマンドはuCSDの他コマンド実行中に実行しないでください。
また，このコマンド実行中にこのコマンドを含む他コマンドは実行しないでください。

このコマンドは，一度もセットアップを実施したことがない状態では実行できません。また，アンセットアップ後の状態では実行しないでください。実行した場合，コマンドが異常終了します。

「Ctrl+C」キーを押してこのコマンド実行を中断しないでください。データベース領域が壊れるおそれがあります。何らかの要因でこのコマンド実行が中断した場合は，uCSDをアンセットアップ後に再セットアップし，再度このコマンドを実行してデータベースを回復させてください。

異なるマシン環境で取得したバックアップファイルを別のマシン環境にリストアする場合，バックアップ取得元の作成パスとリストア先の実データベース作成パスは一致させてください。

バックアップファイル名に，コマンドプロンプトでダブルクォーテーションが必要な特殊文字「&()[]{}^=;!'+,`~<>@|」を含む文字列を指定すると，コマンドプロンプトの構文エラーメッセージが出力され，コマンドが終了することがあります。このとき，戻り値は不定となります。また，バックアップファイル名以外に不正にコマンド引数を指定した場合，不正なコマンド引数に全角スペース，半角スペースを含む特殊文字が含まれる文字列を指定すると，コマンドプロンプトの構文エラーメッセージが出力され，コマンドが終了することがあります。このとき，戻り値は不定となります。

このコマンドは，データベースのバックアップを取得した時点でのuCSDのバージョンと同じバージョンの場合にだけ実行できます。
バックアップを取得した時点とバージョンが異なる場合は，一度uCSDをバックアップを取得したバージョンに戻し，データベースをリストアした後，使用するバージョンのuCSDを上書きインストールしてください。

csdinstlin（ミドルウェアインストール）

形式

csdinstlin -k 形名 -s セットアッププログラム格納ディレクトリ

機能

インストール済みのミドルウェアに対して，インストール形式の修正版を適用します。

csdmideployコマンド，またはcsdmiupdateコマンドから実行されるミドルウェア更新パッチの仕組みを使用して※，インストール形式の修正版を適用します。

注※　マスターイメージ定義ファイルの「Parameter(patch)」タグに記載したパッチスクリプトからこのコマンドを実行します。

対象OS

Red Hat Enterprise Linux

対象ミドルウェア

uCosminexus Application Server

HiRDB Server

オプション

-k

インストールするミドルウェアの形名を指定します。

形名：<英数字記号> 1～25文字

例：P-9W43-7K91

-s

セットアッププログラム格納ディレクトリを指定します。日立PPインストーラのセットアッププログラム（setup）が格納されているディレクトリをマスターイメージ定義ファイルの「Parameter(patch)」タグに記載したパッチ・ディレクトリに指定したディレクトリからの相対パスで指定します。

セットアッププログラム格納ディレクトリ：<相対パス名> 1～247文字

戻り値

値 | 意味
0 | 正常終了しました。
1 | 異常終了しました。（日立PPインストーラ内でエラーが発生した場合）
2 | 異常終了しました。（日立PPインストーラ外でエラーが発生した場合）

注意事項

このコマンドは必ずユーザスクリプト内から実行してください。ユーザスクリプト以外で実行した場合の動作は保証しません。

相対パス名に環境変数を使用しないでください。使用した場合の動作は保証しません。

このコマンドを「&（アンパサンド）」などを利用して，同時に複数実行しないでください。同時に複数実行した場合の動作は保証しません。

2.　uCosminexus Service Directorで使用するファイル

この章では，uCSDで使用するファイルについて説明します。

＜この章の構成＞

2.1　定義ファイルの項目

2.2　uCSDのシステム定義

2.3　テンプレート操作で使用するファイル

2.4　マスターイメージ操作で使用するファイル

2.1　定義ファイルの項目

ここではそれぞれのファイルについての詳細を説明します。

各ファイルで説明する項目は次のとおりです。ただし，ファイルによっては説明しない項目もあります。

形式
定義ファイルの形式について説明しています。

ファイル名
定義ファイルのファイル名について説明しています。

格納先ディレクトリ
定義ファイルの格納場所について説明しています。

説明
定義ファイルの用途について説明しています。

指定項目
定義ファイルで指定できる項目について説明しています。

記述例
定義ファイルの記述例について説明しています。

＜この節の構成＞

2.1.1　構文要素

2.1.1　構文要素

ユーザ指定値で使用できる文字・記号一覧を次に示します。

＜この項の構成＞

(1)　記号

(1)　記号

コマンドの機能およびユーザ指定値の範囲の説明で使用する記号について説明します。各記号の意味を次の表に示します。

表2-1　記号の説明

記号
意味

|
この記号で囲まれた項目は選択できることを示します。
(例)disk=A|B
AまたはBを指定できることを示します。

{ }
この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目と項目の区切りは「|」で示します。
(例) {A|B|C}
AとBとCのどれかを指定することを示します。

[ ]
この記号で囲まれている項目は省略してもよいことを示します。

…
この記号の直前に示された項目を繰り返し複数個指定できることを示します。

<<　>>
ユーザ指定値の省略値を示します。

<　>
ユーザ指定値の構文要素記号を示します。

表2-2　コマンド形式の構文要素

構文要素
意味

英字
半角アルファベット（A ～ Z，a ～ z）

英字記号
英字，半角記号（#，-， @，(，)， _）

英数字
英字と半角数字（0 ～ 9）

英数字記号
英字記号と半角数字（0 ～ 9）

符号なし整数
半角数字（0 ～ 9）

文字列
任意の文字の配列

ドライブ
英字1文字＋:（半角コロン）1文字（例C:）

相対パス名

次の要素で構成される文字列

英数字

_（半角下線）

.（半角ピリオド）

△（半角空白）

( （半角左括弧）

) （半角右括弧）

パス区切りの¥（半角円記号）

ネットワークドライブ，UNC形式の指定はできません。
次に示すWindows，およびMS-DOSの予約語をディレクトリ名，ファイル名に含むことはできません。
CON, PRN, AUX, CLOCK$, NUL,
COM0, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9,
LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9

絶対パス名

ドライブで始まり，次の要素で構成される文字列

英数字

_（半角下線）

.（半角ピリオド）

△（半角空白）

( （半角左括弧）

) （半角右括弧）

パス区切りの¥（半角円記号）

ドライブだけの指定はできません。
ネットワークドライブ，UNC形式の指定はできません。
次に示すWindows，およびMS-DOSの予約語をディレクトリ名，ファイル名に含むことはできません。
CON, PRN, AUX, CLOCK$, NUL,
COM0, COM1, COM2, COM3,COM4, COM5, COM6,COM7, COM8, COM9,
LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7,LPT8, LPT9
パスには1つまたは複数のピリオド・スペースで終端するディレクトリを含めてはいけません。

パス名
相対パス名と絶対パス名（1～247文字）

ポート番号
指定可能な値は，半角数字で1～65535の範囲
注意：

1～1023のwell-knownポート，および，49152～65535の既定の動的ポートは割り当てないようにしてください。

すでにほかのアプリケーションで使用されているポート番号は割り当てないようにしてください。

注意事項

XMLファイルを作成する場合は次のことに注意してください。

XMLを使用する場合はXML1.0形式で記述します。記述形式の仕様については，W3CによるXMLの仕様書（Extensible Markup Language (XML) 1.0）を参照してください。

XMLで記述するファイルの中で特殊文字（記号）を使用する場合は，サニタイジング（特殊文字の無効化）が必要です。次の表に示す対応表に従って，特殊文字を置換して記述してください。

サニタイジングが必要な特殊文字 | 置換後の文字
< | &lt;
> | &gt;
& | &amp;
" | &quot;
' | &apos;または&#39;

2.2　uCSDのシステム定義

uCSDシステム定義は次の図のようなファイル構成になっています。

図2-1　uCSDシステム定義の構成

次の表に各システム定義のファイル概要を説明します。

表2-3　システム定義のファイル概要

項番 | ファイルの種類 | 概要
1 | セットアップ定義ファイル | uCSDセットアップコマンド実行時に必要となる項目の設定値を定義します。
2 | システム定義ファイル | uCSDの実行に必要な定義パラメータを設定します。
3 | IPアドレス設定ファイル | uCSDとしてリソース予約を行う際，割り当て可能なIPアドレスを指定します。
4 | 物理構成定義ファイル | uCSDとしてリソース予約を行う際に割り当て可能である物理構成を定義します。
5 | 物理容量定義ファイル | 仮想ホスト配備先ディスク容量を定義します。
6 | 負荷分散機接続設定プロパティファイル | 負荷分散機へのアクセスに必要な接続情報を設定します。
7 | リソース制約定義ファイル | PaaS提供者が，PaaS利用者の使用できるリソースを制限するために，リソース制約管理機能を提供します。

＜この節の構成＞

2.2.1　セットアップ定義ファイル

2.2.2　システム定義ファイル

2.2.3　IPアドレス設定ファイル

2.2.4　物理構成定義ファイル

2.2.5　物理容量定義ファイル

2.2.6　負荷分散機接続設定プロパティファイル

2.2.7　リソース制約定義ファイル

2.2.1　セットアップ定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

セットアップ定義ファイルは次のようなプロパティ形式で記述します。

<Key>=<Value>：KeyとValueをイコール(=)で対応付ける方法

指定する文字列内に円記号(¥)が含まれる場合は¥¥と定義してください。ただし，文字数を数えるときは，¥¥で一文字と数えます。

一行に一定義を記述してください。

パスを指定する場合はダブルクォーテーション(“)で囲まないでください。

シャープ(#)で始まる行はコメントとなります。

空白行は無視されます。

キーの設定を省略した場合はあらかじめ設定された値が反映されます。

パスを定義する場合は絶対パスで指定してください。

コメント以外に，△（半角空白），パス区切りの¥（半角円マーク），:（半角コロン）以外の文字を記述すると，csdsetupコマンドやuCSDの起動がエラーになることがあります。

行末に空白やコメントは記述できません。

1行は1023文字以内で記述してください。

(2)　ファイル名

csdsetup.properties

(3)　格納先ディレクトリ

＜uCSDインストールディレクトリ＞¥mgr¥conf

(4)　説明

セットアップ定義ファイルは，uCSDのセットアップコマンド実行時に使用する，uCSDやuCSDを構成するプログラムの設定値を定義するファイルです。セットアップコマンド実行時，格納先ディレクトリにファイルが存在しない場合，セットアップコマンドがファイルを作成し，デフォルトの設定値でセットアップを行います。同じ定義が重複した場合，後に定義した値が優先されます。セットアップ定義ファイルはcsdsetupコマンド実行時に定義値が有効になります。

(5)　指定項目

次の表にセットアップ定義ファイルで指定できる定義を示します。

表2-4　セットアップ定義ファイルで指定できる定義一覧

項番
プロパティ名
説明
デフォルト値
指定できる値

1
csd_port
uCSDが利用するポート番号を設定します。この情報はHTTPリクエストを発行する際に利用します。
28200
1～65535

2
csd_connector_port
uCSDがコマンド受付に使用する通信用ポート番号を設定します。
28201
1～65535

3
db_port
uCSDが使用するデータベースとの通信用ポート番号を設定します。
28202
5001～65535

4
db_area_path
uCSDが管理するデータを格納するディレクトリの絶対パスを指定します。上書きセットアップの際は，指定値を変更しないようにしてください。エラーメッセージが出力され終了します。
<uCSDインストールディレクトリ>¥¥mgr¥¥system¥¥hdb¥¥dbarea
文字列※
3～130文字(存在するディレクトリ)

5
ejbserver_http_port
uCSDが製品内部との通信用のポート番号を設定します。
28203
1～65535

6
ejbserver_rmi_naming_port
内部処理用のポート番号を設定します。
28204
1～65535

7
csd_receive_timeout
運用コマンドが，uCSDからのレスポンスを待つ時間（秒）を設定します。
60
60～3600

注※　文字列における指定可能文字は，ASCII文字の範囲です。

(6)　記述例

次にセットアップ定義ファイルの記述例を示します。

csd_port=28200
csd_connector_port=28201
db_port=28202
db_area_path=C:¥¥Program Files¥¥Hitachi¥¥uCSD¥¥mgr¥¥system¥¥hdb¥¥dbarea
ejbserver_http_port=28203
ejbserver_rmi_naming_port=28204
csd_receive_timeout=60

注　パス区切り文字は”¥¥”と記載

次の図にuCSDで使用する通信ポートについて説明します。

表番号と項番は「表2-4　セットアップ定義ファイルで指定できる定義一覧」，および「表2-5　システム定義ファイルで指定できるキー」の項番と対応しているため，その値を設定します。

図2-2　通信ポート番号一欄

2.2.2　システム定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　タイマ，リトライ定義の説明

(7)　記述例

(8)　注意事項

(1)　形式

システム定義ファイルはプロパティ形式で記述します。

<Key>=<Value>：KeyとValueをイコール(=)で対応付ける方法

指定する文字列内に円記号(¥)が含まれる場合は¥¥と定義してください。ただし，文字数をカウントするときは，¥¥で一文字と数えます。

一行に一定義を記述してください。

パスを指定する場合はダブルクォーテーション(“)で囲む必要はありません。

シャープ(#)で始まる行はコメントとなります。

空白行は無視されます。

キーの設定を省略した場合はあらかじめ設定された値が反映されます。

パスを定義する場合は絶対パスで指定してください。

コメント以外の全角文字はエラーとなります。

行末に空白やコメントは記述できません。

(2)　ファイル名

csd.properties

(3)　格納先ディレクトリ

＜uCSDインストールディレクトリ＞¥mgr¥conf

(4)　説明

システム定義ファイルは，uCSDの実行に必要な定義パラメータを記述する定義ファイルです。必須ファイルですので必ず格納先ディレクトリにシステム定義ファイルを用意してください。ファイル名，格納先ディレクトリが正しければ，空ファイルを用意しても動作します。その場合，すべての定義がデフォルト値で動作します。設定できる定義については「表2-5　システム定義ファイルで指定できるキー」を参照してください。

システム定義ファイルで定義された値はuCosminexus Service Director - Manager 起動時に反映されます。

(5)　指定項目

次の表にシステム定義ファイルで指定できるキーについて説明します。

表2-5　システム定義ファイルで指定できるキー

項番
プロパティ名
説明
デフォルト値
指定できる値

1
userdata.filepath
テンプレート・マスターイメージ・一時ファイルなどのデータを保存するディレクトリの絶対パスを指定します。
<uCSDインストール先ディレクトリ>
¥¥mgr¥¥data
文字列※1
1～50文字（存在するディレクトリ）

2
log.access.numoffiles
アクセスログのファイル面数を指定します。
2
1～16

3
log.access.filesize
アクセスログの1ファイル当たりのファイルサイズを指定します。(Bytes)
10485760​
1048576​～16777216​

4
log.message.numoffiles
メッセージログのファイル面数を指定します。
2
1～16

5
log.message.filesize
メッセージログの1ファイル当たりのファイルサイズを指定します。(Bytes)
10485760​
1048576​～16777216​

6
log.cmdtrc.numoffiles
コマンドトレースログのファイル面数を指定します。
2
1～16

7
log.cmdtrc.filesize
コマンドトレースログの1ファイル当たりのファイルサイズを指定します。(Bytes)
10485760​
1048576​～16777216​

8
authentication.usergroup
PaaS利用者が所属するグループ名を指定します。
－
文字列※1，※2
1～256文字　以下の文字を除く" / ¥ [ ] : ; | = , + * ? < > @

9
process.log.message.numoffiles
プロセス制御用メッセージログのファイル面数を指定します。
3
2～10

10
process.log.message.filesize
プロセス制御用メッセージログの1ファイル当たりのサイズを指定します。(Bytes)
1048576​
1048576​～16777216​

11
deploy.cmdtimer
仮想ホスト確保，解放の実行終了の監視タイマの値を指定します。(分)
240
0～5000

12
deploy.vmconnretry
仮想ホストへリモート再接続回数を指定します。(回)
10
0～600

13
deploy.sshexcutetimer
仮想ホストのミドルウェアセットアップ，仮想ホストのアップデート実行終了の監視タイマの値を指定します。(分)
240
0～5000

14
deploy.cosmimgrtimer
仮想サーバマネージャ連携処理での仮想サーバマネージャの応答監視時間を指定します。(分)
240
0～5000

15
deploy.ssh.port
仮想ホスト接続用に使用するSSH通信ポート番号を指定します。※3
22
1～65535

16
deploy.manageserver.port
仮想サーバマネージャのポート番号を指定します。
28080
1～65535

17
deploy.remote.tmppath
仮想サーバ（OS：Linux）へファイルを転送する場合に一時格納用に使用するディレクトリパスを指定します。転送するファイルおよび一時格納用ディレクトリ構成の詳細は，「csdmideploy（マスターイメージのデプロイ）」を参照してください。
/tmp/
文字列※1
1～232文字（先頭が”/”で始まり，空白を含まない）

18
deploy.remote.tmppath.win
仮想サーバ（OS：Windows）へファイルを転送する場合に一時格納用に使用するディレクトリパスを指定します。転送するファイルおよび一時格納用ディレクトリ構成の詳細は，「csdmideploy（マスターイメージのデプロイ）」を参照してください。
%SystemRoot%¥¥Temp¥¥
文字列
1～50文字　以下のどれかの形式でだけ指定可能
(a)”＜ドライブ名を表す半角英字＞：¥¥”から始まるパス
(b)”%＜環境変数名＞%”から始まるパス（パスの先頭以外に環境変数を使用できません）
環境変数として使用可能なものは以下だけ（大文字小文字区別しない）
%systemdrive%，%systemroot%，%tmp%，%temp%

19
deploy.vcosmi.connretry
仮想サーバ上で起動するサーバ通信エージェントへの再接続回数を指定します。(回)
120
0～600

20
uoc.path.middlesetup
ミドルセットアップUOCのjarファイルのパスをフルパスで指定します。
60
英数字
_（半角下線）
.（半角ピリオド）
△（半角空白）
( （半角左括弧）
) （半角右括弧）
パス区切りの¥（半角円マーク）
232字以内
その他OSのパスの仕様に従う

21
uoc.path.middlesetup.class
ミドルセットアップUOCのクラス名（パッケージ名を含む）を指定します。
なし
英数字，ピリオド（.），ドル記号（$）およびアンダースコア（_）
ただし，パッケージ名およびクラス名の先頭は英数字
1～1024文字

22
uoc.timer.middlesetup
ミドルセットアップUOC用のタイマを指定します。
60
1～3600

23
uoc.timer.lock
UOCで使用する，ファイル転送およびリモート実行機能を提供するインタフェースの排他制御で，ロック獲得できるまでのタイムアウト時間を指定します。ここで指定した時間を経過してもロックが獲得できなかった場合は例外が発生します。
900
1～3600

24
userdata.delete.interval
uCSDの起動時に，一時ファイルを保存する期間を指定します。(分)
10080
1～144000

25
resource.virtualnetworkdevicename.duplicate
物理構成定義ファイルで，仮想ネットワークデバイス名の重複を許可するかを指定します。
vSphere Distributed Switchを使用し，物理ホストに同名の分散仮想スイッチを複数指定する場合はyを指定してください。
n
yまたはn（大文字小文字区別しない）

26
resource.permission.admin
csdrscstatusコマンドによって操作対象外とされている物理ホストに対し，PaaS提供者からの操作を受け付けるかどうかを指定します。
n
yまたはn（大文字小文字区別しない）

27
resource.vmotion.use
vMotion対応機能を使用するかを指定します。
yを指定した場合はcsdrscupdateコマンドで仮想ホストのマイグレーションを検出します。また，物理構成情報の更新でリソース残量が負になった場合に，警告メッセージ（KFUD24728-W）を出力して更新を続行します。
n
yまたはn（大文字小文字区別しない）

28
send.all.filesize
コマンドに指定するファイルおよびディレクトリの合計サイズの上限を指定します。(KB)※4
ただし，csddbrstrコマンドに指定するバックアップファイルは，プロパティの指定値に関わらず，サイズのチェックを行いません。
102400
1～2097152​

注※1

文字列における指定可能文字は，ASCII文字の範囲です。

注※2

authentication.usergroupで指定するグループ名は大文字・小文字が区別され，それぞれ別グループとして扱われます。

注※3

仮想ホストのOSがLinuxの場合に使用します。

仮想ホストのOSがWindowsの場合，DCOM通信用のポート番号として，139を固定で使用します。

注※4

send.all.filesizeプロパティの指定値を大きくする場合の注意事項を次に示します。

サイズの大きいファイルを指定するとコマンドの通信時間が長くなる場合があります。
セットアップ定義ファイル(csdsetup.properties)のcsd_receive_timeoutプロパティに指定した通信タイムアウト値を見直し，値が小さい場合は大きくしてセットアップを行ってください。

csdtmpregisterコマンド，csdtmpupdateコマンドの-fオプションに指定するファイルはsend.all.filesizeプロパティの指定とは別に最大1MBの制限があります。

JP1/AO連携機能を使用する場合，JP1/AOから入力プロパティで指定するファイルはsend.all.filesizeプロパティの指定とは別に最大100MBの制限があります。また，各種ダウンロードボタンで取得するファイルのサイズ(付属ファイル，エクスポートの場合は全ファイルの合計サイズ）も最大100MBの制限があります。

コマンドに指定するファイルおよびディレクトリは，send.all.filesizeプロパティの指定とは別に全ファイルを2,147,483,647バイト以内のzipファイルにアーカイブできる必要があります。

(6)　タイマ，リトライ定義の説明

システム定義に存在するタイマ，リトライ定義がどのように使用されるか次の図で説明します。

同期コマンド，非同期コマンド（csdmideploy，csdmiundeploy，csdmiupdate）について説明します。

表番号と項番は「表2-4　セットアップ定義ファイルで指定できる定義一覧」，および「表2-5　システム定義ファイルで指定できるキー」の項番と対応しているため，その値を設定します。各タイマ値，リトライ値の詳細は対応した定義の説明を参照してください。

JP1/ITRMや仮想サーバマネージャに関する用語は各製品のマニュアルを参照してください。

図2-3　同期コマンド

図2-4　csdmideploy

図2-5　csdmiundeploy

図2-6　csdmiupdate

csdmiupdateコマンド処理のSSHの接続・切断は，コマンドを実行するユーザが作成したパッチスクリプト単位で行われます。

バッチスクリプトを2つ用意しcsdmiupdateコマンドを実行すると，次のように処理します。また，この時A，Bそれぞれ「表2-5　システム定義ファイルで指定できるキー」の項番13のタイムアウト定義で監視します。

(7)　記述例

次にシステム定義ファイルの記述例を示します。

システム定義ファイルの記述例

userdata.filepath=C:¥¥Program Files¥¥Hitachi¥¥uCSD¥¥mgr¥¥data
log.access.numoffiles=2
log.access.filesize=10485760​
log.message.numoffiles=2

(8)　注意事項

システム定義ファイルを編集する場合は，uCSDのサービス，および，コマンドを停止してください。

XXX.numoffilesを設定し，ファイル面数を変更する場合は<uCSDインストールディレクトリ>¥mgr¥log¥mmapを削除し，変更前のログファイルを任意のディレクトリに退避，または削除してください。

XXX.filesizeを設定し，ログファイルサイズを変更する場合は<uCSDインストールディレクトリ>¥mgr¥log¥mmapを削除し，変更前のログファイルを任意のディレクトリに退避，または削除してください。

ディレクトリの末尾に¥¥が指定されていない場合，uCSDは¥¥を付けて処理を行うため，定義できる文字数の制限は1文字少なくなります。

2.2.3　IPアドレス設定ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

IPアドレス設定ファイルはcsvファイル形式で記述されます。

(2)　ファイル名

ipaddress.csv

(3)　格納先ディレクトリ

<uCSDインストールディレクトリ>¥mgr¥conf

(4)　説明

uCSDのリソース予約時に割り当てるIPアドレスは，IPアドレス設定ファイルに書かれたIPアドレスを使用します。IPアドレス設定ファイルは，uCSDとしてリソース予約を行う際，割り当て可能なIPアドレスを定義する定義ファイルです。IPアドレス設定ファイルは必ず用意してください。uCSDが仮想ホストに割り当てるIPアドレスはあらかじめIPアドレス設定ファイルに記載しておく必要があります。なお，IPアドレス設定ファイルに指定できるIPアドレス数は，最大65535個です。

IPアドレス設定ファイルの記述された内容が反映されるタイミングは，uCSD起動時，およびcsdrscupdateコマンド実行時です。

(5)　指定項目

IPアドレス定義ファイルで指定できる値について説明します。

IPアドレス定義ファイルの記述形式は，「IPアドレス単独指定」と「IPアドレス範囲指定」があります。

IPアドレス単独指定

IPアドレス，IPアドレス種別，[IPアドレスグループ番号]，サブネットマスク，
[デフォルトゲートウェイ]

IPアドレス範囲指定

指定開始IPアドレス-指定終了IPアドレス，IPアドレス種別，
[IPアドレスグループ番号]，サブネットマスク，[デフォルトゲートウェイ]

各項目の説明を次の表に示します。

表2-6　IPアドレス設定ファイルで指定できるキー

項番
項目名
説明
指定範囲
省略時の動作

1
IPアドレス
仮想ホストの仮想NICに割り当てるIPアドレスを記載します。
IPv4形式
省略不可

2
IPアドレス種別
M(管理用IPアドレス)，B(業務用IPアドレス)のどちらかを指定します。
最低1つはMを指定してください。Bの指定は任意であり省略が可能です。
{M|B}
省略不可

3
IPアドレスグループ番号
uCSD内のグループ番号です。IPアドレスグループ番号を指定することによってuCSD内で複数のIPアドレスを任意のグループにまとめることができます。
0～2147483647​の整数値
省略時はIPアドレスグループ番号を0として扱います。

4
サブネットマスク
仮想ホストの仮想NICに割り当てるサブネットマスクを指定します。
IPv4形式
省略不可

5
デフォルトゲートウェイ
仮想ホストの仮想NICに割り当てるデフォルトゲートウェイを指定します。
IPv4形式
省略時は仮想NICに対してデフォルトゲートウェイを設定しません。空文字列""を使用します。

(6)　記述例

次にIPアドレス設定ファイルの記述例を示します。

IPアドレスの設定ファイル設定例

2.1.1.100-2.1.1.150,B,1,255.255.255.0,2.1.1.1
1.1.1.100-1.1.1.150,M,2,255.255.255.0,

2.2.4　物理構成定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

物理構成定義ファイルはXMLファイル形式で記述されます。

(2)　ファイル名

physical_configuration.xml

(3)　格納先ディレクトリ

<uCSDインストールディレクトリ>¥mgr¥conf

(4)　説明

物理構成定義ファイルは物理ホストグループ，物理ホスト，その他のリソースの関係を表したXML形式のファイルであり，PaaS提供者が記述します。物理構成定義ファイル内容が反映されるタイミングはuCSD起動時，および，csdrscupdateコマンド実行時です。物理構成定義ファイルは必須ファイルですので存在しない場合やフォーマットが正しくない場合はエラーが出力されます。

(5)　指定項目

物理構成定義ファイルで指定できる項目について示します。

次の表にXMLファイルの要素ごとの文法を説明します。

表2-7　物理構成定義ファイルのXMLファイル要素の文法

項番
タグ名
属性
出現回数
説明
形式

1
cx_resouces_doc
－
1
－
－

2
xmlns
1
“http://www.hitachi.co.jp/soft/xml/csd/resource/physicalconfiguration”
を指定してください。
－

3

cx_physicalhostgroup
－
1以上
物理ホストグループが持つパラメータを指定します。
－

4
cx_name
1
物理ホストグループ名を指定します。
“/”，“¥”を含まない文字列※1
1～64バイト

5

cx_physicalhost
－
1以上
物理ホストが持つパラメータを指定します。
－

6
cx_name
1
物理ホスト名を指定します。
文字列※1
1～256バイト

7
cx_ip
1
物理ホストのIPアドレスを指定します。
IPv4形式

8

cx_VMware（ハイパーバイザ種別がVMwareの場合）※2
－
0-1
－
－

9
cx_resourcepool
0-1
リソースプール名を指定します。
文字列※1
1～256バイト

10
cx_CPUclock
0-1
リソースプールに割り当てられたCPUクロック数を指定します。
1～1022976​の整数[MHz]，または0※3

11
cx_memory
0-1
リソースプールに割り当てられたメモリ容量を指定します。
256～1022976​の整数[MB]，または0※3

12
cx_datastore
0-1※5
データストア名を指定します。物理容量定義ファイルに記載してあるものから指定する必要があります。
文字列※1
1～256バイト

13

cx_resourcepool
－
0以上
－
－

14
cx_name
1
リソースプール名を指定します。※8
文字列※1
1～256バイト

15
cx_CPUclock
1
リソースプールに割り当てられたCPUクロック数を指定します。
1～1022976​の整数[MHz]，または0※3

16
cx_memory
1
リソースプールに割り当てられたメモリ容量を指定します。
256～1022976​の整数[MB]，または0※3

17
cx_datastore
－
0以上
－
－

18
cx_name
1
データストア名を指定します。物理容量定義ファイルに記載してあるものから指定する必要があります。※9
文字列※1
1～256バイト

19
cx_HVM（ハイパーバイザ種別がHVMの場合）※2
－
0-1
－
－

20

cx_storagepool
－
1以上
－
－

21
cx_resourcename
1
ストレージのリソース名を指定します。物理容量定義ファイルに記載してあるものから指定する必要があります。※4
文字列※1
1～256バイト

22
cx_poolname
1
ストレージプール名を指定します。物理容量定義ファイルに記載してあるものから指定する必要があります。※4
文字列※1
1～64バイト

23
cx_virtual
NetworkDevice
－
1以上
－
－

24
cx_name
1
仮想ネットワークデバイス名を指定します。
ハイパーバイザ種別がVMwareの場合：
仮想スイッチ名※10
ハイパーバイザ種別がHVMの場合：
ネットワークセグメント名
文字列※1
1～255バイト

25
cx_type
1※6
仮想ネットワークデバイス種別を指定します。

MANAGEMENT

BUSINESS

26
cx_purpose
0-1※7
仮想ネットワークデバイスの用途を指定します。
文字列※1
1～255バイト

注　以下の指定をした場合，エラーとなります。

・cx_resourcepool属性（項番9）とcx_resourcepool要素（項番13）の同時指定（同一物理ホスト内）

・cx_datastore属性（項番12）とcx_datastore要素（項番17）の同時指定（同一物理ホスト内）

注※1

文字列における指定可能文字は，ASCII文字の範囲です。

注※2

cx_HVM要素とcx_VMware要素のどちらかを必ず指定します。

同一物理ホスト内でcx_HVM要素とcx_VMware要素は同時に指定できません。同時に指定した場合は物理構成定義ファイルの定義不正としてエラーになります。csdrscupdateコマンド実行時は，標準出力およびメッセージログにエラーメッセージを出力し，コマンドを終了します。uCSD起動時はメッセージログにエラーメッセージを出力しますが，uCSDの起動処理は続行します。

なお，同一の物理構成定義ファイルで，複数の物理ホストを指定したとき，cx_HVM要素とcx_VMware要素は混在させないでください。

注※3

リソースプールのCPUクロック数，メモリ容量に"0"を指定した場合はリソースプールのCPUクロック数，メモリ容量の残量管理はしません。

注※4

同一物理ホスト内（cx_physicalhost要素内）の，ストレージのリソース名，ストレージプール名のセットの重複はエラーとなります。

注※5

cx_datastore属性およびcx_datastore要素の出現回数チェックはXMLスキーマによる構文解析で行いません。必ずcx_datastore属性またはcx_datastore要素のどちらかを指定します。

cx_datastore属性はcx_VMware要素の属性として1度だけ指定でき，cx_datastore要素はcx_VMware要素の子要素として複数回指定できます。

注※6

種別には，cx_typeにMAGEMENTを指定したcx_virtualNetworkDeviceタグを必ず1つだけ定義してください。cx_typeにBUSINESSを指定したcx_virtualNetworkDeviceタグの定義は任意です。BUSINESSを2つ以上定義する場合，リソース制約定義ファイルを必ず使用してください。

注※7

cx_typeにBUSINESSを指定したcx_virtualNetworkDeviceタグが2つ以上存在する場合は，必ず指定してください。

注※8

同一物理ホスト内（cx_physicalhost要素内）の，リソースプール名の重複はエラーとなります。

注※9

同一物理ホスト内（cx_physicalhost要素内）の，データストア名の重複はエラーとなります。

注※10

vSphere Distributed Switchを使用し，物理ホストに同名の分散仮想スイッチを複数指定する場合は，システム定義ファイルの変更が必要です。詳細は「2.2.2　システム定義ファイル」のプロパティ名「resource.virtualnetworkdevicename.duplicate」を参照してください。

(6)　記述例

次に物理構成定義ファイルの記述を示します。

物理構成定義ファイルの記述例（ハイパーバイザ種別がVMwareの場合）

<?xml version="1.0" encoding="UTF-8"?>
<cx_resources_doc xmlns="http://www.hitachi.co.jp/soft/xml/csd/resource/physicalconfiguration">
 <cx_physicalhostgroup cx_name="PhysicalHostGroup1">
   <cx_physicalhost cx_name="BS7600#xx" cx_ip="10.211.110.3">
     <cx_VMware cx_resourcepool="RESPOOL0001" cx_CPUclock="4096" cx_memory="2000" cx_datastore="DSTR001">
     </cx_VMware>
     <cx_virtualNetworkDevice cx_name="vSwitch0" cx_type="MANAGEMENT" />
     <cx_virtualNetworkDevice cx_name="vSwitch1" cx_type="BUSINESS" />
   </cx_physicalhost>
   <cx_physicalhost cx_name="BS7610#xx" cx_ip="10.211.110.4" >
     <cx_VMware cx_resourcepool="RESPOOL0002" cx_CPUclock="8192" cx_memory="32000" cx_datastore="DSTR002">
     </cx_VMware>
     <cx_virtualNetworkDevice cx_name="vSwitch0" cx_type="MANAGEMENT" />
     <cx_virtualNetworkDevice cx_name="vSwitch1" cx_type="BUSINESS" />
   </cx_physicalhost>
 </cx_physicalhostgroup>
</cx_resources_doc>

図2-7　VMwareを使用する場合の構成例

物理構成定義ファイルの記述例（ハイパーバイザ種別がHVMの場合）

<?xml version="1.0" encoding="UTF-8"?>
<cx_resources_doc xmlns="http://www.hitachi.co.jp/soft/xml/csd/resource/physicalconfiguration">
 <cx_physicalhostgroup cx_name="PhysicalHostGroup1">
   <cx_physicalhost cx_name="PhysicalHost1" cx_ip="10.211.110.3">
     <cx_HVM>
       <cx_storagepool cx_resourcename="RSC001@10.209.160.2" cx_poolname="ThinProvisioningPool:1"/>
     </cx_HVM>
     <cx_virtualNetworkDevice cx_name="1a" cx_type="MANAGEMENT" />
     <cx_virtualNetworkDevice cx_name="1b" cx_type="BUSINESS" />
   </cx_physicalhost>
   <cx_physicalhost cx_name="PhysicalHost2" cx_ip="10.211.110.4" >
     <cx_HVM>
       <cx_storagepool cx_resourcename=RSC001@10.209.160.2 cx_poolname="ThinProvisioningPool:2"/>
     </cx_HVM>
     <cx_virtualNetworkDevice cx_name="1a" cx_type="MANAGEMENT" />
     <cx_virtualNetworkDevice cx_name="1b" cx_type="BUSINESS" />
   </cx_physicalhost>
 </cx_physicalhostgroup>
</cx_resources_doc>

図2-8　HVMを使用する場合の構成例

2.2.5　物理容量定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

物理容量定義ファイルはXML形式で記述します。

(2)　ファイル名

storage_capacity.xml

(3)　格納先ディレクトリ

<uCSDインストールディレクトリ>¥mgr¥conf

(4)　説明

ハイパーバイザ種別がVMwareの場合
仮想ホストを配置するデータストアの容量を管理します。容量を管理するデータストア名とデータストアの容量はXML形式の物理容量定義ファイルにPaaS提供者が記述します。物理構成定義ファイル内容が反映されるタイミングはuCSD起動時，および，csdrscupdateコマンド実行時です。物理容量定義ファイルは必須ファイルですので存在しない場合やフォーマットが正しくない場合はエラーが出力されます。

図2-9　データストアの容量管理

図2-9はデータストアの容量管理について表しています。コンポーネントテンプレートファイルに定義されるVMのサイズ(<Property ovf:key=”vmsize” ...>)は，仮想ホストが利用するディスクサイズを表しています。物理容量定義ファイルにはuCSDで管理するデータストアの全容量が定義されます。物理配置候補算出（csdmiposコマンド）で，仮想ホストが利用するディスクサイズとデータストアの残容量を比較し，ディスクサイズを満たすデータストアを持つ物理ホストが物理配置候補として選択されます。その後，リソース予約（csdmireserveコマンド）で，データストアの残容量から仮想ホストが利用するディスクサイズ分減らすことによって，データストアの容量を管理します。

ハイパーバイザ種別がHVMの場合
仮想ホストを配置するストレージを管理します。ストレージ接続ポート，ストレージのリソース名，およびストレージプール名はXML形式の物理容量定義ファイルにPaaS提供者が記述します。ストレージ接続ポート，ストレージのリソース名，およびストレージプール名はJP1/ITRMで管理している内容と一致させる必要があります。
物理構成定義ファイル内容が反映されるタイミングはuCSD起動時，および，csdrscupdateコマンド実行時です。物理容量定義ファイルは必須ファイルですので存在しない場合やフォーマットが正しくない場合はエラーが出力されます。

(5)　指定項目

物理容量定義ファイルで指定できる項目を示します。

次の表にXMLファイル要素ごとの文法を示します。

表2-8　物理容量定義ファイルのXMLファイル要素の文法

項番
タグ名
属性
出現回数
説明
形式

1
cx_storages_doc
－
－
－
－

2
xmlns
1
"http://www.hitachi.co.jp/soft/xml/csd/resource/storagecapacity"を指定します。
－

3

cx_datastore
(ハイパーバイザ種別がVMwareの場合)
－
0以上
－
－

4
cx_name
1
データストア名を指定します。
文字列※1
1～256バイト

5
cx_size
1
データストアの容量を指定します。※2
1～2147483647​の整数[MB]

6
cx_stragepool
(ハイパーバイザ種別がHVMの場合)
－
0以上
－
－

7
cx_port
1
ストレージ接続ポートを指定します。
文字列※1
1～40バイト

8
cx_resourcename
1
ストレージのリソース名を指定します。
文字列※1
1～256バイト

9
cx_poolname
1
ストレージプール名を指定します。
文字列※1
1～64バイト

注※1　文字列における指定可能文字は，ASCII文字の範囲です。

注※2　データストアの最大容量を考慮した上で指定してください。

(6)　記述例

定義ファイルの記述例について説明しています。

物理容量定義ファイルの記述例（ハイパーバイザ種別がVMwareの場合）

<?xml version="1.0" encoding="UTF-8"?>
<cx_storage_doc xmlns="http://www.hitachi.co.jp/soft/xml/csd/resource/storagecapacity">
 <cx_datastore cx_name="DSTR001" cx_size="1000000​" />
 <cx_datastore cx_name="DSTR002" cx_size="500000" />
 <cx_datastore cx_name="DSTR003" cx_size="800000" />
</cx_storage_doc>

物理容量定義ファイルの記述例（ハイパーバイザ種別がHVMの場合）

<?xml version="1.0" encoding="UTF-8"?>
<cx_storage_doc xmlns="http://www.hitachi.co.jp/soft/xml/csd/resource/storagecapacity">
 <cx_storagepool cx_port="CL3-A" cx_resourcename="AMS2000@10.209.150.3" cx_poolname="ThinProvisioningPool:1" />
 <cx_storagepool cx_port="CTL4-B" cx_resourcename="AMS2100@10.209.150.6" cx_poolname="ThinProvisioningPool:2" />
 <cx_storagepool cx_port="CL2-C" cx_resourcename="AMS2200@10.209.150.10" cx_poolname="ThinProvisioningPool:3" />
</cx_storage_doc>

2.2.6　負荷分散機接続設定プロパティファイル

＜この項の構成＞

(1)　格納先

(2)　説明

(1)　格納先

＜uCSDインストールディレクトリ＞¥mgr¥conf¥lb

(2)　説明

Cosiminexusのアプリケーションサーバの負荷分散機接続設定プロパティファイルを格納先に用意してください。詳細な項目や記述方式はCosiminexusのマニュアルを参照してください。

2.2.7　リソース制約定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(1)　形式

リソース制約定義ファイルはXML形式で記述します。

(2)　ファイル名

constraint_condition.xml

(3)　格納先ディレクトリ

<uCSDインストールディレクトリ>¥mgr¥conf

(4)　説明

リソース制約定義ファイルは，PaaS利用者・PaaS提供者のリソースをPaaS提供者が制限するために指定するXML形式のファイルであり，PaaS提供者が記述します。

制限できるリソースを次に示します。

使用できる仮想ネットワークデバイス名と，仮想ネットワークデバイスに割り当てられる仮想ホストのIPアドレス（物理ホストごとに指定）

管理LANに割り当てられるVLAN ID（構成パターンテンプレートの接続先ネットワーク名ごとに指定）

使用できるコンポーネントテンプレート名と，コンポーネントテンプレートに割り当てられる仮想ホストのIPアドレス（コンポーネントテンプレートごとに指定）

使用できる負荷分散機名と，負荷分散機に割り当てられる仮想ホストのIPアドレス（負荷分散機ごとに指定）

使用できるユーザ名と，次のリソース（ユーザごとに指定）

使用可能なマスターイメージのセクション

マスターイメージのセクションに割り当て可能な仮想ホストのIPアドレス

使用可能なVLAN ID

注

リソース制約定義ファイルを指定した場合，リソース制約定義ファイルに記載していないリソースは使用できません。

使用するリソースをすべて記載してください。

リソース制約定義ファイルの内容が反映されるタイミングはuCSD起動時および csdrscupdateコマンド実行時です。

リソース制約定義ファイルは，PaaS利用者・PaaS提供者のリソースを制限しない場合は指定する必要はありません。

ただし，業務用の仮想NICが2つ以上定義されたマスターイメージを登録する場合は，リソース制約定義ファイルを必ず指定してください（リソース制約定義ファイルが指定されなかった場合は，csdmiregisterコマンドがエラーとなります）。

(5)　指定項目

リソース制約定義ファイルで指定できる項目について示します。

次の表にXMLファイルの要素ごとの文法を説明します。

表2-9　リソース制約定義ファイルのXML文法

項番
タグ名
属性
出現回数
説明
形式

1
cx_constraintcondition_doc
－
－
－
－

2
xmlns
1
"http://www.hitachi.co.jp/soft/xml/
csd/resource/constraintcondition"を指定します。
－

3

cx_condition
－
1
－
－

4

cx_physicalCondition
－
1以上
－
－

cx_physicalhostIP
1
物理ホストのIPアドレスを指定します。
IPv4の形式

5

cx_virtualNetworkDeviceCondition
－
1以上
－
－

cx_virtualNetworkDevice
1
仮想ネットワークデバイス名を指定します。
文字列
1～255バイト

6

cx_ipAddress
－
1以上
－
－

cx_min
1
指定可能IPアドレスの最小値を指定します。※1
IPv4の形式

7
cx_max
1
指定可能IPアドレスの最大値を指定します。※1
IPv4の形式

8
cx_networkCondition
－
1以上
－
－

cx_networkConnection
1
接続先ネットワーク名を指定します。
英数字と_ (スペース)
1～32文字
”management.”を含めて10～32文字の文字列
例：management.接続先ネットワーク名

9

cx_vlanId
－
1以上
－
－

cx_min
1
指定可能VLAN IDの最小値を指定します。※1
0～4095の整数※3

10
cx_max
1
指定可能VLAN IDの最大値を指定します。※1
0～4095の整数※3

11
cx_templateCondition
－
1以上
－
－

cx_template
1
コンポーネントテンプレート名を指定します。
英数字記号
1～32文字

12

cx_ipAddress
－
1以上
－
－

cx_min
1
指定可能IPアドレスの最小値を指定します。※1
IPv4の形式

13
cx_max
1
指定可能IPアドレスの最大値を指定します。※1
IPv4の形式

14
cx_loadBalancerCondition
－
0以上
－
－

cx_loadBalancer
1
負荷分散機接続設定プロパティファイル名を指定します。
英数字※2
1～64文字

15

cx_ipAddress
－
1以上
－
－

cx_min
1
指定可能IPアドレスの最小値を指定します。※1
IPv4の形式

16
cx_max
1
指定可能IPアドレスの最大値を指定します。※1
IPv4の形式

17
cx_userCondition
－
1以上
－
－

cx_user
1
PaaS利用者・PaaS提供者のユーザ名を指定します。
文字列
1～1024バイト

18

cx_sectionCondition
－
1以上
－
－

cx_section
1
セクション名を指定します。
英数字記号
1～32文字

19

cx_ipAddress
－
1以上
－
－

cx_min
1
指定可能IPアドレスの最小値を指定します。※1
IPv4の形式

20
cx_max
1
指定可能IPアドレスの最大値を指定します。※1
IPv4の形式

21
cx_vlanId
－
0以上
－
－

cx_min
1
指定可能VLAN IDの最小値を指定します。※1
0～4095の整数※3

22
cx_max
1
指定可能VLAN IDの最大値を指定します。※1
0～4095の整数※3

注

指定できる文字は，ASCII文字の範囲内とします。

注※1

値を範囲ではなく個別に指定する場合，最小値と最大値に同じものを指定します。また，最小値＞最大値となった場合はエラーとします。

注※2

チェックするのは文字列長だけです。

注※3

分散仮想スイッチを使用する場合は1～4094としてください。リソース予約時にVLAN IDを4095と決定した場合，デプロイ時にエラーとなります。

2.3　テンプレート操作で使用するファイル

次にテンプレート操作で使用するファイルの概要を示します。

図2-10　テンプレートで使用するファイルの構成

表2-10　テンプレートで使用するファイル概要一覧

項番 | ファイルの種類 | 概要
1 | 構成パターンテンプレートファイル | Web，DBなどの機能を持つ構成要素とそれらのネットワーク構成から，業務の構成パターンを表現します。
2 | サイジングUOC | 業務システムを構築する際に，テンプレート情報と業務システム要件をもとにサイジングを行うUOCです。
3 | コンポーネントテンプレートファイル | 構成パターンの構成要素となるホストを表現します。
4 | ミドルウェア定義用テンプレートファイル | ミドルウェアごとに用意されているミドルウェア定義ファイルのひな形ファイルです。
5 | ミドルウェア定義用パラメータファイル | ミドルウェア定義の値が記載されているファイル。固定値が記載されているパラメータファイルとデフォルト値が記載されているパラメータファイルの2種類存在します。
6 | OS設定用テンプレートファイル | OSごとに用意されているOS定義ファイルのひな形ファイルです。
7 | OS設定用パラメータファイル | OSに設定する値が記載されているファイル。固定値が記載されているパラメータファイルとデフォルト値が記載されているパラメータファイルの2種類存在します。
8 | ミドルウェアセットアップスクリプト | ミドルウェアをセットアップするためのスクリプトファイルです。
9 | hosts_templateファイル | hostsファイル作成のためのテンプレートファイルです。

＜この節の構成＞

2.3.1　構成パターンテンプレートファイル

2.3.2　サイジングUOC

2.3.3　コンポーネントテンプレートファイル

2.3.4　ミドルウェア定義用テンプレートファイル

2.3.5　ミドルウェア定義用パラメータファイル

2.3.6　OS設定用テンプレートファイル

2.3.7　OS設定用パラメータファイル

2.3.8　ミドルウェアセットアップスクリプト

2.3.9　hosts_templateファイル

2.3.1　構成パターンテンプレートファイル

＜この項の構成＞

(1)　記述形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(1)　記述形式

構成パターンテンプレートファイルはXML形式で記述します。

サポートするXMLファイルの文字コードはUTF-8とします。XMLファイルにはXML宣言を記述し，XML宣言におけるencodingの値にUTF-8を指定してください。

タグは，「表2-13　構成パターンテンプレートファイルのXML記述文法」の順番に従って記述してください。従わない場合，エラーとなることがあります。

「表2-13　構成パターンテンプレートファイルのXML記述文法」に示すタグの親子関係以外の位置にタグを記述した場合，エラーとせず該当タグを無視して動作する場合があるので注意してください。

(2)　ファイル名

構成パターンテンプレートファイルのファイル名は任意です。

(3)　格納先ディレクトリ

構成パターンテンプレートファイルの格納先は任意です。

(4)　説明

構成パターンテンプレートファイルはPaaS利用者が作成するマスターイメージの元となるファイルになります。構成パターンテンプレートファイルが持つ情報一覧を次の表に示します。

表2-11　構成パターンテンプレートファイルが持つ情報

項番
項目
説明

1
テンプレート名
テンプレートの名称を表します。ほかのテンプレートと重複しない名称を指定してください。

2
テンプレートパターン
（テンプレート種別）
テンプレートの種別を表します。ここでは，構成パターンテンプレートであることを指定します。

3
識別子
VirtualSystemCollection，またはAbstractSystemCollection※2を識別するための識別子を表します。

4
要素の説明
親要素の説明を表します。

5
要素の名前
親要素の名前を表します。

6
コンポーネントID
構成パターン内の要素を識別するために使うIDです。要素間で重複してはいけません。
このIDは，マスターイメージ登録時にコンポーネントテンプレートとの組み合わせを指定する際に使用します。

7
デプロイ一時停止フラグ
業務システムのデプロイ中に，VMデプロイ完了のタイミング（ミドルウェアのセットアップ前）でデプロイを一時停止するかどうか指定するフラグです。

8
ティア※1
構成パターン内の要素が持つティア（例：WEB，DBなど）を表します。
マスターイメージ登録時には，同じティアを持つコンポーネントテンプレートとの組み合わせを指定します。

9
セットアップ順序
ティアのセットアップ順序を表します。構成パターンテンプレート内で重複した値は指定できません。ただし，同一AbstractSystemCollection内の場合は，重複した値を指定することができます。
業務システムのデプロイ時には，ティアに対応づけられたミドルウェアのセットアップ※3を，この順序で実行します。サイジングによってコンポーネント内の仮想ホストが2台以上の構成になった場合，仮想ホスト間で同じセットアップ順序を持つミドルウェアは，並列にセットアップを行います。
セットアップ例を「図2-11　セットアップ例」で示します。
同一AbstractSystemCollection内に指定したAbstractSystemのうち，ミドルウェア識別子にhitachi.Cosminexusを指定したミドルウェアは同時にセットアップを行ないます。その場合のセットアップ順序は，同じ値を指定してください。異なる値を指定した場合，指定されているうちの最小の値が有効となります。

10
ティア種別
ミドルウェア識別子にhitachi.Cosminexusを指定した場合に仮想サーバマネジャのティアを表します。

11
接続先ネットワーク名
構成パターン内の要素が属するネットワーク名を表します。同じネットワーク名の要素は同一のネットワークに属することを表します。

12
UOC
UOC種別
構成パターンテンプレートに登録するUOCの種別（サイジング）を表します。

UOCクラス名
UOCのパッケージ名を含むクラス名を表します。

jarファイル名
UOCのjarファイル名を表します。この値はcsdtmpregisterコマンドの-dオプションで指定するディレクトリからの相対パスを記述してください。

UOCパラメータ名
UOCへの入力パラメータの名前を表します。

UOCパラメータ値
UOCへの入力パラメータの値を表します。

13
仮想ネットワークデバイス用途
構成パターンが使用する仮想ネットワークデバイスの用途を表します。物理構成定義ファイルに記載する仮想ネットワークデバイスの用途の中から，構成パターンの仮想ネットワークデバイスとして使用する値を設定します。

14
デフォルトゲートウェイ設定フラグ
接続先ネットワークに，デフォルトゲートウェイ情報を設定することを表します。

注　構成パターンテンプレートファイルに記述したUOCの情報は，マスターイメージ登録時にマスターイメージ定義ファイルに同様の記述をしてください。構成パターンテンプレートだけへの記述である場合，マスターイメージにUOC情報は反映されません。

注※1　構成パターンテンプレートとコンポーネントテンプレートを関連づけるための名前を示します。

注※2　AbstractSystemCollection要素間で重複した識別子を指定しないでください。

注※3　マスターイメージ定義ファイルにパッチ適用の設定がされている場合は，同一順序内でミドルウェアセットアップからミドルウェア更新まで続けて実施します。その際の処理順序は「図2-11　セットアップ例」の注意事項を参照してください。

図2-11　セットアップ例

注　マスターイメージ定義ファイルにパッチ適用の設定がされている場合の処理順序は次のとおりです。

(E)のセットアップ

(E)の更新

(F)のセットアップ

(F)の更新

(A)と(C)のセットアップ

(A)と(C)の更新

(B)と(D)のセットアップ

(B)と(D)の更新

(5)　指定項目

「表2-12　構成パターンテンプレートファイルのパラメータの指定方式」にテンプレート内の可変値のパラメータ指定方式を表し，「表2-13　構成パターンテンプレートファイルのXML記述文法」にXMLファイルの要素ごとの文法を示します。

表2-12　構成パターンテンプレートファイルのパラメータの指定方式

項番
項目
形式

1
テンプレート名
英数字記号（”#”，”-“， “@”，”(“，”)”，” _”）
1～32文字

2
UOCクラス名
英数字，ピリオド（.），ドル記号（$）およびアンダースコア（_）※1

3
jarファイル名
相対パス名。ただし，半角空白は指定できません。
1～160文字
csdtmpregisterまたはcsdtmpupdateコマンドの-dオプションで指定したディレクトリからの相対パスの形式。jarファイルは-dオプションで指定したディレクトリ内に置く必要があります。

4
UOC種別
次の値を指定します。
サイジングUOC：sizing

5
UOCパラメータ名
英数字記号
1～32文字

6
UOCパラメータ値
文字列（日本語可）
1～1024文字

7
識別子
英数字と_
1～32文字

8
要素の説明
文字列（日本語可）
1～255文字

9
要素の名前
文字列（日本語可）
1～255文字

10
コンポーネントID
1～65535の整数

11
デプロイ一時停止フラグ
trueまたはfalse
すべて小文字とします。

12
ティア
英数字と_
1～32文字

13
セットアップ順序
1～65535の整数

14
ティア種別
ミドルウェア識別子がhitachi.Cosminexusの場合に，仮想サーバマネジャのティアを表す次のどれかの値を指定します。

combined-tier

http-tier

j2ee-tier

15
接続先ネットワーク名
（management，またはbusinessの接頭辞を付けて，ネットワークを表現します）
英数字と_ （スペース）
1～32文字
次のどちらかの形式（“management.”または“business.”を含めて10～32文字の文字列）

管理LANの場合：management.接続先ネットワーク名

業務LANの場合：business.接続先ネットワーク名

ハイパーバイザ種別がVMwareの場合：

management.は必ず１つだけ指定します。business.は指定しないことも可能です。

ハイパーバイザ種別がHVMの場合：

management.は必ず１つだけ指定します。business.は必ず1つ以上指定します。

コンポーネントテンプレートのItem(NIC)に指定した数以下にしてください。Item(NIC)よりも多く接続先ネットワーク名を指定した場合は，csdmiregisterコマンド実行時にエラー(KFUD23127-E)になります。
コンポーネントテンプレートのItem(NIC)に指定した数より少ない場合，差分のItem(NIC)は未使用として扱います。

16
仮想ネットワークデバイス用途
ASCII文字※2
1～255バイト

17
デフォルトゲートウェイ設定フラグ
trueまたはfalse
すべて小文字とします。

注※1　パッケージ名およびクラス名の先頭は英数字だけです。1～1024文字で指定してください。

注※2　JP1/ITRMへの指定値です。指定時にチェックされるため，uCSDは使用文字の確認はしません。

表2-13　構成パターンテンプレートファイルのXML記述文法

項番
タグ名
属性
出現回数
説明

1
Envelope
－
1
ルート要素を表します。

2
xmlns
1
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。

3
xmls:ovf
1
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。

4
xmls:csd
1
"http://www.hitachi.co.jp/soft/csd"を指定してください。

5
csd:type
1
patternを指定します。構成パターンテンプレートであることを表します。

6
csd:name
1
テンプレート名を指定します。
表2-20の項番7で設定した値と同じ値を設定してください。

7

References
－
1
空要素として指定

8
ProductSection（parameter）
－
0-1
構成パターンテンプレート特有のパラメータを指定します。

9
ovf:class
1
parameterを指定します。構成パターンテンプレートのパラメータであることを表します。

10

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

11
Property
－
0-1
親要素ProductSectionが持つパラメータを指定します

12
ovf:key
1
deploy.pauseを指定。
デプロイ中に一時停止するかを指定します。

13
ovf:type
1
boolean

14
ovf:value
1
true | <<false>>

15
ProductSection（uoc.UOC種別）
－
0-1
サイジングUOCの情報を指定します。

16
ovf:class
1
uoc.sizingを指定。
サイジングUOCのパラメータであることを表します。

17

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

18
Property
－
1
－

19
ovf:key
1
"クラス名"
SizingUocを実装したクラス名を指定します。

20
ovf:type
1
string

21
ovf:value
1
keyに指定したクラスを含むjarファイル名を指定します。
csdtmpregisterコマンドの-dオプションで指定したディレクトリからの相対パスで指定します。

22

Value
－
0-20
－

23
ovf:key
1
UOCへのパラメータ名を指定します。

24
ovf:value
1
UOCへのパラメータ値を指定します。

25
VirtualSystemCollection
－
1
AbstractSystemの集まりを表します。

26
ovf:id
1
任意の識別子を指定します。必須ですが，uCSDではコメントとして扱われます。

27

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

28
Name
－
0-1
テキストノードに要素の名前（コメント）を指定します。

29
AbstractSystem
－
1-20
AbstractSystemを1つ以上指定します。

30
ovf:id
1
コンポーネントIDを指定します。親要素VirtualSystemCollection内でほかのAbstractSystemと重複できません。
表2-20の項番17で設定した値と同じ値を設定してください。

31

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

32
Name
－
0-1
テキストノードに要素の名前（コメント）を指定します。

33
ProductSection
（class=tier.ティア）
－
1-5
複数指定する場合には，親要素AbstractSystem内でティアの値が重複しないよう設定してください。

34
ovf:class
1
ティアを指定します。
表2-16の項番45で設定した値と同じ値を設定してください。

35

Info
－
1
テキストノードに要素の説明（コメント）を記述します。

36
Property
（key=order）
－
0-1
指定した場合には，この構成パターンテンプレートファイル内のその他のティアについても，この要素を必ず指定してください。また，その場合value属性に指定するセットアップ順序は重複してはいけません。

37
ovf:key
1
orderを指定。
セットアップ順序であることを表します。

38
ovf:type
1
uint16

39
ovf:value
1
構成パターン内でのティアのセットアップ順序を指定します。小さい番号から順にセットアップします。省略した場合には任意の順番となります。

40
Property
（key=tiertype）
－
0-1
ティア種別を指定します。ミドルウェア識別子にhitachi.Cosminexusの場合に指定できます。ミドルウェア識別子がhitachi.Cosminexusで，ティア種別を指定しない場合，combined-tierとして動作します。

41
ovf:key
1
tiertypeを指定。
ティア種別であることを表します。

42
ovf:type
1
string

43
ovf:value
1
ミドルウェア識別子がhitachi.Cosminexusの場合に，仮想サーバマネジャのティアを表す値を指定します。
表2-12の項番14で設定した値と同じ値を設定してください。

44
NetworkConnectionSection
－
1
－

45

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

46
Network（name=management.接続先ネットワーク名）
－
1
－

47
ovf:name
1
AbstractSystemが属する管理用の接続先ネットワーク名にmanagement接頭辞を付けて指定します。

48
csd:purpose
0-1
接続先ネットワークが使用する，仮想ネットワークデバイス名の用途を指定します（物理構成定義ファイルに記載した物理ホストが保持する仮想ネットワークデバイスの用途）。

49
csd:defaultGateway
0-1
接続先ネットワークに対して，デフォルトゲートウェイ情報を設定することを示すフラグ。省略した場合はtrueとなります。
tureのときは，NICに，IPアドレス設定ファイルに指定したデフォルトゲートウェイ情報を設定します。

50

Description
－
0-1
テキストノードに親要素の説明（コメント）を記述します。

51
Network（name=business.接続先ネットワーク名）
－
VMware:
0-9※1
HVM:
1-3※2
－

52
ovf:name
1
AbstractSystemが属する業務用の接続先ネットワーク名にbusinessの接頭辞を付けて指定します。

53
csd:purpose
0-1
接続先ネットワークが使用する，仮想ネットワークデバイス名の用途を指定します（物理構成定義ファイルに記載した物理ホストが保持する仮想ネットワークデバイスの用途）。

54
csd:defaultGateway
0-1
接続先ネットワークに対して，デフォルトゲートウェイ情報を設定することを示すフラグ。省略した場合はtrueとなります。
tureのとき，NICに，IPアドレス設定ファイルに指定したデフォルトゲートウェイ情報を設定します。

55

Description
－
0-1
テキストノードに親要素の説明（コメント）を記述します。

56
AbstractSystemCollection
－
1
AbstractSystemの集まりを表します。
AbstractSystemCollection内に記載できるAbstractSystem（子要素）の構成は次のとおりです。

http-tier + j2ee-tier構成

ミドルウェア識別子にhitachi.Cosminexusを使用する場合，仮想サーバマネジャにおける，仮想サーバグループを表します。
AbstractSystemCollection内に指定したAbstractSystemのうち，ミドルウェア識別子にhitachi.Cosminexusを使用するものを同一の仮想サーバグループとします。
サイジングでのデプロイするホスト数は，AbstractSystemCollection要素単位で決定します。同一AbstractSystemCollectionに含まれる複数のコンポーネントでは，サイジング時のnumberOfHost値を，同じ値とする必要があります。一致していない場合，同一AbstractSystemCollection内のコンポーネントごとに返却されたnumberOfHost値のうち最小のものをサイジング結果のnumberOfHost値として動作します。

57
ovf:id
1
任意の識別子を指定します。必須ですがuCSDではコメントとして扱われます。

58

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

59
Name
－
0-1
テキストノードに要素の名前（コメント）を指定します。

60
AbstractSystem
※3
※3
※3

注※1　VMwareの制限値です。上限値はプログラムでチェックしません。

注※2　JP1/DPMの制限値です。下限値と上限値はプログラムでチェックしません。

注※3　AbstractSystemタグについては，項番29～55と同一の内容です。

2.3.2　サイジングUOC

csdmiregisterコマンドの-sオプションまたはcsdmiupdateコマンド（-sオプション指定）実行時，マスターイメージのサイジング時に使用します。

このUOCには，構成パターンテンプレートのコンポーネントごとに，業務を運用するのに十分な性能・台数のサーバを算出し，その結果をuCSDに渡すまでの処理を作成します。

サイジングUOCの詳細は「3．UOC」を参照してください。

2.3.3　コンポーネントテンプレートファイル

＜この項の構成＞

(1)　記述形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定できる項目

(1)　記述形式

コンポーネントテンプレートファイルはXML形式で記述します。

サポートするXMLファイルの文字コードはUTF-8とします。XMLファイルにはXML宣言を記述し，XML宣言におけるencodingの値にUTF-8を指定してください。

タグは，「表2-16　コンポーネントテンプレートファイルのXMLファイル要素の文法」の順番に従って記述してください。従わない場合，エラーとなることがあります。

「表2-16　コンポーネントテンプレートファイルのXMLファイル要素の文法」に示すタグの親子関係以外の位置にタグを記述した場合，エラーとせず該当タグを無視して動作する場合があるので注意してください。

(2)　ファイル名

コンポーネントテンプレートファイル名は任意です。

(3)　格納先ディレクトリ

コンポーネントテンプレートファイルの格納先は任意です。

(4)　説明

構成パターンの構成要素となるホストを表現するテンプレートです。

コンポーネントテンプレートが持つ情報を次の表に示します。

表2-14　コンポーネントテンプレートファイルが持つ情報

項番
項目
説明

1
テンプレート名
テンプレートの名称を表します。ほかのテンプレートと重複しない名称を指定してください。

2
テンプレートパターン
（テンプレート種別）
テンプレートの種別を表します。ここでは，コンポーネントテンプレートであることを指定します。

3
識別子
VirtualSystemを識別するための識別子を表します。

4
要素の説明
親要素の説明を表します。

5
要素の名前
親要素の名前を表します。

6
仮想イメージテンプレート情報
仮想イメージテンプレート名
コンポーネントテンプレートに対応する仮想イメージテンプレートの名称を表します。この名称はJP1/ITRMに登録されている必要があります。

ユーザ名

Linuxの場合
仮想イメージテンプレートのユーザ名と初期パスワードを指定します。※3，※4

Windowsの場合
仮想イメージテンプレートの管理者権限ユーザ名と初期パスワードを指定します。ユーザ名には"Administrator"を指定します。

パスワード

VMのサイズ
VMのディスク容量を表します。この仮想イメージテンプレートからデプロイした仮想ホストに割り当てられるディスク容量を指定してください。※5

7
ミドルウェアの情報
ミドルウェア識別子
ミドルウェアを識別するための識別子を表します。

製品名
ホスト上で動作するミドルウェアの製品名を表します。

ベンダー
製品のベンダーを表します。

バージョン
ミドルウェアのバージョン，詳細バージョンを表します。

詳細バージョン

製品のURL
製品のURLを表します。

ベンダーのURL
ベンダーのURLを表します。

ティア
このミドルウェアの機能がどのティア（例：WEB，DBなど）に対応するか表します。この情報は，マスターイメージ作成時に構成パターン内のティアとミドルウェアをつなぎ合わせるために使用します。

PP一覧
PP形名
ミドルウェアに含まれるPP形名とバージョンの一覧を表します。

バージョン

ミドルウェア定義格納ディレクトリ
ミドルウェア定義用テンプレートファイルとミドルウェア定義用パラメータファイルを格納したディレクトリのパスを表します。この値はcsdtmpregisterコマンドの-dオプションで指定するディレクトリからの相対パスです。

エラー時続行可否フラグ
デプロイ処理中にミドルウェアのセットアップに失敗した場合に，デプロイを継続するかどうかを表す情報です。

ロードバランサ使用有無
ロードバランサを使用するかどうかを示します。ミドルウェアがCosminexusの場合に指定できます。
構成パターンテンプレートにNetwork（name=business.接続先ネットワーク名）が1つ以上指定されている場合に指定してください。

ロードバランサ業務IP識別子
Cosminexus使用時に，ロードバランサが使用する業務IPを表すための情報です※1。このパラメータで指定した識別子を持つNICに割り当てたIPアドレスを，ロードバランサが使用するIPアドレスとします。
次のコンポーネントテンプレートの場合，設定してください。

ミドルウェア識別子が“hitachi.Cosminexus”である

業務NICを2つ以上使用する※2

ロードバランサを使用する

構成パターンテンプレートに指定した接続先ネットワークの中で，ロードバランサが使用する接続先ネットワークに指定されている仮想ネットワークデバイス用途と同じ値を指定してください。

スクリプト情報
スクリプト名
ミドルウェアのセットアップに使用するスクリプト名と，スクリプトを配置したディレクトリのパスを表します。指定したディレクトリ内にはスクリプトに付属するファイルを配置することが可能です。
指定するディレクトリのパスは，csdtmpregisterコマンドの-dオプションで指定するディレクトリからの相対パスです。
マスターイメージまたはVM単位で異ならない固定のものについて記載するようにしてください。
テンプレートの登録（csdtmpregister）後，記述内容の修正（csdtmpupdate）を行いたい場合に当該テンプレートを使用しているマスターイメージが存在した場合は，使用しているすべてのマスターイメージをアンデプロイ（csdmiundeploy）させた後，削除（csdmidelete）する必要があります。
そのため，マスターイメージまたはVM単位で異なる可能性のあるものは，マスターイメージ定義ファイルのパッチ情報として記載してください。
詳細は「2.4.1　マスターイメージ定義ファイル」を参照してください。

スクリプト・ディレクトリ

8
OSの設定情報
OS設定ファイル格納ディレクトリ
OS設定ファイルテンプレートファイルとOS設定用パラメータファイルを格納したディレクトリのパスを表します。この値はcsdtmpregisterコマンドの-dオプションで指定するディレクトリからの相対パスです。

hostsテンプレート使用有無
hostsファイルのテンプレートを使用するかどうかを示します。使用する場合はcsdtmpregisterコマンドの-dオプションで指定するディレクトリ直下に名称”hosts_template”で作成します。

9
OS情報
OS種別
仮想イメージテンプレートが表すホストのOSの種類とバージョンを示します。

OSバージョン

10
ハイパーバイザ種別
仮想イメージテンプレートで表すホストが動作するハイパーバイザ種別を表します。

11
CPUの情報
CPUクロック
仮想イメージテンプレートが表すホストのCPUクロックとコア数のデフォルト値，最大値，最小値を表します。サイジングによって，指定範囲内でデフォルト値から変更できます。

CPUコア数

インスタンスID
テンプレート内で，CPUを表すハードウェアを識別する値です。

12
メモリの情報
メモリサイズ
仮想イメージテンプレートが表すホストのメモリ容量のデフォルト値，最大値，最小値。サイジングによって，指定範囲内でデフォルト値から変更できます。

インスタンスID
テンプレート内で，メモリを表すハードウェアを識別する値です。

13
NICの情報
NICのネットワーク名
JP1/ITRMの仮想イメージテンプレートが保持するネットワーク名を表します。ハイパーバイザ種別によって次の情報となります。

VMwareの場合：
仮想イメージテンプレートが保持するネットワーク名

HVMの場合：
仮想イメージテンプレートが保持するNIC番号

インスタンスID
テンプレート内で，NICを表すハードウェアを識別する値です。NICが複数ある場合には，それぞれ別の値となります。

14
FC-HBA情報
PCIデバイス識別情報
仮想イメージテンプレートが保持するPCIデバイス識別情報です。

インスタンスID
テンプレート内でFC-HBAを表すハードウェアを識別する値です。FC-HBA情報が複数ある場合には，それぞれ別の値となります。

FC-HBA種別
仮想ホストに設定するFC-HBA種別です。

注※1

Cosminexusの仮想サーバグループ情報ファイルの属性名:serviceipに使用されます。

注※2

業務NICが1つの場合は指定不要です（指定することもできます）。この業務NICに割り当てたIPアドレスが，ロードバランサが使用するIPアドレスになります。

注※3

仮想イメージテンプレートが表すホストのOSがLinuxの場合，uCSDはcsdmideployコマンド，またはcsdmiupdateコマンド実行時に，仮想イメージテンプレートが表すホストに対し，コンポーネントテンプレートに指定したroot権限ユーザでSSH接続を実行します。SSH接続を許可するユーザを制限したい場合は，あらかじめ仮想イメージテンプレートの基になるホストに対し，次の設定を実行しておくことで制限できます。

対象ファイル | 設定項目 | 設定値 | 設定内容
/etc/ssh/sshd_config | AllowUsers | ログインを許可したいユーザ名 | 指定されたユーザだけログインを許可します。

注※4

一般ユーザを指定した場合はhosts転送機能でエラーとなります。

注※5

指定したディスク容量は物理容量定義ファイルに指定したデータストアまたはストレージの残量管理にだけ使用します。デプロイする仮想ホストのディスク容量は変更できません。

コンポーネントテンプレートは，ミドルウェア定義用・OS設定用テンプレートファイル，ミドルウェア定義用・OS設定用パラメータファイル，ミドルウェアのセットアップスクリプト，およびhostsテンプレートを持ちます。これらのファイルはPaaS提供者が任意のディレクトリ内に作成して，テンプレート登録コマンドにそのディレクトリを指定することで，uCSDに登録されます。

(5)　指定できる項目

「表2-15　コンポーネントテンプレートファイルのパラメータ指定方式」にテンプレート内の可変値のパラメータ指定方式を表し，「表2-16　コンポーネントテンプレートファイルのXMLファイル要素の文法」にXMLファイルの要素ごとの文法を示します。

表2-15　コンポーネントテンプレートファイルのパラメータ指定方式

項番
項目
形式

1
テンプレート名
英数字記号
1～32文字

2
識別子
英数字と_
1～32文字

3
仮想イメージテンプレート名
文字列（日本語可）
1～255文字

4
root権限ユーザ名
文字列（使用できる文字はJP1/ITRMのマニュアル参照）
1～255文字

5
パスワード
文字列（使用できる文字はJP1/ITRMのマニュアル参照）
1～255文字

6
VMのサイズ
1～2147483647​の整数
単位は[MB]とします。

7
要素の説明
文字列（日本語可）
1～255文字

8
要素の名前
文字列（日本語可）
1～255文字

9
ミドルウェア識別子
Cosminexus，HiRDB，またはJP1の場合，次の値です。

hitachi.Cosminexus

hitachi.HiRDB

optional.PFM_AgentforCosminexus

optional.PFM_AgentforHirdb

optional.Jp1Base

その他の場合，次の形式で指定します（optional.を含めて10～32文字の文字列）。

optional.任意の製品名

任意の製品名：英数字と_.#-@（）から成る文字列

10
製品名
ベンダー
英数字と_.#-@（）
1～255文字

11
バージョン
詳細バージョン
英数字と_.#-@（）
1～32文字

12
製品のURL
ベンダーのURL
URLに使用できる文字（uCSDでは使用しないためチェックはしない）
1～255文字

13
ティア
英数字と_
1～32文字

14
PP形名
英数字と_.#-@（）
1～32文字

15
ミドルウェア定義格納ディレクトリ
相対パス名
ただし半角空白は指定できません。
csdtmpregisterもしくはcsdtmpupdateコマンドの-dオプションに指定したディレクトリからの相対パスを指定します。
定義に指定した定義格納ディレクトリのパス長と，ディレクトリ内に格納したファイルのパス（定義格納ディレクトリからの相対パス）の最大長を足した値が160文字以内に収まる長さ。

16
エラー時続行可否フラグ
trueまたはfalse

17
ロードバランサ使用有無
trueまたはfalse
構成パターンテンプレートにNetwork（name=business.接続先ネットワーク名）を指定していない場合は，trueを指定できません。

18
hostsテンプレート使用有無
trueまたはfalse

19
OS設定ファイル格納ディレクトリ
相対パス名
ただし，半角空白は指定できません。csdtmpregisterもしくはcsdtmpupdateコマンドの-dオプションに指定したディレクトリからの相対パスを指定します。
定義に指定したOS設定ファイル格納ディレクトリのパス長と，ディレクトリ内に格納したファイルのパス（OS設定ファイル格納ディレクトリからの相対パス）の最大長を足した値が160文字以内に収まる長さ。

20
スクリプト名
相対パス名
ただし，半角空白は指定できません。1～160文字
スクリプト・ディレクトリからの相対パスでセットアップスクリプトを指定します。

21
スクリプト・ディレクトリ
相対パス名
ただし，半角空白は指定できません。csdtmpregisterもしくはcsdtmpupdateコマンドの-dオプションに指定したディレクトリからの相対パスを指定します。
定義に指定したスクリプト・ディレクトリのパス長と，ディレクトリ内に格納したファイルのパス（スクリプト・ディレクトリからの相対パス）の最大長を足した値が160文字以内に収まる長さ。

22
OS種別
RedHat Enterprise Linuxの場合：79
RedHat Enterprise Linux 64-Bitの場合：80
Microsoft Windows Server 2008 R2の場合：103

23
インスタンスID
0～65535の整数
ハードウェア（CPU，メモリ，NIC（複数あり），FC-HBA（複数あり））ごとに異なる値を指定します。

24
ハイパーバイザ種別
VMwareの場合：VMware
HVMの場合：HVM

25
CPUクロック
10～999990の整数
単位は[MHz]とします。

26
CPUコア数
1～4096の整数

27
メモリサイズ
256～1022976​の整数
単位は[MB]とします。
ハイパーバイザ種別によって，次のように指定します。
VMwareの場合：ギガバイトに変換後，小数点3位以下を切り捨てます。
HVMの場合：0.25ギガバイト単位で計算し，端数は切り捨てます。

28
NICのネットワーク名
英数字と_ （スペース）
1～255文字
JP1/ITRMの仮想イメージテンプレートが保持するネットワーク名を記載します。ハイパーバイザ種別によって，次の値となります。
VMwareの場合：仮想イメージテンプレートが保持するネットワーク名
HVMの場合：仮想イメージテンプレートが保持するNIC番号

29
PCIデバイス識別情報
[xx:xx:xx] xx:0または00～ff（16進数2桁）
（例）[5:4:0]または[05:04:00]
仮想イメージテンプレートが保持するPCIデバイス識別情報を指定します。ハイパーバイザ種別がHVMの場合だけ指定可能です。HVM以外の場合に指定すると，エラーになります。

30
FC-HBA種別
仮想ホストに設定するFC-HBA種別として，次のどれかを指定します。
B：ブート用のFC-HBAとして設定
Y：ブート用以外で有効なFC-HBAとして設定
N：無効なFC-HBAとして設定
ブート用のFC-HBA（B）は必ず1つ設定してください。
ハイパーバイザ種別がHVMの場合だけ指定可能です。HVM以外の場合に指定すると，エラーになります。

31
ロードバランサ業務IP識別子
文字列
1～255バイト
構成パターンテンプレートに記載した用途のうち，ロードバランサが使用する業務IPを表すための情報を指定します。
ロードバランサ使用有無でtrueを指定した場合だけ指定できます。

表2-16　コンポーネントテンプレートファイルのXMLファイル要素の文法

項番
タグ名
属性
出現回数
説明

1
Envelope
－
1
ルート要素を表します。

2
xmlns
1
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。

3
xmlns:ovf
1
"http://schemas.dmtf.org/ovf/envelope/1"を指定してください。

4
xmlns:vssd
1
"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"を指定してください。

5
xmlns:rasd
1
"http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" を指定してください。

6
xmlns:csd

"http://www.hitachi.co.jp/soft/csd"を指定してください。

7
csd:type
1
componentを指定。
コンポーネントテンプレートであることを表します。

8
csd:name
1
テンプレート名
表2-20の項番18で設定した値と同じ値を設定してください。

9

References
－
1
空要素として指定

10
VirtualSystem
－
1
VMの情報を定義します。

11
ovf:id
1
任意の識別子を指定します。必須ですが，uCSDではコメントとして扱われます。

12

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

13
Name
－
0-1
テキストノードに要素の名前（コメント）を指定します。

14
ProductSection（ref.ImageTemplate）
－
1
仮想イメージテンプレートを指定します。

15
ovf:class
1
ref.ImageTemplateを指定します。

16

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

17
Property（key=name）
－
1
－

18
ovf:key
1
nameを指定します。
JP1/ITRMに登録した仮想イメージテンプレート名であることを表します。

19
ovf:type
1
string

20
ovf:value
1
JP1/ITRMに登録した仮想イメージテンプレート名を指定します。

21
Property（key=user）
－
1
－

22
ovf:key
1
userを指定します。
root権限ユーザ名であることを表します。

23
ovf:type
1
string

24
ovf:value
1
root権限ユーザ名を指定します。

25
Property（key=password）
－
1
－

26
ovf:key
1
passwordを指定します。
初期パスワードであることを表します。

27
ovf:type
1
string

28
ovf:value
1
仮想イメージテンプレートのrootユーザの初期パスワードと同じものを指定します。

29
Property（key=vmsize）
－
1
－

30
ovf:key
1
vmsizeを指定します。
VMのディスクサイズであることを表します。

31
ovf:type
1
uint32

32
ovf:value
1
VMのディスクサイズを指定します。

33
ProductSection（pp.ミドルウェア識別子）
－
1-5
－

34
ovf:class
1
pp.ミドルウェア識別子を指定します。親要素VirtualSystem内で重複してはいけません。
表2-20の項番20で設定した値と同じ値を設定してください。

35

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

36
Product
－
0-1
テキストノードに製品名を記述します。

37
Vendor
－
0-1
テキストノードにベンダーを記述します。

38
Version
－
0-1
テキストノードにバージョンを記述します。

39
FullVersion
－
0-1
テキストノードに詳細なバージョンを記述します。

40
ProductUrl
－
0-1
テキストノードに製品のURLを記述します。

41
VendorUrl
－
0-1
テキストノードにベンダーのURLを記述します。

42
Property（key=tier）
－
1
親の親要素VirtualSystem内でvalueの値が重複してはいけません。

43
ovf:key
1
tierを指定します。

44
ovf:type
1
string

45
ovf:value
1
ミドルウェアの機能がどのティアに対応するかを表します。親の親要素VirtualSystem内で重複してはいけません。
表2-13の項番34で設定した値と同じ値を設定してください。

46
Property（key=ppname.PP形名）
－
0-5
－

47
ovf:key
1
ppname.PP形名を指定します。

48
ovf:type
1
string

49
ovf:value
1
PP形名に対応するミドルウェアのバージョンを指定します。

50
Property（key=dirname）
－
0-1
－

51
ovf:key
1
dirnameを指定します。

52
ovf:type
1
string

53
ovf:value
1
ミドルウェア定義格納ディレクトリを指定します（csdtmpregisterコマンドの-dオプションで指定したディレクトリからの相対パスで指定します）。

54
Property（key=errorProcess）
－
0-1
－

55
ovf:key
1
errorProcessを指定します。

56
ovf:type
1
boolean

57
ovf:value
1
ミドルウェアのセットアップ失敗時にデプロイを継続するかどうかを指定します。trueの場合に継続します。省略時はfalseとなります。

58
Property（key=LoadBalancer）
－
0-1
－

59
ovf:key
1
LoadBalancerを指定します。

60
ovf:type
1
boolean

61
ovf:value
1
ロードバランサ使用有無を指定します。trueの場合，ロードバランサを使用します。省略時は，falseとなります。

62
Property（key=script.スクリプト名）
－
0-1
－

63
ovf:key
1
script.スクリプト名を指定します。

64
ovf:type
1
string

65
ovf:value
1
セットアップ用の格納ディレクトリを指定します。

66
Property（key=LoadBalancerServiceIpId）
－
0-1
－

67
ovf:key
1
LoadBalancerServiceIpIdを指定します。

68
ovf:type
1
string

69
ovf:value
1
ミドルウェアが使用するロードバランサ業務IP識別子を指定します。

70

ProductSection（os）
－
0-1
－

71
ovf:class
1
osを指定します。

72

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

73
Property（key=dirname）
－
1
－

74
ovf:key
1
dirnameを指定します。

75
ovf:type
1
string

76
ovf:value
1
OS設定ファイル格納ディレクトリを指定します。

77
Property（key=hosts）
－
0-1
－

78
ovf:key
1
hostsを指定します。

79
ovf:type
1
boolean

80
ovf:value
1
hostsテンプレートを使用するかどうかを指定します。trueの場合にhostsテンプレートを使用します。省略時はfalseとなります。

81
OperatingSystemSection
－
1
－

82
ovf:id
1
OS種別を指定します。

83
ovf:version
1
OSバージョンを指定します。

84

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

85
Description
－
0-1
テキストノードに親要素の説明（コメント）を記述します。

86
VirtualHardwareSection
－
1
－

87

Info
－
1
テキストノードに親要素の説明（コメント）を記述します。

88
System
－
1
－

89

vssd:Description
－
0-1
テキストノードに要素の説明（コメント）を記述します。

90
vssd:ElementName
－
1
テキストノードに要素の名称（コメント）を指定します。

91
vssd:InstanceID
－
1
テキストノードにインスタンスIDを指定します。
親の親要素VirtualHardwareSection内で重複してはいけません。

92
vssd:VirtualSystemType
－
1
テキストノードにハイパーバイザ種別を指定します。

93
Item（CPU）
－
1
－

94
ovf:bound
0-1
defaultを指定します。
本属性の指定を省略した場合，defaultとなります。

95

rasd:AllocationUnits
－
1
テキストノードに"hertz * 10^6"を指定します。

96
rasd:Description
－
0-1
テキストノードに要素の説明（コメント）を記述します。

97
rasd:ElementName
－
1
テキストノードに要素の名称を指定します。

98
rasd:InstanceID
－
1
テキストノードにインスタンスIDを指定してください。親の親要素VitualHardwareSection内で重複してはいけません。

99
rasd:ResourceType
－
1
テキストノードに3を指定します。

100
rasd:VirtualQuantity
－
1
テキストノードにCPUコア数を指定します。

101
csd:CpuClock
－
1
CPUクロック[MHz]を指定します。

102
Item（CPU）
－
1
－

103
ovf:bound
1
maxを指定します。
最大値であることを表します。

104

子要素については，defaultと同様
－
－
－

105
Item（CPU）
－
1
－

106
ovf:bound
1
minを指定します。
最小値であることを表します。

107

子要素については，defaultと同様
－
－
－

108
Item（メモリ）
－
1
－

109
ovf:bound
0-1
defaultを指定します。
本属性の指定を省略した場合，defaultとなります。

110

rasd:AllocationUnits
－
1
テキストノードに”byte*2^20”を指定します。

111
rasd:Description
－
0-1
－

112
rasd:ElementName
－
1
テキストノードに要素の名前（コメント）を指定します。

113
rasd:InstanceID
－
1
テキストノードにインスタンスIDを指定します。親の親要素VitualHardwareSection内で重複してはいけません。

114
rasd:ResourceType
－
1
テキストノードに4を指定します。

115
rasd:VirtualQuantity
－
1
テキストノードにメモリサイズ[MB]を指定します。

116
Item（メモリ）
－
1
－

117
ovf:bound
1
maxを指定します。
最大値であることを，表します。

118

子要素については，defaultと同様
－
－
－

119
Item（メモリ）
－
1
－

120
ovf:bound
1
minを指定します。
最小値であることを，表します。

121

子要素については，defaultと同様
－
－
－

122
Item（NIC）
－
VMware:
0-10※1
HVM:
0-16※2
仮想イメージテンプレートのNICの構成と同じ数だけ指定します。指定しなかったNICに対しては，csdmireserveコマンドによるリソースの割り当てがされません。

123

rasd:Description
－
0-1
テキストノードに要素の説明（コメント）を記述します。

124
rasd:ElementName
－
1
テキストノードにNICのネットワーク名を指定します。親の親要素VirtualHardwareSection内で重複してはいけません。

125
rasd:InstanceID
－
1
テキストノードにインスタンスIDを指定してください。親の親要素VitualHardwareSection内で重複してはいけません。

126
rasd:ResourceType
－
1
テキストノードに10を指定します。

127
Item（FC-HBA）
－
0以上
仮想イメージテンプレートが保持するPCIデバイス識別情報を指定します。
ハイパーバイザ種別がHVMの場合に指定できます。
ブート用のFC-HBA(B)を指定する場合は必ず1つだけ指定しなければなりません。

128

rasd:Address
－
1
テキストノードに仮想イメージテンプレートが保持するPCIデバイス識別情報を指定します。
親の親要素
VirtualHardwareSection内で重複してはいけません。

129
rasd:Description
－
0-1
テキストノードに要素の説明（コメント）を記述します。

130
rasd:ElementName
－
1
テキストノードに”FC-HBA”を指定します。

131
rasd:InstanceID
－
1
テキストノードにインスタンスIDを指定します。
親の親要素VirtualHardwareSection内で重複してはいけません。

132
rasd:ResourceSubType
－
1
FC-HBA種別を表します。

133
rasd:ResourceType
－
1
テキストノードに7を指定します。

構成パターンテンプレートのNetwork要素の定義数は，コンポーネントテンプレートのItem(NIC)に指定した数以下とする必要があります。Item(NIC)よりも多く接続先ネットワーク名を指定した場合は，csdmiregisterコマンド実行時にエラー(KFUD23127-E)となります。

コンポーネントテンプレートのItem(NIC)に指定した数より少ない場合，差分のItem(NIC)は未使用として扱います。

注※1　VMwareの制限値です。上限値はプログラムでチェックしません。

注※2　HVMの制限値です。上限値はプログラムでチェックしません。

2.3.4　ミドルウェア定義用テンプレートファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(1)　形式

ミドルウェア定義用テンプレートファイルはVTL（Velocity Template Language）で記述されます。uCSDでは次のVTLをサポートします。

可変部作成
${可変部名称}とファイルに記載することによってテンプレートファイルの可変部として識別されます。ただし，代入を行う場合だけ，${可変部名称}と記載してください。

四則演算
#set△（${可変部名称}△四則演算記号△${可変部名称}）と記載することで可変部の値で四則演算を行います。
「四則演算記号」は（+,-,/,*）をサポートします。
記載例：#set△（${aaa}△+△${bbb}）

代入
#set△（$可変部名称△=△”文字列”）
あるいは
#set△（$可変部名称△=△数値）
と記載すると可変部に文字列あるいは数値が挿入されます。
ただし，#set△${aaa}△=△${bbb}のように可変部単体を代入することはできません。このような代入を行うと，マージで定義の内容が一部欠落する場合があります（Velocityの仕様）。
（凡例）　△：半角スペース

要素に数値を記載した場合の注意事項を次に示します。

(a) 数値として扱えるのは，10進数として解釈できる範囲です※。

(b) 数値の記載として冗長な部分はVelocity変換時に次のように最適化されます。

例 | 変換前 | 変換後
（例1） | 00320 | 320 | 上位桁の”0”が除かれる
（例2） | 003.20 | 3.2 | 上位桁と小数点以下最終位の”0”が除かれる

(c) 小数がOS定義ファイルおよびミドル定義ファイルで展開される際の文字列形式：java.lang.Doubleのpublic static String toString（double d）の仕様に従います。

注※

整数として指定できる最大値と最小値（java.lang.Longで扱うことができる範囲）

小数として指定できる最大値と最小値（java.lang.Doubleで扱うことができる範囲）

(2)　ファイル名

ミドルウェア定義用テンプレートファイル名は任意です。

(3)　格納先ディレクトリ

ミドルウェア定義用テンプレートファイルの格納先は任意です。

(4)　説明

ミドルウェア定義ファイルを生成するためのテンプレートファイルです。テンプレートファイルにパラメータファイルの内容を反映させミドルウェア定義ファイルを生成します。テンプレートファイルの拡張子は「.vm 」です。

(5)　指定項目

ミドルウェア定義用テンプレートファイルの指定項目は各ミドルウェアのマニュアルを参照してください。このテンプレートの記載ルールは次のようになります。

行
行には，自然行と論理行が存在します。
自然行は一般的な行において改行コードで終わる一行の文字列であり，論理行とは改行コードの変わりにバックスラッシュ文字（¥）を使用し，改行コードをエスケープすることで隣接している複数の自然行までを含めて一行とするものです。自然行，論理行ともに記載できます。

コメント
「##」のあとに続く自然行はコメントとなります。
複数行コメントしたい場合は，「#*」と「*#」の間の自然行がコメント行となります。

可変部
可変部とはテンプレートファイルに挿入する必要がある場所を識別する識別子です。
よってパラメータファイルで定義した可変部の値をテンプレートファイルで使用する時はテンプレートファイルに${パラメータファイルの可変部名称}と記載します。

可変部名称制約
可変部名称で使用できる文字は半角アルファベット（大文字含む），半角数字，「_」，「-」です。
可変部名称の先頭は必ず「CsdU_」から始めます。

CsdU_XXXXX

（凡例）

XXXXX：1～25文字

uCSDのサイジングまたはリソース予約で決定する項目を設定する可変部名称はあらかじめ予約されています。下記の可変部名称がパラメータファイルに指定されている場合は設定順序に従い可変部の値が上書きされます。

事前に予約する項目の名称を次に示します。

項番 | 項目 | 可変部名称
1 | CPUコア数 | CsdS_CpuCore
2 | CPUクロック数 | CsdS_CpuClock
3 | メモリサイズ | CsdS_MemSize
4 | 業務用IPアドレス | CsdS_IPAddressBussinessX（X:1以上の整数）
5 | 管理用IPアドレス | CsdS_IPAddressManageX（X:1）
6 | DB用IPアドレス※2 | CsdS_DBIPAddressX（X:1）
7 | DB用ホスト名 | CsdS_DBHostNameX（X:1以上の整数）
8 | サブネットマスク | －
| 業務用 | CsdS_SubNetMaskBussinessX（X:1以上の整数）
管理用 | CsdS_SubNetMaskManageX（X:1）
9 | デフォルトゲートウェイ | －
| 業務用 | CsdS_GateWayBussinessX（X:1以上の整数）
管理用 | CsdS_GateWayManageX（X:1以上の整数）
10 | 仮想ホスト名 | CsdS_HostName
11 | パスワード | CsdS_LogInPasswd※1
12 | ユーザ名 | CsdS_LogInUserName

注※1　数値だけのパスワードが登録されている場合，Velocity変換時に，「(1)形式」に示すような数値の最適化が行われます。したがって，CsdS_LogInPasswdを使用してVelocity変換する場合は，数値だけのパスワードは登録してはいけません。

注※2　ミドルウェアにHiRDBを指定した仮想ホストの業務IPアドレス。

(1) 業務用LANが2未満の場合

ミドルウェアがHiRDBの仮想ホストの業務LANに設定されているIPアドレスを設定します。

(2) 業務用LANが2以上の場合

リソース予約対象仮想ホストの業務用LANと，ミドルウェアがHiRDBの仮想ホストの業務用LANで，同一の仮想ネットワークデバイス用途を持つNICに設定されているIPアドレスを設定します。複数存在する場合は，J2EEサーバのNICで最初に定義されているものとします。

2.3.5　ミドルウェア定義用パラメータファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　設定順序

(7)　定義生成後の出力ファイル

(1)　形式

パラメータファイルはプロパティ形式で記述します。

指定する文字列内に円記号(¥)が含まれる場合は¥¥とします。

一行に一定義を記述してください。

パスを指定する場合はダブルクォーテーション(”)で囲む必要はありません。

シャープ(#)で始まる行はコメントとなります。

空白行は無視されます。

キーの設定を省略した場合はあらかじめ設定された値が反映されます。

パスを定義する場合は絶対パスで指定してください。

コメント以外の全角文字はエラーとなります。

行末に空白やコメントは記述できません。

可変部
可変部とはテンプレートファイルに挿入する必要がある場所を識別する識別子です。パラメータファイルにはテンプレートファイルと同じ可変部を記載します。
可変部は「${可変部名称}」で設定しますが，パラメータファイルでは「可変部名称」で可変部を定義します。可変部名称は複数のパラメータファイルをまたがって同じ名称を指定できます。

可変部名称制約
可変部名称で使用できる文字は半角アルファベット（大文字含む），半角数字，「_」，「-」です。
可変部名称の先頭は必ず「CsdU_」から始めます。

CsdU_XXXXX

（凡例）　XXXXX：1～25文字

(2)　ファイル名

ミドルウェア定義用パラメータファイル名は任意です。

注　ペアとなるテンプレートファイルと同じ名前を指定してください。

(3)　格納先ディレクトリ

ミドルウェア定義用パラメータファイルの格納先は任意です。

(4)　説明

ミドルウェア定義情報一式に存在する，ミドルウェア定義の値が記載されているファイルです。固定値が記載されているパラメータファイルとデフォルト値が記載されているパラメータファイルの2種類存在します。このファイルはコンポーネントテンプレートファイルに記載したミドルウェア単位で作成します。固定値のパラメータファイルの拡張子は「.fix」，デフォルト値のパラメータファイルの拡張子は「.default」です。

(5)　指定項目

指定できるキーは各ミドルウェアのマニュアルを参考にしてください。

ミドルウェア定義用のパラメータファイルとテンプレートファイルによるミドルウェア定義ファイルの作成概要を次に示します。

図2-12　ミドルウェア定義ファイル作成概要

(6)　設定順序

定義パラメータの値をテンプレートファイルに挿入する際の設定順番は次のようになります。

したがって，定義パラメータが重複している場合は次の設定順番で上書きします。

パラメータファイル（デフォルト）

マスターイメージ
マスターイメージに設定される順序詳細：
(i)サイジングUOCで指定した定義パラメータ
(ii)マスターイメージ定義ファイルで指定した定義パラメータ
注　(i)(ii)で同一パラメータがある場合は，(ii)の情報が有効

パラメータファイル（固定値）

(7)　定義生成後の出力ファイル

項番 | デプロイ先OS | ファイル種別 | 出力ファイルの文字コード | 出力ファイルの改行コード
1 | Linux | テンプレートファイル(.vm) | UTF-8 | ¥n
2 | テンプレートファイル(.vm)およびパラメータファイル(.default/.fix)以外 | 文字コードの変換は行わない（元のファイルの文字コードを使用） | 改行コードの変換は行わない（元のファイルの改行コードを使用）
3 | Windows | テンプレートファイル(.vm) | xml形式※ | UTF-8 | ¥r¥n
4 | 上記以外 | MS932 | ¥r¥n
5 | テンプレートファイル(.vm)およびパラメータファイル(.default/.fix)以外 | 文字コードの変換は行わない（元のファイルの文字コードを使用） | 改行コードの変換は行わない（元のファイルの改行コードを使用）

注※　XMLパーサが正常に構文解析可能なら，テンプレートファイルがXML形式だと判断します。

2.3.6　OS設定用テンプレートファイル

＜この項の構成＞

(1)　形式

(2)　説明

(3)　記述形式

(1)　形式

OS設定用テンプレートファイルはVTLで記述されます。

ミドルウェア定義用テンプレートファイルの形式を参照してください。

(2)　説明

OS定義ファイルを作成するためのひな形ファイルです。OSのカーネルパラメータを変更したい場合などに使用するものです。

(3)　記述形式

ミドルウェア定義用テンプレートファイルの記述形式を参照してください。

2.3.7　OS設定用パラメータファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　記述形式

(6)　設定順序

(7)　定義生成後の出力ファイル

(1)　形式

パラメータファイルはプロパティ形式で記述します。

指定する文字列内に円記号(¥)が含まれる場合は¥¥とします。

一行に一定義を記述してください。

パスを指定する場合はダブルクォーテーション(”)で囲む必要はありません。

シャープ(#)で始まる行はコメントとなります。

空白行は無視されます。

キーの設定を省略した場合はあらかじめ設定された値が反映されます。

パスを定義する場合は絶対パスで指定してください。

コメント以外の全角文字はエラーとなります。

行末に空白やコメントは記述できません。

可変部
可変部とはテンプレートファイルに挿入する必要がある場所を識別する識別子です。パラメータファイルにはテンプレートファイルと同じ可変部を記載します。
可変部は「${可変部名称}」で設定しますが，パラメータファイルでは「可変部名称」で可変部を定義します。可変部名称は複数のパラメータファイルをまたがって同じ名称を指定できます。

可変部名称制約
可変部名称で使用できる文字は半角アルファベット（大文字含む），半角数字，「_」，「-」です。
可変部名称の先頭は必ず「CsdU_」から始めます。

CsdU_XXXXX

（凡例）　XXXXX：1～25文字

(2)　ファイル名

OS設定用パラメータファイル名は任意です。

注　ペアとなるテンプレートファイルと同じ名前を指定してください。

(3)　格納先ディレクトリ

OS設定用パラメータファイル名は任意です。

(4)　説明

OS定義情報一式に存在する，OSに設定する値が記載されているファイルです。

固定値が記載されているパラメータファイルとデフォルト値が記載されているパラメータファイルの2種類存在します。固定値のパラメータファイルの拡張子は「.fix」，デフォルト値のパラメータファイルの拡張子は「.default」です。

(5)　記述形式

ミドルウェア定義用パラメータファイルの記述形式を参照してください。

(6)　設定順序

ミドルウェア定義用パラメータファイルの設定順序を参照してください。

(7)　定義生成後の出力ファイル

ミドルウェア定義用パラメータファイルの定義生成後の出力ファイルを参照してください。

2.3.8　ミドルウェアセットアップスクリプト

ミドルウェアをセットアップするためのスクリプトが記述されたファイルです。

ファイルの記述例については製品同梱のサンプルファイルを参照してください。サンプルファイルは次の場所に格納されています。

<uCSDインストール先ディレクトリ>¥mgr¥sample¥※1¥※2¥ctHirdbDir¥script

注※1　「HVM」または「VMWare」を指定

注※2　「Windows」または「Linux」を指定

ミドルウェアセットアップスクリプト実行時のカレントディレクトリは次に設定されています。

deploy.remote.tmppathまたはdeploy.remote.tmppath.winに指定したパス※¥csd_tmp¥setup

ミドルウェアセットアップスクリプトからほかのディレクトリおよびファイルを相対パスで指定する場合は，上記で設定されたカレントディレクトからの相対パスで指定するようにしてください。

注※　システム定義ファイルcsd.propertiesで指定

2.3.9　hosts_templateファイル

デプロイしたホストに配布するhostsファイルのテンプレートです。

csdtmpregisterコマンドで登録するコンポーネントテンプレートに付属するファイルの1つです。

csdmireserveコマンド実行時にリソース予約完了したIPアドレスと仮想ホスト名が書き加えられhostsファイルが作成されます。

このファイルにはPaaS提供者が使用したい任意のIPアドレス・ホスト名を書いてください。

リソース予約機能の実行時に読み込まれ，リソース予約完了した全VMのIPアドレス，仮想ホスト名を追記していきuCSD用のhostsファイル（hostsファイルA）を作成します。

なお，このファイルはOSのhostsファイルの記述方式に従って作成してください。

＜この項の構成＞

(1)　uCSD追記内容

(2)　hostsファイル作成

(3)　hostsファイル作成後のデプロイの動作

(4)　hostsファイルの作成に失敗した場合の回復手順

(1)　uCSD追記内容

uCSDがhostsに追記するホスト名は次のとおりとします。

業務IP：「仮想ホスト名 + "-bX"」

自身の管理IP：「仮想ホスト名」と「仮想ホスト名 + "-m0"」

他ホストの管理IP：「仮想ホスト名 + "-m0"」
（凡例）
X：整数（0～構成パターンテンプレートで定義したNIC数-1）

また，hostsに記載するIPアドレスは次のとおりとします。

対象仮想ホストの管理IP

同一業務システム内の業務IP
（業務IPを持たない仮想ホストは管理IPを記載する）

フォーマットは次のとおり半角スペース1個区切りとします。

IPアドレス△仮想ホスト名-bX

IPアドレス△仮想ホスト名△仮想ホスト名-m0

（例）マスターイメージに，次の仮想ホストが存在する場合

host1（1.1.1.1(M), 2.1.1.1(B), 3.1.1.1(B)）

host2（1.1.1.2(M), 2.1.1.2(B)）

host3（1.1.1.3(M)）

hostsファイルA（host1用）追記内容:

1.1.1.1△host1△host1-m0

2.1.1.1△host1-b0

3.1.1.1△host1-b1

2.1.1.2△host2-b0

1.1.1.3△host3-m0

hostsファイルA（host2用）追記内容:

1.1.1.2△host2△host2-m0

2.1.1.1△host1-b0

3.1.1.1△host1-b1

2.1.1.2△host2-b0

1.1.1.3△host3-m0

hostsファイルA（host3用）追記内容:

1.1.1.3△host3△host3-m0

2.1.1.1△host1-b0

3.1.1.1△host1-b1

2.1.1.2△host2-b0

（凡例）

△：半角スペース１文字

X：整数（0～構成パターンテンプレートで定義したNIC数-1）

(2)　hostsファイル作成

csdmideployコマンド実行時に，構築が成功した仮想ホストに対して，uCSDが作成したhostsファイルから，仮想ホストのhostsファイルを作成します。

その際，仮想ホストを構築するための仮想イメージテンプレートに付随するhostsファイル（hostsファイルB）のバックアップを次のディレクトリに保存します。なお，次のディレクトリと同一名称のディレクトリ，またはファイルを作成しないでください。

Linuxの場合

/etc/csd_hosts_backup

Windowsの場合

%SystemRoot%System32¥drivers¥etc¥csd_hosts_backup¥hosts.bak

hostsファイルBにhostsファイルAの内容を追記し，仮想ホストに配布するhostsファイルを作成します。

hostsファイルに上記以外の変更を加えたい場合には，次の手順を実行してください。

hostsファイルBを書き換えるスクリプトを用意し※，マスターイメージ定義ファイルのOSのパッチ情報に指定する。

仮想ホストの構築前ならcsdmideployコマンドを，構築後ならcsdmiupdateコマンドを実行する。

注※

仮想ホストに，hostsファイルBのバックアップファイルが存在する場合には，バックアップファイルも書き換えるようにスクリプトを作成してください。

マスターイメージ定義ファイルのOSのパッチ情報の指定については「2.4.1　マスターイメージ定義ファイル」を参照してください。

配布されたhostsファイルは，仮想ホスト上に次のファイルとして保存されます。

Linuxの場合

/etc/hosts

Windowsの場合

%SystemRoot%¥System32¥drivers¥etc¥hosts

(3)　hostsファイル作成後のデプロイの動作

hostsファイル作成後のデプロイの動作は次のようになります。

項番
hostsファイル作成の
実行結果
hostsファイル作成後の動作
デプロイ完了後の
業務システムstatus

1
デプロイ対象のすべての仮想ホストでhostsファイル作成に成功した場合
構築処理を継続
（ミドルウェアセットアップ処理は実行する）
deployed
※　最終的なステータスはミドルウェアセットアップ処理の成否によって決定

2
デプロイ対象の仮想ホストのうち1つ以上，hostsファイル作成に失敗した場合
構築処理を中断
（ミドルウェアセットアップ処理は実行しない）
failed（deploy）

3
デプロイ対象のすべての仮想ホストに対するhostsファイル作成が失敗した場合
構築処理を中断
（ミドルウェアセットアップ処理は実行しない）
failed（deploy）

(4)　hostsファイルの作成に失敗した場合の回復手順

hostsファイル作成の実行結果は，uCSDのコマンド（csdmils）で確認できます※。

hostsファイル作成に失敗した場合は，uCSDのメッセージログにKFUD25006-Eが出力されます。

デプロイ終了後，メッセージログにKFUD25006-Eが出力された場合，次の手順でhostsファイルを再作成してください。

注※　hostsファイル作成失敗の場合，必ず業務システムstatusはfailed（deploy）に遷移します。

回復手順

hostsファイル作成に失敗した原因を取り除く

csdmiundeployコマンドで仮想ホストをアンデプロイする※

csdmideployコマンドを再度実行する

注※　この手順は省略できます。

2.4　マスターイメージ操作で使用するファイル

図2-13　マスターイメージ操作で使用するファイルの構成

表2-17　マスターイメージ操作で使用するファイルの概要

項番
ファイルの種類
概要

1
マスターイメージ定義ファイル
テンプレートの組み合わせや使用するUOCの情報など，マスターイメージ構築に使う情報を定義するファイル。

2
UOC
サイジングUOC実装クラスを格納したjar形式のファイル。

3
マスターイメージ構成ファイル
マスターイメージをエクスポートしたファイル。

4
物理配置制約ファイル
物理ホスト，仮想ホストの制約に関する情報を記述したファイル。

5
リソース定義ファイル
IPアドレスなどのネットワークに関するリソースの予約を設定するファイル。

6
OSパッチ適用スクリプト
OSにパッチを適用するためのシェルコマンドが記述されたスクリプトファイル。

7
OSパッチ本体
（ファイルセット）
OSに適用するためのパッチ群。

8
ミドルウェアパッチ適用スクリプト
ミドルウェアにパッチを適用するためのシェルコマンドが記述されたスクリプトファイル。

9
ミドルパッチ本体
（ファイルセット）
ミドルウェアに適用するためのパッチ群。

＜この節の構成＞

2.4.1　マスターイメージ定義ファイル

2.4.2　UOC

2.4.3　マスターイメージ構成ファイル

2.4.4　物理配置制約ファイル

2.4.5　リソース定義ファイル

2.4.6　OSパッチ

2.4.7　ミドルウェアパッチ

2.4.1　マスターイメージ定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

マスターイメージ定義ファイルはXML形式で記述します。

サポートするXMLファイルの文字コードはUTF-8とします。XMLファイルにはXML宣言を記述し，XML宣言におけるencodingの値にUTF-8を指定してください。

タグは，「表2-20　マスターイメージ定義ファイルのXML文法」の順番に従って記述してください。従わない場合，エラーとなることがあります。

(2)　ファイル名

マスターイメージ定義ファイルのファイル名は任意です。

(3)　格納先ディレクトリ

マスターイメージ定義ファイルの格納先は任意です。

(4)　説明

マスターイメージ定義ファイルは，テンプレートの組み合わせや使用するUOCの情報など，マスターイメージ構築で使用する情報を定義するファイルです。マスターイメージ登録を行うcsdmiregisterコマンドと，マスターイメージ更新を行うcsdmiupdateコマンドで利用します。

(5)　指定項目

次にマスターイメージ定義ファイルで定義する項目を示します。

表2-18　マスターイメージ定義ファイルの定義項目

項番 | 項目
1 | マスターイメージ名，セクション，バージョン
2 | マスターイメージの説明
3 | 構成パターンテンプレートとコンポーネントテンプレートの組み合わせ
4 | サイジングUOC
5 | ミドルウェアの固定パラメータ情報
6 | OS設定ファイルの固定パラメータ情報
7 | パッチ情報

表2-19　マスターイメージ定義ファイルのパラメータと指定方式

項番
項目
形式
説明

1
マスターイメージ名
英数字記号
1～32文字
マスターイメージ名を指定します。

2
セクション
英数字記号
1～32文字
セクションを指定します。
セクションとはマスターイメージ名の付加的な名称です。例えば，あるマスターイメージを2つの異なる物理配置に構築する場合に，マスターイメージ名が同じでも異なるセクションを設定すれば，2つの異なるマスターイメージとして登録することができます。
なお，uCSDでは，マスターイメージをマスターイメージ名＋セクションの組み合わせで区別します。
注　セクション省略を含む

3
バージョン
VV-RR
V:数字
R:数字
マスターイメージのバージョンを指定します。

4
マスターイメージの説明
文字列(日本語可)
1～255文字
マスターイメージの説明(コメント)を記述します。

5
構成パターンテンプレート名
英数字記号
1～32文字
マスターイメージのひな形として使う構成パターンテンプレート名を指定します。

6
UOCクラス名
英数字，ピリオド（.），ドル記号（$）およびアンダースコア（_）
注　ただし，パッケージ名およびクラス名の先頭は英数字1～1024文字
UOCのクラス名(パッケージ名を含む)を指定します。

7
jarファイル名
相対パス名。ただし，半角空白は指定できません。
1～160文字
UOCで使用するjarファイルを指定します。
csdmiregisterコマンドまたはcsdmiupdateコマンドの-dオプションで指定するディレクトリに配置します。

8
UOCパラメータ名
英数字記号
1～32文字
UOCの入力パラメータの名称を指定します。

9
UOCパラメータ値
文字列(日本語可)1～1024文字
UOCの入力パラメータの名称に対応する値を指定します。

10
コンポーネントID
1～65535の整数
構成パターンテンプレートのコンポーネントIDを指定します。
構成パターンテンプレートに存在するすべてのコンポーネントIDに対応するComponent要素を記述します。

11
コンポーネントテンプレート名
英数字記号
1～32文字
コンポーネントIDに当てはめるコンポーネントテンプレートを指定します。

12
ミドルウェア識別子
CosminexusまたはHiRDBの場合，次の値です。
hitachi.Cosminexushitachi.HiRDBその他の場合，次の形式で指定する（optional.を含めて10～32文字の文字列）
optional.任意の製品名任意の製品名：英数字と_.#-@()から成る文字列
コンポーネントテンプレートのミドルウェアの識別子（hitachi.Cosminexusなど）を指定します。

13
パラメータ名
CsdU_A...A
CsdU_:固定文字列
A...A: 英数字と_-
1～25文字
コンポーネントテンプレートに登録された定義情報／OS設定ファイル情報の中で，固定化したいパラメータ名を指定します。
パラメータ名とは，ミドルウェア定義用・OS設定用テンプレートファイル，ミドルウェア定義用・OS設定用パラメータファイルで使用する可変部名称のことです。

14
パラメータ値
文字列（日本語可）
1～1024文字
固定したいパラメータ名に対応する値を指定します。

15
パッチ名
相対パス名。ただし，半角空白は指定できません。
1～247文字
パッチ・ディレクトリからの相対パスでパッチスクリプトを指定します。
マスターイメージまたはVM単位で異なる可能性のあるものはコンポーネントテンプレートのミドルセットアップスクリプトではなくこちらに記載してください。

16
パッチ・ディレクトリ
絶対パス名。ただし，半角空白は指定できません。
定義に指定したパッチ・ディレクトリのパス長と，ディレクトリ内に格納したファイルのパス（パッチ・ディレクトリからの相対パス）の最大長を足した値が247文字以内に収まる長さ。
パッチ・ディレクトリのパス。絶対パスを指定します。
パッチ・ディレクトリはuCSDで管理しない（uCSDには取り込まれない）ため，PaaS提供者，またはPaaS利用者が適切に管理してください。

17
適用順序
1～65535の整数
パッチの適用順序を指定します。
適用順序はマスターイメージの一連のライフサイクル（登録・更新～削除まで）の中で，OSごとまたはミドルごとにユニークな番号とします。適用順序に65535を割り当てた場合，それ以降はパッチの追加ができなくなるので，小さい番号から順番に指定します。
なお，デプロイ後のマスターイメージにcsdmiupdateコマンドでパッチを追加する場合は，すでに指定した番号よりも大きい番号を指定します。
OS内またはミドル内での適用順序を指定するものであり，OS間またはミドル間の適用順序については，「表1-13　アップデート処理でのOS更新・ミドルウェア更新処理」「表1-36　デプロイ処理の流れ」を参照してください。

18
VLAN ID
0～4095の整数
業務LANで使用するVLAN IDを指定します。
リソース制約定義ファイルを使用している場合，利用者条件リソース制約定義ファイルの範囲内の値だけ指定できます。
範囲外を指定した場合はマスターイメージの登録が失敗します（KFUD23114-E）。
VLAN IDを指定しないで，かつリソース定義ファイルも指定しない場合は，次の値が仮定されます。

リソース制約定義ファイルを使用している場合：

リソース制約定義ファイルで指定された値のうち最小値

リソース制約定義ファイルを使用していない場合：

VLAN IDは0（VLAN使用無し）とする

表2-20　マスターイメージ定義ファイルのXML文法

項番
タグ名
属性
出現回数
説明

1
MasterImage
－
1
－

2
xmlns
1
"http://www.hitachi.co.jp/soft/xml/csd/service/masterimage_define"を指定してください。

3
name
1
マスターイメージ名を指定します。

4
section
0-1
マスターイメージのセクションを指定します。
マスターイメージ名＋セクションの組み合わせは，他マスターイメージと重複できません。

5
version
1
マスターイメージのバージョンを指定します。

6

Description
－
0-1
テキストノードにマスターイメージの説明を指定します。

7
PatternTemplate
－
1
テキストノードに構成パターンテンプレート名を指定します。
表2-13の項番6で設定した値と同じ値を設定してください。

8
Parameter(uoc.UOC種別)
－
0-1
－

9
type
1
uoc.sizingを指定します。
サイジングUOCであることを表します。

10

Property
－
1
－

11
key
1
UOCクラス名 を指定します。

12
value
1
jarファイル名 を指定します。
csdmiregisterまたはcsdmiupdate(-d)コマンドで指定するディレクトリからの相対パスを指定します。

13

Value
－
0-20
複数指定する場合には，親要素Property内でkeyの値が重複してはいけません。

14
key
1
UOCへの入力パラメータのキーを指定します。

15
value
1
キーに対応する，入力パラメータの値を指定します。

16
Component
－
1-20
－

17
id
1
構成パターンテンプレート内でこのコンポーネントを指すAbstractSystemのovf:idの値(コンポーネントID)を指定します。親要素内で重複してはいけません。
表2-13の項番30で設定した値と同じ値を設定してください。

18
template
1
コンポーネントテンプレート名を指定します。
表2-16の項番8で設定した値と同じ値を設定してください。

19
Vlan
－
0-1
－

20
businessId
1
業務LANで使用するVLAN IDを指定します。

21

Middleware
－
0-5
ミドルウェアの情報を設定します。
親要素Component内でidの値が重複してはいけません。

22
id
1
コンポーネントテンプレート内でこのミドルウェアを指すProductSectionのovf:classから”pp.”を取り除いた値を指定します。(例:hitachi.HiRDB)
表2-16の項番34で設定した値と同じ値を設定してください。

23

Parameter(fixed)
－
0-1
ミドルウェア定義情報を設定します。

24
type
1
fixedを指定します。
定義の固定化パラメータの情報であることを表します。

25

Property
－
1-100
固定化パラメータ情報を設定します。複数指定する場合には，親要素Parameter内でkeyの値が重複してはいけません。

26
key
1
固定化パラメータ名を指定します。

27
value
1
固定パラメータ名に対応した値を指定します。

28
Parameter(patch)
－
0-1
ミドルウェアのパッチ情報を設定します。

29
type
1
patchを指定します。
パッチの情報であることを表します。

30

Property
－
1-120
パッチの情報を設定します。
複数指定する場合には，親要素Parameter内でkeyおよびorderの値が重複してはいけません。

31
key
1
パッチ名を指定します。

32
value
1
パッチ・ディレクトリを指定します。

33
order
1
パッチ適用順序を指定します。

34
Parameter(fixed)
－
0-1
OS設定ファイル情報を指定します。

35
type
1
fixedを指定します。
固定化パラメータの情報であることを表します。

36

Property
－
1-10
固定化パラメータ情報を設定します。複数指定する場合には，親要素Parameter内でkeyの値が重複してはいけません。

37
key
1
固定化パラメータ名を指定します。

38
value
1
固定パラメータ名に対応した値を指定します。

39
Parameter(patch)
－
0-1
OSのパッチ情報を指定します。

40
type
1
patchを指定します。
パッチの情報であることを表します。

41

Property
－
1-120
パッチの情報を設定します。複数指定する場合には，親要素Parameter内でkeyおよびorderの値が重複してはいけません。

42
key
1
パッチ名を指定します。

43
value
1
パッチ・ディレクトリを指定します。

44
order
1
パッチ適用順序を指定します。

(6)　記述例

次にマスターイメージ定義ファイルの記述例を示します。

マスターイメージ定義ファイルの記述例

<?xml version="1.0" encoding="UTF-8"?>
<MasterImage
xmlns="http://www.hitachi.co.jp/soft/xml/csd/service/masterimage_define"
name="WEBDBsystem" section="kaihatsu" version="01-01">
 <Description>Sample web db system</Description>
 <PatternTemplate>webdbpattern</PatternTemplate>

 <Parameter type="uoc.sizing">
   <!-- sizing uoc -->
   <Property key="com.sample.WebDbSizing" value="sizing.jar">
     <!-- input parameters -->
     <Value key="pattern" value="webdb1"/>
     <Value key="dbdisksize" value="60"/>
   </Property>
 </Parameter>

 <Component id="1" template="webtemplate1">
   <Middleware id="hitachi.Cosminexus">
     <Parameter type="fixed">
       <!-- fixed parameters(middleware) -->
       <Property key="CsdU_xxxxx" value="1"/>
       <Property key="CsdU_yyyyy" value="no"/>
     </Parameter>
     <Parameter type="patch">
       <!--  M/W patch -->
       <Property key="patch1.sh" value="e:¥patch¥db¥cosmi¥patch1"
                  order="1"/>
     </Parameter>
   </Middleware>
   <Parameter type="fixed">
     <!-- fixed parameters(os files) -->
     <Property key="CsdU_zzzz" value="100"/>
   </Parameter>
   <Parameter type="patch">
     <!-- OS patch -->
     <Property key="fix1.sh" value="e:¥patch¥db¥fix1" order="1"/>
     <Property key="fix2.sh" value="e:¥patch¥db¥fix2" order="2"/>    
   </Parameter>
 </Component>

 <Component id="2" template="dbtemplate3">
   <Middleware id="hitachi.HiRDB">
     <Parameter type="fixed">
       <!-- fixed parameters(middleware) -->
       <Property key="CsdU_bbbbb" value="3"/>
     </Parameter>
   </Middleware>
 </Component>

 <Vlan businessId="10" />

</MasterImage>

2.4.2　UOC

マスターイメージ登録・更新時にサイジングを実行する場合に登録するjar形式のファイルです。jarファイルには，サイジングの処理を実装したクラスファイルを格納します。UOCの作成方法については「3.1　UOC概要」を参照してください。

2.4.3　マスターイメージ構成ファイル

マスターイメージとは，PaaS提供者またはPaaS利用者が構築した業務システムの任意の時点の構成情報一式を表します。具体的には，業務システム構築時に適用した情報（テンプレート，業務要件，サイジング結果，物理配置，確保リソースなど）を含みます。さらに，業務システム構築後にOSパッチ適用，ミドルウェアのバージョンアップ，定義値変更した場合にはそれらの情報も含みます。

uCSDは，csdmiexportコマンドによってマスターイメージをマスターイメージのスナップショットとして出力します。マスターイメージのスナップショットは，マスターイメージ構成ファイル(XMLファイル)と，その他の定義ファイルなどを含むファイル一式として出力します。

表2-21　マスターイメージのスナップショットのファイル一覧

項番 | ファイル種別 | 説明
1 | マスターイメージ構成ファイル | マスターイメージの構成を表すファイル。読み込み専用のファイルとして出力します。
2 | マスターイメージ定義ファイル | マスターイメージ登録・更新に使用した，マスターイメージ定義ファイル。
3 | 物理配置制約ファイル | 物理配置算出に使用した，物理配置制約ファイル。
4 | リソース定義ファイル | リソース予約に使用したリソース定義ファイル。
5 | UOCのjarファイル | マスターイメージ登録・更新時に登録したUOCのjarファイル。
6 | ミドルウェア定義ファイル | デプロイするホストごとに生成したミドルウェア定義ファイル。
7 | OS設定ファイル | デプロイするホストごとに生成したOS設定ファイル。
8 | hostsファイル | デプロイするホストごとに生成したhostsファイル。

2.4.4　物理配置制約ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　格納先ディレクトリ

(4)　説明

(5)　指定項目

(6)　記述例

(1)　形式

物理配置制約ファイルはXML形式で記述します。

(2)　ファイル名

物理配置制約ファイルのファイル名は任意です。

(3)　格納先ディレクトリ

物理配置制約ファイルの格納先は任意です。

(4)　説明

物理配置候補算出を行う際に読み込まれるファイルです。物理配置候補算出を行う際の制約を記述します。物理配置制約ファイルではファイル内に記載された制約の順に適用します。物理構成定義ファイルと同様に，XML形式の物理配置制約ファイルに対応するXMLのスキーマ定義が必要です。物理配置候補算出を行うcsdmiposコマンド実行時に利用します。

(5)　指定項目

次に物理配置制約ファイルの記述内容を示します。

表2-22　物理配置制約ファイルのパラメータ指定方式

項番
項目
形式

1
物理ホストグループに関する制約条件名
文字列
1～32文字

2
物理ホストグループに関する制約条件に設定する値
文字列
1～64文字

3
物理ホストに関する制約条件名
文字列
1～32文字

4
物理ホストに関する制約条件に設定する値
文字列
1～64文字

5
ホストID
整数型

6
仮想ホストに関する制約条件名
文字列
1～32文字

7
仮想ホストに関する制約条件に設定する値
文字列
1～256文字

表2-23　物理配置制約ファイルのXML文法

項番 | タグ名 | 属性 | 出現回数 | 説明
1 | cx_restriction_doc | － | 1 | －
2 | xmlns | － | http://www.hitachi.co.jp/soft/xml/csd/resource/restrictionを指定します。
3 |  | cx_physicalhost_group | － | 1 | －
4 |  | cx_physicalhost_group_condition | － | 0以上 | －
cx_name | 1 | 物理ホストグループに関する制約条件名を指定します。
cx_value | 1 | 物理ホストグループに関する制約条件に設定する値を指定します。
5 | cx_physicalhost | － | 1 | －
6 |  | cx_physicalhost_condition | － | 0以上 | －
cx_name | 1 | 物理ホストに関する制約条件名を指定します。
cx_value | 1 | 物理ホストに関する制約条件に設定する値を指定します。
7 | cx_VM※ | － | 1以上 | －
cx_id | 1 | ホストIDを指定します。
8 |  | cx_vm_condition | － | 0以上 | －
cx_name | 1 | 仮想ホストに関する制約条件名を指定します。
cx_value | 1 | 仮想ホストに関する制約条件に設定する値を指定します。

注※　マスターイメージに存在する仮想ホスト数分指定してください。

マスターイメージに存在する仮想ホスト数と一致しない場合はエラーとなります。

表2-24　物理配置制約ファイルに記述する制約条件

項番
項目
説明
制約条件名（name）
値（value）

1
物理ホストグループ
（cx_physicalhost_group_conditionタグのcx_name属性に指定します）
特定の仮想ホスト同士を別々の物理ホストグループ上に配置します。
（例：HA構成）
physicalhost_group_besides
別々の物理ホストグループ上に配置する仮想ホストのID※3

2
特定の仮想ホスト同士を同一物理ホストグループ上に配置します。
（例：同一物理ホストグループ内で業務システムを構築）
physicalhost_group_with
同一物理ホストグループ上に配置する仮想ホストのID※3

3
特定の物理ホストグループを物理配置候補から除外します。
（csdrscstatusコマンドで物理ホストグループの状態を「対象外」にされる前に物理配置候補算出を行う場合）
physicalhost_group_exclusion
除外する物理ホストグループ名

4
物理ホスト
（cx_physicalhost_conditionタグのcx_name属性に指定します）
特定の仮想ホスト同士を別々の物理ホスト上に配置します。
physicalhost_besides
別々の物理ホスト上に配置する仮想ホストのID※3

5
特定の仮想ホスト同士を同一物理ホスト上に配置します。
physicalhost_with
同一物理ホスト上に配置する仮想ホストのID※3

6
特定の物理ホストを物理配置候補から除外します。
（csdrscstatusコマンドで物理ホストの状態を「対象外」にされる前に物理配置候補算出を行う場合）
physicalhost_exclusion
除外する物理ホストのIPアドレス

7
物理ホストグループの名称
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先を直接指定する際に記述します。
physicalhost_group_name
物理ホストグループの名称

8
物理ホストのIPアドレス
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先を直接指定する際に記述します。
physicalhost_IP
IPアドレス

9
負荷分散機接続設定プロパティファイル名
（cx_vm_conditionタグのcx_name属性に指定します）
ロードバランサを個別に設定する場合に負荷分散機接続設定プロパティファイル名を指定します。
LB_name
負荷分散機接続設定プロパティファイル名

10
データストア名
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先データストアを直接指定する際に記述します。
仮想ホストのハイパーバイザ種別がVMwareの場合に指定できます※1。
datastore
データストア名

11
ストレージのリソース名
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先ストレージを直接指定する際にストレージのリソース名を記述します。
仮想ホストのハイパーバイザ種別がHVMの場合に指定できます※1。
必ずストレージプール名と同時に指定してください※2。
storage_resource
ストレージのリソース名

12
ストレージプール名
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先ストレージプールを直接指定する際に記述します。
仮想ホストのハイパーバイザ種別がHVMの場合に指定できます※1。
必ずストレージのリソース名と同時に指定してください※2。
storage_pool
ストレージプール名

13
リソースプール名
（cx_vm_conditionタグのcx_name属性に指定します）
仮想ホストの配置先リソースプール名を直接指定する際に記述します。
仮想ホストのハイパーバイザ種別がVMwareの場合に指定できます※1。
必ず物理ホストのIPアドレスと同時に指定してください※2。
resource_pool
リソースプール名

注※1　仮想ホストのハイパーバイザ種別と異なる制約条件を指定した場合はエラーとなります。

注※2　指定必須の制約条件を指定していない場合はエラーとなります。

注※3　マスターイメージに存在する仮想ホストのホストIDではない場合はエラーとなります。

表2-25　制約として定義してはいけないケース

項番 | ケース
1 | 仮想ホストを別々の物理ホストグループに配置する制約（physicalhost_group_beside）と同一の物理ホストグループに配置する制約（physicalhost_group_with）に設定する値が同じ場合
2 | 仮想ホストを別々の物理ホストに配置する制約（physicalhost_beside）と同一の物理ホストに配置する制約（physicalhost_with）に設定する値が同じ場合
3 | 仮想ホストを別々の物理ホストグループに配置する制約（physicalhost_group_beside）と同一の物理ホストに配置する制約（physicalhost_with）に設定する値が同じ場合
4 | 指定したIPアドレスの物理ホストグループに所属しない物理ホストのIPアドレスを指定した場合
5 | 存在しない物理ホストグループまたは物理ホストのIPアドレスを指定した場合
6 | 物理配置候補から除外する物理ホストグループのIPアドレスと仮想ホストの配置先を直接指定する際の物理ホストグループのIPアドレスが同じ場合
7 | 物理配置候補から除外する物理ホストのIPアドレスと仮想ホストの配置先を直接指定する際の物理ホストのIPアドレスが同じ場合
8 | 存在しないLBを指定した場合
9 | 存在しないデータストアを指定した場合
10 | 存在しないストレージのリソース名，ストレージプール名の組み合わせを指定した場合
11 | 存在しないリソースプールを指定した場合

制約として定義してはいけないケースに該当した場合はエラーとなります。

(6)　記述例

次に物理配置制約ファイルの記述例を示します。

物理配置制約ファイルの記述例

<?xml version="1.0" encoding="UTF-8"?>
<cx_restriction_doc xmlns="http://www.hitachi.co.jp/soft/xml/csd/resource/restriction">
<cx_physicalhost_group>
   <cx_physicalhost_group_condition cx_name="physicalhost_group_with" cx_value="1,2" />
</cx_physicalhost_group>
< cx_physicalhost >
   < cx_physicalhost _condition cx_name=" physicalhost_besides" cx_value="1,2" />
</ cx_physicalhost >
<cx_VM cx_id="1" >
　<cx_vm_condition cx_name=”physicalhost_group_name” cx_value=”PhysicalHostGroup1” />
</cx_VM>
<cx_VM cx_id="2">
 <cx_vm_condition cx_name="physicalhost_IP" cx_value="10.209.150.102" />
</cx_VM>
</cx_restriction_doc>

2.4.5　リソース定義ファイル

＜この項の構成＞

(1)　形式

(2)　ファイル名

(3)　説明

(4)　記述例

(1)　形式

リソース定義ファイルはCSV形式で記述します。

(2)　ファイル名

リソース定義ファイルのファイル名は任意です。

(3)　説明

リソース予約を行う際，uCSDとして仮想ホストに割り当てるIPアドレスをリソース定義ファイルに定義します。なお，指定できるIPアドレスはIPアドレス設定ファイルで定義した範囲内に限ります。リソース定義ファイルが存在しない場合はIPアドレステーブルから割り当てます。

uCSDのコマンドであるcsdmireserveの引数でリソース定義ファイルの格納パスを渡すことでリソース予約を行います。本ファイルを基にリソース予約で決定したIPアドレスと仮想ホスト名を利用してhostsファイルを自動作成します。

リソース定義ファイルでのIPアドレスの指定方式は2つあります。

IPアドレス指定
指定したIPアドレスを割り当てます。指定したIPアドレスは，IPアドレス設定ファイルで定義した値を指定します。IPアドレス個別指定だけ可能であり，IPアドレス範囲指定はできません。

IPアドレスグループ指定
指定したIPアドレスグループから未使用のIPアドレスを割り当てます。

リソース定義ファイルを使用してIPアドレスを設定する仮想ホストについては，管理用・業務用両方のIPアドレスまたはIPアドレスグループ指定を行う必要があります。管理用をIPアドレス指定・業務用をIPアドレスグループ指定または，管理用をIPアドレスグループ指定・業務用をIPアドレス指定のように混在することは可能です。

表2-26　リソース定義ファイルの指定パターン

カラム#(→)
1
2
3
4
5
6

指定パターン
(↓)
ホストID
IPアドレス
IPアドレス
グループ
VLAN ID
仮想ホスト名
仮想ネットワークデバイス用途

1
◎
◎
×
○
○
○※

2
◎
×
◎
○
○
○※

（凡例）

◎：必須

○：任意

×：指定不可

注※

ホストIDの示す仮想ホストが業務用仮想NICを複数持つ場合は，指定必須です。

次の表にリソース定義ファイルの詳細を説明します。

表2-27　リソース定義ファイルの内容詳細

項番
項目
説明
対象※1
設定値※2
備考

1
ホストID
ホストIDを定義します。
○
－
省略不可

2
IPアドレス
リソース予約として対象仮想ホストに割り当てたいIPアドレスを定義します。
IPv4の形式で指定してください。IPアドレスの範囲指定はできません。
－
○
IPアドレスグループ番号とは互いに排他でどちらか一方の設定が必須です。

3
IPアドレス
グループ番号
割り当てたいIPアドレスグループ番号を定義します。
IPアドレスグループ番号は省略可能で省略された場合には，リソース予約の際，該当IPアドレスに対するIPアドレスグループ番号は考慮せずにリソース予約されます。
－
○
IPアドレスとは互いに排他でどちらか一方の設定が必須です。

4
VLAN ID
割り当てたいVLAN IDを定義します。
0：VLAN IDが割り当てられていないIPアドレス
1～4095※4：VLAN IDが割り当てられている
リソース制約定義ファイルを使用していない場合の動作：
VLAN ID指定省略時

管理LAN
0として扱います。

業務LAN
マスターイメージ定義ファイルで業務用VLAN IDを指定した値を使用します。マスターイメージ定義ファイルで指定しない場合は0として扱います。

リソース制約定義ファイルを使用している場合の動作：※3
リソース制約定義ファイルの範囲内の値だけ指定できます。範囲外を指定した場合はエラーとなります（KFUD24221-E）。
VLAN ID指定省略時

管理LAN
リソース制約定義ファイルからuCSDが自動で払い出します。

業務LAN
マスターイメージ定義ファイルで業務用VLAN IDを指定した値を使用します。マスターイメージ定義ファイルで指定しない場合はリソース制約定義ファイルからuCSDが自動で払い出します。

－
○
省略可

5
仮想ホスト名
割り当てたい仮想ホスト名を定義します。1～15バイトの英数字およびハイフン（-）で記載してください。ただし，文字列の先頭と末尾にハイフン（-）は使用できません。また，数字だけの文字列も指定できません。※5
同一ホストに対しては同じ仮想ホスト名を指定してください。異なる仮想ホスト名を指定した場合，何が設定されるか不定です。誤った仮想ホスト名が設定された場合は，該当ホストのリソース開放を行い，再度リソース予約してください。
省略時は「”H”+”マスターイメージID(8桁)”+”ホストID(6桁)”」を自動的に割り当てます。(例:H99999999000001​)
－
○
省略可

6
仮想ネットワークデバイス用途
IPアドレスを割り当てる接続先ネットワーク名を定義します。構成パターンテンプレートのNetwork要素に記載した仮想ネットワークデバイス用途を指定します。
○
－
業務用仮想NICが2つ以上の仮想ホストの場合は，省略できません。

注※1　対象：表項番3～項番5以降の値を設定する対象を指定します。

注※2　設定値：リソース予約において値を決定するものです。

注※3　VLAN IDの優先順位は次のとおりです。

管理LAN
リソース制約定義ファイル < リソース定義ファイル

業務LAN
リソース制約定義ファイル < マスターイメージ定義ファイル < リソース定義ファイル

注※4　分散仮想スイッチを使用する場合は1～4094としてください。4095を指定した場合デプロイ時にエラーとなります。

注※5　uCosminexus Application Serverを使用する仮想ホストの場合，仮想ホスト名の先頭は英字にしてください。先頭に英字以外を使用した場合はデプロイの実行時にuCosminexus Application Serverのセットアップが失敗します。

同じホストID,IPアドレスタイプを示すIPアドレスまたはグループ番号を複数記載した場合は，エラーとします。

リソース定義ファイルの7カラムから9カラムは，uCSDによって予約されています。したがって，リソース定義ファイルに7カラム以上指定した場合の動作は次のとおりです。

7カラムから9カラムに値を指定
指定した値を無視して，リソース予約処理を続行します。

10カラム以降に値を指定
KFUD24005-Eエラーとなり，リソース予約処理を中止します。

表2-28　リソース定義ファイルでの定義フォーマット

名称
定義フォーマット

IPアドレス指定
注　IPアドレス指定を行った場合は，IPアドレスグループ指定があっても無視します。
IPアドレス単独指定形式
ホストID,IPアドレス,,VLAN ID,仮想ホスト名

IPアドレス指定
（業務用仮想NICが2以上の場合）
ホストID, IPアドレス,,VLAN ID,仮想ホスト名,仮想ネットワークデバイス用途

IPアドレスグループ指定
ホストID,,IPアドレスグループ番号,VLAN ID,仮想ホスト名

(4)　記述例

次にリソース定義ファイルの記述例を示します。

リソース定義ファイルの記述例

1,1.1.1.10,,10,host41
1,2.1.1.20,,20,host41
2,,5,10,host42
2,,9,20,host42

2.4.6　OSパッチ

OSに適用するパッチファイル本体と，適用させるためのパッチスクリプトを用意します。用意したパッチをマスターイメージに登録するためには，作成したパッチファイルの情報をマスターイメージ定義ファイルに記述し，csdmiregisterコマンド，または，csdmiupdateコマンドを実行します。登録したパッチファイルは，csdmideployコマンド実行時にスクリプトが実行され適用されます。

なお，マスターイメージがデプロイされていれば，csdmiupdateコマンド実行時にスクリプトが実行されパッチが適用されます。

OSパッチ適用スクリプト実行時のカレントディレクトリは次のように設定されています。

deploy.remote.tmppathまたはdeploy.remote.tmppath.winに指定したパス※ ¥csd_tmp¥patch

注※　システム定義ファイル（csd.properties）で指定

OSパッチ適用スクリプトからほかのディレクトリおよびファイルを相対パスで指定する場合は，上記で設定されたカレントディレクトからの相対パスで指定するようにしてください。

2.4.7　ミドルウェアパッチ

各ミドルウェアに適用するためのパッチファイル本体と，適用させるためのパッチスクリプトを用意します。用意したパッチをマスターイメージに登録するためには，作成したパッチファイルの情報をマスターイメージ定義ファイルに記述し，csdmiregisterコマンド，または，csdmiupdateコマンドを実行します。登録したパッチファイルは，csdmideployコマンド実行時に，仮想ホストの構築とミドルウェア定義配置の後に実行され，ミドルウェアに適用されます。

なお，マスターイメージがデプロイされていれば，csdmiupdateコマンド実行時にスクリプトが実行されパッチが適用されます。

ミドルウェアパッチ適用スクリプト実行時のカレントディレクトリは次のように設定されています。

deploy.remote.tmppath.winに指定したパス※ ¥csd_tmp¥patch

注※　システム定義ファイル(csd.properties)で指定

ミドルウェアパッチ適用スクリプトからほかのディレクトリおよびファイルを相対パスで指定する場合は，上記で設定されたカレントディレクトからの相対パスで指定するようにしてください。

3.　UOC

この章ではuCSDで提供するUOCについて説明します。

＜この章の構成＞

3.1　UOC概要

3.2　UOCの種類

3.3　UOC作成時の注意点

3.4　UOC詳細

3.1　UOC概要

uCSDでサイジングの際に，ユーザ独自の処理を行うために呼び出されるプログラムをUOC(User Own Coding)といいます。UOCは業務に合わせて任意に作成してください。

UOCのコーディングには，Javaを使用します。

3.2　UOCの種類

uCSDでは次のUOCを提供します。UOCを作成する場合は，次の抽象クラスから使用したいメソッドをオーバーライドしてください。

表3-1　uCSDで提供するUOCと抽象クラス

UOC名 | 抽象クラス名 | 用途
サイジングUOC | SizingUocクラス | ユーザ処理においてサイジングを実行するメソッドを提供します。
ミドルセットアップUOC | IMiddleSetupUocクラス | デプロイ・アンデプロイの延長で実行するUOCを提供します。

＜この節の構成＞

3.2.1　サイジングUOC

3.2.2　ミドルセットアップUOC

3.2.1　サイジングUOC

ユーザ処理においてサイジングを実行するメソッドを提供します。

サイジングUOCとuCSD間では次の情報の受け渡しが行われます。それぞれの情報の詳細については，「3.4　UOC詳細」を参照してください。

uCSDでUOC用に提供するクラス・メソッド一覧を次に示します。

表3-2　uCSDでUOC用に提供するクラス・メソッド一覧

項番 | クラス名 | クラスの説明 | メソッド名 | メソッドの説明
1 | SizingUoc | サイジングUOCの抽象クラス | executeSizing | サイジング時に呼び出されるメソッド
2 | SizingParameter | サイジングパラメータを格納したクラス | getComponentPropertiesList | テンプレートまたはマスターイメージ定義ファイルに指定した情報を取得するメソッド
3 | getUocProperties | マスターイメージ定義ファイルに指定したUOCパラメータを取得するメソッド
4 | getDataFilePath | サイジングUOCのjarファイルおよび付属ファイルを配置しているパスを取得するメソッド
5 | SizingResult | サイジング結果を格納したクラス | getComponentPropertiesList | サイジング結果を設定するオブジェクトを取得するメソッド
6 | CsdUocException | UOCの例外クラス | Exceptionクラスのメソッドを引き継ぎます。 | UOCでの例外

表3-3　uCSDがサイジングUOCに渡す情報

項番 | クラス名 | 説明
1 | SizingParameter | サイジングパラメータ

表3-4　サイジングUOCがuCSDに渡す情報

項番 | クラス名 | 説明
1 | SizingResult | サイジング結果

3.2.2　ミドルセットアップUOC

uCSDが提供する抽象クラスを継承し，PaaS提供者が実現したい機能を実装します。

ミドルセットアップUOCで提供するインタフェースを次に示します。

表3-5　ミドルセットアップUOCで提供するインタフェース

項番
クラス名
クラスの説明
メソッド名
メソッドの説明

1
IMiddleSetupUoc
ミドルセットアップUOCのインタフェース
executeUpdateFinalizer
デプロイコマンド終了直前に実行します。

2
executeUndeployInitializer
アンデプロイコマンド実行直後に実行します。

3
IMiddleSetup
セットアップ・アンセットアップ実装クラスのインタフェース
setup
連携製品のセットアップを実装します。

4
unsetup
連携製品のアンセットアップを実装します。

5
IMiddleSetupInformation
uCSDが保持しているマスターイメージ，仮想ホスト情報を取得するクラスのインタフェース
getVmProperyList
セットアップ・アンセットアップ対象の仮想ホスト情報を持つクラスのリストを取得します。

6
getTargetMiInfo
セットアップ・アンセットアップ対象のマスターイメージの情報を取得します。

7
getCsdSystemProperty
uCSDの定義などを取得します。

8
getRemoteHost
ConnectManager
リモートホストに接続し，リモートホスト操作（ファイル転送やコマンド実行）をするクラスを取得します。

9
getUocLockManager
リモートホスト操作（ファイル転送やコマンド実行）において，処理の排他を制御するためのクラスを取得します。

10
IVmProperty
仮想ホスト情報を保持するクラスインタフェース
getHostname
仮想ホストのホスト名を取得します。

11
getIpaddress
仮想ホストのIPアドレスを取得します。

12
getUser
仮想ホストのユーザ名を取得します。

13
getPass
仮想ホストのユーザに対応するパスワードを取得します。

14
getVmId
仮想ホストIDを取得します。

15
getMiddleware
仮想ホストにインストールされているミドルウェアのリストを取得します。

16
getOs
仮想ホストのOSを取得します。

0：Linux

1：Windows

17
getConnectionPort
仮想ホストの通信用コネクションポートを取得します。

Linux：csd.properties#deploy.ssh.port

Windows：139

18
IMiProperty
マスターイメージ情報を保持するクラスインタフェース
getId
マスターイメージIDを取得します。

19
getName
マスターイメージ名を取得します。

20
getVmNumber
マスターイメージの仮想ホスト数を取得します。

21
getParameter
マスターイメージに記述されたUOC用パラメータを取得します。

22
IHostProperty
ホストの情報を格納するインタフェース
getHostname
ホスト名を取得します。

23
getIpaddress
IPアドレスを取得します。

24
getUser
ユーザ名を取得します。

25
getPass
パスワードを取得します。

26
IRemoteHostConnector
リモートホストに接続し，リモートホスト操作（ファイル転送やコマンド実行）をするインタフェース
putFile
リモートホストへファイル/ディレクトリを転送します。

27
getFile
リモートホストからファイル/ディレクトリを取得します。

28
execCommand
リモートホスト上でコマンドを実行します。

29
IRemoteHostConnectManager
リモートホストに接続し，リモートホスト操作（ファイル転送やコマンド実行）をするマネージャのインタフェース
newInstance
IRemoteHostConnectorインタフェースの実装クラスのインスタンスを取得します。

30
IUocLockTable
リモートホスト操作（ファイル転送やコマンド実行）において，処理の排他を制御するインタフェース
lock
排他ロックを取得します。

31
unLock
排他ロックを解除します。

32
IUocLockManager
リモートホスト操作（ファイル転送やコマンド実行）において，処理の排他を制御するマネージャのインタフェース
getInstance
IUocLockTableインタフェースの実装クラスのインスタンスを取得します。

3.3　UOC作成時の注意点

UOCを作成する際の注意点を次に示します。

表3-6　UOC実装クラスを生成する際の注意点

項番
注意点
説明

1
パッケージ名
UOCを実装したクラスを格納するパッケージ名は任意ですが，javaのパッケージ命名規約に従います。

2
UOC実装クラスのアクセス制限
uCSDから各クラスを呼び出すため，クラスおよびオーバーライドするメソッドはpublicとしてください。

3
UOC実装クラスのコンストラクタ
コンストラクタ内で処理が必要な場合は，引数無しのコンストラクタを作成してください。その際，コンストラクタのアクセス制限はpublic にしてください。

4
UOC実装クラスのファイナライザ
UOC実装クラスのファイナライザについては，Javaの仕様に従います。uCSDからコールすることはありません。

5
UOC実装クラスのインスタンス化
UOC実装クラスは，UOCを呼ぶたびにインスタンス化されます。

6
UOC実装クラスの例外処理
UOCから例外をthrowする場合は，CsdUocExceptionクラスを使用してください。UOC内でエラーが発生した場合は，例外をthrowすることで，uCSDにエラーが発生したことを通知します。

7
UOC実装クラスでのメソッドの戻り値
UOCの各メソッドでは戻り値を返却します。UOC内での処理結果をuCSDへ返却する場合，戻り値を設定してください。

8
コーディング

System.exitやSystem.setPropertyなど，システム全体に影響を及ぼすメソッドは発行しないでください。

入力を求める処理・無限ループになる処理は行わないでください。

割り込みが発生した場合（Thread.isInterrupted()で読み取れる）は，直ちに資源を解放し処理を終了してください。

InterruptedExceptionが発生した場合は直ちに資源を解放し上位に例外をthrowしてください。

SizingResultクラスに設定するPropertiesオブジェクト生成時，引数を持つPropertiesクラスのコンストラクタProperties(Properties defaults)を使用しないでください。使用しても引数に指定した値は無視されます。

3.4　UOC詳細

UOCを作成するためのメソッドを示します。これらを利用するためのパッケージ名は次のとおりです。

パッケージ名 | 説明
jp.co.Hitachi.soft.csd.server.uoc | UOCパッケージ

＜この節の構成＞

SizingUocクラス

SizingParameterクラス

SizingResultクラス

CsdUocExceptionクラス

IMiddleSetupUocクラス

IMiddleSetupクラス

IMiddleSetupInformationクラス

IVmPropertyクラス

IMiPropertyクラス

IHostPropertyクラス

IRemoteHostConnectorクラス

IRemoteHostConnectManagerクラス

IUocLockTableクラス

IUocLockManagerクラス

SizingUocクラス

ユーザ処理においてサイジングを実行するメソッドを提供します。

executeSizingメソッド

形式

public SizingResult executeSizing(
      SizingParameter      sizingParameter
);

説明

csdmiregisterコマンド（-sオプション指定）またはcsdmiupdateコマンド（-sオプション指定）によって，マスターイメージのサイジングをする場合に実行されるメソッドです。

このUOCには，構成パターンテンプレートのコンポーネントごとに，業務を運用するのに十分な性能・台数のサーバを算出し，その結果をuCSDに渡すまでの処理を作成します。

戻り値としてSizingResultに値が設定されなかった場合は，デフォルト値を採用します。ただし，コンポーネントIDは設定必須とします。

引数

クラス名 | 説明
SizingParameter | サイジングパラメータ

例外

クラス名 | 説明
CsdUocException | UOC内で例外が発生

UOC内から例外を送出した場合はサイジング処理を停止します。

戻り値

クラス名 | 説明
SizingResult | サイジング結果

注意事項

なし

SizingParameterクラス

サイジング時にマスターイメージ定義ファイルに記載されたサイジングに必要な情報を取得するクラスです。

getComponentPropertiesListメソッド

形式

public　java.util.List<java.util.Properties> getComponentPropertiesList ();

説明

マスターイメージ定義ファイルに記載されたコンポーネントIDごとの情報を取得するメソッドです。

引数

なし

例外

なし

戻り値

インタフェース名
説明

java.util.List<java.util.Properties>
コンポーネントごとにList化されています。
キーを指定することで値を取得できます。キーと取得できる情報の一覧は「表3-7　getComponentPropertiesListメソッドで取得できる情報一覧」を参照してください。

表3-7　getComponentPropertiesListメソッドで取得できる情報一覧

項番
クラス名
キー
説明
取得できる情報（バリュー）

1
java.util.Properties
componentID
コンポーネントID
構成パターンテンプレートのコンポーネントID

2
serverkind
物理/仮想ホスト種別
Virtual

3
hypervisor
ハイパーバイザ種別
serverkindがVirtualのときだけ存在するキー
コンポーネントテンプレートのハイパーバイザ種別

4
os.kind
OS種別
コンポーネントテンプレートのOS種別

5
os.version
OSバージョン
コンポーネントテンプレートのOSのバージョン

6
os.configurepath
OS設定ファイル格納ディレクトリパス
コンポーネントテンプレートのOS設定ファイル格納ディレクトリ

7
os.param.<パラメータ名>※1
OSパラメータ
マスターイメージ定義ファイルのOSのパラメータ値

8
cpuclock.default
CPUクロックのデフォルト値[MHz]
コンポーネントテンプレートのCPUクロックのデフォルト値
<Item>要素のovf:bound属性がdefaultの個所

9
cpuclock.min
CPUクロックの最小値[MHz]
コンポーネントテンプレートのCPUクロックの最小値
<Item>要素のovf:bound属性がminの個所

10
cpuclock.max
CPUクロックの最大値[MHz]
コンポーネントテンプレートのCPUクロックの最大値
<Item>要素のovf:bound属性がmaxの個所

11
cpucore.default
CPUコア数のデフォルト値
コンポーネントテンプレートのCPUコア数のデフォルト値
<Item>要素のovf:bound属性がdefaultの個所

12
cpucore.min
CPUコア数の最小値
コンポーネントテンプレートのCPUコア数の最小値
<Item>要素のovf:bound属性がminの個所

13
cpucore.max
CPUコア数の最大値
コンポーネントテンプレートのCPUコア数の最大値
<Item>要素のovf:bound属性がmaxの個所

14
memory.default
メモリサイズのデフォルト値[MB]
コンポーネントテンプレートのメモリサイズのデフォルト値
<Item>要素のovf:bound属性がdefaultの個所

15
memory.min
メモリサイズの最小値[MB]
コンポーネントテンプレートのメモリサイズの最小値
<Item>要素のovf:bound属性がminの個所

16
memory.max
メモリサイズの最大値[MB]
コンポーネントテンプレートのメモリサイズの最大値
<Item>要素のovf:bound属性がmaxの個所

17
middleware.<ミドルウェア識別子>※2.version
ミドルウェアのバージョン
コンポーネントテンプレートのバージョン

18
middleware.<ミドルウェア識別子>.fullversion
ミドルウェアの詳細バージョン
コンポーネントテンプレートの詳細バージョン

19
middleware.<ミドルウェア識別子>.tier
ミドルウェアが起動するティア
コンポーネントテンプレートのティア

20
middleware.<ミドルウェア識別子>.scriptpath
ミドルウェアのセットアップスクリプトディレクトリのパス
コンポーネントテンプレートのスクリプト・ディレクトリ

21
middleware.<ミドルウェア識別子>.configurepath
ミドルウェアの定義格納ディレクトリパス
コンポーネントテンプレートの定義格納ディレクトリ

22
middleware.<ミドルウェア識別子>.param.<パラメータ名>
ミドルウェアの定義パラメータ
マスターイメージ定義ファイルのミドルのパラメータ値

23
middleware.<ミドルウェア識別子>.tiertype
ミドルウェアが起動するティア種別
構成パターンテンプレートのティア種別（ミドルウェアがCosminexusの場合だけ）

注※1　<パラメータ名>：マスターイメージ定義ファイルに指定した任意の文字列

注※2　<ミドルウェア識別子>：コンポーネントテンプレートに定義済みの任意の文字列

上記文字列は，マスターイメージ定義ファイルもしくはコンポーネントテンプレートに記載した数分存在します。

getUocPropertiesメソッド

形式

public　java.util.Properties getUocProperties ();

説明

マスターイメージ定義ファイルに指定したUOCパラメータを取得するメソッドです。

引数

なし

例外

なし

戻り値

インタフェース名 | 説明
java.util.Properties | キーを指定することで値を取得できます。キーと取得できる情報の一覧は「表3-8　getUocPropertiesメソッドで取得できる情報一覧」を参照してください。

表3-8　getUocPropertiesメソッドで取得できる情報一覧

項番 | クラス名 | キー | 説明 | 取得できる情報（バリュー）
1 | java.util.Properties | <UOCパラメータ名>※ | UOCパラメータ名 | マスターイメージ定義ファイルのUOCパラメータ値

注※　<UOCパラメータ名>：マスターイメージ定義ファイルに指定した任意の文字列

上記文字列は，マスターイメージ定義ファイルに記載した数分存在します。

getDataFilePathメソッド

形式

public String getDataFilePath ();

説明

サイジング実行時，サイジングUOCのjarファイルおよび付属ファイル（csdmiregisterコマンドまたはcsdmiupdateコマンドの-dオプションに指定したディレクトリに格納されているファイル）を配置したパスを取得するメソッドです。

JP1/AO連携など，リモートマシンからファイルを転送してマスターイメージを登録・更新する場合で，サイジング実行中に付属ファイルを参照したいときのファイルパス取得に使用できます。

引数

なし

例外

なし

戻り値

インタフェース名 | 説明
String | サイジングUOCのjarファイルおよび付属ファイルを配置したパスを絶対パスで返します。

SizingResultクラス

サイジング結果を格納するクラスです。サイジング結果はサイジング時にサイジングUOCからuCSDに渡されます。

getComponentPropertiesListメソッド

形式

public　java.util.List<java.util.Properties> getComponentPropertiesList ();

説明

サイジング結果を設定するListオブジェクトを取得するメソッドです。Listの各要素は，マスターイメージ定義ファイルに記載したコンポーネントIDに対応しています。

引数

なし

例外

なし

戻り値

インタフェース名 | 説明
java.util.List<java.util.Properties> | サイジング結果を設定するListオブジェクトです。Listの要素となるjava.util.Properties型のオブジェクトに設定するキーと値の一覧は，「表3-9　getComponentPropertiesListメソッドで取得できる情報一覧」を参照してください。

表3-9　getComponentPropertiesListメソッドで取得できる情報一覧

項番
クラス名
キー※1
説明
指定可能範囲
デフォルト値
VTL可変部予約語との対応

1
java.util.Properties
componentID
コンポーネントID
構成パターンテンプレートのコンポーネントID形式
なし（指定必須）
「表3-7　getComponentPropertiesListメソッドで取得できる情報一覧」のクラスのコンポーネントID
－

2
numberOfHost
デプロイするホスト数
10進数形式
1～20。
加えて，全コンポーネント合計で20以下とする必要がある。
同一AbstractSystemCollection内の複数のコンポーネントで異なるホスト数を返却した場合，最小の値をサイジング結果とする。
1
－

3
numberOfCpuclock
CPUクロック[MHz]
コンポーネントテンプレートのCPUクロック指定形式
コンポーネントテンプレートの最大値と最小値の範囲
コンポーネントテンプレートのデフォルト値
CsdS_CpuClock

4
numberOfCpucore
CPUコア数
コンポーネントテンプレートのCPUコア数指定形式
コンポーネントテンプレートの最大値と最小値の範囲
コンポーネントテンプレートのデフォルト値
CsdS_CpuCore

5
sizeOfMemory
メモリサイズ[MB]
コンポーネントテンプレートのメモリサイズ指定形式
コンポーネントテンプレートの最大値と最小値の範囲
コンポーネントテンプレートのデフォルト値
CsdS_MemSize

6
os.param.<パラメータ名>※2※3
OSパラメータ
1～1024文字
なし
－

7
middleware.<ミドルウェア識別子※4>.param.<パラメータ名>※5
ミドルウェアの定義パラメータ
1～1024文字
なし
－

注※1　キーが上記形式と不一致の場合，マスターイメージの登録・更新に失敗します。

注※2　<パラメータ名>：定義可変部に使用する”CsdU_”で始まるパラメータ名

注※3　キーの指定上限数は10とします。

注※4　<ミドルウェア識別子>：コンポーネントテンプレートに定義済みの任意の文字列

注※5　キーの指定上限数は30とします。

CsdUocExceptionクラス

UOCで例外をthrowする場合に使用する抽象クラスです。Exceptionクラスを継承しているので，Exceptionクラスのメソッドが使用できます。

形式

詳細メッセージを使用しない例外の場合

public CsdUocException ()

指定された詳細メッセージを使用した例外の場合

public CsdUocException (String message)

指定された詳細メッセージおよび原因を使用した例外の場合

public CsdUocException (String message, Throwable cause)

指定された原因を使用した例外の場合

public CsdUocException (Throwable cause)

引数

インタフェース名 | 説明
message | 任意の文字列 (1～255バイト)を指定します。
cause | 原因を指定します。

例外

なし

戻り値

なし

IMiddleSetupUocクラス

表3-10　IMiddleSetupUocインタフェースメソッド一覧

項番 | 戻り値 | メソッド名 | 説明
1 | void | executeUpdateFinalizer | デプロイコマンド終了直前に実行されるメソッドです。
2 | void | executeUndeployInitializer | アンデプロイコマンド実行直後に実行されるメソッドです。

executeUpdateFinalizerメソッド

形式

public void executeUpdateFinalizer(IMiddleSetupInformation middleSetupInfo)

入力

表3-11　executeUpdateFinalizerメソッドへの入力

項番 | 引数：型 | 説明 | 制限
1 | middleSetupInfo : IMiddleSetupInformation | uCSD内に保持しているマスターイメージや仮想ホスト情報を持つクラスです。 | null指定はできません。

出力

なし

例外

表3-12　エラーケース一覧

項番 | Exception | 発生理由 | 発生後の動作
1 | CsdUocException | セットアップ実行処理に失敗 | デプロイコマンド失敗にし，処理を中断します。

注意事項

なし

executeUndeployInitializerメソッド

形式

public void executeUndeployInitializer(IMiddleSetupInformation middleSetupInfo)

入力

表3-13　executeUndeployInitializerメソッドへの入力

項番 | 引数：型 | 説明 | 制限
1 | middleSetupInfo : IMiddleSetupInformation | uCSD内に保持しているマスターイメージや仮想ホスト情報を持つクラスです。 | null指定はできません。

出力

なし

例外

表3-14　エラーケース一覧

項番 | Exception | 発生理由 | 発生後の動作
1 | CsdUocException | アンセットアップ実行処理に失敗 | アンデプロイコマンド失敗にし，処理を中断します。

注意事項

なし

IMiddleSetupクラス

表3-15　IMiddleSetupインタフェースメソッド一覧

項番 | 戻り値 | メソッド名 | 説明
1 | void | setup | 連携製品のセットアップを実装するメソッドです。
2 | void | unsetup | 連携製品のアンセットアップを実装するメソッドです。

setupメソッド

形式

public void setup()

入力

なし

出力

なし

例外

表3-16　エラーケース一覧

項番 | Exception | 発生理由 | 発生後の動作
1 | CsdUocException | セットアップ処理中にエラーが発生 | デプロイコマンド失敗にし，処理を中断します。

注意事項

なし

unsetupメソッド

形式

public void unsetup()

入力

なし

出力

なし

例外

表3-17　エラーケース一覧

項番 | Exception | 発生理由 | 発生後の動作
1 | CsdUocException | アンセットアップ処理中にエラーが発生 | アンデプロイコマンド失敗にし，処理を中断します。

注意事項

なし

IMiddleSetupInformationクラス

表3-18　IMiddleSetupInformationインタフェースメソッド一覧

項番
戻り値
メソッド名
説明

1
List<IVmProperty>
getVmProperyList
セットアップ・アンセットアップ対象の仮想ホスト情報を持つクラスのリストを取得します。

2
IMiProperty
getTargetMiInfo
セットアップ・アンセットアップ対象のマスターイメージの情報を取得します。

3
Properties
getCsdSystemProperty
uCSDの定義などを取得します。

4
IRemoteHost
ConnectManager
getRemoteHost
ConnectManager
リモートホストに接続し，リモートホスト操作（ファイル転送やコマンド実行）を行うためのクラスを取得します。

5
IUocLockManager
getUocLockManager
リモートホスト操作（ファイル転送やコマンド実行）において，処理の排他を制御するためのクラスを取得します。

6
boolean
getUniUndeployFlag
仮想ホスト単位のアンデプロイ操作が行われたかどうかのフラグを取得します。

getVmPropertyListメソッド

形式

public List<IVmProperty> getVmProperyList()

入力

なし

出力

セットアップ・アンセットアップ対象の仮想ホスト情報のリストを取得します。仮想ホストの情報については，「IVmPropertyクラス」を参照してください。

例外

なし

注意事項

なし

getTargetMiInfoメソッド

形式

public IMiProperty getTargetMiInfo()

入力

なし

出力

セットアップ・アンセットアップ対象のマスターイメージ情報を取得します。マスターイメージの情報については，「IMiPropertyクラス」を参照してください。

例外

なし

注意事項

なし

getCsdSystemPropertyメソッド

形式

public Properties getCsdSystemProperty()

入力

なし

出力

uCSDの定義などの情報を取得します。取得できる情報を次の表に示します。なお，valueの値は設定変更をしていないデフォルト値です。

表3-19　getCsdSystemPropertyメソッドで取得できる情報

項番 | key | value（デフォルト） | 説明
1 | executeUser | － | マスターイメージ作成者名です。ミドルセットアップUOC実行ユーザ名を取得します。
2 | csdInstallPath | C:¥Program Files¥HITACHI¥uCSD¥ | uCSDインストールパスを取得します。
3 | userDataFilePath | <インストール先フォルダ>¥mgr¥data | uCSDのシステム定義ファイルのuser.data.filepathの値を取得します。
4 | remoteTempPath_Linux | /tmp | uCSDのシステム定義ファイルのdeploy.remote.temppathの値を取得します。仮想ホスト内一時ディレクトリ作成用です。
5 | remoteTempPath_Windows | %SystemRoot%¥Temp | uCSDのシステム定義ファイルのdeploy.remote.temppath_winの値を取得します。仮想ホスト，リモートホスト内一時ディレクトリ作成用です。

（凡例）

－：該当しません。

例外

なし

注意事項

なし

getRemoteHostConnectManagerメソッド

形式

public IRemoteHostConnectManager getRemoteHostConnectManager ()

入力

なし

出力

リモートホストに接続し，リモートホスト操作（ファイル転送やコマンド実行）を行うためのマネージャを取得します。

例外

なし

注意事項

なし

getUocLockManagerメソッド

形式

public IUocLockManager getUocLockManager()

入力

なし

出力

リモートホスト操作（ファイル転送やコマンド実行）で，処理の排他を制御するためのマネージャを取得します。

例外

なし

注意事項

なし

getUniUndeployFlagメソッド

形式

public boolean getUniUndeployFlag()

入力

なし

出力

アンデプロイ実行時，ホスト単位のアンデプロイかどうかを表すフラグ。

true：アンデプロイ実行時，ホスト指定でアンデプロイした

false：アンデプロイ実行時，マスターイメージ単位でアンデプロイした

例外

なし

注意事項

なし

IVmPropertyクラス

表3-20　IVmPropertyインタフェースメソッド一覧

項番
戻り値
メソッド名
説明

1
String
getHostname
仮想ホストのホスト名を取得します。

2
String
getIpaddress
仮想ホストのIPアドレスを取得します。

3
String
getUser
仮想ホストのユーザ名を取得します。

4
String
getPass
仮想ホストのユーザに対応するパスワードを取得します。

5
int
getVmId
仮想ホストIDを取得します。

6
List<String>
getMiddleware
仮想ホストにインストールされているミドルウェアのリストを取得します。

7
int
getOs
仮想ホストのOSを取得します。
（Linux：0，Windows：1）

8
int
getConnectionPort
仮想ホストの通信用コネクションポートを取得します。
（Linux：uCSDのシステム定義ファイルのdeploy.ssh.port，Windows：139）

IMiPropertyクラス

表3-21　IMiPropertyインタフェースメソッド一覧

項番 | 戻り値 | メソッド名 | 説明
1 | int | getId | マスターイメージIDを取得します。
2 | String | getName | マスターイメージ名を取得します。
3 | int | getVmNumber | マスターイメージの仮想ホスト数を取得します。
4 | Properties | getParameter | マスターイメージに記述されたUOC用パラメータを取得します。

IHostPropertyクラス

表3-22　IHostPropertyインタフェースメソッド一覧

項番 | 戻り値 | メソッド名 | 説明
1 | String | getHostname | ホスト名を取得します。
2 | String | getIpaddress | IPアドレスを取得します。
3 | String | getUser | ユーザ名を取得します。
4 | String | getPass | パスワードを取得します。

IRemoteHostConnectorクラス

putFileメソッド

リモートホストへファイルを転送するメソッドです。転送したファイルは常に上書きされます。このメソッドは，処理が終了するかタイムアウトするまで同期実行します。同一のリモートホストに対して，このメソッドおよびほかのメソッドを同時に複数実行した場合，先に受け付けられたメソッドが終了するまで実行は待機します。

表3-23　各プロトコルにおける転送時の仕様

項番
項目
DCOM（Windows）
SSH（Linux）

1
転送したファイルおよびフォルダに付けられるアクセス権限
転送先のディレクトリの権限が継承されます。
744(rwxr--r--)が付けられます。

2
転送したファイルおよびフォルダの日付
フォルダの日付が転送時の日付に更新されます。ファイルの日付は，作成日時，アクセス日時が更新されます。
ファイル，ディレクトリともに日付が更新されます。

3
ショートカットファイルの転送
ショートカットファイル単体の転送はできません。ただし，フォルダに格納されたショートカットファイルを転送することはできます。その場合，ショートカットファイルが示す実体ファイルではなく，ショートカットファイル自体が転送されます。
ショートカットファイルの転送はできません。
転送した場合，エラーになります。

4
隠しファイルおよびフォルダの転送
Windowsの隠しファイルおよびフォルダの転送はできます。ファイルの場合だけ隠し属性は維持されます。
Linuxの，先頭が「.」（ピリオド）の隠しファイルおよびフォルダは，転送できません。転送した場合，処理に失敗します。
Windowsの隠しファイルおよびフォルダの転送はできます。ただし，隠しファイル属性は消滅します。
Linuxの，先頭が「.」（ピリオド）の隠しファイルおよびディレクトリは，転送できます。

形式

public void putFile(String src, String dest)

入力

表3-24　入力項目一覧

項番
引数名：型
引数の意味
制限

1
src :String
転送元ファイル/フォルダパス

絶対パスを指定します。

247文字以内で指定します。※1※3

null指定はできません。

ドライブだけ（C:¥など）の指定はできません。

2
dest :String
転送先フォルダパス

絶対パスを指定します。

転送後のファイルおよびフォルダのパスを247文字以内で指定します。 ※1※2

null指定はできません。

注※1

英数字，_（半角下線），.（半角ピリオド），△（半角空白），( （半角左括弧），) （半角右括弧），パス区切りの¥¥（半角円マーク2つ）（Windowsの場合），/（スラッシュ）（Linuxの場合）が使用できます。¥¥..¥¥ および ¥¥.¥¥，*（アスタリスク），ネットワークドライブの指定，UNC形式のパス，ピリオドまたはスペースで終端するディレクトリを含めてはなりません（プログラムガードはされません）。

注※2

転送先がWindowsの場合，パスにリモートホスト上の環境変数を含めることもできます。環境変数は，リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合，%（パーセント）文字が使用できます。ただし，環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は，転送に失敗します。

注※3

パスにWindowsおよびMS-DOSの予約語を含めてはなりません。含めた場合，処理に失敗します。予約語については，「表1-8　コマンド形式の構文要素」を参照してください。

出力

入力「転送先フォルダパス」で指定したリモートホスト上のディレクトリの下に，入力「転送元ファイル/フォルダパス」で指定したファイルおよびフォルダがコピーされます。転送先のフォルダが存在しない場合は，自動で作成されます。

例外

表3-25　エラーケース一覧

項番
Exception
発生理由
（原因コード）
発生後の動作
対象リモートホスト
（Linux/Windows）

1
CsdUocRemoteExecuteAssertionFailedException
P_RemoCon.001
処理を中断し，リターンします。
共通

P_RemoCon.002

2
CsdUocRemoteExecuteIOException
P_LinSSH.001
処理を中断し，リターンします。
Linux

P_WinCOM.001
Windows

P_WinCOM.002

P_WinCOM.004

P_WinCOM.005

P_WinCOM.006

P_WinCOM.007

P_WinCOM.008

P_WinCOM.010

P_WinCOM.011

P_WinCOM.013

P_WinCOM.014

P_WinCOM.016

P_WinCOM.017

P_WinCOM.019

P_WinCOM.022

P_WinCOM.024

P_WinCOM.026

P_WinCOM.027

P_WinCOM.029

P_WinCOM.030

P_WinCOM.037

P_WinCOM.038

P_WinCOM.039

P_WinCOM.040

P_WinCOM.041

P_WinCOM.042

P_RemoCon.005

3
CsdUocRemoteExecuteTimeoutException
P_LinSSH.002
処理を中断し，リターンします。
Linux

P_WinCOM.028
Windows

注　対処方法については，マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。

注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合，異なるIPアドレスを指定して，このメソッドを複数同時実行すると，処理が失敗することがあります。

getFileメソッド

リモートホストからファイルを取得するメソッドです。転送したファイルは常に上書きされます。このメソッドは，処理が終了するかタイムアウトするまで同期実行します。同一のリモートホストに対して，このメソッドおよびほかのメソッドを同時に複数実行した場合，先に受け付けられたメソッドが終了するまで実行は待機します。

表3-26　各プロトコルにおける取得時の仕様

項番
項目
DCOM（Windows）
SSH（Linux）

1
取得したファイル/フォルダに付けられるアクセス権限
取得先のディレクトリの権限が継承されます。
取得先のディレクトリの権限が継承されます。

2
転送したファイル/フォルダの日付更新
フォルダの日付が取得時の日付に更新されます。ファイルの日付は，作成日時，アクセス日時が更新されます。
ファイル，ディレクトリともに日付が更新されます。

3
ショートカットファイル（Windowsの場合），シンボリックリンク・ハードリンク（Linuxの場合）の転送
ショートカットファイル単体の取得はできません。ただし，フォルダに格納されたショートカットファイルを転送することはできます。その場合，ショートカットファイルが示す実体ファイルではなく，ショートカットファイル自体が転送されます。
シンボリックリンク・ハードリンクの取得ができます。どちらもリンク先の実体が取得されます。

4
隠しファイルおよびフォルダの取得
Windowsの隠しファイルおよびフォルダの取得はできます。ファイルの場合だけ隠し属性は維持されます。
Linuxの，先頭が「.」（ピリオド）の隠しファイルおよびフォルダは，取得できません。取得を試みた場合，処理に失敗します。
Windowsの隠しファイルおよびフォルダの取得はできます。ただし，隠しファイル属性は消滅します。
Linuxの，先頭が「.」（ピリオド）の隠しファイル/ディレクトリは，取得できます。

形式

public void getFile(String src, String dest)

入力

表3-27　入力項目一覧

項番
引数名：型
引数の意味
制限

1
src :String
取得元ファイル/フォルダパス

絶対パスを指定します。

247文字以内で指定します。

環境変数を使用する場合は，環境変数評価後の長さが247文字以内になるように指定します。※1※2

null指定はできません。

ドライブだけ（C:¥など）の指定はできません。

2
dest :String
取得先フォルダパス

絶対パスを指定します。

247文字以内で指定します。※1※3

null指定はできません。

注※1

英数字，_（半角下線），.（半角ピリオド），△（半角空白），( （半角左括弧），) （半角右括弧），パス区切りの¥¥（半角円マーク2つ）（Windowsの場合），/（スラッシュ）（Linuxの場合）が使用できます。¥¥..¥¥ および ¥¥.¥¥，*（アスタリスク），ネットワークドライブの指定，UNC形式のパス，ピリオドまたはスペースで終端するディレクトリを含めてはなりません（プログラムガードはされません）。

注※2

取得元がWindowsの場合，パスにリモートホスト上の環境変数を含めることもできます。環境変数は，リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合，%（パーセント）が使用できます。ただし，環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は，取得に失敗します。

注※3

パスにWindowsおよびMS-DOSの予約語を含めてはなりません。含めた場合，処理に失敗します。予約語については，「表1-8　コマンド形式の構文要素」を参照してください。

出力

入力「取得先フォルダパス」で指定したローカルホスト上のフォルダの下に，入力「取得元ファイル/フォルダパス」で指定したファイル/フォルダがコピーされます。取得先のフォルダが存在しない場合は，自動で作成されます。

例外

表3-28　エラーケース一覧

項番
Exception
発生理由
（原因コード）
発生後の動作
対象リモートホスト
（Linux /Windows）

1
CsdUocRemoteExecuteAssertionFailedException
P_RemoCon.001
処理を中断し，リターンします。
共通

P_RemoCon.002

2
CsdUocRemoteExecuteIOException
P_LinSSH.001
処理を中断し，リターンします。
Linux

P_WinCOM.001
Windows

P_WinCOM.002

P_WinCOM.004

P_WinCOM.005

P_WinCOM.006

P_WinCOM.007

P_WinCOM.008

P_WinCOM.010

P_WinCOM.011

P_WinCOM.013

P_WinCOM.014

P_WinCOM.016

P_WinCOM.017

P_WinCOM.019

P_WinCOM.022

P_WinCOM.024

P_WinCOM.026

P_WinCOM.027

P_WinCOM.029

P_WinCOM.030

P_WinCOM.037

P_WinCOM.038

P_WinCOM.039

P_WinCOM.040

P_WinCOM.041

P_WinCOM.042

P_RemoCon.006

3
CsdUocRemoteExecuteTimeoutException
P_LinSSH.002
処理を中断し，リターンします。
Linux

P_WinCOM.028
Windows

注　対処方法については，マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。

注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合，異なるIPアドレスを指定して，このメソッドを複数同時実行すると，処理が失敗することがあります。

execCommandメソッド

形式

public int execCommand(String commandline)

入力

表3-29　入力項目一覧

項番
引数名：型
引数の意味
制限

1
commandline :String
実行するコマンドのパス
コマンドライン全体で1023文字以内になるように指定します。
コマンドは絶対パスを指定します。
パスの長さは247文字以内で指定します。※1※2
ただし，リモートホストのPATH環境変数に設定されていれば，コマンド名だけの実行もできます。
null指定はできません。

注※1

英数字，_（半角下線），.（半角ピリオド），△（半角空白），( （半角左括弧），) （半角右括弧），パス区切りの¥¥（半角円マーク2つ）（Windowsの場合），/（スラッシュ）（Linuxの場合）が使用できます。

注※2

リモートホストがWindowsの場合，パスにリモートホスト上の環境変数を含めることもできます。環境変数は，リモートホストへログインしたユーザの環境変数が適用されます。環境変数を使用する場合，%（パーセント）が使用できます。ただし，環境変数の展開後のパスの長さが247文字を超えないようにしてください。超えた場合は，コマンド実行が失敗します。

出力

なし

例外

表3-30　エラーケース一覧

項番
Exception
発生理由
（原因コード）
発生後の動作
対象リモートホスト
（Linux /Windows）

1
CsdUocRemoteExecuteAssertionFailedException
P_RemoCon.001
処理を中断し，リターンする。
共通

P_RemoCon.002

2
CsdUocRemoteExecuteIOException
P_LinSSH.001
処理を中断し，リターンする。
Linux

P_WinCOM.001
Windows

P_WinCOM.002

P_WinCOM.004

P_WinCOM.005

P_WinCOM.006

P_WinCOM.007

P_WinCOM.008

P_WinCOM.010

P_WinCOM.011

P_WinCOM.013

P_WinCOM.016

P_WinCOM.017

P_WinCOM.019

P_WinCOM.022

P_WinCOM.024

P_WinCOM.026

P_WinCOM.027

P_WinCOM.029

P_WinCOM.030

P_WinCOM.037

P_WinCOM.038

P_WinCOM.039

P_WinCOM.040

P_WinCOM.041

P_WinCOM.042

P_RemoCon.007

3
CsdUocRemoteExecuteTimeoutException
P_LinSSH.002
処理を中断し，リターンする。
Linux

P_WinCOM.028
Windows

注　対処方法については，マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。

注意事項

同一リモートホストに対して複数のIPアドレスが設定されている場合，異なるIPアドレスを指定して，このメソッドを複数同時実行すると，処理が失敗することがあります。

IRemoteHostConnectManagerクラス

newInstanceメソッド

IRemoteHostConnectorインタフェースの実装クラスのインスタンスを取得します。複数のリモートホストに対して通信を行う場合は，リモートホストごとにこのメソッドを実行してインスタンスを取得してください。

形式

public IRemoteHostConnector execCommand(Properties prop, String ipAddress,
           String userId, String password, CommunicationProtocol protocol)

入力

表3-31　入力項目一覧

項番
引数名：型
引数の意味
制限

1
prop :Properties (java.util.Properties)
「表3-32プロパティキー」で示すプロパティキーと対応する値をセットしたプロパティクラスのオブジェクトを指定します。
nullを指定した場合，デフォルト値を適用します。

2
ipAddress :String
リモートホストのIPアドレスを指定します。
IPv4だけです。
null指定はできません。

3
userId : String
リモートホストのユーザIDを指定します。
Windowsの場合はAdministrator権限を持つユーザだけです。
null指定はできません。

4
password :String
リモートホストのパスワードを指定します。
null指定はできません。

5
protocol :CommunicationProtocol
接続方式を指定します。
Linuxの場合：「SSH」
Windowsの場合：「DCOM」
注　enum型定数クラスでどちらかを選択します。
null指定はできません。

表3-32　プロパティキー

項番
キー
説明
必須/任意
指定範囲・条件
デフォルト値

1
RemoteHost.Port
リモートホストの接続ポート番号
任意
半角数字（1～65535）
・Linuxだけ
・Windowsの場合は変更できません。
キーと値ともにnull指定はできません。
22（Linuxの場合）
139（Windowsの場合）

2
RemoteHost.Connect.RetryNum
リモートホストへのセッション再確立回数（単位：回）
任意
半角数字（0～600）※
0を指定した場合，再確立をしません。
キーと値ともにnull指定はできません。
10

3
RemoteHost.Connect.RetryWaitTime
セッション再確立間隔（単位：ms）
任意
半角数字（0，1，1000～600000）※
再確立回数に0を指定した場合，この指定は無効になります。
キーと値ともにnull指定はできません。
5000

4
RemoteHost.Connect.SSH.execWaitTime
SSH方式で，リモートホスト上で実行したコマンドの終了を待つ時間（単位：分）
任意
半角数字（1～60）
キーと値にはnull指定はできません。
定義
deploy.sshexcutetimerで指定された値を採用します。

注※　設定値の見積もりについては，「2.2.2(6)タイマ，リトライ定義の説明」を参照してください。

出力

なし

例外

表3-33　エラーケース一覧

項番
Exception
発生理由
（原因コード）
発生後の動作
対象リモートホスト
（Linux /Windows）

1
CsdUocRemoteExcecuteAssertionFailedException
P_RemoCon.001
処理を中断し，リターンします。
共通

P_RemoCon.002

注　対処方法については，マニュアル「uCosminexus Service Director メッセージ」の「ファイル転送とコマンドのリモート実行時に出力するメッセージの原因コード」を参照してください。

注意事項

この機能を利用するために必ず実行する必要があります。

IUocLockTableクラス

lockメソッド

排他ロックを取得するメソッドです。排他ロックを開始したい所でこのメソッドを実行します。引数lockKeysのListに，取得したいロックのキーを指定することで，そのキーをロックオブジェクトとして排他ロックを取得することができます。ロックキーとして，IPアドレスの文字列を与えることによって，VM単位で排他制御を行うことを想定しています。ロック獲得中に，再度このメソッドを実行して別のロックを取得（ネスト）することはできません。なお，ロック獲得待ち時間は，システム定義ファイル（csd.properties）のuoc.timer.lock定義で指定します。

形式

public void lock(List<String> lockKeys)

入力

表3-34　入力項目一覧

項番
引数名：型
引数の意味
制限

1
lockKeys :List<String>
ロックオブジェクトの識別子（ロックキー）を格納したリストです。
ロックキーは複数指定できます。
String型のIPアドレスをListにして指定し，VM単位で排他制御を行うことを目的としています。指定したIPアドレスが有効であるかはチェックしません。

出力

なし

例外

表3-35　エラーケース一覧

項番
Exception
発生理由
（原因コード）
発生後の動作

1
CsdUocRemoteExecuteAssertionFailedException
P_RemoCon.001
処理を中断し，リターンします。

P_RemoCon.002
処理を中断し，リターンします。

2
CsdUocRemoteExecuteMultipleLockException
P_RemoCon.003
処理を中断し，リターンします。

3
CsdUocRemoteExecuteTimeoutException
P_RemoCon.004
処理を中断し，リターンします。

注意事項

タイムアウト時間の設定は，ほかのUOCスレッドの処理時間も考慮して設定してください。設定時間が長過ぎる場合，ロックが獲得できるまで処理が待たされることになり，UOCのタイムアウト時間まで処理が終了しないことがあります。

unLockメソッド

排他ロックを解除するメソッドです。排他ロックを終了したいところでこのメソッドを実行します。このメソッドを実行すると，自スレッドが取得したロックをすべて解除します。ほかのスレッドが獲得したロックを解除することはできません。すでにロックを解除している場合は，即リターンします。

形式

public void unLock()

入力

なし

出力

なし

例外

なし

注意事項

排他ロック使用後は，必ずこのメソッドを実行してロックを解除してください。

IUocLockManagerクラス

getInstanceメソッド

IUocLockTableインタフェースの実装クラスのインスタンスを取得するクラスメソッドです。排他ロック機能を利用する際は，必ず実行します。

形式

public IUocLockTable getInstance()

入力

なし

出力

戻り値として，IUocLockTableインタフェースの実装クラスのインスタンスを返します。

例外

なし

注意事項

なし

付録

＜この付録の構成＞

付録A　このマニュアルの参考情報

付録B　用語解説

付録A　このマニュアルの参考情報

このマニュアルを読むに当たっての参考情報を示します。

＜この節の構成＞

付録A.1　関連マニュアル

付録A.2　このマニュアルでの表記

付録A.3　英略語

付録A.4　KB（キロバイト）などの単位表記について

付録A.1　関連マニュアル

関連マニュアルを次に示します。必要に応じてお読みください。

uCosminexus Service Director メッセージ（3020-3-V17）

付録A.2　このマニュアルでの表記

このマニュアルでは，製品名を次のように表記しています。

表記 | 製品名
Cosminexus | uCosminexus Application Server
HiRDB | HiRDB Server Version 9
HDvM | Hitachi Device Manager
HVM | Hitachi Virtualization Manager
JP1/ITRM | JP1/IT Resource Management - Manager
JP1/SC/DPM | JP1/ServerConductor/Deployment Manager
uCSD | uCosminexus Service Director
vCenter | VMware(R) vCenter Server
VMware | ESX | VMware(R) ESX
VMware(R) vSphere ESXi

付録A.3　英略語

このマニュアルで使用する英略語を次に示します。

英略語 | 英字での表記
AP | Application Program
ASCII | American Standard Code for Information Interchange
CD-ROM | Compact Disc - Read Only Memory
CPU | Central Processing Unit
CSV | Comma Separated Value
DB | Database
FC-HBA | Fibre Channel - Host Bus Adapter
GMT | Greenwich Mean Time
GUI | Graphical User Interface
HTTP | Hyper Text Transfer Protocol
ID | Identifier
IP | Internet Protocol
IPv4 | Internet Protocol version 4
J2EE | Java 2 Enterprise Edition
LAN | Local Area Network
LB | Load Balancer
NIC | Network Interface Card
OS | Operating System
PaaS | Platform as a Service
PCI | Peripheral Components Interconnect
PP | Program Product
SSH | Secure Shell
UNC | Universal Naming Convention
UOC | User Own Coding
URL | Uniform Resource Locator
UTF-8 | 8-bit UCS Transfer Format
VLAN | Virtual LAN
VM | Virtual Machine
XML | Extensible Markup Language

付録A.4　KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

付録B　用語解説

（英字）

PaaS提供者

PaaS環境構築者のことです。必要なリソースをそろえ，PaaS環境を構成するミドルウェアを決定します。PaaS利用者に対して，安定したPaaS環境を提供する責任があります。

PaaS利用者

業務システム構築担当者および責任者のことです。PaaS提供者から提供されるテンプレートを基に業務システムを構築し，テスト工程を経て，本番環境にリリースします。業務システムの運用も担当します。

（カ行）

仮想イメージテンプレート

JP1/ITRMが管理するテンプレートのことです。仮想ホストのデプロイ元になるデータであり，ライブラリで管理されます。

仮想サーバマネージャ

uCosminexus Application Serverが提供する仮想サーバマネージャのことです。

（サ行）

サイジング

業務用件に基づき，仮想ホスト数，メモリ所要量，CPUスペックとコア数，OSおよびミドルウェア定義を決定する処理のことです。

スナップショット

マスターイメージをエクスポートしたファイルのことです。PaaS利用者はこのファイルを再利用およびカスタマイズして，マスターイメージを作成できます。

（タ行）

デプロイ

JP1/ITRMで仮想化ソフトウェア上に仮想ホストを構築する操作のことです。また，uCSDでは，PaaS環境の構築を実現するためにOSとミドルウェアの定義配布およびセットアップ処理までを含めます。

テンプレート

仮想ホスト構成情報，ミドルウェア構成およびUOCを持つファイル一式のことです。PaaS提供者が作成して，PaaS利用者に提供します。uCSDがサンプルとしても提供します。

（マ行）

マスターイメージ

PaaS利用者が，テンプレートを基に業務システム固有情報を付けて作成した業務システム情報一式のことです。uCSDの構成管理で管理されていて，スナップショットをuCSDにインポートして作成できます。また，PaaS利用者は，マスターイメージに付けた業務システム名称を指定して，デプロイ指示をします。

索引

[Ｃ][Ｉ][Ｏ][Ｐ][Ｕ]
[カ行][サ行][タ行][ハ行][マ行][ラ行]

(英字)

(Ｃ)

csddbcopy（データベースのバックアップ）

csddbrstr（データベースのリストア）

csdinfoget（トラブルシュート情報の収集）

csdinstlin（ミドルウェアインストール）

csdmidelete（マスターイメージの削除）

csdmideploy（マスターイメージのデプロイ）

csdmiexport（マスターイメージのエクスポート）

csdmils（マスターイメージの表示）

csdmipos（物理配置候補の算出）

csdmiregister（マスターイメージの登録）

csdmirelease（物理リソースの予約解除）

csdmireserve（物理リソースの予約）

csdmisetpassword（仮想ホストのパスワード設定）

csdmistopdeploy（デプロイ処理の中断）

csdmiundeploy（マスターイメージのアンデプロイ）

csdmiupdate（マスターイメージの更新）

csdmivmstatus（仮想ホスト，ミドルウェアのステータス変更）

csdrscls（物理リソース情報の出力）

csdrscstatus（物理リソースの状態変更）

csdrscupdate（物理構成情報の更新）

csdsetaccount（アカウント情報の登録）

csdsetup（uCSD運用環境のセットアップ）

csdtmpcontrol（テンプレートの属性設定）

csdtmpdelete（テンプレートの削除）

csdtmpls（テンプレートの表示）

csdtmpregister（テンプレートの登録）

csdtmpupdate（テンプレートの更新）

csdunsetup（uCSD運用環境のアンセットアップ）

(Ｉ)

IPアドレス設定ファイル

(Ｏ)

OS設定用テンプレートファイル

OS設定用パラメータファイル

OSパッチ

(Ｐ)

PaaS提供者〔用語解説〕

PaaS利用者〔用語解説〕

(Ｕ)

UOC

概要

作成時の注意点

種類

UOC詳細

CsdUocExceptionクラス

IHostPropertyクラス

IMiddleSetupInformationクラス

IMiddleSetupUocクラス

IMiddleSetupクラス

IMiPropertyクラス

IRemoteHostConnectManagerクラス

IRemoteHostConnectorクラス

IUocLockManagerクラス

IUocLockTableクラス

IVmPropertyクラス

SizingParameterクラス

SizingResultクラス

SizingUocクラス

(カ行)

(か)

仮想イメージテンプレート〔用語解説〕

仮想サーバマネージャ〔用語解説〕

(こ)

構成パターンテンプレートファイル

構文要素

構文要素

コマンド実行可能status

コンポーネントテンプレートファイル

(サ行)

(さ)

サイジング〔用語解説〕

サイジングUOC

サイジングUOC

(し)

システム定義ファイル

(す)

スナップショット〔用語解説〕

(せ)

セットアップ定義ファイル

(タ行)

(て)

デプロイ〔用語解説〕

テンプレート〔用語解説〕

テンプレート操作で使用するファイル

(ハ行)

(ふ)

負荷分散機接続設定プロパティファイル

物理構成定義ファイル

物理配置制約ファイル

物理容量定義ファイル

文法記述記号

(マ行)

(ま)

マスターイメージ〔用語解説〕

マスターイメージ構成ファイル

マスターイメージ操作で使用するファイル

マスターイメージ定義ファイル

(み)

ミドルウェアセットアップスクリプト

ミドルウェア定義用テンプレートファイル

ミドルウェア定義用パラメータファイル

ミドルウェアパッチ

ミドルセットアップUOC

(め)

メソッド詳細

execCommandメソッド〔IRemoteHostConnectorクラス〕

executeSizingメソッド〔SizingUocクラス〕

executeUndeployInitializerメソッド〔IMiddleSetupUocクラス〕

executeUpdateFinalizerメソッド〔IMiddleSetupUocクラス〕

getComponentPropertiesListメソッド〔SizingParameterクラス〕

getComponentPropertiesListメソッド〔SizingResultクラス〕

getCsdSystemPropertyメソッド〔IMiddleSetupInformationクラス〕

getDataFilePathメソッド〔SizingParameterクラス〕

getFileメソッド〔IRemoteHostConnectorクラス〕

getInstanceメソッド〔IUocLockManagerクラス〕

getRemoteHostConnectManagerメソッド〔IMiddleSetupInformationクラス〕

getTargetMiInfoメソッド〔IMiddleSetupInformationクラス〕

getUniUndeployFlagメソッド〔IMiddleSetupInformationクラス〕

getUocLockManagerメソッド〔IMiddleSetupInformationクラス〕

getUocPropertiesメソッド〔SizingParameterクラス〕

getVmPropertyListメソッド〔IMiddleSetupInformationクラス〕

lockメソッド〔IUocLockTableクラス〕

newInstanceメソッド〔IRemoteHostConnectManagerクラス〕

putFileメソッド〔IRemoteHostConnectorクラス〕

setupメソッド〔IMiddleSetupクラス〕

unLockメソッド〔IUocLockTableクラス〕

unsetupメソッド〔IMiddleSetupクラス〕

(ラ行)

(り)

リソース制約定義ファイル

リソース定義ファイル

■ 商標類

BSAFEは，EMC Corporationの米国およびその他の国における登録商標または商標です。
Linuxは，Linus Torvalds 氏の日本およびその他の国における登録商標または商標です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
MS-DOSは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
Red Hatは，米国およびその他の国でRed Hat, Inc. の登録商標もしくは商標です。
RSAは，EMC Corporationの米国およびその他の国における登録商標または商標です。
VMwareは，米国およびその他の地域における VMware, Inc. の登録商標または商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。
uCosminexus Service Directorは，米国EMC コーポレーションのRSA BSAFE(R)ソフトウェアを搭載しています。
This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP
server project.
Portions of this software were developed at the National Center for Supercomputing
Applications (NCSA) at the University of Illinois at Urbana-Champaign.
This product includes software developed by the University of California, Berkeley
and its contributors.
This software contains code derived from the RSA Data Security Inc. MD5
Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie
Mellon University, and Bell Communications Research, Inc (Bellcore).
Regular expression support is provided by the PCRE library package, which is open
source software, written by Philip Hazel, and copyright by the University of
Cambridge, England. The original software is available from
ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
This product includes software developed by Ralf S. Engelschall <rse@engelschall.com>
for use in the mod_ssl project (http://www.modssl.org/).
This product includes software developed by the Apache Software Foundation
(http://www.apache.org/).
This product includes software developed by IAIK of Graz University of Technology.
This product includes software developed by the Java Apache Project for use in the
Apache JServ servlet engine project (http://java.apache.org/).
This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi
(http://relaxngcc.sf.net/).
This product includes software developed by Andy Clark.