機能説明
パラメーター設定定義の新規追加、更新、削除、一覧表示、および、取得をします。また、パラメーター設定定義に関連付けられたスクリプトパッケージを、アップロードまたはダウンロードします。
新規追加、更新、取得は、入力ファイルにパラメーター設定定義入力ファイルを使用します。パラメーター設定定義入力ファイルはXML形式です。詳細は、「2.1 設定するパラメーターの定義」を参照してください。
アップロードとダウンロードは、スクリプトパッケージを使用します。スクリプトパッケージはZIP形式のファイルです。詳細は、「2.1.5 パッケージファイル」を参照してください。
記述形式
【Windows】
swcfmg_param_settingdef.exe { -add -file "パラメーター設定定義ファイルパス" | -update -id "パラメーター設定定義ID" -file "パラメーター設定定義ファイルパス" | -delete -id "パラメーター設定定義ID",… | -list [-file "出力ファイルパス"] [-e "文字コード"] | -get -id "パラメーター設定定義ID" -file "出力ファイルパス" | -upload -id "パラメーター設定定義ID" -file "スクリプトパッケージファイルパス" | -download -id "パラメーター設定定義ID" -dir "出力ディレクトリパス" } |
【Linux】
swcfmg_param_settingdef { -add -file "パラメーター設定定義ファイルパス" | -update -id "パラメーター設定定義ID" -file "パラメーター設定定義ファイルパス" | -delete -id "パラメーター設定定義ID",… | -list [-file "出力ファイルパス"] [-e "文字コード"] | -get -id "パラメーター設定定義ID" -file "出力ファイルパス" | -upload -id "パラメーター設定定義ID" -file "スクリプトパッケージファイルパス" | -download -id "パラメーター設定定義ID" -dir "出力ディレクトリパス" } |
オプション
指定されたパラメーター設定定義ファイルに記載された内容で、パラメーター設定定義を新規追加します。入力ファイルは、XML形式のパラメーター設定定義ファイルです。
追加されたパラメーター設定定義に対してパラメーター設定定義IDが生成されます。このIDを標準出力に出力します。
生成するIDの形式
パラメーター設定定義IDは、以下の規則で自動採番します。
SS(プレフィックス) + 8桁の番号 例: SS00000001
標準出力の出力形式
パラメーター設定定義IDを以下の形式で出力します。
[パラメーター設定定義ID]
パラメーター設定定義IDのパラメーター設定定義を、指定されたパラメーター設定定義ファイルパスに記載された内容で更新します。入力ファイルは、XML形式のパラメーター設定定義ファイルです。
パラメーター設定定義IDのパラメーター設定定義を削除します。また、ソフトウェアとパラメーター設定定義との関連付けがある場合は、この関連付けを削除します。パラメーター設定定義IDは‘,'(カンマ)で区切って複数指定できます。
登録されているパラメーター設定定義の一覧表示を、CSV形式のパラメーター設定定義一覧ファイルで出力します。
-file “出力ファイルパス”が省略された場合、情報はコマンドの標準出力に出力されます。
指定したファイルが存在しない場合はファイルを新規作成し、存在する場合は既存のファイルへ上書きします。
エラーのため、ファイル出力できなかった場合、新規作成時は、新たなファイルは作成しません。既存ファイルへの上書きの場合は、既存ファイルを保証します。
標準出力の出力形式
パラメーター設定定義の一覧表示を以下の形式で出力します。
項番 | 項目名 | 備考 |
---|---|---|
1 | パラメーター設定定義ID | パラメーター設定定義IDを出力します。 |
2 | 製品で事前定義した定義か | 製品で事前定義したパラメーター設定定義であるかを出力します。 |
3 | パラメーター設定定義の名前 | パラメーター設定定義の名前を出力します。 |
4 | パラメーター設定の方式 | パラメーター設定の方式を出力します。 |
5 | スクリプトパッケージのファイル名 | スクリプトパッケージのファイル名を出力します。 |
ヘッダーの形式
CSVファイルの先頭には、以下の形式でヘッダーを挿入します。出力する情報がない場合でも、ヘッダーを出力します。
#Definition ID,Product predefined,Definition name,Method,Package name |
パラメーター設定定義IDのパラメーター設定定義を、指定された出力ファイルパスに出力します。出力ファイルは、XML形式のパラメーター設定定義ファイルです。
指定したファイルが存在しない場合はファイルを新規作成し、存在する場合は既存のファイルへ上書きします。
エラーのため、ファイル出力できなかった場合、新規作成時は、新たなファイルは作成しません。既存ファイルへの上書きの場合は、既存ファイルを保証します。
パラメーター設定定義IDのパラメーター設定定義に、スクリプトパッケージをアップロードします。入力ファイルは、ZIP形式のスクリプトパッケージファイルです。
アップロードできるスクリプトパッケージは、以下の条件のものです。条件以外の場合は、エラーになります。
拡張子はZIPにする
ファイルの拡張子はZIPにしてください。
ファイルサイズは2MB以下にする
アップロードできるファイルサイズは、2MB以下です。
スタートアップスクリプトはルートに格納する
スタートアップスクリプト(startup.cmdまたはstartup.sh)は、ディレクトリの下ではなく、ZIPファイルのルートに格納してください。
パラメーター設定定義IDのパラメーター設定定義に登録されているスクリプトパッケージをダウンロードします。出力ディレクトリパスにZIP形式のスクリプトパッケージファイルを出力します。
出力ディレクトリにファイルが存在しないことを確認してください。出力ディレクトリにファイルが存在した場合はエラーになります。
ファイルの文字コードを指定します。
以下の文字コードが指定できます。半角英大文字で指定します。
[Windows]
SJIS
[Linux]
UTF-8
EUC
本オプションを省略した場合、本コマンドの実行環境の文字コードで動作します。
復帰値
復帰値 | 意味 |
---|---|
0 | 正常終了しました。 |
10 | パラメーター異常です。 |
20 | 指定された入出力パスのエラーです。 |
30 | 指定された文字コードに誤りがあります。 |
40 | ファイルが解析できません。 |
50 | ファイルの記述に誤りがあります。 |
70 | 指定されたIDが存在しません。 |
71 | 指定されたIDは製品で事前定義したものです。 |
72 | 指定されたIDにパッケージが登録されていません。 |
73 | 指定されたIDにパッケージが正常に登録されていません。 |
80 | 削除対象には、関連付けられている事前定義パラメーターが存在するため、削除できません。 |
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で管理する必要がなくなったパラメーター設定定義は、本コマンドを使用して情報を削除してください。
パラメーター設定定義を削除する前に、関連付けられている事前定義パラメーターが存在しないことを確認してください。この情報が存在する場合、パラメーター設定定義を削除することはできません。
パラメーター設定定義が登録されていない場合は、ヘッダー情報だけを出力します。
#Definition ID,Product predefined,Definition name,Method,Package name |
パラメーター設定定義ファイルに誤りがある場合は、パラメーター設定定義の登録・更新を中止します。以下のエラーメッセージを出力します。
XMLファイルの検証でエラーが発生しました。[詳細:(原因)] |
使用例
新規追加
【Windows】
swcfmg_param_settingdef.exe -add -file C:\work\paramsettingdef.xml |
【Linux】
swcfmg_param_settingdef -add -file /tmp/paramsettingdef.xml |
更新
【Windows】
swcfmg_param_settingdef.exe -update -id SS00000001 -file C:\work\paramsettingdef.xml |
【Linux】
swcfmg_param_settingdef -update -id SS00000001 -file /tmp/paramsettingdef.xml |
削除
【Windows】
swcfmg_param_settingdef.exe -delete -id SS00000001 |
【Linux】
swcfmg_param_settingdef -delete -id SS00000001 |
一覧表示
【Windows】
swcfmg_param_settingdef.exe -list |
【Linux】
swcfmg_param_settingdef -list |
取得
【Windows】
swcfmg_param_settingdef.exe -get -id SS00000001 -file C:\work\paramsettingdef.xml |
【Linux】
swcfmg_param_settingdef -get -id SS00000001 -file /tmp/paramsettingdef.xml |
アップロード
【Windows】
swcfmg_param_settingdef.exe -upload -id SS00000001 -file C:\work\paramsettingdef.zip |
【Linux】
swcfmg_param_settingdef -upload -id SS00000001 -file /tmp/paramsettingdef.zip |
ダウンロード
【Windows】
swcfmg_param_settingdef.exe -download -id SS00000001 -dir C:\work\paramsettingdef |
【Linux】
swcfmg_param_settingdef -download -id SS00000001 -dir /tmp/paramsettingdef |