<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">


<refentry id="gfservice-agent.1">

<refentryinfo><date>6 Jun 2013</date></refentryinfo>

<refmeta>
<refentrytitle>gfservice-agent</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Gfarm</refmiscinfo>
</refmeta>

<refnamediv id="name">
<refname>gfservice-agent</refname>
<refpurpose><command moreinfo="none">gfservice</command> のエージェント</refpurpose>
</refnamediv>

<refsynopsisdiv id="synopsis">
<cmdsynopsis sepchar=" ">
  <command moreinfo="none">gfservice-agent</command>
    <arg choice="opt" rep="norepeat"><replaceable>オプション</replaceable></arg>
    <arg choice="plain" rep="norepeat">ホスト ID</arg>
    <arg choice="plain" rep="norepeat">サブコマンド</arg>
    <arg choice="opt" rep="norepeat"><replaceable>引数 ...</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<!-- body begins here -->

<refsect1 id="description"><title>DESCRIPTION</title>

<para>
<command moreinfo="none">gfservice-agent</command> は、<command moreinfo="none">gfservice</command> の
エージェントです。
<command moreinfo="none">gfservice</command> を用いて操作したいホストすべてに、この
エージェントをインストールする必要があります。
<command moreinfo="none">gfservice</command> と異なり、設定ファイルは読み込みません。
</para>

<para>
<command moreinfo="none">gfservice-agent</command> は、ユーザが直接実行することを意図
して作成されたものではありません。
日常の利用では、SSH と Sudo を介して <command moreinfo="none">gfservice</command> コマンド
によって実行されるだけです。
</para>

<para>
ホスト ID 引数は <command moreinfo="none">gfservice</command> のものと同じですが、
<command moreinfo="none">gfservice-agent</command> ではホスト ID をホストの種別
("gfmd", "gfsd", "client" のいずれか) を区別するため、および
デバッグメッセージのためにしか使っていません。
</para>

<para>
<command moreinfo="none">gfservice-agent</command> のサブコマンド名は 
<command moreinfo="none">gfservice</command> のものに似ていますが、引数は異なります。
たとえば、<command moreinfo="none">gfservice-agent</command> の <command moreinfo="none">unmount</command>
サブコマンドは、
「<parameter moreinfo="none">directory</parameter>=<replaceable>ディレクトリ</replaceable>」
という引数をとります。
</para>

<literallayout format="linespecific" class="normal">
	gfservice-agent client3 unmount directory=/somewhere
</literallayout>

<para>
これに対して、<command moreinfo="none">gfservice</command> では、
「<replaceable>ディレクトリ</replaceable>」という引数をとります。
</para>

<literallayout format="linespecific" class="normal">
	gfservice unmount client3 /somewhere
</literallayout>

<para>
<command moreinfo="none">gfservice-agent</command> の引数はほとんどすべて、「キー=値」
という形になっています。
複数の引数をとる場合、引数の順序は任意です。
<command moreinfo="none">gfservice-agent</command> は、未知のキーを無視します。
</para>

</refsect1>

<refsect1 id="options"><title>OPTIONS</title>

<variablelist>

<varlistentry>
<term><option>-d</option></term>
<listitem>
<para>
デバッグ情報を出力します。
</para>
</listitem>
</varlistentry>

</variablelist>

</refsect1>

<refsect1 id="sub-commands"><title>SUB-COMMANDS</title>

<para>
<command moreinfo="none">gfservice-agent</command> は現在のところ、次のサブコマンドを
認識します。
</para>

<variablelist>

<varlistentry>
<term>
<command moreinfo="none">get-config-gfarm-param</command>
<parameter moreinfo="none">param</parameter>=<replaceable>パラメタ名</replaceable>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
「<command moreinfo="none">config-gfarm -T</command>」コマンドを実行して、
「<replaceable>パラメタ名</replaceable> 」の値を標準出力に出力します。
引数「<parameter moreinfo="none">param</parameter>=<replaceable>パラメタ名</replaceable>」
が省略された場合は、「<command moreinfo="none">config-gfarm -T</command>」コマンドの
結果すべてを出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">get-config-gfsd-param</command>
<parameter moreinfo="none">param</parameter>=<replaceable>パラメタ名</replaceable>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
「<command moreinfo="none">config-gfsd -T</command>」コマンドを実行して、
「<replaceable>パラメタ名</replaceable>」の値を標準出力に
出力します。
引数「<parameter moreinfo="none">param</parameter>=<replaceable>パラメタ名</replaceable>」
が省略された場合は、「<command moreinfo="none">config-gfsd -T</command>」コマンドの
結果すべてを出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backend-db-status</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
バックエンドデータベースが動作中であれば、終了コード 0 で終了します。
それ以外の場合は、1 で終了します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">gfmd-status</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
gfmd が動作中であれば、終了コード 0 で終了します。
それ以外の場合は、1 で終了します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">gfsd-status</command>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
gfsd が動作中であれば、終了コード 0 で終了します。
それ以外の場合は、1 で終了します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">start-backend-db</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
<parameter moreinfo="none">timeout</parameter>=<replaceable>時間</replaceable>
</term>
<listitem>
<para>
バックエンドデータベースが実行中でなければ、実行を開始します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">start-gfmd</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
<parameter moreinfo="none">timeout</parameter>=<replaceable>時間</replaceable>
</term>
<listitem>
<para>
gfmd が実行中でなければ、実行を開始します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">start-gfsd</command>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
<parameter moreinfo="none">timeout</parameter>=<replaceable>時間</replaceable>
</term>
<listitem>
<para>
gfsd が実行中でなければ、実行を開始します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">config-gfarm</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
「<command moreinfo="none">config-gfarm</command>」コマンドを実行します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">config-gfarm-master</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
「<command moreinfo="none">config-gfarm</command> <parameter moreinfo="none">-r</parameter>」コマンドを実行
します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">config-gfsd</command>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
「<command moreinfo="none">config-gfsd</command>」コマンドを実行します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unconfig-gfarm</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
<command moreinfo="none">stop-gfarm</command> サブコマンドを実行して、その後 gfmd と
バックエンドデータベースが作成したファイルやディレクトリをすべて削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unconfig-gfsd</command>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
サブコマンド <command moreinfo="none">stop-gfsd</command> を実行し、その後 gfsd が作成した
ファイルやディレクトリをすべて削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unconfig-client</command>
<parameter moreinfo="none">config-gfsd-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
<filename moreinfo="none">gfarm2.conf</filename> ファイルと共有秘密鍵ファイルを削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">promote</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
<command moreinfo="none">gfmd</command> をスレーブからマスターへ昇格させます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">promote-gfmd</command>
<parameter moreinfo="none">config-gfarm-options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
サブコマンド <command moreinfo="none">promote</command> の別名です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">mount</command>
<parameter moreinfo="none">directory</parameter>=<replaceable>ディレクトリ</replaceable>
<parameter moreinfo="none">options</parameter>=<replaceable>オプション</replaceable>
</term>
<listitem>
<para>
Gfarm2 ファイルシステムを「<replaceable>ディレクトリ</replaceable>」に
マウントします。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unmount</command>
<parameter moreinfo="none">directory</parameter>=<replaceable>ディレクトリ</replaceable>
</term>
<listitem>
<para>
「<replaceable>ディレクトリ</replaceable>」にマウントされた Gfarm2
ファイルシステムをアンマウントします。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">umount</command>
<parameter moreinfo="none">directory</parameter>=<replaceable>ディレクトリ</replaceable>
</term>
<listitem>
<para>
サブコマンド <command moreinfo="none">unmount</command> の別名です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">set-gfmd-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
<parameter moreinfo="none">value</parameter>=<replaceable>値</replaceable>
</term>
<listitem>
<para>
<filename moreinfo="none">gfmd.conf</filename> ファイルに、
</para>

