機能説明
パラメーター管理に事前定義のパラメーターを新規追加、更新、削除、一覧表示、および、取得をします。また、事前定義のパラメーターに関連付けられたパラメーターパッケージを、アップロードまたはダウンロードします。
新規追加、更新、取得は、入力ファイルにパラメーター情報ファイルを使用します。パラメーター情報ファイルは、CSV形式のパラメーター情報CSVファイルとXML形式のパラメーター情報XMLファイルが存在します。詳細は、『開発ガイド』の「パラメーター情報の定義」を参照してください。
アップロードとダウンロードは、パラメーターパッケージファイルを使用します。パラメーターパッケージファイルはZIP形式のファイルです。詳細は、『開発ガイド』「パラメーター情報の定義」の「パッケージファイル」を参照してください。
記述形式
【Windows】
swcfmg_param_predef.exe { -add -sdefid "パラメーター設定定義ID" -file "パラメーター情報CSVファイルパス" [-e "文字コード"] | -add -sdefid "パラメーター設定定義ID" -xml "パラメーター情報XMLファイルパス" | -update -id "パラメーター情報ID" -file "パラメーター情報CSVファイルパス" [-e "文字コード"] | -update -id "パラメーター情報ID" -xml "パラメーター情報XMLファイルパス" | -delete -id "パラメーター情報ID",… | -list [-sdefid "パラメーター設定定義ID"] [-file "出力ファイルパス"] [-e "文字コード"] | -get -id "パラメーター情報ID" -file "出力ファイルパス" [-e "文字コード"] | -get -id "パラメーター情報ID" -xml "出力ファイルパス" | -upload -id "パラメーター情報ID" -file "パラメーターパッケージファイルパス" | -download -id "パラメーター情報ID" -dir "出力ディレクトリパス" } |
【Linux】
swcfmg_param_predef { -add -sdefid "パラメーター設定定義ID" -file "パラメーター情報CSVファイルパス" [-e "文字コード"] | -add -sdefid "パラメーター設定定義ID" -xml "パラメーター情報XMLファイルパス" | -update -id "パラメーター情報ID" -file "パラメーター情報CSVファイルパス" [-e "文字コード"] | -update -id "パラメーター情報ID" -xml "パラメーター情報XMLファイルパス" | -delete -id "パラメーター情報ID",… | -list [-sdefid "パラメーター設定定義ID"] [-file "出力ファイルパス"] [-e "文字コード"] | -get -id "パラメーター情報ID" -file "出力ファイルパス" [-e "文字コード"] | -get -id "パラメーター情報ID" -xml "出力ファイルパス" | -upload -id "パラメーター情報ID" -file "パラメーターパッケージファイルパス" | -download -id "パラメーター情報ID" -dir "出力ディレクトリパス" } |
オプション
指定されたパラメーター情報CSVファイルに記載された内容で、事前定義パラメーターを新規追加します。そして、事前定義パラメーターは、指定したパラメーター設定定義IDのパラメーター設定定義と関連付けられます。入力ファイルは、CSV形式のパラメーター設定定義ファイルです。
追加された事前定義パラメーターに対してパラメーター情報IDが生成されます。このIDを標準出力に出力します。
生成するIDの形式
事前定義パラメーターは、以下の規則で自動採番します。
PM(プレフィックス) + 8桁の番号 例： PM00000001
標準出力の出力形式
パラメーター情報IDを以下の形式で出力します。
[パラメーター情報ID]
入力ファイルは、XML形式のパラメーター設定定義ファイルです。その他は上のオプションと同じ動作をします。
パラメーター情報IDの事前定義パラメーターを、指定されたパラメーター情報CSVファイルに記載された内容で更新します。入力ファイルは、CSV形式のパラメーター設定定義ファイルです。
入力ファイルは、XML形式のパラメーター情報ファイルです。その他は上のオプションと同じ動作をします。
パラメーター情報IDの事前定義パラメーターを削除します。パラメーター情報IDは‘,'（カンマ）で区切って複数指定できます。
登録されている事前定義のパラメーターについて一覧表示を、CSV形式の事前定義パラメーター一覧ファイルで出力します。
-setid パラメーター設定定義IDに関連付けられた事前定義パラメーターだけを一覧表示で出力します。
-file “出力ファイルパス”が省略された場合、情報はコマンドの標準出力に出力されます。
指定したファイルが存在しない場合はファイルを新規作成し、存在する場合は既存のファイルへ上書きします。
エラーのため、ファイル出力できなかった場合、新規作成時は、新たなファイルは作成しません。既存ファイルへの上書きの場合は、既存ファイルを保証します。
標準出力の出力形式
事前定義パラメーターの一覧表示を以下の形式で出力します。
項番 | 項目名 | 備考 |
|---|---|---|
1 | パラメーター設定定義ID | パラメーター情報に関連付けているパラメーター設定定義IDを出力します。 |
2 | パラメーター情報ID | 事前定義パラメーターのパラメーター情報IDを出力します。 |
3 | パラメーター情報の名前 | 事前定義パラメーターのパラメーター情報の名前を出力します。 |
4 | パラメーターパッケージのファイル名 | パラメーターパッケージのファイル名を出力します。 |
ヘッダーの形式
CSVファイルの先頭には、以下の形式でヘッダーを挿入します。出力する情報がない場合でも、ヘッダーを出力します。
#Parameter setting definition ID,Parameter information ID,Parameter information name,Package name |
パラメーター情報IDの事前定義パラメーターを、指定された出力ファイルパスに出力します。出力ファイルは、CSV形式のパラメーター情報ファイルです。
指定したファイルが存在しない場合はファイルを新規作成し、存在する場合は既存のファイルへ上書きします。
エラーのため、ファイル出力できなかった場合、新規作成時は、新たなファイルは作成しません。既存ファイルへの上書きの場合は、既存ファイルを保証します。
出力ファイルは、XML形式のパラメーター情報ファイルです。その他は上のオプションと同じ動作をします。
パラメーター情報IDの事前定義パラメーターに、パラメーターパッケージをアップロードします。入力ファイルは、ZIP形式のパラメーターパッケージファイルです。
アップロードできるパラメーターパッケージは、以下の条件のものです。条件以外の場合は、エラーになります。
拡張子はZIPにする
ファイルの拡張子はZIPにしてください。
ファイルサイズは2MB以下にする
アップロードできるファイルサイズは、2MB以下です。
パラメーター情報IDの事前定義パラメーターに登録されているパラメーターパッケージをダウンロードします。出力ディレクトリパスにZIP形式のパラメーターパッケージファイルを出力します。
出力ディレクトリにファイルが存在しないことを確認してください。出力ディレクトリにファイルが存在した場合はエラーになります。
ファイルの文字コードを指定します。
以下の文字コードが指定できます。半角英大文字で指定します。
[Windows]
SJIS
[Linux]
UTF-8
EUC
本オプションを省略した場合、本コマンドの実行環境の文字コードで動作します。
復帰値
復帰値 | 意味 |
|---|---|
0 | 正常終了しました。 |
10 | パラメーター異常です。 |
20 | 指定された入出力パスのエラーです。 |
30 | 指定された文字コードに誤りがあります。 |
40 | ファイルが解析できません。 |
50 | ファイルの記述に誤りがあります。 |
70 | 指定されたIDが存在しません。 |
72 | 指定されたIDにパッケージが登録されていません。 |
73 | 指定されたIDにパッケージが正常に登録されていません。 |
100 | Systemwalker Software Configuration Manager は起動していません。 |
101 | 同時実行できないコマンドが実行されています。 |
102 | コマンド実行権限がありません。 |
110 | 書き込みエラーです。 |
120 | メディアライブラリでディスク容量不足が発生しました。 |
200 | セットアップされていません。 |
255 | システムエラーです。 |
コマンド格納場所
管理サーバ
【Windows】
[Systemwalker Software Configuration Managerインストールディレクトリ]\SWCFMGM\bin |
【Linux】
/opt/FJSVcfmgm/bin |
実行に必要な権限/実行環境
【Windows】
Administrator権限が必要です。ご利用OSがWindows Server 2008以降の場合は、管理者として実行してください。
管理サーバで実行可能です。
【Linux】
システム管理者（スーパーユーザー）のみが実行できます。
管理サーバで実行可能です。
注意事項
本コマンドは同時に実行する事はできません。コマンド実行中に他のコマンドを実行すると、排他エラーとなります。
Systemwalker Software Configuration Managerが起動した状態で本コマンドを実行してください。
Systemwalker Software Configuration Managerで管理する必要がなくなった事前定義パラメーターは、本コマンドを使用して情報を削除してください。
事前定義パラメーターが登録されていない場合は、ヘッダー情報だけを出力します。
#Parameter setting definition ID,Parameter information ID,Parameter information name,Package name |
CSV形式のパラメーター情報ファイルに誤りがある場合は、事前定義パラメーターの登録・更新を中止します。以下のエラーメッセージを出力します。
ファイルの記述に誤りがあります。[行番号:n][原因:(原因)] |
(原因) には、以下のどれかが出力されます。
メッセージ | 意味 |
|---|---|
Number of elements. | 該当行の要素の数を見直してください。 |
Mandatory elements are not specified. | CSVの形式と一致しません。正しい形式で入力してください。 |
The key element is invalid. | パラメーターの状態に指定された値が不正です。正しい形式で入力してください。 |
The status element is invalid. | パラメーターのキーに指定された値が不正です。正しい形式で入力してください。 |
The number of characters of name element is invalid. | 名前の文字数が不正です。正しい文字数を入力してください。 |
The number of characters of description element is invalid. | 説明の文字数が不正です。正しい文字数を入力してください。 |
The number of characters of key element is invalid. | キーの文字数が不正です。正しい文字数を入力してください。 |
The number of characters of value element is invalid. | 値の文字数が不正です。正しい文字数を入力してください。 |
XML形式のパラメーター情報ファイルに誤りがある場合は、事前定義パラメーターの登録・更新を中止します。以下のエラーメッセージを出力します。
XMLファイルの検証でエラーが発生しました。[詳細:(原因)] |
使用例
新規追加
【Windows】
swcfmg_param_predef.exe -add -sdefid SS00000001 -file C:\work\parampredef.xml |
【Linux】
swcfmg_param_predef -add -sdefid SS00000001 -file /tmp/parampredef.xml |
更新
【Windows】
swcfmg_param_predef.exe -update -id PM00000001 -file C:\work\parampredef.xml |
【Linux】
swcfmg_param_predef -update -id PM00000001 -file /tmp/parampredef.xml |
削除
【Windows】
swcfmg_param_predef.exe -delete -id PM00000001 |
【Linux】
swcfmg_param_predef -delete -id PM00000001 |
一覧表示
【Windows】
swcfmg_param_predef.exe -list |
【Linux】
swcfmg_param_predef -list |
取得
【Windows】
swcfmg_param_predef.exe -get -id PM00000001 -file C:\work\parampredef.xml |
【Linux】
swcfmg_param_predef -get -id PM00000001 -file /tmp/parampredef.xml |
アップロード
【Windows】
swcfmg_param_predef.exe -upload -id PM00000001 -file C:\work\parampredef.zip |
【Linux】
swcfmg_param_predef -upload -id PM00000001 -file /tmp/parampredef.zip |
ダウンロード
【Windows】
swcfmg_param_predef.exe -download -id PM00000001 -dir C:\work\parampredef |
【Linux】
swcfmg_param_predef -download -id PM00000001 -dir /tmp/parampredef |
