ページの先頭行へ戻る
Systemwalker Runbook Automation リファレンスガイド
Systemwalker
第3章 運用操作部品リファレンス > 3.5 構成要素の操作部品 > 3.5.1 構成要素を取得
前次

3.5.1 構成要素を取得

機能説明

構成管理データベース(Configuration Management Data Base)に格納されている構成要素(Configuration Item)を取得します。

オプション

基本オプション

(1) hostname

構成要素を取得依頼するホスト名またはIPアドレスです。

構成要素の取得先を管理サーバに設定する場合、以下を指定します。

  • IPv4の場合: “localhost”または“127.0.0.1”

  • IPv6の場合: “localhost”または“::1”

ホスト名またはIPアドレスを省略した場合、引数エラーとなります。

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

(2) searchxpath

構成要素を取得するための条件式です。

searchxpathを省略した場合、引数エラーとなります。

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

構成要素を取得するための条件式は、以下のように指定します。

(例)

  • すべての論理サーバ情報(LogicalServer)を取得

    /%LogicalServer

  • hostnameが“svr001”の論理サーバ情報(LogicalServer)を取得

    /%LogicalServer[./#observed/rc:LogicalServer[@hostname='svr001']]

  • OS種別(OSSetting)が“Windows”の論理サーバ情報(LogicalServer)を取得

    /%LogicalServer[(./#observed/rc:LogicalServer/rc:SystemSettings/rc:OSSetting[matches(@name,'Windows.*')])]

ポイント

  • 通常のXPathの軸(axis)に対して、“%”、“&”、“#”を用いたCMDB独自の拡張が追加されています。

  • “%”は構成アイテムを表します。%の後に構成アイテムのタイプ名を指定します。例えば、“%LogicalServer”は構成アイテム“LogicalServer”を表します。

  • “&”はリレーションを表します。&の後にリレーションのタイプ名を指定します。通常は“&GRelation”を指定してください。

  • /%LogicalServer/&GRelation/%InstalledSoftwareのように記述することで、LogicalServerと関連しているInstalledSoftwareを検索できます(検索結果はInstalledSoftwareです)。

  • “#”はレコードを表します。“#expected”は設計レコードを、“#observed”は実態レコードを表します。

  • 構成アイテムの定義については、“第6章 構成アイテム形式”を参照してください。

拡張オプション

(1) xpath

構成要素から属性情報を取得するための条件式です。

xpathを指定した場合、条件に一致した属性情報を取得します。

条件に一致した属性情報が複数存在する場合は、属性情報をダブルクォーテーションで囲み、カンマ区切りで文字列を出力します。

(例) 属性情報がAおよびB "C,D"の場合："A","B ""C,D"""

xpathを省略した場合、searchxpathで指定したサーバの構成要素を取得します。

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

構成要素から属性情報を取得するための条件式は、以下のように指定します。

(例)

特定の論理サーバの属性情報を取得：

entities/cmdb:item/cmdb:record/ns0:LogicalServer/attribute::属性名

(2) ostype

構成要素を取得依頼するホストのOS種別です。

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

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

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

(3) username

構成要素を取得依頼するホストへSSHを利用して接続するユーザー名です。

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

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

  • 業務サーバがWindowsの場合: システムユーザー

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

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

(4) password

構成要素を取得依頼するホストへSSHを利用して接続するユーザーのパスワードです。

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

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

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

(5) execusername

構成要素を取得依頼するホストで、構成要素を取得するユーザー名です。

実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。

hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。

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

(6) execpassword

本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。

(7) timeout

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

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

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

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

(8) retry

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

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

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

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

(9) retry_interval

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

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

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


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

復帰値

アイコン

シンボル名
矢印名

復帰値

意味

成功

0

構成要素の取得に成功しました。

失敗

161

構成要素の取得に失敗しました。リトライ回数を指定した場合、リトライします。

187

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

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

188

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

189

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

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

197

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

または、条件式に一致した構成要素がありませんでした。

200

構成要素の取得が異常終了しました。

－

－

201

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

202

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

203

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

205

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

206

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

207

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

208

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

出力情報

変数

意味

message

構成要素の取得に成功した場合、以下のメッセージを設定します。

The operation component was successful.

構成要素の取得に失敗した場合、エラー内容を文字列として設定します。

ci_get_result

取得結果をXML形式の文字列として設定します。xpathを指定している場合は、CSV形式の文字列として設定します。

returnCode

復帰値を設定します。

（ci_get_resultの出力例）

<?xml version="1.0" encoding="UTF-8"?>
<entities>
<cmdb:item id="xxxxx" type="LogicalServer" version="1" xmlns:cmdb="http://xxxxx">
  <cmdb:record type="observed">
    <ns0:LogicalServer hostname="xxxxx" id="xx.xx.xx.xx" ipAddress="xx.xx.xx.xx" name="" nickname="xxxxx" status="unknown" vendorID="" xmlns:ns0="urn:xmlns-fujitsu-com:rcxml2004-05">
      <ns0:LogicalServerConfiguration>
        <ns0:LogicalPSU option=""/>
        <ns0:LAN description=" " id="xxxxx" index="" ipAddress="xx.xx.xx.xx" macAddress="xx:xx:xx:xx:xx:xx" netmask="xx.xx.xx.xx" netmaskAddress="xx.xx.xx.xx" speed=""/>
      </ns0:LogicalServerConfiguration>
      <ns0:SystemSettings>
        <ns0:Network gateway="xx.xx.xx.xx" hostname="xxxxx" subnetAddress="xx.xx.xx.x" subnetMask="xx.xx.xx.xx"/>
        <ns0:OSSetting codeSet="UTF-8" name="LINUX"/>
        <ns0:DHCP flag="0"/>
        <ns0:NTDomain name=" "/>
        <ns0:SNMP certifyProtocol="" community="public" description="" encryptionProtocol="" securityLevel="" securityModel="None" userName=""/>
      </ns0:SystemSettings>
    </ns0:LogicalServer>
  </cmdb:record>
  <cmdb:instanceId>
    <cmdb:mdrId>mdr000000000004</cmdb:mdrId>
    <cmdb:localId>xx.xx.xx.xx</cmdb:localId>
  </cmdb:instanceId>
  <cmdb:instanceId>
    <cmdb:mdrId>mdr000000000001</cmdb:mdrId>
    <cmdb:localId>xxxxx</cmdb:localId>
  </cmdb:instanceId>
</cmdb:item>
</entities>

注意事項

前次
Copyright 2010-2017 FUJITSU LIMITED