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

$ hammer --help

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

$ hammer organization --help

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

$ hammer | less

デフォルトでは hammer は、コマンドをハックするたびに、Satellite の認証情報を求めます。以下のようにコマンド実行時に認証情報を指定できます。

$ hammer -u <username> -p <password> <subcommands>

または、以下の手順に従い、保存した認証情報を使用してください。

Satellite がインストールされていないサーバーで個別に hammer をインストールして、そのサーバーをリモートの Satellite と接続して使用することができます。

このパッケージのインストールには、rhel-X-server-satellite-6.X-rpms リポジトリーが必要です。接続にワークステーションを使用するには、リポジトリーを手動でインストールする必要があります。詳細は『Red Hat Satellite インストールガイド』を参照してください。

多くの hammer コマンドは組織固有のものです。--organization-id パラメーターを毎回指定しなくても良いように、Hammer コマンドにデフォルトの組織や、場所を設定することができます。これには以下を実行します。

$ hammer defaults add --param-name organization_id --param-value <org_ID>

hammer organization list コマンドの出力で <org_ID> を検索します。同様に、以下のようにデフォルトの場所を設定することができます。

$ hammer defaults add --param-name location_id --param-value <loc_ID>

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

$ hammer defaults list

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

デフォルトでは、グローバルの 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 オプションと同等)。

:per-page: 30

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

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

対話型シェルで 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 ping コマンドを使用して、コアの Satellite サービスのステータスを確認することができます。katello-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

Red Hat Satellite の組織は、Satellite デプロイメント内にあるシステム、コンテンツ、その他の機能を分離して集めたものです。本章では、hammer を使用した組織の作成、変更の方法を説明します。

$ hammer organization create \
--name "<org_name>" \
--label "<org_label>" \
--description "<org_description>"

$ ORG="ACME"
$ hammer organization create \
--name $ORG \
--description "Example organization"

$ hammer organization update \
--name $ORG \
--compute-resource-ids 1

$ hammer organization list

$ ORG = "Red Hat Enterprise Linux Developer Team"
$ hammer product list --organization $ORG

$ hammer defaults add --param-name organization_id --param-value 1

$ hammer subscription upload \
--organization-label <org_label> \
--file <path_to_manifest>

$ hammer subscription upload --organization $ORG --file /tmp/manifest.zip

$ hammer subscription list --organization $ORG

Red Hat Satellite の場所は、物理的な場所を示すデフォルトの設定を集めたものです。本セクションでは、hammer を使用した場所の作成方法を説明します。

$ hammer location create --name <location_name>

ORG="ACME"
LOCATIONS="london munich boston"

for LOC in ${LOCATIONS}
do
  hammer location create --name "${LOC}"
  hammer location add-organization --name "${LOC}" --organization "${ORG}"
done

リポジトリーは、コンテンツコレクション用のストレージを提供します。本セクションでは、hammer を使用してリポジトリーを有効化、同期する方法を説明します。

$ hammer repository-set enable \
--organization-label <org_label> \
--product "<product_name>" \
--basearch "<base_architecture>" \
--releasever "<release_version>" \
--name "<repository_name>"

$ hammer repository-set enable \
--organization $ORG \
--product "Red Hat Enterprise Linux Server" \
--basearch "x86_64" \
--releasever "7Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)"

$ hammer repository synchronize \
--product "<product_name>" \
--name "<repo_name>" \
--organization-label <org_label> \
--async

$ hammer repository synchronize \
--product "Red Hat Enterprise Linux Server" \
--name "Red Hat Enterprise Linux 7 Server (RPMs)" \
--organization $ORG \
--async

Repository is being synchronized in task 640bb71f-0ce5-40a3-a675-425a4acacceb

$ hammer task progress --id 640bb71f-0ce5-40a3-a675-425a4acacceb

$ hammer repository list --organization $ORG

$ hammer product synchronize \
--organization-label <org_label> \
--name "<product_name>" \
--async

ORG="ACME"

for i in $(hammer --csv repository list --organization $ORG | grep -vi '^ID' | awk -F, {'print $1'})
do
  hammer repository synchronize --id ${i} --organization $ORG --async
