csdcheck(設計書のチェック)
形式
csdcheck -x 設計書
機能
設計書の表構成や入力値をチェックします。
実行可能ユーザ
PaaS提供者,PaaS利用者がこのコマンドを実行できます。
オプション
- -x
-
設計書のExcelファイルを指定します。
設計書:対象ファイル:〜<パス名> 1〜247文字※
- 注※ 全角を含むすべての文字が使用できます。
-
サロゲートペアに該当する文字をパスに使用した場合,使用できるパス名長が247文字より短くなる場合があります。
戻り値
値 |
意味 |
---|---|
0 |
正常終了しました。 |
0以外 |
異常終了しました。 |
実行例
- (1) 実行結果(すべてのチェックを実施し完了した場合)
-
すべてのチェックを実施し完了した(設計書に記載不備なし)場合の表示例を次に示します。
Check Result: Date:2015/05/20 12:34:56 KFUD93122-I チェック中 進捗=1/7 KFUD93122-I チェック中 進捗=2/7 KFUD93122-I チェック中 進捗=3/7 KFUD93122-I チェック中 進捗=4/7 KFUD93122-I チェック中 進捗=5/7 KFUD93122-I チェック中 進捗=6/7 KFUD93122-I チェック中 進捗=7/7 KFUD93123-I チェックが完了しました。ファイルパス=C:\Program Files\ Hitachi\uCSD\mgr\sample\VMware\Linux\ddSystem01.xlsx
- (2) 実行結果(続行できないエラーを検出し処理が中断した場合)
-
続行できないエラーを検出し処理が中断した場合の表示例を次に示します。
Check Result: Date:2015/05/20 12:34:56 KFUD93122-I チェック中 進捗=1/7 Sheet Table Row Column Cause Reference ID Details ---------------------------------------------------------------------------------- CSD_Setting, COLUMN_NAME_DEF, 18, 2, DUPLICATION, KFUD23229-E, コンポーネントID KFUD93124-E エラーを検出しました。処理を中断します。ファイルパス= C:\Program Files\ Hitachi\uCSD\mgr\sample\VMware\Linux\ddSystem01.xlsx
表1‒12 表示項目の説明 項番
項目
説明
1
Sheet
チェック対象のシート名です。
2
Table
チェック対象の表名です。
3
Row
エラーの要因となったセルが含まれる行番号です。
4
Column
エラーの要因となったセルが含まれる列番号です。
5
Cause
原因コードです。
6
Reference ID
マニュアル「Hitachi IT System Configuration Manager メッセージ」に記載されている,エラーの原因の詳細,対処方法を参照する際にキーとなるメッセージIDです。
7
Details
エラーの要因となったセルに入力された値。または,エラー個所を示す情報※です。
先頭300文字まで表示します。
Detailsに表示する値に改行が含まれる場合,出力フォーマットが崩れることを防ぐため,改行を削除した状態で出力します。
表1‒13 Details列に出力されるエラー個所を示す情報一覧 項番
Details列に表示するエラー個所を示す情報の形式
該当するReference ID
1
可変部定義名=<可変部定義名> ホスト名=<ホスト名>※
KFUD23237-E
2
可変部定義名=<可変部定義名>
KFUD23238-E
3
コンポーネントID=<コンポーネントID>
KFUD23240-E
KFUD23242-E
4
設定対象識別子=<設定対象識別子>
KFUD23242-E
5
ホスト名=<ホスト名>
KFUD23243-W
表1‒14 原因コード一覧 項番
原因コード
説明
1
SHEET_NOT_EXIST
Sheet欄に示されたシートが存在しません。
2
MISSING_COLUMN
表に記載すべき列が不足しています。
3
TABLE_NOT_EXIST
Table欄に示された表が存在しません。
4
ERROR_VALUE
シート中のセルにエラー値が存在します。
5
NOT_EMPTY
入力してはいけないセルに値を記載しています。
6
EMPTY
セルに値が入力されていません。
7
LENGTH
入力値の文字数が制限を超えています。
8
RANGE
入力範囲外の値を入力しました。
9
CHARACTER
入力できない文字を入力しました。または,入力すべき文字が含まれていません。
10
SPACE
表のデータ行の入力値に全角または半角スペースが含まれています。
11
LINE_FEED
表のデータ行の入力値に改行が含まれています。
12
FULLWIDTH_CHAR
表のデータ行の入力値に全角文字が含まれています。
13
DUPLICATION
ほかの入力値と重複する値を入力しました。
14
MISSING_HOST
ホスト情報が不足しています。
15
EXCESS_HOST
余分なホスト情報が記載されています。
16
INVALID_VALUE
無効な値を指定しました。
17
OTHER
上記以外(外部参照リンク切れなど)です。
注意事項
-
消費メモリについて
-
メモリを大量に消費(最大5GB)するため,ほかのISCM運用コマンド実行中はこのコマンドの使用を避けてください。
-
このコマンドを実行する場合は,空きメモリ容量が十分にあることを確認してから実行してください。
-
チェック内容
この機能でチェックするチェック内容を説明します。
- 設計書ファイルのチェック項目一覧
-
設計書ファイル(Excelファイル)に関するチェック内容を次に示します。
表1‒15 設計書ファイルのチェック項目一覧 項番
チェック内容
対応するメッセージID
対応する原因コード
エラー検出後の動作
1
設計書ファイルの拡張子が.xlsまたは.xlsxであるかどうか。
KFUD93013-E※
EXTENSION
処理中断
2
設計書ファイルがISCMで読み込めるかどうか。
KUFD23228-E※
OPENまたはFORMAT
処理中断
- シート構成のチェック項目一覧
-
設計書のシート構成に関するチェック内容を次に示します。
表1‒16 シート構成のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
設計書に設定シートが存在すること。および,シート名定義表に記載したシートが存在するかどうか。
KFUD23230-E
SHEET_NOT_EXIST
処理中断
- 表構成のチェック項目一覧
-
表構成に関するチェック内容を次に示します。
- 各表共通のチェック項目
-
各表共通のチェック内容を次に示します。
項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
表に記載した列名が重複していないかどうか。
KFUD23233-E
DUPLICATION
該当する行のチェック完了後,処理中断
2
表に記載すべき列が不足していないかどうか。
KFUD23234-E
MISSING_COLUMN
処理中断
3
解析対象列間の(データ行)入力規則に一致しているかどうか(入力必須個所に記載があるかどうか)。
KFUD23229-E
KFUD23235-E
NOT_EMPTY
EMPTY
表の終端まで続行し,表単独チェック終了後に処理中断
4
シート中に表が存在しているかどうか。
KFUD23232-E
TABLE_NOT_EXIST
処理中断
- 各表固有のチェック項目
-
各表固有のチェック内容を次に示します。
- (1) シート名定義表
-
シート名定義表に関するチェック内容を次に示します。
表1‒17 シート名定義表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
制限文字数(全角半角ともに31文字まで)をオーバーしていないかどうか。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
2
重複するシート名が存在しないかどうか。
DUPLICATION
- (2) 列名定義表
-
列名定義表に関するチェック内容を次に示します。
表1‒18 列名定義表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
重複する列名が存在しないかどうか。
KFUD23229-E
DUPLICATION
表の終端まで続行し,表単独チェック終了後に処理中断
- (3) 特殊文字定義表
-
特殊文字定義表に関するチェック内容を次に示します。
表1‒19 特殊文字定義表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
特殊文字に(全角/半角)空白,改行が含まれていないかどうか。
KFUD23241-W
SPACEまたはLINE_FEED
処理を続行
2
特殊文字が全角/半角ともに8文字以内であるかどうか。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
3
特殊文字が他の特殊文字の文字列と重複していないかどうか。
DUPLICATION
- (4) 設計書オプション定義表
-
設計書オプション定義表に関するチェック内容を次に示します。
表1‒20 設計書オプション定義表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
表終端判定ルール記載行に「NUM_COLUMN」以外の文字列が指定されていないかどうか。
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
- (5) マスターイメージ基本情報表
-
マスターイメージ基本情報表に関するチェック内容を次に示します。
表1‒21 マスターイメージ基本情報表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
マスターイメージ名の文字種チェック。
英数字(a-zA-Z0-9),または,記号「_」「#」「-」「@」「(」「)」
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
2
マスターイメージ名の長さが1〜32文字であるかどうか。
LENGTH
3
セクションの文字種チェック。
英数字(a-zA-Z0-9),または,記号「_」「#」「-」「@」「(」「)」
CHARACTER
4
セクションの長さが1〜32文字であるかどうか。
ただし,セクションは省略できる。
LENGTH
5
バージョンの文字種チェック。
VV-RR
V:半角数字
R:半角数字
CHARACTER
6
マスターイメージの説明の長さが1〜255文字であるかどうか。
ただし,マスターイメージの説明は省略できる。
LENGTH
7
構成パターンテンプレート名の文字種チェック。
英数字(a-zA-Z0-9),または,記号「_」「#」「-」「@」「(」「)」
CHARACTER
8
構成パターンテンプレート名の長さが1〜32文字であるかどうか。
LENGTH
9
サイジングUOCのUOCクラス名の文字種チェック。
英数字(a-zA-Z0-9),または,記号「.」「$」「_」
ただし,クラス名(パッケージ名含む)の頭文字は英数字であること。
CHARACTER
10
サイジングUOCのUOCクラス名の長さが1〜1024文字であるかどうか。
LENGTH
11
サイジングUOCのjarファイル名の文字種チェック。
英数字(a-zA-Z0-9)
「_」(半角下線)
「.」(半角ピリオド)
「△」(半角空白)
「( 」(半角左括弧)
「)」(半角右括弧)
パス区切りの「\」(半角円マーク)。
また,Windows予約後(「AUX」,「CON」,「NUL」,「PRN」,「CLOCK$」,
「COM0〜COM9」,「LPT0〜LPT9」)が含まれていないかどうか。
CHARACTER
12
サイジングUOCのjarファイル名の長さが1〜160文字であるかどうか。
LENGTH
13
サイジングUOCのUOCクラス名とjarファイル名の両方が記載されているか,両方が記載されていないかどうか。
KFUD23235-E
EMPTY
- (6) コンポーネント情報表
-
コンポーネント情報表に関するチェック内容を次に示します。
表1‒22 コンポーネント情報表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
ホスト台数の文字種チェック。
数値(0-9)
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
2
ホスト台数を指定した場合,1〜100の範囲であるかどうか。
文字種チェックでエラーを検出した場合はチェックしない。
RANGE
3
コンポーネントIDの文字種チェック。
数値(0-9)
CHARACTER
4
コンポーネントIDの範囲チェック。
1〜65535
文字種チェックでエラーを検出した場合はチェックしない。
RANGE
5
コンポーネントID重複チェック。
DUPLICATION
6
コンポーネントテンプレート名の文字種チェック。
英数字(a-zA-Z0-9),または,記号「_」「#」「-」「@」「(」「)」
CHARACTER
7
コンポーネントテンプレート名の長さが1〜32文字であるかどうか。
LENGTH
8
設定対象識別子の文字種チェック。
文字種:
「hitachi.Cosminexus」,
「hitachi.HiRDB」,
または,
「optional.XXX」
ただし,XXX部分は
英数字(a-zA-Z0-9),または,記号「_」「.」「#」「-」「@」「(」「)」
CHARACTER
9
設定対象識別子の長さがoptionalを含めて10〜32文字であるかどうか。
LENGTH
10
設定対象識別子の(同一コンポーネント内の)重複チェック。
DUPLICATION
- (7) サイジングUOC入力パラメータ表
-
サイジングUOC入力パラメータ表に関するチェック内容を次に示します。
表1‒23 サイジングUOC入力パラメータ表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
UOCパラメータ名の文字種チェック。
英数字(a-zA-Z0-9),または,記号「_」「#」「-」「@」「(」「)」
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
2
UOCパラメータ名の長さが1〜32文字であるかどうか。
LENGTH
3
UOCパラメータ名の重複チェック。
DUPLICATION
4
UOCパラメータ値に(全角/半角)空白,改行,全角文字が含まれていないかどうか。
KFUD23241-W
SPACE
LINE_FEED
FULLWIDTH_CHAR
処理続行
5
UOCパラメータ値の長さが1〜1024文字であるかどうか。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
- (8) ネットワーク情報表
-
ネットワーク情報表に関するチェック内容を次に示します。
表1‒24 ネットワーク情報表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
コンポーネントIDの文字種チェック。
数値(0-9)
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
2
コンポーネントIDの範囲チェック。
1〜65535
文字種チェックでエラーを検出した場合はチェックしない。
RANGE
3
IPアドレスが,IPv4形式であるかどうか。(0.0.0.0〜255.255.255.255)
INVALID_VALUE
4
IPアドレスの重複チェック。
DUPLICATION
5
VLAN IDの文字種チェック。
数値(0-9)
CHARACTER
6
VLAN IDが0 〜4095の範囲であるかどうか。
文字種チェックでエラーを検出した場合はチェックしない。
RANGE
7
代表ホスト名の長さが,MS932文字コードで15bytes以下であるかどうか。
LENGTH
8
仮想ネットワークデバイス用途の長さが,MS932文字コードで255bytes以下であるかどうか。。
9
仮想ネットワークデバイス用途の重複チェック。
DUPLICATION
- (9) 解析情報表
-
解析情報表に関するチェック内容を次に示します。
表1‒25 解析情報表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
コンポーネントIDの文字種チェック。
数値(0-9)
KFUD23229-E
CHARACTER
表の終端まで続行し,表単独チェック終了後に処理中断
2
コンポーネントIDの範囲チェック。
1〜65535
文字種チェックでエラーを検出した場合はチェックしない。
RANGE
3
設定対象識別子の文字種チェック。
文字種:
「hitachi.Cosminexus」,「hitachi.HiRDB」,
または,「optional.XXX」
ただし,XXX部分は
英数字(a-zA-Z0-9),または,記号「_」「.」「#」「-」「@」「(」「)」
CHARACTER
4
設定対象識別子の長さがoptionalを含めて10〜32文字であるかどうか。
LENGTH
- (10) パラメータと設定値情報表
-
パラメータと設定値情報表に関するチェック内容を次に示します。
表1‒26 パラメータと設定値情報表のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
代表ホスト名の長さが,MS932文字コードで15bytes以下であるかどうか。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
2
ホスト名が重複していないかどうか。
KFUD23239-E
DUPLICATION
3
繰り返し形式の可変部定義名の階層番号が階層レベルと一致しているかどうか。
KFUD23229-E
CHARACTER
4
繰り返し形式の可変部定義名の文字制約に違反していないかどうか。
制約:英数字と「_」,「-」だけ。
5
繰り返し形式の可変部定義名の文字数が1〜256文字であるかどうか。
LENGTH
6
変数形式の可変部定義名の文字制約に違反していないかどうか。
制約:英数字と「_」,「-」。
CHARACTER
7
変数形式の可変部定義名の文字数が6〜256文字であるかどうか。
LENGTH
8
個別設定値に(全角/半角)空白,改行,全角文字が含まれていないかどうか。ただし,個別設定値列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23241-W
SPACE
LINE_FEED
FULLWIDTH_CHAR
処理続行
9
個別設定値の長さが1〜1024文字であるかどうか。
ただし,個別設定値列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
10
区切り文字に(全角/半角)空白,改行,全角文字が含まれていないかどうか。ただし,区切り文字列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23241-W
SPACE
LINE_FEED
FULLWIDTH_CHAR
処理続行
11
区切り文字の長さが1〜1024文字であるかどうか。
ただし,区切り文字列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
12
デフォルト設定値に(全角/半角)空白,改行,全角文字が含まれていないかどうか。ただし,デフォルト設定値列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23241-W
SPACE
LINE_FEED
FULLWIDTH_CHAR
処理続行
13
デフォルト設定値の長さが1〜1024文字であるかどうか。
ただし,デフォルト設定値列で有効な特殊文字(メタ文字を表す特殊文字を除く)が入力されている場合は,チェックしない。
KFUD23229-E
LENGTH
表の終端まで続行し,表単独チェック終了後に処理中断
- セルのチェック項目一覧
-
セルに関するチェック内容を次に示します。
表1‒27 セルのチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
セルに入力した数値※において,数値の範囲が,-2147483648〜2147483647の範囲を超えていないかどうか。
KFUD23229-E
RANGE
表の終端まで続行し,表単独チェック終了後に処理中断
2
入力がエラーとなっていないかどうか。
ERROR_VALUE
- 異種表間(同一シート内)チェック
-
異種表間(同一シート内)に関するチェック内容を次に示します。
表1‒28 異種表間(同一シート内)のチェック内容一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
マスターイメージ基本情報表にサイジングUOCクラス名&jarファイル名が指定されていない場合に,コンポーネント情報表にホスト台数が記載されているかどうか。
KFUD23240-E
EMPTY
続行し,同一シート内異種表間チェック終了後に処理中断
- 同種シート間チェック
-
同種シート間に関するチェック内容を次に示します。
表1‒29 同種シート間のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
繰り返し形式の可変部定義名(子項目)が,同一親項目内で重複していないかどうか。
KFUD23238-E
DUPLICATION
続行し,同種シート間チェック終了後に処理中断
2
繰り返し形式の可変部定義名(子項目)に対応する区切り文字とデフォルト設定値の連結後の長さが,全角/半角ともに1024文字以下であるかどうか。
KFUD23237-E
LENGTH
3
繰り返し形式の可変部定義名(子項目)に対応する区切り文字と個別設定値の連結後の長さが,全角/半角ともに1024文字以下であるかどうか。
4
パラメータ定義シートの「パラメータと設定値情報表」間で,変数形式の可変部定義名が重複していないかどうか。
KFUD23238-E
DUPLICATION
5
パラメータ定義シートの「パラメータと設定値情報表」間で,変数形式の可変部定義名に対応する,区切り文字とデフォルト設定値の連結後の長さが全角/半角ともに1024文字以下であるかどうか。
KFUD23237-E
LENGTH
6
パラメータ定義シートの「パラメータと設定値情報表」間で,変数形式の可変部定義名に対応する,区切り文字と個別設定値の連結後の長さが全角/半角ともに1024文字以下であるかどうか。
- 異種シート間チェック
-
異種シート間に関するチェック内容を次に示します。
表1‒30 異種シート間のチェック項目一覧 項番
チェック内容
対応するReference ID
対応する原因コード
エラー検出後の動作
1
コンポーネント情報表に記載したコンポーネントID&ホスト台数と,ネットワーク情報表に記載したコンポーネントID&ホスト単位記載数が一致しているかどうか。
KFUD23242-E
MISSING_HOST
(ネットワーク情報が不足している場合)
EXCESS_HOST
(ネットワーク情報が過剰に記載されている場合)
すべてのコンポーネントIDに対するホスト数をチェック後,処理中断
2
コンポーネント情報表に記載したコンポーネントID&設定対象識別子と,解析情報表に記載したコンポーネントID&設定対象識別子が一致しているかどうか。
INVALID_VALUE
すべてのパラメータ定義シートをチェック後,処理中断
3
ネットワーク情報表に記述した代表ホスト名と,パラメータと設定値情報表に記述したホスト名が一致しているかどうか。
KFUD23243-W
MISSING_HOST
(ネットワーク情報表で定義したホスト名の個別設定値列がパラメータと設定値情報表に存在しない場合)
EXCESS_HOST
(ネットワーク情報表に定義していないホスト名の個別設定値列がパラメータと設定値情報表に存在する場合)
処理続行