ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker

3.4.1 ファイルを転送

機能説明

ファイルを転送します。

ホスト名またはIPアドレスの指定方法により、指定したホストからのファイル取得、指定したホストから他のホストへのファイルコピーも実現可能です。

オプション

基本オプション

(1) hostname

ファイル転送先のホスト名またはIPアドレスです。

ファイル転送先を管理サーバに設定する場合、以下を指定します。

  • IPv4の場合: 'localhost'または'127.0.0.1'

  • IPv6の場合: 'localhost'または'::1'

ファイル転送先のホスト名またはIPアドレスを省略した場合、引数エラーとなります。

ファイル転送先のホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(2) sourcehostname

ファイル転送元のホスト名またはIPアドレスです。

ファイル転送元を管理サーバに設定する場合、以下を指定します。

  • IPv4の場合: 'localhost'または'127.0.0.1'

  • IPv6の場合: 'localhost'または'::1'

ファイル転送元のホスト名またはIPアドレスを省略した場合、引数エラーとなります。

ファイル転送元のホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

hostnameとsourcehostnameの情報が一致する場合、指定したホストでファイルをコピーします。

ファイル転送先とファイル転送元に異なる業務サーバを指定した場合、ファイル転送元のホストから管理サーバにファイルの転送を行ったあと、管理サーバからファイル転送先のホストへファイルの転送を行います。

(3) sourcefile

転送元のファイルの名前(絶対パス)です。

FTPを利用する場合、かつ、転送元が管理サーバ以外の場合、FTPサーバのホームディレクトリからの相対パスでファイルの名前を指定します。

圧縮ファイル、画像ファイルなどのバイナリファイル、およびテキストファイルを指定できます。

テキストファイルを指定した場合、文字コード変換を行わず転送します。

ファイル名を省略した場合、引数エラーとなります。

ファイル名の文字数の上限は、255文字です。それより大きい場合、引数エラーとなります。

(4) destinationfile

転送先のファイルの名前(絶対パス)です。

FTPを利用する場合、かつ、転送先が管理サーバ以外の場合、FTPサーバのホームディレクトリからの相対パスでファイルの名前を指定します。

ファイル名を省略した場合、引数エラーとなります。

ファイル名の文字数の上限は、255文字です。それより大きい場合、引数エラーとなります。

拡張オプション

(1) connectiontype

ホストへの通信方法です。

“File Transfer Infrastructure”(ファイル転送基盤)、“SSH”、“FTP”のいずれかを指定します。なお、大文字/小文字は区別しません。

上記以外を指定した場合、引数エラーとなります。

通信方法の入力を省略した場合、通信可能な方法を検索して通信します。

(2) ostype

ファイル転送先のホストのOS種別です。

Windows、Linux、Solarisを指定します。なお、大文字/小文字は区別しません。

OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。

OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(3) username

ファイル転送先のホストへSSHまたはFTPを利用して接続するユーザー名です。

接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。

  • 業務サーバがWindowsの場合: Administrator

  • 業務サーバがLinux、Solarisの場合: root

接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(4) password

ファイル転送先のホストへSSHまたはFTPを利用して接続するユーザーのパスワードです。

接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したパスワードの値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。

接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(5) charactercode

ファイル転送先のホストの文字コードです。

hostnameオプションに'localhost'、'127.0.0.1'または'::1'を指定した場合、無効になります。

“UTF-8”、“SJIS”、“EUC”のいずれかを指定します。なお、大文字/小文字は区別しません。

“UTF-8”、“SJIS”、“EUC”以外を指定した場合、引数エラーとなります。

指定を省略した場合の動作は以下のとおりです。

- 通信方法がFTPの場合、“UTF-8”が設定されます。

- 通信方法がFTP以外の場合、転送先ホストの文字コードを自動判別します。

(6) sourceostype

ファイル転送元のホストのOS種別です。

Windows、Linux、Solarisを指定します。なお、大文字/小文字は区別しません。

OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。

OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(7) sourceusername

ファイル転送元のホストへSSHまたはFTPを利用して接続するユーザー名です。

ファイル転送元のユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、sourceusernameは以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。

  • 業務サーバがWindowsの場合: Administrator

  • 業務サーバがLinux、Solarisの場合: root

ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(8) sourcepassword

ファイル転送元のホストへSSHまたはFTPを利用して接続するユーザーのパスワードです。

ファイル転送元のユーザー名および接続に必要なパスワードを省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したパスワードの値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。

パスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(9) sourcecharactercode

ファイル転送元のホストの文字コードです。

sourcehostnameオプションに'localhost'、'127.0.0.1'または'::1'を指定した場合、無効になります。

“UTF-8”、“SJIS”、“EUC”のいずれかを指定します。なお、大文字/小文字は区別しません。

“UTF-8”、“SJIS”、“EUC”以外を指定した場合、引数エラーとなります。

指定を省略した場合の動作は以下のとおりです。

- 通信方法がFTPの場合、“UTF-8”が設定されます。

- 通信方法がFTP以外の場合、転送先ホストの文字コードを自動判別します。

(10) timeout

運用操作部品の実行の完了待ち合わせ時間(秒)です。

300~86,400(1日)の範囲で指定が可能です。

(例) 完了待ち合わせを10分間行う場合:600

指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値:201で中断します。

(11) retry

運用操作部品の実行の起動リトライ回数です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行う回数を指定します。0~5の範囲で指定が可能です。

起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。

(例) 起動リトライを2回行う場合:2

(12) retry_interval

運用操作部品のリトライ間隔(秒)です。

運用操作部品が復帰値:161で終了した場合に、起動リトライを行うまでの間隔を指定します。1~14400の範囲で指定が可能です。

(例) 300秒間隔でリトライを行う場合:300


timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

ファイル転送が正常終了しました。

失敗

161

ファイルの転送に失敗しました。リトライ回数を指定した場合、リトライします。

177

ファイルのアクセスに失敗しました。

187

運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH、FTP)時の認証に失敗しました。

または、運用操作部品による操作を実施する際に、業務サーバとの通信処理(ファイル転送基盤)で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。

188

RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH、FTP)が切断されました。

189

運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH、FTP)できませんでした。

または、運用操作部品による操作を実施する際に、業務サーバとの通信処理(ファイル転送基盤)で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。

197

オプションの内容に誤りがありました。

200

ファイルの転送が異常終了しました。

201

運用操作部品の実行がタイムアウトしました。

202

運用操作部品が実行されませんでした。

203

運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。

205

運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。

206

運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。

207

運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。

208

運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。

出力情報

変数

意味

message

ファイル転送に成功した場合、以下のメッセージを設定します。

The operation components was successful.

ファイル転送に失敗した場合、エラー内容を文字列として設定します。

returnCode

復帰値を設定します。

注意事項