done

$ hammer sync-plan create \
--name "<sync_plan_name>" \
--enabled=true \
--interval <repetition_interval> \
--organization-label <org_label> \
--sync-date "<initial_sync>"

$ hammer sync-plan create \
--name "daily sync at 3 a.m." \
--enabled=true \
--interval daily \
--organization $ORG \
--sync-date "2016-01-15 03:00:00"

$ hammer product set-sync-plan \
--organization-label <org_label> \
--name "<product_name>" \
--sync-plan "<sync_plan_name>"

ORG="ACME"
SYNC_PLAN="daily sync at 3 a.m."

for i in $(hammer --csv product list --organization $ORG --per-page 999 | grep -vi '^ID' | grep -vi not_synced | awk -F, {'{ if ($5!=0) print $1}'})
do
  hammer product set-sync-plan --sync-plan $SYNC_PLAN --organization $ORG --id $i
done

$ hammer product list --organization $ORG --sync-plan "daily sync at 3 a.m."

$ hammer sync-plan list --organization-label <org_label>

$ hammer product create --name "<product_name>" --organization-label <org_label>

$ hammer repository create \
--name "<repo_name>" \
--organization-label <org_label> \
--product "<product_name>" \
--content-type <cont_type> --publish-via-http true \
--url "<repo_url>"

$ hammer repository upload-content \
--product "<product_name>" \
 --organization-label <org_label> \
 --id "<repo_id>" \
--path <path_to_dir>

ライフサイクル環境は、コンテンツライフサイクルのステージを表します。本セクションでは、hammer を使用してライフサイクル環境を表示、作成する方法を説明します。デフォルトでは、組織ごとにライブラリー環境が存在します。以下の構文を使用して、新しいライフサイクル環境を作成します。

$ hammer lifecycle-environment create \
--name <env_name> \
--description "<env_description>" \
--organization-label <org_label> \
--prior <prior_env_name>

$ hammer lifecycle-environment create \
--name Development \
--description "Initial testing" \
--organization $ORG \
--prior Library

既存のライフサイクル環境を表示するには、以下のコマンドを実行します。

$ hammer lifecycle-environment list --organization-label <org_label>

上記のコマンドの出力は以下のようになります。

---|-------------|------------
ID | NAME        | PRIOR
---|-------------|------------
2  | Library     |
5  | Development | Library
6  | Testing     | Development
---|-------------|------------

ライフサイクル環境に関するコマンドの情報は、hammer lifecycle-environment --help を参照してください。

コンテンツビューとは、ライブラリーからのコンテンツのサブセットで、インテリジェントフィルターで作成されます。コンテンツビューは、別の用途で (通常、開発、QA、実稼働環境) コンテンツを利用できるように、ライフサイクル環境に公開、プロモートすることができます。

$ hammer content-view create \
--name <cv_name> \
--repository-ids <repo_ID1>,<repo_ID2>,<repo_ID3> \
--description "<cv_description>" \
--organization-label <org_label>

--repository-ids オプションは、選択したリポジトリーをコンテンツビューに追加して、hammer repository list コマンドを使用して ID を検索します。このオプションを省略して、空のコンテンツビューを作成し、update または add-repository サブコマンドを使用して後ほど変更することもできます。

$ hammer content-view create \
--name cv-rhel7-server \
--repository-ids 1,2,3 \
--description "Initial CV for RHEL 7" \
--organization $ORG

$ hammer content-view create \
--name ccv-rhel7-server-scl \
--description "CCV for RHEL7 and Software Collections" \
--organization $ORG \
--composite --component-ids 2,6

コンテンツビューに追加可能なコンテンツビューは、RPM パッケージ、Puppet モジュール、Docker イメージの 3 つです。

$ hammer content-view update \
--repository-ids <repo_ID1>,<repo_ID2>... \
--name <cv_name> \
--organization-label <org_label>

$ hammer content-view add-repository \
--organization-label <org_label> \
--name <cv_name> \
--repository-id <repo_ID>

