機能説明
指定したサーバにソフトウェアをインストールします。
サイレントインストールが可能なソフトウェアを対象として、インストールを行います。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: “localhost”または“127.0.0.1”
IPv6の場合: “localhost”または“::1”
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
ソフトウェアをインストールするコマンド名と引数です。
コマンド名と引数には、絶対パスまたは相対パスが利用できます。
コマンド名にパスの情報が含まれている場合は、以下のとおり指定してください。なお、コマンド名で指定したコマンドの引数にパスの情報が含まれる場合は、コマンドの仕様に従って指定してください。
パスの区切り文字を“\”から“/”に変更する。
パスの情報をダブルクォーテーションで囲む。
業務サーバがWindowsかつ、ファイル転送基盤を利用して接続するかつ、パスに“%”を含む場合、“%”を2つ繰り返す。
拡張子が.batおよび、.cmdのコマンド名には、拡張子を指定してください。拡張子を指定しない場合の動作は保証されません。
コマンド名と引数を省略した場合、引数エラーとなります。
コマンド名と引数の文字数の上限は、8000文字です。それより大きい場合、引数エラーとなります。
対話型のコマンドが実行された場合、エラーとなります。
拡張オプション
ソフトウェアのインストールファイルの転送元のホスト名またはIPアドレスです。
管理サーバを転送元に設定する場合、以下を指定します。
IPv4の場合: “localhost”または“127.0.0.1”
IPv6の場合: “localhost”または“::1”
本オプションを指定する場合は、sourcefileオプションおよびdestinationfileオプションの指定が必要です。
インストールを行うホストにすでにインストールファイルが存在する場合は、本オプション、および、sourcefileオプション、destinationfileオプションの指定を省略できます。省略する場合は、3つを省略します。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
ソフトウェアのインストールファイルの名前(絶対パス)です。
インストールファイルが複数ある場合は、インストールファイルが格納されているフォルダ(ディレクトリ)の名前(絶対パス)を指定します。
本オプションを指定する場合は、sourcehostnameオプションおよびdestinationfileオプションの指定が必要です。
インストールを行うホストにすでにインストールファイルが存在する場合は、本オプション、および、sourcehostnameオプション、destinationfileオプションの指定を省略できます。省略する場合は、3つを省略します。
ファイル名の文字数の上限は、255文字です。それより大きい場合、引数エラーとなります。
インストール先のソフトウェアのインストールファイルの名前(絶対パス)です。
転送元のインストールファイルにフォルダ(ディレクトリ)名を指定した場合は、フォルダ(ディレクトリ)の名前(絶対パス)を指定します。
本オプションを指定する場合は、sourcehostnameオプションおよびsourcefileオプションの指定が必要です。
インストールを行うホストにすでにインストールファイルが存在する場合は、本オプション、および、sourcehostnameオプション、sourcefileオプションの指定を省略できます。省略する場合は、3つを省略します。
ファイル名の文字数の上限は、255文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: システムユーザー
業務サーバがLinux、Solarisの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストでコマンドを実行するユーザー名です。
実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。
実行ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。
ファイル転送元のホストのOS種別です。
Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
ファイル転送元のホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、sourceusernameは以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: システムユーザー
業務サーバがLinux、Solarisの場合: root
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
ファイル転送元のホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | ソフトウェアのインストールに成功しました。 |
| 失敗 | 161 | ソフトウェアのインストールに失敗しました。リトライ回数を指定した場合、リトライします。 |
177 | インストールファイルのアクセスに失敗しました。 | ||
178 | コマンドにより実行中のプログラムが異常終了しました。 | ||
187 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | オプションの指定に誤りがありました。もしくは、構成管理データベース(CMDB)の登録情報に問題があります。 | ||
200 | ソフトウェアのインストールが異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 | ||
| 失敗 | 上記以外 | コマンドの復帰値です。 |
出力情報
変数 | 意味 |
|---|---|
message | ソフトウェアのインストールに成功した場合、以下のメッセージを設定します。 The operation component was successful. ソフトウェアのインストールに失敗した場合、エラー内容を文字列として設定します。 |
install_command_stdout | インストールコマンドの標準出力を設定します。 |
install_command_stderr | インストールコマンドの標準エラー出力を設定します。 |
install_command_rcode | インストールコマンドの復帰値を設定します。 |
returnCode | 復帰値を設定します。 |
注意事項
本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともいずれかの方法では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
インストールファイルにフォルダ(ディレクトリ)名を指定した場合、本運用操作部品にて指定したフォルダ(ディレクトリ)配下にあるファイルを圧縮したあとで、インストール先のホストに圧縮ファイルの転送を行います。本運用操作部品の処理を行っている間、sourcefileオプション、および、destinationfileオプションに指定したフォルダ(ディレクトリ)に一時的に圧縮ファイルを作成します。
ソフトウェアのインストールファイルとインストール先のソフトウェアのインストールファイルに存在しないフォルダ(ディレクトリ)名を指定した場合、復帰値177のエラーとなります。
インストールファイルが自己解凍ファイルの場合は、事前に解凍を行ってください。
インストールを行うホストに転送したインストールファイルは、本運用操作部品の処理が終わったあとも削除はしません。
インストール後にOSを自動で再起動するソフトウェアをインストールした場合でも、運用操作部品は正常終了します。
本運用操作部品は、インストールするソフトウェアにより、時間がかかる場合があります。このため、タイムアウトにならないようにtimeoutに適切な値を設定してください。
インストールファイル名には、半角英数字、空白文字、全角文字と以下の記号だけを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
インストールを実行するサーバにSSHを行う場合は、commandlineオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合はインストールを実行するサーバにRBAエージェントを導入してください。
業務サーバにRBAエージェントが未導入の場合は、sourcefileオプションおよびdestinationfileオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
復帰値について、Systemwalker Runbook Automationでは、159～240までの値を設定しています。159～240以外の復帰値、および159～240内でも未使用の復帰値は、Systemwalker Runbook Automationが設定した値ではなく、インストールコマンドが出力した値です。コマンド自身を調査してください。
commandlineオプションに存在しないコマンド名を指定した場合、復帰値42のエラーとなる場合があります。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
