機能説明
構成変更テンプレートに基づき、管理対象サーバに対して構成変更を行います。
記述形式
【Windows】
swcfmg_configuration_change.exe -userid "ユーザーID" -templateid "テンプレートID" [-jobname "ジョブ名"] [ -file "パラメーターファイルパス" [-e "文字コード"] [-wait] | -batch "一括パラメーターファイルパス" [-e "文字コード"] | -parameter "パラメーター名"="パラメーター値",… [-wait]] |
【Linux】
swcfmg_configuration_change -userid "ユーザーID" -templateid "テンプレートID" [-jobname "ジョブ名"] [ -file "パラメーターファイルパス" [-e "文字コード"] [-wait] | -batch "一括パラメーターファイルパス" [-e "文字コード"] | -parameter "パラメーター名"="パラメーター値",… [-wait]] |
オプション
構成変更を行います。ユーザーIDに、実行されるジョブの管理者となるユーザーを指定します。ユーザーは、指定したサーバに対して構成変更を実行できる権限を持つテナント管理者、テナント利用者、兼任管理者である必要があります。
使用する構成変更テンプレートのテンプレートIDを指定します。
実行されるジョブのジョブ名を指定します。ジョブ名は、85文字以内で指定してください（< > & " ' | , は指定不可）。省略した場合、テンプレート名がジョブ名として指定されます。-batchオプションを指定した場合は、本オプションの指定は無視されます。
パラメーターをCSVファイルで指定します。CSVファイルの1行につき、パラメーターを1つ記載してください。CSV形式のカラム数は2つです。1カラム目にパラメーター名、2カラム目にパラメーター値を指定してください。いずれの値も省略できません。また、テンプレートで定義されているパラメーターをすべて記載する必要があります。CSVファイルの指定例を以下に示します。
例）
param1,value1 param2,value2 |
ファイルの文字コードを指定します。
以下の文字コードが指定できます。半角英大文字で指定します。
[Windows]
SJIS
UTF-8
[Linux]
UTF-8
EUC
本オプションを省略した場合、本コマンドの実行環境の文字コードで動作します。
複数の構成変更を一括して行います。パラメーターはCSVファイルで指定します。
CSVファイルの1行目はヘッダー行です。CSVファイルの2行目以降の行はボディー行です。
各ボディー行は、1つの構成変更です。
ボディー行の1カラム目には、各構成変更のジョブ名を指定します。ジョブ名は省略可能です。ジョブ名を省略した場合は、テンプレート名がジョブ名になります。ヘッダー行の1カラム目の内容は無視されます。
1カラム目を除く各カラムは、パラメーターを表します。ヘッダー行には、構成変更テンプレートのパラメーター名を指定します。ボディー行には、ヘッダー行で指定したパラメーター名に対応するパラメーターの値を指定します。
例）
jobName,param1,param2 job1,value11,value12 job2,value21,value22 |
1つ目の構成変更のジョブ名はjob1です。
パラメーターparam1の値はvalue11です。パラメーターparam2の値はvalue12です。
2つ目の構成変更のジョブ名はjob2です。
パラメーターparam1の値はvalue21です。パラメーターparam2の値はvalue22です。
パラメーターをコマンドの引数で指定します。パラメーター名とパラメーター値を‘='(イコール)で区切って指定してください。パラメーターは、‘,'(カンマ)で区切って複数指定できます。テンプレートで定義されているパラメーターをすべて指定する必要があります。パラメーター値に特殊記号を含む場合、注意事項を参照にパラメーターを指定してください。パラメーター値に特殊記号を含む場合、-fileオプションでパラメーターを指定することを推奨します。
-parameterオプションの指定例を以下に示します。
例）
-parameter param1=value1,param2=value2 |
ジョブが以下の状態になった時点でコマンドを復帰します。本オプションを省略した場合、ジョブが開始後、すぐにコマンドが復帰します。
completed : 完了
selecting_abnormal : 選択中(異常)
completed_abnormal : 完了(異常)
canceled : 中止
本コマンド完了後、構成変更がジョブとして実行されます。実行されるジョブのジョブIDを標準出力に出力します。-batchオプションが指定された場合は、実行されるジョブのジョブIDの一覧をカンマで区切って標準出力に出力します。
標準出力の出力形式
[ジョブID],[ジョブID], … |
パラメーター値は、パラメーターの種別により指定方法が異なります。
パラメーターの種別 | 指定方法 | 例 |
|---|---|---|
サーバ | 値となる業務サーバのサーバIDまたはIPアドレスを指定してください。 | 192.168.1.1 |
文字列 | 値となる文字列を指定してください。 ワークディレクトリは、"#{work.directory}"を指定してください。 | C:\work |
ファイル | 値に資産または管理サーバ上のファイルを指定できます。
| media://000000002/1 media://000000003 C:\work\install.bat |
数値 | 値となる数値を指定してください。 | 100 |
真偽値 | 値となる真偽値を指定してください。 | true |
パスワード | 値となる文字列を指定してください。 | password |
復帰値
復帰値 | 意味 |
|---|---|
0 | 正常終了しました。 【-waitオプション指定時】 ジョブの状態が完了となりました。 |
10 | パラメーター異常です。 |
20 | 指定された入出力ファイルパスのエラーです。 |
30 | 指定された文字コードに誤りがあります。 |
50 | ファイルの記述に誤りがあります。パラメーター値、または、設定情報の値に誤りがあります。 |
70 | 指定されたユーザーまたはテンプレートに誤りがあります。 |
81 | 指定されたテンプレートを使用する権限がありません。 |
90 | 【-waitオプション指定時】 ジョブの状態が選択中(異常)となりました。 |
91 | 【-waitオプション指定時】 ジョブの状態が完了(異常)となりました。 |
92 | 【-waitオプション指定時】 ジョブの状態が中止となりました。 |
100 | Systemwalker Software Configuration Manager は起動していません。 |
103 | ディレクトリサービスの接続に失敗しました。 |
200 | セットアップされていません。 |
255 | システムエラーです。 |
コマンド格納場所
【Windows】
[Systemwalker Software Configuration Managerインストールディレクトリ]\SWCFMGM\bin |
【Linux】
/opt/FJSVcfmgm/bin |
実行に必要な権限
【Windows】
Administrator権限が必要です。ご利用OSがWindows Server 2008以降の場合は、管理者として実行してください。
管理サーバで実行可能です。
本コマンドは同時に実行する事ができます。
【Linux】
システム管理者(スーパーユーザー)のみが実行できます。
管理サーバで実行可能です。
本コマンドは同時に実行する事ができます。
注意事項
Systemwalker Software Configuration Managerが起動した状態で本コマンドを実行してください。
管理サーバに対して構成情報の変更を行うことはできません。
-parameterオプションでパラメーターを指定する際、パラメーター値に記号を含む場合、OSの仕様により以下に注意してください。-fileオプションでパラメーターを指定することを推奨します。
【Windows】
パラメーター値に半角空白または以下の記号を指定することはできません。
-fileオプションで指定してください。
, = " |
パラメーター値に以下の文字を含む場合、予期しない動作をする場合があります。‘^’でエスケープしてください。
& | < > ( ) |
パラメーター値に‘%’を使用し、かつ、環境変数を展開したくない場合、‘%’を‘^’でエスケープしてください。
【Linux】
パラメーター値に以下の文字を含む場合、予期しない動作をする場合があります。-parameterオプションの値全体を‘"’(ダブルクォーテーション)で囲って指定することを推奨します。
" $ @ & ' ( ) ^ | [ ] { } ; * ? < > ` \ |
パラメーター値に半角空白を含む場合は、-parameterオプションの値全体を‘"’(ダブルクォーテーション)で囲ってください。
-parameterオプションの値全体を‘"’(ダブルクォーテーション)を囲った場合、パラメーター値に以下の文字を含む場合、予期しない動作をする場合があります。‘\’(バックスラッシュ)でエスケープしてください。
" $ ` \ |
パラメーター値に以下の文字を含む場合は、パラメーターの値を‘\"’で囲ってください。
, = " |
パラメーター値の‘"’は‘\"\"’を指定してください。
例）-parameterオプションの指定例を以下に示します。
【Windows】
パラメーター名 | パラメーター値 |
|---|---|
param1 | value |
param2 | (x86) |
-parameter param1=value,param2=^(x86^) |
【Linux】
パラメーター名 | パラメーター値 |
|---|---|
param1 | "value" |
param2 | C:\Program Files (x86) |
-parameter "param1=\"\"\"value\"\"\",param2=\"C:\\Program Files (x86)\"" |
入力ファイルに誤りがある場合、標準出力に以下のようなメッセージを出力します。
CFMGC20005 ファイルの記述に誤りがあります。[行番号:n][原因:原因]
[原因]には、以下のどれかが出力されます。
メッセージ | 意味 |
|---|---|
Number of elements. | 該当行の要素の数を見直してください。 |
Mandatory parameters are not specified. () | “()”内のパラメーターが指定されていません。 |
Mandatory elements are not specified. | 該当行の必須項目を入力してください。 |
The parameter does not exist. | 該当行のパラメーターはテンプレートで定義されていません。 |
The same parameter is specified in another line. | 該当行までに、同じパラメーターが記載されています。 |
The parameter value is not valid as a type. | 該当行のパラメーター値が、パラメーター種別によって規定された値ではありません。『操作ガイド』の「パラメーターの定義」を参照に、パラメーター値が、パラメーター種別で規定された値かどうか確認してください。
|
設定情報またはパラメーターの指定に誤りがある場合、標準出力に以下のようなメッセージを出力します。誤りのある処理の設定情報、値と原因が出力されます。パラメーター、または、構成変更テンプレートに記載された値を見直してください。『操作ガイド』の「設定情報の定義」を参照し、値の見直しを行ってください。
CFMGC30605 設定情報の指定に誤りがあります。[処理名:処理名][設定情報:設定情報][値:値][原因:原因]
[設定情報]には、以下のどれかが出力されます。
設定情報 | 原因 | 意味 |
|---|---|---|
target : 対象 | Operation not permitted for the specified server. | 指定したサーバに対して構成変更を実行する権限がありません。
|
Operation not permitted for admin server. | 管理サーバに対しては実行できません。 | |
script : スクリプト | The script is incorrect. | 指定されたスクリプトに誤りがあります。以下を確認してください。
|
| Operation not permitted for the specified asset. | 指定した資産を使用する権限がありません。-useridオプションで指定したユーザーが該当資産を使用できるかどうか確認してください。 |
| The number of characters of value is invalid. | 文字数が不正です。 |
The value contains invalid characters. | 使用できない文字が含まれています。 | |
The value is invalid. | 不正な値です。 |
使用例
【Windows】
swcfmg_configuration_change.exe -userid user001 -templateid 000000001 -file C:\work\param.csv |
【Linux】
swcfmg_configuration_change -userid user001 -templateid 000000001 -file /tmp/param.csv |