$ hammer content-view filter create \
--type rpm \
--name exclude-emacs \
--description "Excluding emacs package" \
--inclusion false \
--organization $ORG \
--repository-ids 1,2,3 \
--content-view cv-rhel7-server

$ hammer content-view filter rule create \
--name "emacs*" \
--organization $ORG \
--content-view cv-rhel7-server \
--content-view-filter exclude-emacs

$ hammer content-view filter rule list \
--content-view cv-rhel7-server \
--content-view-filter exclude-emacs \
--organization $ORG

$ hammer content-view filter create \
--type erratum \
--name limit-errata-by-date \
--description "Excluding errata by date" \
--inclusion false \
--organization $ORG \
--repository-ids 1,2,3 \
--content-view cv-rhel7-server

$ hammer content-view filter rule create \
--end-date <YYYY-MM-DD> \
--organization $ORG \
--content-view cv-rhel7-server \
--content-view-filter limit-errata-by-date \
--types enhancement,bugfix,security

$ hammer content-view puppet-module add \
--content-view <cv_name> \
--name <module_name>

$ hammer repository upload-content --path <image_archive> --id <repo_id>

コンテンツビューを公開し、表示してホストが利用できるようにします。以下のコマンドを使用して選択したコンテンツビューを公開します。

$ hammer content-view publish \
--id <cv_ID> \
--organization-label <org_label> \
--async

コンテンツビューの <cv_ID> を検索して、hammer content-view list コマンドの出力に公開します。公開されたコンテンツビューはライブラリー環境で利用できます。コンテンツビューのステータスを確認するには、以下のコマンドを実行します。

$ hammer content-view info --id <cv_ID>

プロモーションとは、別のライフサイクル環境にコンテンツビューを移動する行為のことです。これには以下のコマンドを実行します。

$ hammer content-view version promote \
--content-view <cv_name> \
--organization-label <org_label> \
--to-lifecycle-environment <env_name>

ここでは env_name は移行後のライフサイクル環境名を示します。

ORG="ACME"
CV_ID=1

for i in $(hammer --csv lifecycle-environment list --organization $ORG | grep -vi '^ID' | awk -F, {'print $1'} | sort -n)
do
   hammer content-view version promote --organization $ORG --to-lifecycle-environment-id $i --id $CV_ID
done

$ hammer content-view version info --id 1

増分更新では、ライフサイクル環境で新規コンテンツビューのバージョンをプロモートする必要なしに、公開されたコンテンツビューを変更できます。増分更新の結果、新規コンテンツビューのマイナーバージョンが作成されます。増分更新は、緊急時に素早く更新するには有用です。エラータ、パッケージ または Puppet モジュールの追加に、増分更新を使用できます。

コンテンツビューに新規パッケージを追加する増分更新を作成するには以下を実行します。

$ hammer content-view version incremental-update \
--content-view-version-id <cv_ID> \
--packages <pkg_name1>,<pkg_name2> \
--lifecycle-environment-ids <env_ID1>, <env_ID2>,...

hammer content view version list の出力でコンテンツビューのバージョン ID を検索します。--packages オプションでパッケージを指定するのではなく、--puppet-modules で Puppet モジュールを、--errata-ids でエラータを追加できます (例3.8「増分更新を使用してコンテンツビューにエラータを追加する手順」を参照します)。増分更新との連携についての情報は hammer content-view version incremental-update --help を実行します。

$ hammer content-view version incremental-update \
--content-view-version-id 4 \
--errata-ids 8c3801f6-12a7-4a62-83f4-addbb1f34ce6 \
--lifecycle-environments Infrastructure

Red Hat Satellite のドメインは DNS ゾーンを表します。Satellite は、Red Hat Satellite Capsule Server DNS を使用してドメイン名を割り当てる機能があります。これにより、特定のドメイン内のホストをグループ化し、名前を指定して、パラメーターや Puppet 変数と関連付けることができます。

新規ドメインを作成するには、以下のコマンドを実行します。

$ hammer domain create --name <domain_name>

