クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String receive_file(String hostname, String username, String password, String source, String destination, String ostype) | 指定したホストからファイルを取得します。 取得に成功した場合、"Success"を返します。 取得に失敗した場合、例外を返します。 |
String send_file(String hostname, String username, String password, String source, String destination, String ostype) | 指定したホストへファイルを転送します。 転送に成功した場合、"Success"を返します。 転送に失敗した場合、例外を返します。 |
Integer return_code() | ファイル取得・転送の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイルを取得・転送するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルを取得・転送するホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
source 転送元のファイルの名前を指定します。
destination 転送先のファイルの名前を指定します。 ostype 対象となるホストのOS種別を指定します。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
ファイルの取得や転送の対象となるファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
destinationで指定したファイル名と同じ名前のファイルが転送先に存在する場合、ファイルを上書きします。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、sourceおよびdestinationに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
管理サーバのインストールパスに空白文字を入力した場合、本ライブラリを利用した操作結果は保証されません。本ライブラリを利用して運用操作部品を作成する場合は、管理サーバのインストールパスに空白文字を含めないでください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String change_file_authority(String hostname, String username, String password, String execusername, String execpassword, String filename, String ownerauthority, String groupauthority, String otherauthority, String ostype) | 指定したホストのファイルのアクセス権限を変更します。 アクセス権限の変更に成功した場合、"Success"を返します。 アクセス権限の変更に失敗した場合、例外を返します。 |
Integer return_code() | アクセス権限変更の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username アクセス権限を変更するファイルが存在するホストへSSHを利用して接続するユーザー名を 指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password アクセス権限を変更するファイルが存在するホストへSSHを利用して接続するユーザーの パスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
filename アクセス権限を変更するファイルの名前を指定します。
ownerauthority 変更するファイルの所有者のアクセス権限内容を指定します。 実行権限(X)、読み込み(R)、書き込み(W)、すべての権限解除(C)を指定します。 OS種別がWindowsの環境かつ、ファイル転送基盤を利用して存在するファイルのアクセス権限内容を 変更する場合は、ファイルの属性が変更となります。 groupauthority 変更するファイルの所有グループのアクセス権限内容を指定します。 実行権限(X)、読み込み(R)、書き込み(W)、すべての権限解除(C)を指定します。 OS種別がWindowsの環境に存在するファイルのアクセス権限内容を変更する場合、指定した内容は 無効となります。
otherauthority 変更するファイルのその他のユーザーのアクセス権限内容を指定します。 実行権限(X)、読み込み(R)、書き込み(W)、すべての権限解除(C)を指定します。 OS種別がWindowsの環境に存在するファイルのアクセス権限内容を変更する場合、指定した内容は 無効となります。
execusername ファイルのアクセス権限を変更するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
ostype 対象となるホストのOS種別を指定します。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
ファイルのアクセス権限変更の対象となるファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、filenameに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope//bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String search_file(String hostname, String username, String password, String filename, String ostype, String execusername, String execpassword) | 指定したホストに指定したファイルが存在するか確認します。ファイルの存在確認に成功した場合、“Success”を返します。 ファイルの存在確認に失敗した場合、例外を返します。 |
Integer return_code() | ファイルの存在確認の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイルの存在確認をするホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルの存在確認をするホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
filename 存在を確認するファイルの名前を指定します。 ostype 対象となるホストのOS種別を指定します。
execusername ファイルの存在確認をするユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
存在確認をするファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、filenameに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String make_file(String hostname, String username, String password, String filename, String text, String overwrite, String ostype, String exec_username, String exec_password) | 指定したホストにテキストファイルを作成します。 ファイルの作成に成功した場合、“Success”を返します。 ファイルの作成に失敗した場合、例外を返します。 |
String delete_file(String hostname, String username, String password, String filename, String ostype, String exec_username, String exec_password) | 指定したホストのファイルを削除します。 ファイルの削除に成功した場合、“Success”を返します。 ファイルの削除に失敗した場合、例外を返します。 |
Integer return_code() | ファイル作成または削除の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイルを作成または削除するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルを作成または削除するホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
filename 作成または削除するファイルの名前を指定します。
text 作成するファイルに書き込む文字列を指定します。 overwrite ファイルがすでに存在する場合に、上書きして作成するかを指定します。 off(上書きしない)、on(上書きする)を指定します。 ostype 対象となるホストのOS種別を指定します。
exec_username ファイルを作成または削除するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 exec_password 本ライブラリではexec_passwordの値を使用しません。 exec_passwordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
作成するテキストファイルは、以下に示す文字コードで作成します。
ファイルを作成するホスト | テキストファイルの文字コード |
|---|---|
Windowsの管理サーバ | SJIS |
Linuxの管理サーバ | UTF-8 |
Windowsの連携サーバ・業務サーバ | SJIS |
Linuxの連携サーバ・業務サーバ | 接続ユーザーの環境変数LANGの値の文字コード |
作成または削除するファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、textおよびfilenameに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String add_string(String hostname, String username, String password, String filename, String addstring, String outputfile, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストに存在するテキストファイルに文字列を追加します。ファイルへの文字列の追加に成功した場合、"Success"を返します。 ファイルへの文字列の追加に失敗した場合、例外を返します。 |
Integer return_code() | ファイルへの文字列追加の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username 文字列を追加するファイルが存在するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password 文字列を追加するファイルが存在するホストへSSHを利用して接続するユーザーのパスワード を指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
filename 文字列を追加するファイルの名前を指定します。
addstring ファイルに追加する文字列を指定します。 outputfile ファイルに文字列を追加した結果を出力するファイルの名前を指定します。 overwrite outputfileがすでに存在していた場合、上書きをするかを指定します。 off(上書きしない)、on(上書きする)を指定します。 ostype 対象となるホストのOS種別を指定します。
execusername ファイルを作成するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
文字列を追加するファイルには、以下に示す文字コードのテキストファイルを指定してください。
ファイルを作成するホスト | テキストファイルの文字コード |
|---|---|
Windowsの管理サーバ | SJIS |
Linuxの管理サーバ | UTF-8 |
Windowsの連携サーバ・業務サーバ | SJIS |
Linuxの連携サーバ・業務サーバ | 接続ユーザーの環境変数LANGの値の文字コード |
文字列を追加するファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、filename、addstring、およびoutputfileに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String copy_file(String hostname, String username, String password, String sourcefilename, String destination, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストでファイルを複写します。 ファイルの複写に成功した場合、“Success”を返します。 ファイルの複写に失敗した場合、例外を返します。 |
String move_file(String hostname, String username, String password, String sourcefilename, String destination, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストでファイルを移動します。 ファイルの移動に成功した場合、“Success”を返します。 ファイルの移動に失敗した場合、例外を返します。 |
Integer return_code() | ファイル複写または移動の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイルを複写または移動するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルを複写または移動するホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
sourcefilename 複写元または移動元のファイルの名前を指定します。
destination 複写先または移動先のディレクトリ名またはファイル名を指定します。 overwrite ファイルがすでに存在する場合に、上書きして作成するかを指定します。 ostype 対象となるホストのOS種別を指定します。
execusername ファイルを複写または移動するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecusernameの値を使用しません。 execusernameの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
複写または移動するファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、sourcefilenameおよびdestinationに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String compress_file(String hostname, String username, String password, String compfilename, String filename, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストのファイルを圧縮します。 圧縮形式はzip形式です。 ファイルの圧縮に成功した場合、“Success”を返します。 ファイルの圧縮に失敗した場合、例外を返します。 |
String decompress_file(String hostname, String username, String password, String compfilename, String directoryname, String ostype, String execusername, String execpassword) | 指定したホストの圧縮ファイルを解凍します。 解凍可能な圧縮形式はzip形式です。 ファイルの解凍に成功した場合、“Success”を返します。 ファイルの解凍に失敗した場合、例外を返します。 |
Integer return_code() | ファイル圧縮または解凍の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイルを圧縮または解凍するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルを圧縮または解凍するホストへSSHを利用して接続するユーザーのパスワードを指定します。 ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
compfilename 圧縮ファイルの名前を指定します。
filename 圧縮するファイルの名前を指定します。 directoryname 解凍先ディレクトリの名前を指定します。 overwrite 圧縮ファイルがすでに存在する場合に、上書きして作成するかどうかを指定します。 ostype 対象となるホストのOS種別を指定します。 execusername ファイルを圧縮または解凍するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecusernameの値を使用しません。 execusernameの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
圧縮ファイル名および圧縮するファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、filename、compfilenameおよびdirectorynameに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String change_file_encoding(String searchfile, String outputfile, String character_encoding, String from_encoding, String overwrite) | 指定したホストのファイルの文字コードを変換します。 文字コードの変換に成功した場合、"Success"を返します。 文字コードの変換に失敗した場合、例外を返します。 |
Integer return_code() | 文字コード変換の結果の復帰値を返します。 |
入力情報
searchfile 文字コードを変換するファイルの名前を指定します。
outputfile 文字コードを変換した結果を出力するファイルの名前を指定します。 from_encoding 変換前の文字コードを指定します。
character_encoding 変換後の文字コードを指定します。 overwrite 結果を出力するファイルがすでに存在する場合に、上書きして作成するかどうかを指定します。
注意事項
文字コードを変換するファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、searchfileおよびoutputfileに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String search_file_character_string(String hostname, String username, String password, String searchfile, String searchstring, String outputmode, String searchscope, String searchmode, String exclusionsearch, String outputfile, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストのテキストファイル内の文字列を検索します。 文字列の検索に成功した場合、"Success"を返します。 文字列の検索に失敗した場合、例外を返します。 |
Integer return_code() | 指定文字列を検索した結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイル内の文字列を検索するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイル内の文字列を検索するホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
searchfile 文字列の検索をするファイル名を指定します。
searchstring 検索する文字列を指定します。
outputmode 検索した結果を出力する方式を指定します。 line(行番号のみ出力)、text(行の内容のみ出力)、 all(行番号と行の内容を出力）を指定します。
searchscope 指定文字列のファイル内の検索範囲を指定します。 開始位置と終了位置の番号は-(ハイフン)で区切ります。 開始位置を省略した場合、開始位置はファイルの先頭となります。 終了位置を省略した場合、終了位置はファイルの最後となります。 開始位置と終了位置を省略した場合、ファイルを全検索します。 (例) 10行目から20行目を検索する場合:10-20 ファイルの先頭から20行目を検索する場合:-20 10行目からファイルの最後までを検索する場合:10-
searchnode 指定文字列の検索方法です。 first(指定文字列が初めに検出できるまで検索)、all(指定された範囲を全検索)を指定します。
exclusionsearch 排他検索をするか指定します。 off(通常の検索)、on(排他検索)を指定します。
outputfile 文字列の検索結果を出力するファイル名を指定します。
overwrite outputfileがすでに存在していた場合、上書きをするかを指定します。 off(上書きしない)、on(上書きする)を指定します。 ostype 対象となるホストのOS種別を指定します。
execusername ファイル内の文字列を検索するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
文字列の検索をするファイルには、以下に示す文字コードのテキストファイルを指定してください。
ファイルを作成するホスト | テキストファイルの文字コード |
|---|---|
Windowsの管理サーバ | SJIS |
Linuxの管理サーバ | UTF-8 |
Windowsの連携サーバ・業務サーバ | SJIS |
Linuxの連携サーバ・業務サーバ | 接続ユーザーの環境変数LANGの値の文字コード |
文字列の検索をするファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、searchfile、searchstring、およびoutputfileに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
クラス名
Swrba_File
メソッド一覧
メソッド | 意味 |
String replace_file_character_string(String hostname, String username, String password, String searchfile, String searchstring,String replacestring String outputfile, String overwrite, String ostype, String execusername, String execpassword) | 指定したホストのテキストファイル内の文字列を置換します。 文字列の置換に成功した場合、"Success"を返します。 文字列の置換に失敗した場合、例外を返します。 |
Integer return_code() | 指定文字列を検索した結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username ファイル内の文字列を置換するホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ファイルの文字列を置換するホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
searchfile 文字列の置換をするファイル名を指定します。
searchstring 置換する文字列を指定します。
replacestring 置換後の文字列を指定します。
outputfile 文字列の置換結果を出力するファイル名を指定します。
overwrite outputfileがすでに存在していた場合、上書きをするかを指定します。 off(上書きしない)、on(上書きする)を指定します。 ostype 対象となるホストのOS種別を指定します。
execusername ファイル内の文字列を置換するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
文字列の置換をするファイルには、以下に示す文字コードのテキストファイルを指定してください。
ファイルを作成するホスト | テキストファイルの文字コード |
|---|---|
Windowsの管理サーバ | SJIS |
Linuxの管理サーバ | UTF-8 |
Windowsの連携サーバ・業務サーバ | SJIS |
Linuxの連携サーバ・業務サーバ | 接続ユーザーの環境変数LANGの値の文字コード |
文字列の置換をするファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、searchfile、searchstring、replacestring、およびoutputfileに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_file.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_file.rb |
