オペレーションライブラリでは、以下のクラスを提供します。
項番 クラス名称 |
クラス名
Swrba_Systemoperation
メソッド一覧
メソッド | 意味 |
String Systemoperation_shutdown(String hostname, | OSに停止依頼を行います。 停止依頼に成功した場合、"Success"を返します。 停止依頼に失敗した場合、例外を返します。 |
String Systemoperation_reboot(String hostname, | OSに再起動依頼を行います。 再起動依頼に成功した場合、"Success"を返します。 再起動依頼に失敗した場合、例外を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
deferringtime OSの停止または再起動処理開始までの猶予時間を指定します。
ostype OSのタイプを指定します。
username サーバのホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password サーバのホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
execusername 処理を実行するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
格納場所
Windows | <インストールパス>\SWRBAM \rbaope\bin\parts\lib \standard\swrba_systemoperation.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_systemoperation.rb |
クラス名
Swrba_Systemoperation
メソッド一覧
メソッド | 意味 |
String change_hostname(String hostname, String newhostname, String ostype, String username, String password, String execusername, String execpassword, String domainusername, String domainpassword) | ホスト名の変更を行います。 ホスト名の変更に成功した場合、変更後のホスト名を返します。 ホスト名の変更に失敗した場合、例外を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
newhostname 変更後のホスト名を指定します。
ostype OSのタイプを指定します。
username サーバのホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password サーバのホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
execusername 処理を実行するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。 domainusername ドメインに接続するためのユーザー名を指定します。 domainpassword ドメインに接続するためのユーザーのパスワードを指定します。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
本ライブラリを使用してLinuxのホスト名を変更する場合、以下のファイルに対して操作を行います。
/etc/sysconfig/network
/etc/hosts
変更後のホスト名には半角英数字と-(ハイフン)の指定が可能です。ホスト名の先頭には半角英字のみ、ホスト名の末尾には半角英数字のみ指定してください。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
管理サーバのインストールパスに空白文字を入力した場合、本ライブラリを利用した操作結果は保証されません。本ライブラリを利用して運用操作部品を作成する場合は、管理サーバのインストールパスに空白文字を含めないでください。
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_systemoperation.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_systemoperation.rb |
クラス名
Swrba_Systemoperation
メソッド一覧
メソッド | 意味 |
String join_domainorworkgroup(String hostname, String username, String password, String domain, String workgroup, String domainusername, String domainpassword) | OSに設定するドメイン名またはワークグループ名の設定を行います。 設定に成功した場合、"Success"を返します。 設定に失敗した場合、例外を返します。 |
String set_dns(String hostname, String username, String password, String interfacename, String dns, String ostype, String execusername, String execpassword) | OSに設定するDNSサーバアドレスを設定します。 設定に成功した場合、"Success"を返します。 設定に失敗した場合、例外を返します。 |
String set_wins(String hostname, String username, String password, String interfacename, String wins) | OSに設定するWINSアドレスを設定します。 設定に成功した場合、"Success"を返します。 設定に失敗した場合、例外を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
username サーバのホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password サーバのホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
domain OSに設定するドメイン名を指定します。 workgroup OSに設定するワークグループ名を指定します。 domainusername ドメインに参加するためのユーザー名を指定します。 domainuserpassword ドメインに参加するためのユーザーのパスワードを指定します。 interfacename DNSサーバアドレス、WINSアドレスを設定するネットワーク・インターフェースの名前を指定します。 dns OSに設定するDNSサーバアドレスを指定します。 wins OSに設定するWINSアドレスを指定します。
ostype OSのタイプを指定します。
execusername 処理を実行するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、domain、workgroup、およびinterfacenameに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
管理サーバのインストールパスに空白文字を入力した場合、本ライブラリを利用した操作結果は保証されません。本ライブラリを利用して運用操作部品を作成する場合は、管理サーバのインストールパスに空白文字を含めないでください。
格納場所
Windows | <インストールパス>\SWRBAM \rbaope\bin\parts\lib \standard\swrba_systemoperation.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_systemoperation.rb |
クラス名
Swrba_Systemoperation
メソッド一覧
メソッド | 意味 |
String install_software(String hostname,String commandline, String sourcehostname, String sourcefile, String destinationfile, String ostype, String username, String password, String execusername, String execpassword, Sting sourceostype, String sourceusername, String sourcepassword) | ソフトウェアのインストールを行います。 インストールに成功した場合、"Success"を返します。 インストールに失敗した場合、例外を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
commandline ソフトウェアをインストールするコマンド名と引数を指定します。
sourcehostname ソフトウェアのインストールファイルの転送元のホスト名またはIPアドレスを指定します。
sourcefile ソフトウェアのインストールファイルの名前を指定します。
destinationfile インストール先のソフトウェアのインストールファイルの名前を指定します。
ostype OSのタイプを指定します。
username ホストへSSHを利用して接続するユーザー名を指定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり 変更できません。このため、ユーザー名を指定しても無効になります。 ・業務サーバがWindowsの場合: システムユーザー
・業務サーバがLinuxの場合: root password ホストへSSHを利用して接続するユーザーのパスワードを指定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
execusername 処理を実行するユーザー名を指定します。
hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、 システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。 execpassword 本ライブラリではexecpasswordの値を使用しません。 execpasswordの値を指定した場合、無効となります。
sourceostype ファイル転送元のホストのOSのタイプを指定します。 sourceusername ファイル転送元のホストへSSHを利用して接続するユーザー名を指定します。 sourcepassword ファイル転送元のホストへSSHを利用して接続するユーザーのパスワードを指定します。
注意事項
本ライブラリは、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともいずれかの方法では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
インストールファイルにフォルダ(ディレクトリ)名を指定した場合、指定したフォルダ(ディレクトリ)配下にあるファイルを圧縮したあとで、インストール先のホストに圧縮ファイルの転送を行います。本ライブラリの処理を行っている間、sourcefile、および、destinationfileに指定したフォルダ(ディレクトリ)に一時的に圧縮ファイルを作成します。
インストールファイルが自己解凍ファイルの場合は、事前に解凍を行ってください。
インストールを行うホストに転送したインストールファイルは、本ライブラリの処理が終わったあとも削除はしません。
インストール後にOSを自動で再起動するソフトウェアをインストールした場合でも、本ライブラリは正常終了します。
インストールファイル名には、半角英数字と以下の記号のみを利用してください。
利用可能な記号：“!”、“~”、“_”、“-”、“.”
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
インストールを実行するサーバにRBAエージェントが未導入の場合は、commandlineに日本語を指定すると操作結果は保証されません。日本語を指定する場合はインストールを実行するサーバにRBAエージェントを導入してください。
業務サーバにRBAエージェントが未導入の場合は、sourcefileおよびdestinationfileに日本語を指定すると操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
復帰値について、Systemwalker Runbook Automationでは、159～240までの値を設定しています。159～240以外の復帰値、および159～240内でも未使用の復帰値は、Systemwalker Runbook Automationが設定した値ではなく、インストールコマンドが出力した値です。コマンド自身を調査してください。
commandlineオプションに存在しないコマンド名を指定した場合、復帰値42のエラーとなる場合があります。
管理サーバのインストールパスに空白文字を入力した場合、本ライブラリを利用した操作結果は保証されません。本ライブラリを利用して運用操作部品を作成する場合は、管理サーバのインストールパスに空白文字を含めないでください。
格納場所
Windows | <インストールパス>\SWRBAM \rbaope\bin\parts\lib \standard\swrba_systemoperation.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_systemoperation.rb |