hammer organization add-domain または hammer location add-domain コマンドを使用して組織と場所に対して、新規作成したドメインを関連付けることができます。ドメインのステータスを表示するには、以下のコマンドを実行します。

$ hammer domain info --name <domain_name>

Red Hat Satellite のサブネットは、システムのグループを指定するネットワークを定義します。サブネットは、標準の IP アドレス設定を使用して、ネットワークを定義、Red Hat Satellite Capsule Server の DHCP 機能を使用して、サブネット内のシステムに IP アドレスを割り当てます。以下のコマンドには、サブネットの作成に最小限必要なオプションが含まれます。

$ hammer subnet create \
--name <subnet_name> \
--organization-ids <org_ID1>,<org_ID2>... \
--location-ids <loc_ID1>,<loc_ID2>... \
--domain-ids <dom_ID1>,<dom_ID2>... \
--boot-mode <boot_mode> \
--network <network_address> \
--mask <netmask> \
--ipam <ipam>

ここでは <boot_mode> は Static または DHCP のいずれか、<ipam> は DHCP, Internal DB、None のいずれかを指定します。DHCP を使用する場合は --from および --to オプションを使用して IP 範囲を設定してください。設定可能なオプションの完全な一覧は、hammer subnet create --help コマンドの出力を参照してください。

Satellite のアーキテクチャーはホストおよびオペレーティングシステムの論理グループを表します。アーキテクチャーを表示するには以下のコマンドを実行します。

$ hammer architecture list

アーキテクチャーは、ホストが Puppet に登録されると自動的に Satellite により登録されるため、(hammer でこのオプションが提供されていますが) 手動で作成する必要はほぼありません。

コンピュートリソースは、仮想化およびクラウドプロバイダーからハードウェアを抽象化したものです。Satellite はコンピュートリソースを使用して仮想マシンとコンテナーをプロビジョニングします。以下のコマンドを使用してコンピュートリソースを作成します。

$ hammer compute-resource create \
--name <cr_name> \
--organization-ids <org_ID1>,<org_ID2>... \
--location-ids <loc_ID1>,<loc_ID2>... \
--provider <provider>

ここでは <provider> は RHEV、RHEL OpenStack Platform、Libvirt、Docker、Rackspace、Google、EC2 または VMware のいずれかを指定します。プロバイダーのタイプに従い、--url または --user などの他のオプションが必要な場合もあります。詳細は hammer compute-resource create --help コマンドの出力を参照してください。

インストールメディア (ISO イメージ) では、Red Hat Satellite のキックスタートツリー及び新規ホストインストールのコンテンツを提供します。メディアを表示するには、以下のコマンドを実行します。

$ hammer medium list

新規メディアを追加するには以下のコマンドを実行します。

$ hammer medium create --name <medium_name> --path <path_to_medium>

メディアの追加時 (hammer medium create --help コマンドの出力参照) または 後ほど hammer organization add-medium か hammer location add-medium コマンドを使用して、メディアを組織および場所で直接利用できるようにすることが可能です。

パーティションテーブルは、システムのプロビジョニング時の新規インストール用のパーティションとファイルシステムのレイアウトを定義します。Red Hat Satellite により、オペレーティングシステムファミリーが関連付けられたデフォルトのパーティションテーブルを提供します。パーティションテーブルを表示するには、以下のコマンドを実行します。

$ hammer partition-table list

新しいパーティションテーブルを作成するには、以下のコマンドを実行します。

$ hammer partition-table create \
--name <table_name> \
--file <path_to_layout_file> \
--os-family <os_family>

他のサブコマンドについては hammer partition-table --help コマンドを参照してください。

テンプレートをプロビジョニングすると、無人インストールをシステム的に実行する手段が提供されます。Satellite が提供するプロビジョニングテンプレートを表示するには以下のコマンドを実行します。

$ hammer template list

新規テンプレートを追加するには以下のコマンドを実行します。

$ hammer template create --name <template_name> --file <path_to_template_file>

他のサブオプションについては hammer template --help コマンドの出力を参照します。

