2.4.8 設計書
(1) 形式
設計書は次に示すファイル形式で記述します。
項番 |
項目 |
説明 |
---|---|---|
1 |
ファイル形式 |
|
2 |
ファイルサイズ |
|
3 |
シートの数 |
1000シート以下 |
4 |
シートのサイズ |
10000行以下,10000列以下 |
5 |
セルに入力できる文字数※ |
1024文字以下 |
6 |
セルの表示形式※ |
|
7 |
セルに入力できる値※ |
|
8 |
列の幅 |
255文字以下 |
9 |
行の高さ |
409ポイント以下 |
10 |
挿入できるオブジェクト |
|
11 |
フィルタ |
使用できます。 |
12 |
非表示の行,列 |
使用できます。 |
13 |
暗号化されたドキュメント (パスワードによる保護) |
使用できません。パスワードを解除してください。 |
- 注意事項
-
ISCMではExcelファイルの操作に,Apache POI 3.10を使用しています。上記以外の条件における動作は,Apache POI 3.10に従います。
(2) ファイル名
設計書のファイル名は任意です。
(3) 格納先ディレクトリ
設計書の格納先は任意です。
(4) 説明
設計書は,テンプレートの組み合わせや使用するUOCの情報など,マスターイメージ構築で使用する情報を定義するファイルです。マスターイメージ登録を行うcsdmiregisterコマンドと,マスターイメージ更新を行うcsdmiupdateコマンドで利用します。
(5) シートの構成
設計書のシートの構成を次に示します。
項番 |
シート |
シート名 |
説明 |
---|---|---|---|
1 |
マスターイメージ基本情報シート |
CSD_MasterImage_Sheet |
マスターイメージの名称や構成情報を指定するシートです。 シート名は設定シートで変更できます。 シート数:1 次に示す表を指定します
|
2 |
パラメータ定義シート |
“CSD_”で始まるシート名 |
ミドルウェアのパラメータを指定するシートです。 シート名の規則は設定シートで変更できます。 シート数:0〜997※ 注※ 項番1,3,4のシートを含めて設計書内のシートの合計が1000を超えないようにしてください。 次に示す表を指定します
|
3 |
ネットワーク情報シート(リソース予約情報シート) |
CSD_ResourceReserve_Sheet |
マスターイメージ内のホストが使用するネットワーク情報を指定するシートです。 シート名は設定シートで変更できます。 シート数:1 次に示す表を指定します
|
4 |
設定シート |
CSD_Setting |
設計書のシート名,および表の列名を設定するためのシートです。 シート名は変更できません。 シート数:1 次に示す表を指定します
|
(6) 表の構成
設計書に記載する表の構成を次に示します。
ISCMは,次に示す表の列名を検索し,該当列に指定された値を解析します。以降,これらの列を総称して解析対象列と記載します。
(a) マスターイメージ基本情報シート
マスターイメージ基本情報シートでは,マスターイメージに共通する情報やマスターイメージを構成するコンポーネントの情報を定義します。
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
MI-基本情報 |
マスターイメージ名 |
表2-19 項番1を参照 |
2 |
セクション |
表2-19 項番2を参照 |
|
3 |
マスターイメージのバージョン |
表2-19 項番3を参照 |
|
4 |
マスターイメージの説明 |
表2-19 項番4を参照 |
|
5 |
構成パターンテンプレート名 |
表2-19 項番5を参照 |
|
6 |
サイジングUOCクラス名 |
表2-19 項番6を参照 |
|
7 |
サイジングUOCファイル名 |
表2-19 項番7を参照 |
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
コンポーネントID |
構成パターンテンプレートのコンポーネントIDを指定します。 |
表2-19 項番10を参照 |
2 |
コンポーネントテンプレート名 |
コンポーネントテンプレート名を指定します。 |
表2-19 項番11を参照 |
3 |
ホスト台数 |
コンポーネントに含まれるホストの台数を指定します。※1 |
ホスト台数を指定する場合:1〜20 サイジングUOCでホスト台数を算出する場合:入力しません(空欄) |
4 |
設定対象識別子 |
コンポーネントテンプレートのミドルウェア識別子を指定します。 |
表2-19 項番12を参照 |
5 |
項番※2 |
項番を記載します。 |
空文字でない任意の文字列 |
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
UOC入力パラメータ |
サイジングUOCへの入力パラメータのキー名を指定します。 |
表2-19 項番8を参照 |
2 |
UOC設定値 |
上記キーに対応する,サイジングUOCへの入力パラメータの設定値を指定します。 |
表2-19 項番9を参照 |
3 |
項番※ |
項番を記載します。 |
空文字でない任意の文字列 |
(b) パラメータ定義シート
パラメータ定義シートでは,ミドルウェアのパラメータを定義します。マスターイメージ基本情報シートのコンポーネント情報表に記載した,コンポーネントIDと設定対象識別子の組み合わせのうち,パラメータを指定するものごとにパラメータ定義シートを作成してください。また,1つのミドルウェアについて複数の定義ファイルがある場合は,コンポーネントIDと設定対象識別子の組み合わせが同じシートを複数作成することもできます。
また,パラメータと設定値情報表では,同一ファイル内で繰り返し出現する定義の記述方法や,特殊文字を使用した記述ができます。これらの記述例については,「(7)(b) 繰り返し形式の可変部定義名を使用した設計書の記述例」または「(7)(c) 特殊文字を使用した設計書の記述例」を参照してください。
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
解析情報 |
コンポーネントID |
表2-19 項番10を参照 コンポーネント情報表のコンポーネントIDと合わせてください。 |
2 |
設定対象識別子 (設定対象のミドルウェア識別子を指定します。) |
表2-19 項番12を参照 |
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
区切り文字 |
設定値を1つ前の行の設定値と連結してパラメータを指定する場合の区切り文字を指定します。 |
0〜1024文字 ただし,連結後の設定値が1024文字以下である必要があります。 特殊文字を使用して設定値を指定する場合は,設定シートの特殊文字定義表で定義した内容に従って指定してください。特殊文字定義については表2-40を参照してください。 |
2 |
デフォルト設定値 |
パラメータに対応するデフォルトの設定値を指定します。 |
表2-19 項番14を参照 特殊文字を使用して設定値を指定する場合は,設定シートの特殊文字定義表で定義した内容に従って指定してください。特殊文字定義については表2-40を参照してください。 |
3 |
設定値※1,※3 |
パラメータに対応するホストごとの個別設定値を指定します。 |
表2-19 項番14を参照 特殊文字を使用して設定値を指定する場合は,設定シートの特殊文字定義表で定義した内容に従って指定してください。特殊文字定義については表2-40を参照してください。 |
4 |
可変部定義名※2,※4,※5 |
ミドルウェア定義用テンプレートファイルやスクリプトファイルに記載するVTLの可変部名称を指定します。 |
表2-19 項番13を参照 繰り返し形式の可変部定義名を使用する場合は,「2.3.4(5) 指定項目」の「繰り返し形式の可変部名称制約」を参照してください。 |
5 |
項番※6 |
項番を記載します。 |
空文字でない任意の文字列 |
項番 |
可変部定義名 |
重複時の動作 |
---|---|---|
1 |
CsdU_A...A |
KFUD23238-Eメッセージを出力して処理を中断します。※ |
2 |
CsdUn_A...A (繰り返し形式の可変部定義名の親項目) |
繰り返しリストの1要素として,繰り返しリストに追加します。 要素が保持する可変部定義名および繰り返しリストの組み合わせが不一致の場合でも,処理を続行します。 |
3 |
a...a (繰り返し形式の可変部定義名の子項目) |
同一階層かつ同一要素内の場合,KFUD23238-Eメッセージを出力して処理を中断します。 別階層,または別要素内の場合は処理を続行します。 |
(c) ネットワーク情報シート
ネットワーク情報シートでは,ホストに割り当てるIPアドレスやホスト名などのネットワーク情報を定義します。ネットワーク情報シートで指定するホストの数は,マスターイメージ基本情報シートで指定したホスト数か,サイジングUOCで算出されたホスト数以上である必要があります。
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
コンポーネントID |
構成パターンテンプレートのコンポーネントIDを指定します。 |
表2-19 項番10を参照 コンポーネント情報表のコンポーネントIDと合わせてください。 |
2 |
IPアドレス |
NICに割り当てるIPアドレスを指定します。 |
表2-27 項番2を参照 |
3 |
VLAN-ID |
対象のNICに割り当てるVLAN IDを指定します。 |
表2-27 項番4を参照 |
4 |
ホスト名※1 |
IPアドレスやVLAN IDを割り当てるホストのホスト名を指定します。 |
表2-27 項番5を参照 同一コンポーネントID内で同一のホスト名を指定することはできません。 |
5 |
仮想ネットワークデバイス用途 |
IPアドレスを割り当てる接続先ネットワーク名を定義します。 |
表2-27 項番6を参照 業務用仮想NICが2つ以上の仮想ホストの場合は,省略できません。 |
6 |
項番※2 |
項番を記載します。 |
空文字でない任意の文字列 |
(d) 設定シート
設定シートでは,設計書を構成するシート名や,表の列名を定義します。この表の値を変更することによって,シート名や表の列名をカスタマイズすることができます。
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
シート名定義 |
マスターイメージ基本情報シート名 |
1〜31文字 |
2 |
パラメータ定義シートプレフィックス名※ |
1〜31文字 |
|
3 |
ISCMで予約されている領域です。 |
− |
|
4 |
ネットワーク情報シート名 (リソース予約情報シート名) |
1〜31文字 |
|
5 |
ISCMで予約されている領域です。 |
− |
|
6 |
ISCMで予約されている領域です。 |
− |
- 注意事項
-
-
シート名定義は項番の順に定義してください。
-
予約されている領域は空欄にしないでください。また,行自体を削除しないでください。
-
項番 |
列名 |
説明 |
指定値 |
---|---|---|---|
1 |
列名定義 |
マスターイメージ基本情報列の列名 |
1〜1024文字 |
2 |
コンポーネントID列の列名 |
1〜1024文字 |
|
3 |
コンポーネントテンプレート名列の列名 |
1〜1024文字 |
|
4 |
ホスト台数列の列名 |
1〜1024文字 |
|
5 |
ISCMで予約されている領域です。 |
− |
|
6 |
ISCMで予約されている領域です。 |
− |
|
7 |
ISCMで予約されている領域です。 |
− |
|
8 |
設定対象識別子列の列名 |
1〜1024文字 |
|
9 |
サイジングUOC入力パラメータ列の列名 |
1〜1024文字 |
|
10 |
サイジングUOC設定値列の列名 |
1〜1024文字 |
|
11 |
解析情報列の列名 |
1〜1024文字 |
|
12 |
区切り文字列の列名 |
1〜1024文字 |
|
13 |
デフォルト設定値列の列名 |
1〜1024文字 |
|
14 |
設定値(ホスト単位)列の列名 |
1〜1024文字 |
|
15 |
可変部定義名列の列名 |
1〜1024文字 |
|
16 |
ISCMで予約されている領域です。 |
− |
|
17 |
ISCMで予約されている領域です。 |
− |
|
18 |
IPアドレス列の列名 |
1〜1024文字 |
|
19 |
ISCMで予約されている領域です。 |
− |
|
20 |
VLAN ID列の列名 |
1〜1024文字 |
|
21 |
ホスト名列の列名 |
1〜1024文字 |
|
22 |
ISCMで予約されている領域です。 |
− |
|
23 |
仮想ネットワークデバイス用途列の列名 |
1〜1024文字 |
|
24 |
ISCMで予約されている領域です。 |
− |
|
25 |
ISCMで予約されている領域です。 |
− |
|
26 |
ISCMで予約されている領域です。 |
− |
|
27 |
項番の列名 |
1〜1024文字 |
|
28 |
ISCMで予約されている領域です。 |
− |
|
29 |
ISCMで予約されている領域です。 |
− |
|
30 |
ISCMで予約されている領域です。 |
− |
項番 |
列名 |
説明 |
記載可能列※4 |
指定値 |
---|---|---|---|---|
1 |
特殊文字定義※1,※2 |
メタ文字という意味を持たせる文字列を記載します。 記載可能列に記載した値が項番2以降の特殊文字と完全一致せず,先頭がメタ文字の場合,設計書解析時に先頭のメタ文字を削除して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
2 |
デフォルト値を適用するという意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時にデフォルト値列に記載された値に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
3 |
左のセルの値を適用するという意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時に左のホストの設定値(個別)列に記載された値に置換して読み込みます。 ただし,記載可能列がシートのいちばん左のホストの場合,設定値(デフォルト)列に記載された値に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
4 |
空文字列という意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時に長さ0の文字列("")に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
5 |
未定義という意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,可変部定義名列の値を無視し,何も入力されていない場合と同様に処理します。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
6 |
半角スペースという意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時に半角スペース(" ")に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
7※5 |
改行(LF)という意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時に改行("\n")に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
|
8 |
改行(CR+LF)という意味を持たせる文字列を記載します。 記載可能列に記載した値がこの項の特殊文字と完全一致した場合,設計書解析時に改行("\r\n")に置換して読み込みます。 |
[パラメータ定義シート]
|
半角または全角 1〜8文字※3 |
注 表中の太字は必須の列です。
- 注※1
-
特殊文字は重複しないように個別の値を設定してください。
- 注※2
-
特殊文字は項番の順に定義してください。
- 注※3
-
特殊文字定義の値に空文字列を記載した場合,空文字列を記載した項目の特殊文字は定義されていないものとして扱います。
- 注※4
-
特殊文字を記載可能列ではない列に記載した場合,記載した文字列自体を設定値として扱います。
また,「デフォルト値適用」の特殊文字および「左のセルの値適用」の特殊文字によって別のセルを参照している場合,最終的な参照先で設定値として解釈されている値を参照元の値に設定します。
具体例を次の図に示します。
図2‒14 特殊文字が記載できない列に記載した場合の具体例 - 注※5
-
改行(CR+LF)や改行(LF)を特殊文字で記載した場合でも,Velocityによる定義生成時に出力ファイルの仕様に合わせて改行コードが変換されます。出力ファイルの詳細仕様については,「2.3.5 (7) 定義生成後の出力ファイル」を参照してください。
- 注意事項
-
特殊文字を使用している場合,置換後の設定値と置換後の区切り文字を連結後の文字列が1024文字以下である必要があります。
表2‒41 設計書オプション定義表に記載する項目 項番
列名
説明
指定値
1
設計書オプション定義
表の終端判定ルールを記載します。
NUM_COLUMN:
項番列の記載有無で表の終端を判定します。
入力しない(空欄),または,設計書オプション定義表の記載なし:
すべての解析対象列が空か否かで表の終端を判定します。
表の終端判定ルール「NUM_COLUMN」の指定が必要なケースを次の図に示します。
この図のように,階層構造を表現した表を作成しようとすると,項番1,4の解析対象列(デフォルト設定値列,設定値列,可変部定義名列)はすべて空欄になり,表の終端判定ルール「NUM_COLUMN」を指定しなかった場合は,表の解析が最後の項番6の行まで行われません(解析対象列がすべて空の項番1の行を終端と判定する)。表の終端判定ルールで「NUM_COLUMN」を選択すると,項番列が新たに解析対象列となり,項番列の記載有無だけで表の終端であるかどうかを判断するため,項番6の行まで解析されます。
なお,「NUM_COLUMN」を選択した場合,解析対象列となる項番列の列名は,設定シートの列名定義表で設定します。
(7) 記述例
(a) サンプルファイル
次のサンプルファイルを参照してください。
項番 |
構築対象のOS |
設計書のパス |
---|---|---|
1 |
Linux |
<ISCMインストールディレクトリ>\mgr\sample\VMware\Linux\ddSystem01.xlsx または <ISCMインストールディレクトリ>\mgr\sample\HVM\Linux\ddSystem01.xlsx |
2 |
Windows |
<ISCMインストールディレクトリ>\mgr\sample\VMware\Windows\ddSystem01.xlsx または <ISCMインストールディレクトリ>\mgr\sample\HVM\Windows\ddSystem01.xlsx |
(b) 繰り返し形式の可変部定義名を使用した設計書の記述例
ホストごとに設定項目を指定するような,同一ファイル内で繰り返し出現する定義について,ミドルウェア定義用テンプレートファイルは変更しないで,設計書の変更だけで定義の出現回数を変更できるようになります。
繰り返し形式の可変部定義名を使用した設計書の記述例を次の図に示します。
(c) 特殊文字を使用した設計書の記述例
特殊文字を使用することで,デフォルト値から変更した項目や,改行と半角スペースのような見た目では区別できない値が設定された項目の判別を容易にし,レビューを実施しやすくします。
設定シートでの特殊文字定義表の設定例を次に示します。
項番 |
特殊文字定義 |
説明 |
---|---|---|
1 |
\ |
メタ文字(セルの値が項番2以降の特殊文字と完全一致せず,先頭がメタ文字だった場合,先頭のメタ文字を削除した文字列を設定します。) |
2 |
- |
デフォルト値を適用 |
3 |
← |
左のセルの値を適用 |
4 |
設定なし |
空文字 |
5 |
未定義 |
未定義 |
6 |
△ |
半角スペース |
7 |
\n |
改行(LF) |
8 |
\r\n |
改行(CR+LF) |
特殊文字を上記設定例のように設定した場合のパラメータと設定値情報表の記載例を次に示します。
繰り返し形式の可変部と組み合わせた記載例を次に示します。可変部定義名および繰り返しリストを1つも保持しない要素は無視します。このため,hostBでのパラメータ(2)の設定値に「未定義」とすると,hostBの出力ファイルは,パラメータ(1)の設定だけが出力されます。特殊文字「未定義」を使用することで,繰り返す数がホストごとに異なる場合に有効な記述例です。
(8) 設計書のカスタマイズ
設計書は必要に応じて表の構成を変更することができます。変更方法を次に示します。
項番 |
変更方法 |
説明 |
---|---|---|
1 |
シートの追加 |
設計書にシートを追加することができます。シート名は任意ですが,設定シートのシート名定義表で指定したシート名に該当すると,ISCMの解析対象となります。 |
2 |
シート名の変更 |
設計書のシート名を変更することができます。シート名は任意ですが,設定シートのシート名定義表で指定する必要があります。 |
3 |
表の位置の移動 |
表はシート内で移動することができます。ただし,他の表と結合しないでください。複数の表を上下に並べる場合,空行を少なくとも1行あけてください。※ |
4 |
列の追加 |
設計書の表には列を追加することができます。列を追加する位置は任意です。パラメータと設定値情報表に設定値列を追加する場合を除き,列名は列名定義表の指定値と重ならないようにしてください。 |
5 |
列名の変更 |
設計書の列名は変更することができます。列名は任意ですが,設定シートの列名定義表で指定する必要があります。また,列名は文字列として指定する必要があります。 |
6 |
解析対象列以外のセルの変更 |
ISCMでは,解析対象列以外のセルの値は解析しないため,任意の値を記載できます。 |
7 |
特殊文字の変更 |
デフォルト設定値や個別の設定値で指定する特殊文字を変更できます。設定シートの特殊文字定義表を「表2-40 特殊文字定義表に記載する項目」の内容に従って指定する必要があります。 |
項番 |
シート名 |
表名 |
セル結合が必要な個所 |
---|---|---|---|
1 |
マスターイメージ基本情報シート |
コンポーネント情報表 |
上記セルの列内での結合は,コンポーネント単位での結合が必要です。 |
2 |
パラメータ定義シート |
パラメータと設定値情報表 |
表中の列名を記載する行(表のヘッダ部分)は2行とし,その2行に含まれる各列の上下2つのセルを結合する必要があります。ただし,設定値列は上側のセルに列名を,下側のセルにホスト名を記載するため,セル結合はしないでください。 |
3 |
ネットワーク情報シート |
ネットワーク情報表 |
上記セルの列内での結合は,ホスト単位での結合が必要です。 |