機能説明
本コマンドを使用することで、Webコンソールを使用せずに以下の操作を行うことができます。
自動運用プロセスグループの登録と更新
自動運用プロセスグループの取得
自動運用プロセスグループの削除
自動運用プロセスグループの検索と表示
プロセス定義の登録と更新
プロセス定義の削除
プロセス定義の公開
プロセス定義の廃止
プロセス定義の検索と表示
プロセスの起動
プロセスインスタンスの検索
プロセスインスタンスの詳細情報取得
プロセスインスタンスの削除
ノードの活性化
運用操作部品の登録と更新
運用操作部品の一覧取得
運用操作部品の削除
プロセス状況の一覧取得
スケジュール定義の一覧取得
スケジュール定義の操作
記述形式
swrba_admin app-add -user ユーザーID -file Barファイル |
swrba_admin app-update -user ユーザーID -file Barファイル |
swrba_admin app-get -user ユーザーID -d 出力ディレクトリ [-appid 自動運用プロセスグループID,...] |
swrba_admin app-delete -user ユーザーID -appid 自動運用プロセスグループID,... |
swrba_admin app-list -user ユーザーID [-appname 自動運用プロセスグループ名,... [-namematch {forward|backward}]] |
swrba_admin pd-add -user ユーザーID -file プロセス定義ファイル -appid 自動運用プロセスグループID |
swrba_admin pd-update -user ユーザーID -file プロセス定義ファイル -appid 自動運用プロセスグループID |
swrba_admin pd-delete -user ユーザーID {[-pdid プロセス定義ID,...]|[[-appid 自動運用プロセスグループID [-pdname プロセス定義名]] [-latest 最新版から残す版数] [-force] [-state {draft|published|obsolete},...]]} [-complete] |
swrba_admin pd-publish -user ユーザーID -appid 自動運用プロセスグループID [-pdname プロセス定義名 [-version プロセス定義のバージョン]] [-state draft|obsolete] |
swrba_admin pd-obsolete -user ユーザーID -appid 自動運用プロセスグループID -pdname プロセス定義名 |
swrba_admin pd-list -user ユーザーID [-state {draft|published|obsolete},...] [-appid 自動運用プロセスグループID] [-pdname プロセス定義名,... [-namematch {forward|backward}]] |
swrba_admin pi-start -user ユーザーID -appid 自動運用プロセスグループID -pdname プロセス定義名 [-version プロセス定義のバージョン] [-paramfile パラメーターファイル] |
swrba_admin pi-list -user ユーザーID [-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error},...] [-piid プロセスインスタンスID,...] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID,...] [-appid 自動運用プロセスグループID] |
swrba_admin pi-get -user ユーザーID -d 出力ディレクトリ [-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error},...] [-piid プロセスインスタンスID,...] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID,...] [-appid 自動運用プロセスグループID] |
swrba_admin pi-delete -user ユーザーID {[-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error},...] [-piid プロセスインスタンスID,...] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID,...] [-appid 自動運用プロセスグループID]} |
swrba_admin ni-activate -user ユーザーID -appid 自動運用プロセスグループID -piid プロセスインスタンスID -niid ノードインスタンスID |
swrba_admin parts-register -user ユーザーID -partsfile Zipファイル |
swrba_admin parts-list -user ユーザーID |
swrba_admin parts-delete -user ユーザーID -partsid 運用操作部品ID,.... |
swrba_admin si-get -user ユーザーID -file 出力ファイル名 [-startdate yyyy-mm-dd] [-enddate yyyy-mm-dd] [-state {running|wait|end|pending|suspended|aborted|error}] [-pdname プロセス定義名] [-initiator プロセス起動ユーザーID] [-owner スケジュール定義所有者] [-appid 自動運用プロセスグループID] [-sdname スケジュール定義名] [-piname プロセスインスタンス名] [-memo メモ] |
swrba_admin sd-list -user ユーザーID [-appid プロセスグループID] [-sdname スケジュール定義名] [-state {valid|invalid|pending}] [-pdname プロセス定義名] [-memo メモ] [-pattern スケジュールパターン名] [-holiday 休日カレンダー名] |
swrba_admin sd-ctrl -user ユーザーID -appid プロセスグループID -sdname スケジュール定義名 -state {valid|invalid|pending} |
-userを省略することでユーザーIDをパラメーターから省略することも可能です。パラメーターにユーザーIDが設定されていない場合は、コマンド実行後にユーザーIDの入力が求められます。
-passwordを指定することでパスワードをパラメーターとして設定することも可能です。パラメーターにパスワードが設定されていない場合は、コマンド実行後にパスワード入力が求められます。
パスワード文字列に"(ダブルクォーテーション)が含まれる場合は、以下のように入力してください。
-passwordを指定しない場合
ダブルクォーテーションの位置 | パスワード文字列例 | 入力例 |
---|---|---|
先頭のみ | "swrbauser | "swrbauser |
最後のみ | swrbauser" | swrbauser" |
先頭と最後の2箇所 | "swrbauser" | ""swrbauser"" |
パスワード文字列の途中 | swrba"user | swrba"user |
-passwordを指定する場合
ダブルクォーテーションの位置 | パスワード文字列例 | 入力例 |
---|---|---|
先頭のみ | "swrbauser | -password \"swrbauser |
最後のみ | swrbauser" | -password swrbauser\" |
先頭と最後の2箇所 | "swrbauser" | -password \"\"swrbauser\"\" |
パスワード文字列の途中 | swrba"user | -password swrba\"user |
オプション
以下の各オプションは、それぞれ同時に指定することはできません。
自動運用プロセスグループの登録を行います。
登録するBarファイルのパスを指定します。
本コマンドで登録した自動運用プロセスグループの自動運用プロセスグループ名および自動運用プロセスグループIDは、以下のとおりに設定されます。
自動運用プロセスグループ名:Systemwalker Runbook Automation Studioでプロジェクト名として設定した名前
自動運用プロセスグループID:指定したBarファイルの拡張子を除いたファイル名
すでに同一名の自動運用プロセスグループIDが登録されている場合はエラーとなります。正常に登録が完了すると自動運用プロセスグループは自動的にオンラインになります。
自動運用プロセスグループの更新を行います。
更新するBarファイルのパスを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとします。
なお、自動運用プロセスグループ更新中は自動運用プロセスグループの状態がオフラインとなります。オフラインの間は自動運用プロセスグループ所有者以外にはプロセス定義が参照できなくなります。また、プロセスの起動もできません。自動運用プロセスグループの状態は、更新終了後に自動的にオンラインになります。
自動運用プロセスグループの取得を行います。
出力ディレクトリを指定します。指定したディレクトリ配下に「指定した自動運用プロセスグループID.bar」のファイルが出力されます。同一ファイル名が存在する場合は上書きします。出力ディレクトリが存在しない場合は自動で作成します。
指定した自動運用プロセスグループのBarファイルを取得するための自動運用プロセスグループIDを指定します。指定したIDの自動運用プロセスグループが存在しない場合はエラーとなります。本オプションが指定されない場合は全自動運用プロセスグループを対象とします。
複数指定する場合は、カンマ(,)区切りで指定してください。
自動運用プロセスグループの削除を行います。
自動運用プロセスグループに登録されているプロセス定義やプロセスインスタンス、スケジュール定義も合わせて削除されます。
プロセス定義を削除するための自動運用プロセスグループIDを指定します。複数指定する場合は、カンマ(,)区切りで指定してください。
指定した自動運用プロセスグループの削除に成功した場合は、削除したことを示すメッセージが表示されます。指定したIDの自動運用プロセスグループが存在しない場合は、プロセスグループの削除に失敗したことを示すメッセージは表示されません。
自動運用プロセスグループの検索を行います。
自動運用プロセスグループ名を指定します。
複数指定する場合は、カンマ(,)区切りで指定してください。本オプションを指定しない場合は、すべての自動運用プロセスグループが検索対象となります。
自動運用プロセスグループ名の検索パターンを指定します。前方一致または後方一致を指定してください。何も指定しない場合は、完全一致となります。
プロセス定義の登録を行います。
プロセス定義の登録を行います。同じ名前のプロセス定義が指定した自動運用プロセスグループ内に存在する場合や、指定した自動運用プロセスグループが存在しない場合はエラーとなります。プロセス定義は登録完了後にドラフト状態となります。また、自動運用プロセスグループIDを指定しない場合は、エラーとなります。
プロセス定義を格納するための自動運用プロセスグループIDを指定します。指定したIDの自動運用プロセスグループが存在しない場合はエラーとなります。
プロセス定義の更新を行います。
プロセス定義の更新を行います。指定したプロセス定義が存在しない場合はエラーとなります。プロセス定義はドラフト状態として登録されます。
また、プロセス定義の更新が完了しても、すでに起動しているプロセスインスタンスには反映されません。更新したプロセス定義が公開されたあとに起動されたプロセスより、更新内容が有効になります。
プロセス定義を格納するための自動運用プロセスグループIDを指定します。指定したIDの自動運用プロセスグループが存在しない場合はエラーとなります。
プロセス定義の削除を行います。以下のオプションを指定しない場合はすべての自動運用プロセスグループが検索対象となります。
-pdid
-appid
-pdname
-state
-latest
-force
削除対象のプロセス定義の状態が“公開”または“廃止”の場合は、削除後にプロセス定義の状態が“削除済み”になります。ただし、削除対象のプロセス定義の状態が“ドラフト”の場合は、プロセス定義が完全に削除されるため、Webコンソールおよびswrba_admin pd-listに表示されません。
プロセス定義IDを指定します。指定したプロセス定義が存在しない場合は正常終了します。本オプションと以下のオプションの同時指定は不可です。
複数指定する場合は、カンマ(,)区切りで指定してください。
-appid
-pdname
-state
-latest
-force
プロセス定義名を指定します。本オプションを指定しない場合はすべてのプロセス定義が検索対象となります。本オプションを指定する場合は自動運用プロセスグループの指定は必須です。
自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。本オプションを指定しない場合はすべての自動運用プロセスグループが検索対象となります。
プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。
複数指定する場合は、カンマ(,)区切りで指定してください。
draft : ドラフト状態のプロセス定義を検索します。
published : 公開済状態のプロセス定義を検索します。
obsolete : 廃止されたプロセス定義を検索します。
最新世代から残す世代数を指定します。本オプションを指定しない場合はすべての世代が削除対象となります。例えば、最新版を残したい場合は1を指定してください。
プロセスインスタンスを削除してからプロセス定義を削除します。本オプションを指定しない場合は、プロセスインスタンスを削除しません。
本オプションは、-completeと同時に指定することはできません。
プロセス定義を完全に削除します。本オプションを指定して実行した場合は、削除対象のプロセス定義の状態に関わらず、Webコンソール及びswrba_admin pd-listに表示されません。また、削除対象のプロセス定義から生成されたプロセスインスタンスも全て削除します。
本オプションは、-forceと同時に指定することはできません。
プロセス定義の公開を行います。ドラフト状態、または廃止状態のプロセス定義を公開します。
自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。
プロセス定義名を指定します。指定したプロセス定義が存在しない場合はエラーとなります。
本オプションを省略した場合、以下のようになります。
指定した自動運用プロセスグループに登録されているドラフト状態および廃止状態のすべてのプロセス定義の最新バージョンを公開します。ただし、-stateオプションで状態が指定されている場合は、指定されている状態(ドラフト状態、または廃止状態)のプロセス定義が対象となります。
公開状態にする途中で失敗した場合、コマンドは異常終了して処理を中断します。ただし、最新バージョンが公開済のプロセス定義が含まれている場合、処理を継続します。
プロセス定義のバージョンを指定します。本オプションは、-pdnameが指定されている場合のみ有効です。
指定したバージョンが存在しない場合や、すでに公開済みのバージョンが指定された場合はエラーとなります。
本オプションを省略した場合、最新バージョンを公開します。ただし、-pdnameが指定され、最新バージョンが公開済みの場合はエラーになります。
公開対象とするプロセス定義の状態を指定します。状態は、以下の形式で指定してください。
draft:ドラフト
obsolete:廃止
本オプションを省略した場合、ドラフト状態と廃止状態のプロセス定義を公開します。
プロセス定義の廃止を行います。廃止可能なプロセス定義が存在しない場合はエラーとなります。
自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。
プロセス定義名を指定します。指定したプロセス定義が存在しない場合はエラーとなります。
プロセス定義を検索し、リスト形式で表示します。どのパラメーターも設定しない場合は全プロセス定義を対象に検索します。なお、-userに管理者権限を持たないユーザーを指定した場合は、ドラフト状態のプロセス定義を参照できません。以下に指定できるパラメーターを示します。
プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。
draft : ドラフト状態のプロセス定義を検索します。
published : 公開済状態のプロセス定義を検索します。
obsolete : 廃止されたプロセス定義を検索します。
複数指定する場合は、カンマ(,)区切りで指定してください。
自動運用プロセスグループIDを指定します。
プロセス定義名を指定します。
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。
プロセスを起動します。
自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。
プロセス定義名を指定します。指定したプロセス定義が存在しない場合はエラーとなります。
プロセス定義のバージョンを指定します。指定したバージョンが存在しない場合はエラーとなります。
本オプションが指定されていない場合は最新バージョンを起動します。
起動するプロセスに必要なパラメーターを記述したファイル名を指定します。ファイルには、以下の内容を記述します。
UDA名=値 |
ファイルの記述形式は、一般的なJavaのプロパティの形式です。
指定されたUDAに、値を設定しプロセスを起動します。指定されたUDAが存在しない場合はエラーとなります。また、使用できる値の形式はSTRING型のみとなります。指定されたファイルの文字コードがUTF-8ではない場合、エラーとなります。
改行文字をUDA値に渡したい場合は“${line.separator}”を記述してください。
公開したプロセス定義と本コマンドの実行者に属するプロセス定義を起動できます。
プロセスインスタンスを検索し、リスト形式で表示します。どのパラメーターも設定しない場合は全件検索となります。以下に指定できるパラメーターを示します。
プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。
yyyy-mm-dd
プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。
yyyy-mm-dd
-startedafterのみを指定した場合は、指定された日付から現在までの期間で検索します。-startedbeforeのみを指定した場合は、指定された日付までの期間で検索します。上記以外の形式で指定された場合や開始日と終了日の関係が不正な場合はエラーとなります。
プロセスインスタンスIDを指定します。
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセスインスタンスの状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。
running : 実行中
closed : 終了
suspended : 一時停止
aborted : 中止
created : 作成済み
error : エラー
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセス定義名を指定します。複数指定する場合は、カンマ(,)区切りで指定してください。
また、本オプションには以下のパラメーターを使用し詳細な条件を設定することが可能です。
プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。
検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。
プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り(,)で指定してください。
プロセスインスタンスを検索し、詳細情報を取得します。どのパラメーターも設定しない場合は全件検索となります。以下に指定できるパラメーターを示します。
出力ディレクトリを指定します。出力内容と構成は以下のとおりです。
- 自動運用プロセスグループID - プロセスインスタンスID - プロセスインスタンスID.xml : プロセスインスタンス詳細情報ファイルです。 - attachmentsfilesディレクトリ : プロセスインスタンスに添付された文書が格納されます。
プロセスインスタンス詳細情報ファイルの詳細は、“2.6 プロセスインスタンス詳細情報ファイル”を参照してください。
プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。
yyyy-mm-dd
プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。
yyyy-mm-dd
-startedafterのみを指定した場合は、指定された日付から現在までの期間で検索します。-startedbeforeのみを指定した場合は、指定された日付までの期間で検索します。上記以外の形式で指定された場合や開始日と終了日の関係が不正な場合はエラーとなります。
プロセスインスタンスIDを指定します。
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセスインスタンスの状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。
running : 実行中
closed : 終了
suspended : 一時停止
aborted : 中止
created : 作成済み
error : エラー
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセス定義名を指定します。複数指定する場合は、カンマ(,)区切りで指定してください。また、本オプションには以下のパラメーターを使用し詳細な条件を設定することが可能です。
プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。
検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。
プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り(,)で指定してください。
プロセスインスタンスを削除します。
プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。
yyyy-mm-dd
プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。
yyyy-mm-dd
-startedafterのみを指定した場合は、指定された日付から現在までの期間で検索します。-startedbeforeのみを指定した場合は、指定された日付までの期間で検索します。上記以外の形式で指定された場合や開始日と終了日の関係が不正な場合はエラーとなります。
プロセスインスタンスの状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。
running : 実行中
closed : 終了
suspended : 一時停止
aborted : 中止
created : 作成済み
error : エラー
複数指定する場合は、カンマ(,)区切りで指定してください。
プロセスインスタンスIDを指定します。
複数指定する場合はカンマ区切り(,)で指定してください。
プロセス定義名を指定します。複数指定する場合は、カンマ(,)区切りで指定してください。また、本オプションには以下のパラメーターを使用し詳細な条件を設定することが可能です。
プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。
検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。
プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り(,)で指定してください。
ノードを活性化します。対象のノードが活性化できない状態の場合はエラーとなります。
自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。
プロセスインスタンスIDを指定します。
ノードインスタンスIDを指定します。
運用操作部品を登録します。指定された運用操作部品が既に登録されている場合は、登録済みの運用操作部品を更新します。
登録するZipファイルのパスを指定します。運用操作部品では無いZipファイルが指定された場合はエラーとなります。
登録されている運用操作部品の一覧を、リスト形式で表示します。
運用操作部品を削除します。指定された運用操作部品IDが既に削除されている場合はエラーとなります。
運用操作部品IDを指定します。複数指定する場合はカンマ区切り(,)で指定してください。
プロセス状況を検索し、詳細情報を取得します。自動運用プロセスの実行スケジュールと現在の状態を取得できます。以下に指定できるパラメーターを示します。なお、以下のパラメーターをすべて省略した場合、本日の情報を検索します。
プロセス状況を出力するファイル名を指定します。相対パスまたは絶対パスでの指定が可能です。
ファイルの詳細は、“2.9 プロセスインスタンス状況情報ファイル”を参照してください。
取得期間の開始日を指定します。以下の形式で指定してください。
yyyy-mm-dd
取得期間の終了日を指定します。以下の形式で指定してください。
yyyy-mm-dd
-startdateのみを指定した場合は、指定された日付から現在までの期間で検索します。-startdateと-enddateの間隔は7日以内にしてください。指定した期間が8日以上の場合は、コマンドの完了に時間がかかったり、エラーとなる場合があります。-enddateのみを指定した場合は、2011/01/01より指定された日付までの期間で検索となるため、コマンドの完了に時間がかかったり、エラーとなる場合がありますので、必ず-startdateを指定してください。-startdateと-enddateを省略した場合は、本日を検索します。1日のみを検索対象とする場合は、開始日・終了日に同じ日を指定してください。上記以外の形式で指定された場合や開始日と終了日の関係が不正な場合はエラーとなります。
検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は、全自動運用プロセスグループを対象として検索します。
プロセス定義名を指定します。
プロセスを起動したユーザーIDを指定します。
スケジュール定義所有者を指定します。
プロセスインスタンス名を指定します。本項目に指定した文字列を含むプロセスインスタンス名で起動されたプロセスインスタンスを検索します。
プロセス状況(ガントチャート)における状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。それ以外の文字列を指定した場合はエラーとなります。
running : 実行中
wait : 実行待ち
end : 終了
pending : 保留
suspended : 一時停止
aborted : 中止
error : エラー
スケジュール定義名を指定します。
メモを指定します。本項目に指定した文字列を含むmemoをもつスケジュール定義より起動されたプロセスインスタンスを検索します。
スケジュール定義一覧を表示します。
対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。
スケジュール定義名を指定します。本項目に指定した文字列をスケジュール定義名に含むスケジュール定義を検索します。
スケジュール定義の状態を指定します。状態には以下を指定してください。
valid : 有効
invalid : 無効
pending : 保留
スケジュール定義のメモを指定します。本項目に指定した文字列をメモに含むスケジュール定義を検索します。
スケジュールパターン名を指定します。
休日カレンダー名を指定します。
プロセス定義名を指定します。
スケジュール定義の状態操作を行います。
対象となる自動運用プロセスグループIDを指定します。
スケジュール定義名を指定します。
スケジュール定義の状態を指定します。
スケジュール定義の状態を指定します。状態には以下を指定してください。
valid : 有効
invalid : 無効
pending : 保留
復帰値
復帰値 | 意味 |
---|---|
0 | 正常終了 |
1 | パラメーターエラー |
2 | 認証エラー |
3 | 管理サーバでのエラー |
4 | 内部エラー |
5 | 権限エラー |
6 | ファイル入出力エラー |
7 | 運用操作部品の操作エラー |
8 | スケジュール定義およびプロセス状況の操作エラー |
不定 | 強制終了 |
コマンド格納場所
【Windows】
[Systemwalker Runbook Automation 管理サーバのインストール先]\SWRBAM\bin |
【Linux】
/opt/FJSVswrbam/bin |
実行に必要な権限/実行環境
【Windows】
Administrator権限が必要です。管理者として実行してください。
管理サーバで実行可能です。
Webコンソールにログインできる利用者のみが実行できます。
以下の操作を行う場合はWebコンソールにログインできる利用者でかつ管理者権限が必要です。
自動運用プロセスグループを登録・更新・削除する場合
自動運用プロセスグループを取得する場合
自動運用プロセスグループの一覧を取得する場合
プロセスインスタンスを削除する場合
プロセス定義を削除する場合
プロセス定義を公開・廃止する場合
ノードを活性化する場合
運用操作部品を登録・更新・削除する場合
運用操作部品の一覧を取得する場合
また、上記のユーザーの場合、すべてのプロセス定義およびプロセスインスタンスが検索できます。
【Linux】
システム管理者(スーパーユーザー)のみが実行できます。
管理サーバで実行可能です。
Webコンソールにログインできる利用者のみが実行できます。
以下の操作を行う場合はWebコンソールにログインできる利用者でかつ管理者権限が必要です。
自動運用プロセスグループを登録・更新・削除する場合
自動運用プロセスグループを取得する場合
自動運用プロセスグループの一覧を取得する場合
プロセスインスタンスを削除する場合
プロセス定義を削除する場合
プロセス定義を公開・廃止する場合
ノードを活性化する場合
運用操作部品を登録・更新・削除する場合
運用操作部品の一覧を取得する場合
また、上記のユーザーの場合、すべてのプロセス定義およびプロセスインスタンスが検索できます。
注意事項
Barファイルについて
Barファイルは、Systemwalker Runbook Automation StudioかWebコンソールからエクスポートした拡張子が.bar形式のファイルである必要があります。それ以外のファイルを指定した場合はエラーとなります。
プロセス定義ファイルについて
プロセス定義ファイルは、Systemwalker Runbook Automation StudioかWebコンソールからエクスポートした、拡張子が.xpdl形式のファイルである必要があります。Webコンソールから、エクスポートしたプロセス定義ファイルを使用する場合はXPDL2.0の形式で出力したファイルを使用してください。XPDL1.0またはBPEL形式には対応していません。
プロセス定義名について
プロセス定義名には、空白が使用できます。空白を含むプロセス定義名を指定する場合はダブルクォーテーション(")で囲んでください。
Zipファイルについて
Zipファイルは、Systemwalker Runbook Automation StudioかWebコンソールからエクスポートした、拡張子が.zip形式のファイルである必要があります。それ以外のファイルを指定した場合はエラーとなります。
pd-deleteのforceオプションを指定する場合
自動運用プロセスグループがオフライン状態の場合、2027のメッセージを出力してコマンドが失敗します。自動運用グループをオンライン状態に操作してから再度実行してください。
pd-deleteのappidオプションを指定する場合
自動運用プロセスグループが存在しない場合、2020のメッセージを出力してコマンドが失敗します。自動運用グループが存在するかどうか確認してください。
pd-deleteのstateオプションを指定しない場合
プロセス定義が削除状態の場合はプロセスインスタンスを削除しません。
app-deleteで指定したプロセスグループが存在しない場合
指定したプロセスグループが存在しない場合は、コマンドの復帰値は0となります。また、プロセスグループの削除に失敗したことを示すメッセージは出力されません。
pd-deleteでプロセス定義を削除する場合
複数のプロセス定義を削除する場合には、削除対象として指定したプロセス定義のうち、複数のプロセス定義の削除に失敗した場合でも、コマンドの復帰値は0となります。個々のプロセス定義の削除結果については、コマンド実行中に標準出力に表示されるメッセージを確認してください。
pi-deleteでプロセスインスタンスを削除する場合
以下の場合は、プロセスインスタンスの削除に失敗したことを示すメッセージは出力されません。また、コマンドの復帰値は0となります。
-stateオプションで指定した状態のプロセスインスタンスが存在しない場合
-startedafter/-startedbeforeオプションで指定した期間に動作したプロセスインスタンスが存在しない場合
-initiatorで指定したプロセスインスタンス起動ユーザーIDが存在しない場合
-pdnameで指定したプロセス定義名が存在しない場合
実行結果/出力形式
プロセス定義を新規登録する場合
FSP_SW/RB-A_BASE: INFO: 02001: pd-addが正常終了しました。 Option:pd-add -file sample0001.xpdl -appid app001 Code:0
プロセス定義を検索する場合
FSP_SW/RB-A_BASE: INFO: 02000: pd-listを開始します。Option:pd-list ApplicationID ProcessID ProcessDifinitionName Version Status Owner sample001 0001 sample process001 1.0 published rba_user1 sample002 0002 sample process002 1.0 published rba_user1 sample002 0001 sample process003 1.0 published rba_user1 FSP_SW/RB-A_BASE: INFO: 02001: pd-listが正常終了しました。 Option:pd-list Code:0
プロセスグループを検索する場合
FSP_SW/RB-A_BASE: INFO: 02000: app-listを開始します。Option:app-list ID Name Ownergroup Status sample001 0001 rba_user1 Online sample002 0002 rba_user2 Offline FSP_SW/RB-A_BASE: INFO: 02001: app-listが正常終了しました。 Option:app-list Code:0
プロセスインスタンスを検索する場合
FSP_SW/RB-A_BASE: INFO: 02000: pi-listを開始します。Option:pi-list ProcessInstanceID ProcessInstanceName Status Initiator 2889 PROCESS_cl_1 closed ibpm_server1 2890 PROCESS_cl_1 running ibpm_server1 2891 PROCESS_cl_1 error ibpm_server1 FSP_SW/RB-A_BASE: INFO: 02001: pi-listが正常終了しました。 Option:pi-list Code:0
運用操作部品の一覧を取得する場合
FSP_SW/RB-A_BASE: INFO: 02000: parts-listを開始します。Option:parts-list Id Name Category Owner USER_PARTS1 sample parts001 コマンドの実行 rba_user1 USER_PARTS2 sample parts002 構成情報の操作 rba_user2 USER_PARTS3 sample parts003 その他 rba_user3 FSP_SW/RB-A_BASE: INFO: 02001: parts-listが正常終了しました。 Option:parts-list Code:0
スケジュール定義を検索する場合
FSP_SW/RB-A_BASE: INFO: 02000: sd-listを開始します。Option:sd-list ScheduleDefinitionID ApplicationID ProcessDefinitionName ScheduleDefinitionName Status Owner SchedulePatternName HolidayCalendarName NextStartupDate LastStartupDate 3 sample002 process003 sch003 invalid rba_user1 pattern3 SYSTEM_CALENDAR 2 sample002 process002 sch002 valid rba_user1 pattern2 HOL1,HOL2 2016-01-13 00:00 1 sample001 process001 sch001 valid rba_user1 pattern1 2015-12-21 13:39 FSP_SW/RB-A_BASE: INFO: 02001: sd-listが正常終了しました。 Option:sd-list Code:0
プロセス定義を-forceで削除した場合
piid:200942を削除しました。 piid:200958を削除しました。 piid:201025を削除しました。 pdid:200895を削除しました。 pdid:200817を削除しました。 pdid:200809を削除しました。 pdid:200778を削除しました。 pdid:200770を削除しました。 pdid:200521を削除しました。 pdid:200990を削除しました。 pdid:200911を削除しました。 プロセス定義を8件削除しました。 プロセスインスタンスを3件削除しました。 FSP_SW/RB-A_BASE: INFO: 02001: pd-deleteが正常終了しました。 Option:pd-delete -appid command -latest 1 -force Code:0
プロセス定義を削除する場合の使用例
例1)ドラフト状態の最新版と、最新版から1つ前にあるドラフト状態の版を残す場合
swrba_admin pd-delete -state draft -latest 2
プロセス定義の中でドラフト状態である最新版のプロセス定義と、最新版から1つ前にあるドラフト状態の版を残して削除します。
削除されるパターン
3.0 | draft |
2.0 | draft |
1.0 | draft |
上記の場合、1.0版が削除されます。
削除されないパターン
3.0 | draft |
2.0 | public |
1.0 | draft |
上記の場合、ドラフト状態のプロセス定義が最新版である3.0版と、1つ前のドラフト状態である1.0版の2世代しか存在しないため、何も削除されません。
例2)ドラフトの全バージョンとプロセスインスタンス削除
swrba_admin pd-delete -state draft -force
ドラフト状態のプロセス定義をプロセスインスタンスと共に削除します。
削除されるパターン
5.0 | draft |
4.0 | obsolete |
3.0 | draft |
2.0 | public |
1.0 | draft |
上記の場合、5.0と3.0と1.0のプロセス定義とプロセスインスタンスが削除されます。
削除されないパターン
3.0 | obsolete |
2.0 | public |
1.0 | obsolete |
上記の場合、ドラフト状態のプロセス定義が存在しないため何も削除されません。