オペレーティングシステムはインストールの方法とメディアの組み合わせを定義して、ファミリーにグループ化します。デフォルトでは、Red Hat Satellite は Red Hat ファミリーを使用します。ファミリーを利用することで、Satellite はホストのプロビジョニング時に特定の動作を変更することができます。オペレーティングシステムを表示するには以下のコマンドを実行します。

$ hammer os list

新規オペレーティングシステムを作成するには、以下のコマンドを実行します。

$ hammer os create --name <os_name> --major <version_number>

次に、アーキテクチャー、パーティションテーブル、インストールメディア、設定テンプレートをオペレーティングシステムに追加することができます。詳細は hammer os --help の出力を参照してください。

PARTID=$(hammer --csv partition-table list | grep "Kickstart default" | cut -d, -f1)
PXEID=$(hammer --csv template list --per-page=1000 | grep "Kickstart default PXELinux" | cut -d, -f1)
SATID=$(hammer --csv template list --per-page=1000 | grep "provision" | grep "Satellite Kickstart Default" | cut -d, -f1)

for i in $(hammer --csv os list | grep -vi '^ID' | awk -F, {'print $1'})
do
   hammer partition-table add-operatingsystem --id="${PARTID}" --operatingsystem-id="${i}"
   hammer template add-operatingsystem --id="${PXEID}" --operatingsystem-id="${i}"
   hammer os set-default-template --id="${i}" --config-template-id="${PXEID}"
   hammer os add-config-template --id="${i}" --config-template-id="${SATID}"
   hammer os set-default-template --id="${i}" --config-template-id="${SATID}"
done

パラメーターは、プロビジョニング時の Red Hat Satellite の動作を定義します。パラメーターは複数ありますが、詳細は『Red Hat Satellite Host Configuration Guide』を参照してください。以下の例を使用してグローバルパラメーターを設定します。

$ hammer global-parameter set --name <param_name> --value <param_value>

$ hammer global-parameter set --name firewall --value --disabled

$ hammer global-parameter list
---------|-------------
NAME     | VALUE
---------|-------------
firewall | --disabled
---------|-------------

同様に hammer を使用して他のパラメータータイプを設定することができます。

$ hammer domain set-parameter \
--name <param_name> \
--value <param_value> \
--domain <domain_name>

$ hammer hostgroup set-parameter \
--name <param_name> \
--value <param_value> \
--hostgroup <hg_name>

$ hammer host set-parameter \
--name <param_name> \
--value <param_value> \
--host <h_name>

$ hammer sc-param \
--name <param_name> \
--default-value <param_value>

ホストグループは、ホストまたはホストグループの集まりです。共有のホストパラメーターを保持するために、ホストグループを作成することを推奨します。ホストグループのメンバーは、これらのパラメーターを継承するので、ホストの作成じに個別に設定する必要はありません。階層形式でホストグループをネスト化できる点に注意してください。

以下のコマンドはホストグループの作成の基本オプションを表示しています。

$ hammer hostgroup create \
--name "<hostgroup_name>" \
--environment "<environment_name>" \
--architecture "<architecture_name>" \
--domain <domain_name> \
--subnet <subnet_name> \
--puppet-proxy <proxy_name> \
--puppet-ca-proxy <ca-proxy_name> \
--operatingsystem "<os_name>" \
--partition-table "<table_name>" \
--medium "<medium_name>" \
--organization-ids <org_ID1>,<org_ID2>... \
--location-ids <loc_ID1>,<loc_ID2>...

設定可能なオプションの完全一覧については hammer hostgroup create --help を参照してください。ホストグループの作成時に構成できない設定が 2 つあります。

$ hammer hostgroup set-parameter \
--hostgroup "<hostgroup_name>" \
--name "kt_activation_keys" \
--value <key_name>

hammer activation-key list を実行してアクティベーションキーの名前を検索します (アクティベーションキーの詳細は4章アクティベーションキーの管理を参照してください)。

MAJOR="7"
OS=$(hammer --output csv os list | awk -F "," "/RedHat ${MAJOR}/ {print \$2;exit}")
ARCH="x86_64"
ORG="ACME"
LOCATIONS="london,munich"
PTABLE_NAME="ptable-acme-os-rhel-server"
DOMAIN="example.com"