<literallayout format="linespecific" class="normal">
	<replaceable>設定名称</replaceable> <replaceable>値</replaceable>
</literallayout>

<para>
という行を追加します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">set-gfarm-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
<parameter moreinfo="none">value</parameter>=<replaceable>値</replaceable>
</term>
<listitem>
<para>
<filename moreinfo="none">gfarm2.conf</filename> ファイルに、
</para>

<literallayout format="linespecific" class="normal">
	<replaceable>設定名称</replaceable> <replaceable>値</replaceable>
</literallayout>

<para>
という行を追加します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">set-gfsd-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
<parameter moreinfo="none">value</parameter>=<replaceable>値</replaceable>
</term>
<listitem>
<para>
<filename moreinfo="none">gfsd.conf</filename> ファイルに、
</para>

<literallayout format="linespecific" class="normal">
	<replaceable>設定名称</replaceable> <replaceable>値</replaceable>
</literallayout>

<para>
という行を追加します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unset-gfmd-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
</term>
<listitem>
<para>
「<replaceable>設定名称</replaceable>」行を <filename moreinfo="none">gfmd.conf</filename>
ファイルから削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unset-gfarm-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
</term>
<listitem>
<para>
「<replaceable>設定名称</replaceable>」行を <filename moreinfo="none">gfarm.conf</filename>
ファイルから削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">unset-gfsd-conf</command>
<parameter moreinfo="none">directive</parameter>=<replaceable>設定名称</replaceable>
</term>
<listitem>
<para>
「<replaceable>設定名称</replaceable>」行を <filename moreinfo="none">gfsd.conf</filename>
ファイルから削除します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-backend-db</command>
</term>
<listitem>
<para>
バックエンドデータベースのバックアップを行い、バックアップデータを標準出力
へ出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-gfmd-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfmd.conf</filename> ファイルを標準出力に出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-gfarm-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfarm2.conf</filename> ファイルを標準出力に出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-gfsd-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfsd.conf</filename> ファイルを標準出力に出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-usermap</command>
</term>
<listitem>
<para>
<filename moreinfo="none">usermap</filename> ファイルを標準出力に出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">backup-shared-key</command>
</term>
<listitem>
<para>
<filename moreinfo="none">$HOME/.gfarm_shared_key</filename> ファイルを標準出力に
出力します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-backend-db</command>
</term>
<listitem>
<para>
バックエンドデータベースをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-gfmd-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfmd.conf</filename> ファイルをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-gfarm-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfarm2.conf</filename> ファイルをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-gfsd-conf</command>
</term>
<listitem>
<para>
<filename moreinfo="none">gfsd.conf</filename> ファイルをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-usermap</command>
</term>
<listitem>
<para>
<filename moreinfo="none">usermap</filename> ファイルをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">restore-shared-key</command>
</term>
<listitem>
<para>
<filename moreinfo="none">$HOME/.gfarm_shared_key</filename> ファイルをリストアします。
バックアップデータは、標準入力から読み込みます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">gfcmd</command>
<parameter moreinfo="none">cmd</parameter>=<replaceable>コマンド名</replaceable>
<parameter moreinfo="none">args</parameter>="<replaceable>コマンドの引数 ...</replaceable>"
</term>
<listitem>
<para>
Gfarm コマンドを実行します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<command moreinfo="none">grid-proxy-init</command>
<parameter moreinfo="none">args</parameter>="<replaceable>コマンドの引数 ...</replaceable>"
</term>
<listitem>
<para>
<command moreinfo="none">grid-proxy-init</command> コマンドを実行します。
</para>
</listitem>
</varlistentry>

</variablelist>

</refsect1>

</refentry>
