wsadmin スクリプトを使用する管理コマンド呼び出し構文
管理コマンドは、特定の構文を使用してさまざまなオペレーションを呼び出します。
バッチ・モードまたは対話モードで管理コマンドを使用することができます。 以下が、管理コマンドに使用される構文です。
Jacl を使用:
$AdminTask cmdName [targetObject] [options]
ここで、options には以下のものが含まれます。{
[-paramName paramValue] [-paramName] ...
[-stepName {{stepParamValue ...} ...} ...]
[-delete {-stepName {{stepKeyParamValue ...} ...} ...} ...]
[-interactive]
}
または
{
[-paramName paramValue] [-paramName] ...
[-stepName {{stepParamName stepParamValue} {stepParamName stepParamValue} ...]
[-delete {-stepName {{stepKeyParamValue ...} ...} ...} ...]
[-interactive]
}
Jython を使用:
AdminTask.cmdName(['targetObject'], [options])
ここで、options には以下のものが含まれます。'[
[-paramName paramValue] [-paramName ...]
[-stepName [[stepParamValue ...] ...] ...]
[-delete [-collectionStepName [[stepKeyParamValue ...] ...] ...] ...]
[-interactive]
]'
または
'[
[-paramName paramValue] [-paramName ...]
[-stepName [[stepParamName stepParamValue] [stepParamName stepParamValue] ...]
[-delete [-collectionStepName [[stepKeyParamValue ...] ...] ...] ...]
[-interactive]
]'
各部の意味は、次のとおりです。
パラメーター | 説明 |
---|---|
cmdName | 実行される管理コマンドの名前を表します。 |
targetObject | コマンドが作動するターゲット・オブジェクトを表します。 管理コマンドに応じて、この入力は必須、オプション、または存在しない場合があります。 この入力は、コマンド固有ヘルプに表示される Target object に一致します。 |
paramName | 実行されたコマンドのパラメーター名を表します。管理コマンドに応じて、この入力は必須、オプション、または存在しない場合があります。 各パラメーター名は、コマンド固有ヘルプの Arguments 領域に表示される引数名と一致します。 |
paramValue | 前出のパラメーター名に設定されるパラメーター値を表します。 パラメーターは名前と値のペアとして指定されます。パラメーターに値の型として Boolean がある場合、 パラメーター値は必要ではありません。 Boolean 型パラメーターの値を指定することなく、パラメーター名のみを指定する場合は、値は true に設定されます。 |
stepName | コマンドのステップ名を表します。この入力は、 コマンド固有ヘルプの Steps 領域に表示されるステップ名と一致します。 |
stepParamName | ステップのパラメーター名を表します。管理コマンドに応じて、この入力は必須、オプション、または存在しない場合があります。 各パラメーター名は、コマンド固有ヘルプのステップ領域に表示される 引数名に対応します。 |
stepParamValue ... | ステップ用パラメーターの値を表します。ステップ固有ヘルプに表示されているとおりの 正しい順番で、ステップのパラメーター値のすべてを指定します。 値を指定したくないオプションのパラメーターについては、値の代わりに "" を入力します。例えば、 コマンド・ステップがコレクション・タイプの場合、複数のオブジェクトを含み、各オブジェクトは同じパラメーター・セットを持ちます。各オブジェクトを中括弧で囲むことにより、複数のオブジェクトを指定することができます。コレクション・タイプのステップでは、各ステップ・パラメーターは、キーまたは非キーです。 ステップのキー・パラメーターは、コレクションでオブジェクトを一意的に識別するために使用されます。 そのステップにデータがある場合、入力で提供されるキー・パラメーター値は既存のデータのキー・パラメーター値と 比較されます。 一致したものが見つかると、既存データは更新されます。 見つからない場合は、指定されたステップによって、新規オブジェクトの追加が許可されると、入力値が追加されます。 |
delete | コレクションをサポートする特定のステップから 既存のデータを削除するオプションを表します。 |
collectionStepName | コレクション・ステップ名を表します。 |
stepKeyParamValue ... | コレクション・ステップから削除されるオブジェクトを一意的に識別するキー・パラメーターの値を表します。 オブジェクトのキー・パラメーター値は、 そのステップ固有のヘルプに表示される順序で指定する必要があります。 |
interactive | 対話モードを入力するオプションを表します。 |
[ ] | Jython リストの大括弧を表します。 |
[ ] | 大括弧内のパラメーターまたはオプションは、オプションであることを示しています。 これらの大括弧を構文の一部として入力しないようにしてください。 |