hammer lifecycle-environment list --organization "${ORG}" | awk -F "|" '/[[:digit:]]/ {print $2}' | sed s'/ //' | while read LC_ENV
do
  if [[ ${LC_ENV} == "Library" ]]; then
    continue
  fi

  LC_ENV_LOWER=$(echo ${LC_ENV} | tr '[[:upper:]' '[[:lower:]]')
  ParentID=$(hammer --output csv hostgroup list --per-page 999 | awk -F"," "(\$3 ~ /^${LC_ENV_LOWER}$/) {print \$1}")

  hammer hostgroup create --name "rhel-${MAJOR}server-${ARCH}" \
    --medium "${ORG}/Library/Red_Hat_Server/Red_Hat_Enterprise_Linux_${MAJOR}_Server_Kickstart_${ARCH}_${MAJOR}
    Server" \
    --parent-id ${ParentID} \
    --architecture "${ARCH}" \
    --operatingsystem "${OS}" \
    --partition-table "${PTABLE_NAME}" \
    --subnet "${DOMAIN}" \
    --domain "${DOMAIN}" \
    --organizations "${ORG}" \
    --locations "${LOCATIONS}" \
    --content-view "cv-os-rhel-${MAJOR}Server" \
    --environment-id $(hammer --output csv environment list --per-page 999 | awk -F "," "/KT_$ {ORG}_${LC_ENV}_cv_os_rhel_${MAJOR}Server/ {print \$1}")

  HgID=$(hammer --output csv hostgroup list --per-page 999 | awk -F"," "(\$3 ~ /^${LC_ENV_LOWER}\/rhel-${MAJOR}server-${ARCH}$/) {print \$1}")

  hammer hostgroup set-parameter \
    --hostgroup-id "${HgID}" \
    --name "kt_activation_keys" \
    --value "act-${LC_ENV_LOWER}-os-rhel-${MAJOR}server-${ARCH}"
done

ホストグループに一般的なパラメーターを設定して、ホスト作成時に必要なオプションの数を減らすことを推奨します。以下のコマンドは、基本的なホストを作成してホストグループに関連付けます。

$ hammer host create \
--name "<host_name>" \
--hostgroup "<hostgroup_name>" \
--interface="primary=true, \
            provision=true, \
            mac=<mac_address>, \
            ip=<ip_address>" \
--organization-id <org_ID> \
--location-id <loc_ID> \
--ask-root-password yes

上記のコマンドを実行後に、root パスワードを指定するように求められます。ホストの IP および MAC アドレスを指定する必要があります。プライマリーネットワーク・インターフェースの他のプロパティーはホストグループから継承するか、subnet および domain パラメーターを使用して設定することができます。--interface オプションを使用して追加のインターフェースを設定できます。このオプションはキーと値のペア一覧を受け入れます。利用可能なインターフェース設定の一覧については表6.1「--interface オプションの利用可能なキー」を参照してください。

ホストグループのメンバーなしにホストを作成する場合には、「ホストグループの作成」に記載されている追加のオプションを指定します。利用可能なホストのパラメーターは幅広くありますが、詳細は hammer host create --help の出力を参照してください。特定のパラメーターの値は、ホストがプロビジョニングするコンピュートリソースの種別により異なります。参考として表6.2「プロビジョニングに固有のホストオプション」を参照してください。

$ hammer host create --name bondtest \
--hostgroup-id 1 \
--ip=192.168.100.123 \
--mac=52:54:00:14:92:2a \
--subnet-id=1 \
--managed true \
   --interface="identifier=eth1, \
               mac=52:54:00:62:43:06, \
               managed=true, \
               type=Nic::Managed, \
               domain_id=1, \
               subnet_id=1" \
   --interface="identifier=eth2, \
               mac=52:54:00:d3:87:8f, \
               managed=true, \
               type=Nic::Managed, \
               domain_id=1, \
               subnet_id=1" \
   --interface="identifier=bond0, \
               ip=172.25.18.123, \
               type=Nic::Bond, \
               mode=active-backup, \
               attached_devices=[eth1,eth2], \
               managed=true, \
               domain_id=1, \
               subnet_id=1" \
