第1章 Hammer の概要

hammer オプションおよびサブコマンドの完全な一覧を表示するには以下を実行します。

$ hammer --help

以下のように --help を使用してサブコマンドを確認します。

$ hammer organization --help

以下のように grep を使用して help の出力を検索するか、テキストビューワーにリダイレクトすることができます。

$ hammer | less

hammer コマンドを使用する場合は Red Hat Satellite に ID を証明する必要があります。hammer コマンドは手動または自動で実行できます。いずれの場合も、認証には Satellite 認証情報が必要です。hammer 認証には 3 つの方法があります。

自動でコマンドを実行する場合は、hammer 設定ファイルを使用することが推奨されます。たとえば、cron ジョブから Satellite メンテナンスコマンドを実行する場合です。コマンドを手動で実行する場合は、hammer 認証セッションを使用して、コマンドを実行するたびに認証情報を提供する方法が推奨されます。

:foreman:
 :username: 'username'
 :password: 'password'

$ hammer -u username -p password subcommands

Satellite Server がインストールされていないホストに、hammer をインストールして、リモートの Satellite への接続に使用できます。

多くの hammer コマンドは組織固有のものです。--organization パラメーターや --organization-id パラメーターを毎回指定しなくてもよいように、hammer コマンドにデフォルトの組織を設定できます。デフォルトの組織を設定するには、以下のいずれかのコマンドを使用します。

$ hammer defaults add --param-name organization --param-value org_name
$ hammer defaults add --param-name organization_id --param-value org_ID

hammer organization list コマンドの出力で org_ID を確認します。

同様に、名前または ID を指定して、デフォルトのロケーションを設定します。以下のいずれかのコマンドを実行します。

$ hammer defaults add --param-name location --param-value loc_name
$ hammer defaults add --param-name location_id --param-value loc_ID

現在指定しているデフォルトの設定を表示するには、以下のコマンドを実行します。

$ hammer defaults list

1 つの組織を管理することが多い場合には、デフォルトの組織を指定するとコマンドを省略できるので便利です。ただし、別の組織に切り替える場合には、コマンドラインオプションを使用して指定する必要があります。本ガイドの例は、デフォルトの組織を指定していないことを前提としており、「Hammer コマンドで組織の特定」のように、シェル変数のアプローチを使用します。

デフォルトでは、グローバルの hammer 設定は以下の場所に配置されています。

hammer (~/.hammer/cli_config.yml) または CLI モジュール (~/.hammer/cli.modules.d/ の適切な .yml ファイル) にユーザー固有のディレクティブを設定できます。

設定ファイルの読み込み順と、読み込んだモジュールのバージョンを表示するには、以下を実行します。

$ hammer -d --version

「認証」に記載されているような認証情報を保存する以外に、~/.hammer/ 設定ディレクトリーに他の複数のオプションを設定できます。たとえば、~/.hammer/cli_config.yml でデフォルトのログレベルを変更して、以下のディレクティブを使用してログのローテーションを設定することができます。これらのディレクティブは、現在のユーザーにのみ影響を及ぼし、グローバルには適用されない点に注意してください。

:log_level: 'warning'
:log_size: 5 #in MB

同様に、ユーザーインターフェースの設定を行います。たとえば、Hammer 出力で、要求ごとに表示するエントリー数を設定するには、以下の行を変更します。

:per_page: 30

この設定は、--per-page Hammer オプションと同等です。

hammer を設定して、さまざまな Satellite コンポーネントのデバッグ情報をロギングすることができます。

全 Satellite コンポーネントに対してデバッグまたは通常の設定オプションを設定できます。

# foreman-maintain service restart

対話型シェルで hammer コマンドを発行することができます。このシェルを呼び出すには、以下のコマンドを発行します。

$ hammer shell

このシェルでは、「hammer」と入力せずに直接サブコマンドを入力できるので、スクリプトで使用する前にコマンドをテストする際に便利です。このシェルを終了するには、exit と入力するか、[Ctrl + D] を押してください。

hammer コマンドのデフォルトの出力形式を変更して、他のコマンドラインツールやアプリケーションでこの出力結果を処理しやすくすることができます。たとえば、CSV 形式で、カスタムの区切り文字を利用して (ここではセミコロンを使用) 組織を表示するには、以下のコマンドを実行します。

$ hammer --csv --csv-separator ";" organization list

CSV 形式での出力は、ID を解析したり for ループで使用したりする必要がある場合に便利です (例2.6「ACME 組織の全リポジトリーの同期」または例2.8「複数製品への同期プランの割り当て」を参照してください)。

--output オプションには、他に複数のフォーマットオプションがあります。

$ hammer --output output_format organization list

output_format を、以下のいずれかに置き換えます。

hammer コマンドの使用時には、出力からヘッダーを隠すオプションがあります。カスタムスクリプトでパイプを使用するまたは出力を使用する場合は、出力の非表示が便利です。

hammer ping コマンドを使用して、コアの Satellite サービスのステータスを確認することができます。foreman-maintain service status コマンドと併用すると、Satellite の問題の診断、トラブルシューティングに役立ちます。すべてのサービスが予想どおりに実行されている場合には、出力は以下のようになります。

$ hammer ping
candlepin:
    Status:          ok
    Server Response: Duration: 22ms
candlepin_auth:
    Status:          ok
    Server Response: Duration: 17ms
pulp:
    Status:          ok
    Server Response: Duration: 41ms
pulp_auth:
    Status:          ok
    Server Response: Duration: 23ms
foreman_tasks:
    Status:          ok
    Server Response: Duration: 33ms