--organization-id 1 \
--location-id 1 \
--ask-root-password yes

Red Hat Satellite ホストコレクションは、ホストのグループを指します。以下のコマンドはホストコレクションを作成する際に最低限必要なオプションです。

$ hammer host-collection create \
--organization-label <org_label> \
--name <hc_name>

ホストコレクションにホストを追加するには、以下のコマンドを実行します。

$ hammer host-collection add-host \
--id <hc_ID> \
--host-ids <ch_ID1>,<ch_ID2>...

以下のコマンドを実行して、ホストコレクションとアクティベーションキーを関連付けます (アクティベーションキーの詳細は4章アクティベーションキーの管理を参照してください)。

$ hammer activation-key add-host-collection \
--id <ak_ID> \
--host-collection <hc_name>

ホストコレクションのグループに含まれるホストは、アクティベーションからの設定を継承します。

リモートの実行機能により、Satellite Server で任意のコマンドを定義して、リモートホストで実行できます。コマンドは、プロビジョニングテンプレートとよく似たジョブテンプレートで定義されます。デフォルトでジョブテンプレートが複数含まれているので、それを使用することも、リモートホストでのソフトウェアパッケージの操作や Puppet プロセスの起動などのカスタムテンプレートを定義することも可能です。Hammer でこの機能を使用するには、root として以下のコマンドを実行してリモートの実行 CLI をインストールします。

# yum install tfm-rubygem-hammer_cli_foreman_remote_execution

利用可能なジョブテンプレートを表示するには、以下を実行します。

$ hammer job-template list

テンプレート定義ファイルを使用してジョブテンプレートを作成するには以下のコマンドを使用します。

$ hammer job-template create \
--file "<template>" \
--name "<template_name>" \
--provider-type SSH \
--job-category "<category_name>"

<template> は、テンプレート定義が含まれるファイルへのパスに置き換えてください。また、カスタムの <category_name> を指定するか、既存のカテゴリーの 1 つを選択してください (Commands、Katello、Packages、Power、Puppet または Services)。他に利用可能なパラメーターに関する情報は hammer job-template create --help の出力を参照してください。

カスタムパラメーターでジョブを呼び出すには以下を実行します。

$ hammer job-invocation create \
--job-template "<template_name>" \
--inputs <key1>="<value>",<key2>="<value>",... \
--search-query "<query>"

リモートジョブに使用するテンプレート名を指定します。キーと値のペアをコンマ区切りのリストとして入力値を指定してください。hammer job-template info を実行して、テンプレートに必要なパラメーターが何かを表示します。<query> は、どのホストが影響を受けるかを定義するフィルターの表現に置き換えます (例: name ~ rex01)。

$ hammer job-invocation create \
--job-template "Service Action - SSH Default" \
--inputs service="httpd",action="start" \
--search-query "name ~ target"

ジョブの出力を監視するには以下を実行します。

$ hammer job-invocation output \
--id <job_ID> \
--host <host_name>

hammer job-invocation list の出力で <job_ID> を検索します。hammer でのリモートコマンドの実行に関する詳しい情報は hammer job-template --help または hammer job-invocation --help を参照してください。

Red Hat Satellite ではシステムを使用する個別ユーザーに各種情報を定義できます。hammer では、Red Hat Satellite のユーザーを設定するために user create および user update コマンドがあります。以下のコマンドを使用して新規ユーザーを作成します。

$ hammer user create \
--login <user_name> \
--password <user_password> \
--mail <user_mail> \
--auth-source-id 1 \
--organization-ids <org_ID1>,<org_ID2>...

--auth-source-id 1 の設定は、ユーザーは内部で認証されることを意味し、外部認証を代わりとして指定することができます。--admin オプションを指定して、管理者権限をユーザーに授与します。組織 ID を指定する必要はなく、update サブコマンドを使用してユーザーの詳細を変更できます。

ユーザー関連のサブコマンドに関する情報は、hammer user --help の出力を参照してください。

複数のユーザーのパーミッションは、ユーザーグループにまとめることで一括して管理できます。また、ユーザーグループ自体をさらにグループ化してパーミッションの階層を作成できます。以下のコマンドを使用して新規ユーザーグループを作成します。

$ hammer user-group create --name <usergroup_name>

ユーザーグループを追加するには以下のコマンドを実行します。

$ hammer user-group add-user --user <user_name> --id <usergroup_id>

hammer user-group list を実行してユーザーグループ ID を検索します。同様に、add-user-group のサブコマンドを使用するとユーザーグループを追加できます。ユーザーグループ関連の操作に関する情報は hammer user-group --help の出力を参照してください。

Red Hat Satellite のロールは、パーミッションおよびアクセスレベルを定義します。Satellite には、事前定義済みのロールが複数含まれています。これらのロールを表示するには以下のコマンドを実行します。

$ hammer role list

ロールに関連付けられたパーミッションを表示するには、以下のコマンドを実行します。

$ hammer role filters --id <role_id>

<role_id> は、hammer role list に出力されたロールの ID です。

カスタムロールを作成するには、以下のコマンドを実行します。

$ hammer role create --name <role_name>

以下のコマンドでロールにパーミッションフィルターを追加します。

$ hammer filter create \
--role <role_name> \
--permission-ids <perm_ID1>,<perm_ID2>...

hammer filter available-permissions を使用してロールに追加するパーミッションを検索します。ロールおよびパーミッションの詳細については hammer role --help および hammer filter --help の出力を参照します。

$ hammer filter create \
--permission-ids 91 \
--search "name ~ ccv*" \
--role qa-user

ユーザーにロールを割り当てるには、以下のコマンドを実行します。

$ hammer user add-role --id <user_id> --role <role_name>

同様に、ユーザーグループにロールを割り当てることができます。

$ hammer user-group add-role --id <usergroup_id> --role <role_name>

全組織で利用可能なエラータを表示するには、以下のコマンドを実行します。

$ hammer erratum list

$ hammer erratum list --cve CVE-2014-0453

$ hammer erratum list \
--product-id 7 \
--search "bug = 1213000 or bug = 1207972" \
--errata-restrict-applicable 1 \
--order "type desc"

特定のエラータの詳細を表示するには、以下のコマンドを実行します。

$ hammer erratum info --id <erratum_ID>

<erratum_ID> は、hammer erratum list コマンドの出力にあるエラータの一意識別子に置き換えます。名前やリポジトリー名でエラータを特定することも可能です。詳しくは hammer erratum info --help の出力を参照してください。

ホストで利用可能なエラータを表示するには、以下のコマンドを実行します。

$ hammer host errata list --host <hostname>

選択したエラータをホストに適用するには、以下のコマンドを実行します。

$ hammer host errata apply \
--host <hostname> \
--errata-ids <erratum_ID1>,<erratum_ID2>...

HOST="auth01.example.com"
for i in $(hammer --csv host errata list --host $HOST | grep -vi '^ID' | awk -F, {'print $1'})
do
  hammer host errata apply --host $HOST --errata-ids $i
done

ORG="ACME"
RHSA="RHSA-2015:1640"

for i in $(hammer --csv host list --organization $ORG | grep -vi '^ID' | awk -F, {'print $2'})
do
  hammer host errata apply --host $i --errata-ids $RHSA
done

エラータが正しく適用されたことを確認するには、以下のコマンドの出力で適切なタスクを検索します。

$ hammer task list

選択したタスクの状態を確認するには、以下のコマンドを実行します。

$ hammer task progress --id <task_ID>

ホストコレクションに選択したエラータを適用するには、以下のようにコマンドを入力します。

$ hammer host-collection erratum install \
--errata "<erratum_ID1>,<erratum_ID2>,..." \
--name "my-collection" --organization $ORG

このコマンドは、Red Hat Satellite 6.2.8 以降で利用できます。