Sun N1 Service Provisioning System 5.1 コマンド行インタフェース(CLI) リファレンスマニュアル

第 7 章 hdb: ホストを管理する CLI コマンド

この章では、ホストの管理に必要なコマンドについて説明します。

概要

以下に、ホスト管理のための CLI コマンドセットを示します。

表 7–1 ホスト管理のための CLI コマンドセット


CLI 接頭辞	コマンドセットの説明
hdb.a	アプリケーションインスタンスを管理するコマンド (リモートエージェントやローカルディストリビュータなどのアプリケーション)
hdb.h	ターゲットホストを管理するコマンド
hdb.hr	ホスト検索を管理するコマンド
hdb.hs	ホストセットを管理するコマンド
hdb.ht	ホストタイプを管理するコマンド

この章では、コマンドセットごとに、すべてのコマンドについて説明します。

hdb.a: アプリケーションインスタンスの管理

hdb.a コマンドファミリーは、リモートエージェントやローカルディストリビュータなどプロビジョニングソフトウェアのアプリケーションのインスタンスを制御します。

表 7–2 hdb.a コマンドの概要


コマンド名	説明
hdb.a.add	新しいアプリケーションインスタンスを追加する
hdb.a.del	アプリケーションインスタンスを削除する
hdb.a.la	すべてのアプリケーションインスタンスを一覧表示する
hdb.a.lo	特定のアプリケーションインスタンスの情報を検出する
hdb.a.mod	既存のアプリケーションインスタンスを変更する
hdb.a.clear	アプリケーションインスタンスのリソースキャッシュを消去する

hdb.a.add

このコマンドは、新しいアプリケーションインスタンスを追加し、特定の Sun N1 Service Provisioning System ソフトウェアアプリケーションの特定の構成をマスターサーバーに登録します。

表 7–3 hdb.a.add コマンドの引数と結果


引数/結果		構文	説明
hID	[R]	HostID	新しいインスタンスが格納されているホストの ID
type	[R]	AppType	アプリケーション型 (RA\|LD)
pID	[R]	AppInstanceID	親アプリケーション ID
ip	[R]	文字列	アプリケーションの IP アドレス (x.y.z.w)
port	[O]	整数	アプリケーションポート (ssh には不要)
conn	[R]	ConnectionType	接続型 (raw\|ssh\|ssl)
param	[O]	文字列	パラメータ
result		UIAppInstanceUpdate	新しいアプリケーションインスタンスと関連警告

注 –

接続型が ssh のアプリケーションで、-port 引数を省略したり、ポートを 0 に設定した場合は、デフォルトの ssh ポートが使用されます。

hdb.a.del

このコマンドは、マスターサーバーの内部ファイルからアプリケーションインスタンスを削除します。いったん削除されたアプリケーションインスタンスは、マスターサーバーによって認識されなくなります。

注 –

アプリケーションインスタンスを削除しても、アプリケーションインスタンスがインストールされたマシン上の Sun N1 Service Provisioning System ソフトウェアファイルは削除されません。

表 7–4 hdb.a.del コマンドの引数


引数		構文	説明
ID	[R]	AppInstanceID	アプリケーションインスタンス ID

例 7–1 アプリケーションインスタンスを削除する例

この例では、NewYork-v240 という名前のホストからリモートエージェントとローカルディストリビュータを削除します。

ホスト名: NewYork-v240

[Deleting the Remote Agent]
% ./cr_cli -cmd hdb.a.del -ID NM:NewYork-v240:RA -u admin -p admin

[Deleting the Local Distributor]
% ./cr_cli -cmd hdb.a.del -ID NM:NewYork-v240:LD -u admin -p admin

hdb.a.la

このコマンドは、マスターサーバーによって認識されているすべてのアプリケーションインスタンスを一覧表示します。

このコマンドでは、引数は使用できません。

表 7–5 hdb.a.la コマンドの戻り値


結果	結果の構文	説明
result	AppInstanceArray	アプリケーションインスタンス

hdb.a.lo

このコマンドは、指定されたアプリケーションインスタンスに関する情報を検出します。

表 7–6 hdb.a.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	AppInstanceID	アプリケーションインスタンス ID
result		AppInstance	アプリケーションインスタンス

hdb.a.mod

このコマンドは、既存のアプリケーションインスタンスの指定された属性を変更します。省略された引数の値は変更されません。

表 7–7 hdb.a.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	AppInstanceID	アプリケーションインスタンス ID
pID	[O]	AppInstanceID	新しい親アプリケーション ID
ip	[O]	文字列	アプリケーションの新しい IP アドレス (x.y.z.w)
port	[O]	整数	新しいアプリケーションポート
conn	[O]	ConnectionType	新しい接続型 (raw\|ssh\|ssl)
param	[O]	文字列	新しいパラメータ
result		UIAppInstanceUpdate	変更後のアプリケーションインスタンスと関連警告

注 –

接続型が ssh のアプリケーションで、-port 引数を省略したり、ポートを 0 に設定した場合は、デフォルトの ssh ポートが使用されます。

hdb.a.clear

このコマンドは、アプリケーションインスタンスのリソースキャッシュを消去します。

表 7–8 hdb.a.clear コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	AppInstanceID	アプリケーションインスタンス ID

hdb.h: ホストの管理

hdb.h コマンドは、ターゲットホストを管理します。ターゲットホストとは、Sun N1 Service Provisioning System ソフトウェアで管理されているアプリケーションの物理ホストと仮想ホストのことです。

表 7–9 hdb.h コマンドの概要


コマンド	説明
hdb.h.add	新しいホストを追加する
hdb.h.del	ホストを削除する
hdb.h.la	すべてのホストを一覧表示する
hdb.h.lo	ホストに関する情報を検出する
hdb.h.lq	一致するホストを照会する
hdb.h.mod	既存のホストを変更する

hdb.h.add

このコマンドは、ホストリポジトリに新しいホストを追加します。

表 7–10 hdb.h.add コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	ホスト名
desc	[O]	文字列	ホストの説明
tID	[R]	HostTypeID	ホストタイプの ID
attr	[O]	Hashtable	ホストの属性
hide	[O]	ブール型	ホストを非表示にするかどうか。デフォルトは false
pID	[O]	HostID	仮想ホストの場合は親ホストの ID、物理ホストの場合は空
result		ホスト	新しいホスト

注 –

-attr 引数は優先指定を設定するだけです。明示的に指定されていない属性は、デフォルト値を保持します。

例 7–2 ホストを追加する例

この例では、プロビジョニングソフトウェアに基本ホストを追加します。

ホスト名: NewYork-v240
ホストタイプ: system#crhost

% ./cr_cli -cmd hdb.h.add -name NewYork-v240  \
-tID NM:system#crhost -u admin -p admin

例 7–3 仮想ホストを追加する例

この例では、NewYork-v240 という名前のサーバーにある仮想ホストを追加します。

仮想ホスト名: MyAppServer-vhost
ホストタイプ: system#crhost
親ホスト名: NewYork-v240

% ./cr_cli -cmd hdb.h.add -name MyAppServer-vhost  \ 
-tID NM:system#crhost -pID NM:NewYork-v240 -u admin -p admin

hdb.h.del

このコマンドでは、ホストと、ホストにインストールされているすべてのアプリケーションインスタンスおよびコンポーネントを削除します。詳細については、『Sun N1 Service Provisioning System 5.1 システム管理者ガイド』の「ホストの削除」を参照してください。

表 7–11 hdb.h.del コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostID	ホスト ID

例 7–4 ホストレコードを削除する例

この例ではホストを削除します。

ホスト名: NewYork-v240

% ./cr_cli -cmd hdb.h.del -ID NM:NewYork-v240 -u admin -p admin

hdb.h.la

このコマンドは、リポジトリ内のすべてのホストを一覧表示します。

表 7–12 hdb.h.la コマンドの引数と結果


引数/結果		構文	説明
sh	[O]	ブール型	非表示のホストを表示するかどうか。デフォルトは false
result		HostArray	ホスト

hdb.h.lo

このコマンドは、リポジトリからホストに関する情報を検出します。

表 7–13 hdb.h.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostID	ホスト ID
result		ホスト	ホスト

hdb.h.lq

このコマンドは、指定された条件またはフィルタに一致するホストを照会します。

注 –

このコマンドを呼び出すときは、クエリー (-query) かフィルタ (-filt または -phys) を指定する必要があります。

表 7–14 hdb.h.lq コマンドの引数と結果


引数/結果		構文	説明
query	[O]	AttributeCriteriaList	照会条件
filt	[O]	AppTypeCriteria	アプリケーション型のフィルタ
phys	[O]	PhysicalCriteria	物理ホストまたは仮想ホストに限定するフィルタ
sh	[O]	ブール型	非表示のホストを表示するかどうか。デフォルトは false
result		HostArray	ホスト

hdb.h.mod

このコマンドは、既存のホストの指定された属性を変更します。省略された引数の値は変更されません。

表 7–15 hdb.h.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostID	ホスト ID
name	[O]	文字列	ホスト名
desc	[O]	文字列	ホストの説明
tID	[O]	HostTypeID	ホストタイプの ID
attr	[O]	Hashtable	ホストの属性
hide	[O]	ブール型	ホストを非表示にするかどうか
pID	[O]	HostID	仮想ホストの場合は親ホストの ID、物理ホストの場合は “<null>”
result		ホスト	変更後のホスト

注 –

値を変更する属性は、-attr 引数で指定します。明示的に指定されていない属性は、デフォルト値を保持します。または、デフォルト値にリセットされます。

hdb.hr: ホスト検索の管理

概要

hdb.hr コマンドは、ホスト検索を管理します。

表 7–16 hdb.hr コマンドの概要


コマンド	説明
hdb.hr.add	新しいホスト検索を追加する
hdb.hr.del	ホスト検索を削除する
hdb.hr.la	すべてのホスト検索を一覧表示する
hdb.hr.le	ホスト検索によって返されるすべてのホストを一覧表示する
hdb.hr.lo	ホスト検索に関する情報を検出する
hdb.hr.mod	既存のホスト検索を変更する

hdb.hr.add

このコマンドは、新しいホスト検索を追加し、リポジトリにホスト検索の名前と検索条件を入力します。

表 7–17 hdb.hr.add コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	ホスト検索の名前
desc	[O]	文字列	ホスト検索の説明
q	[R/O]	AttributeCriteriaList	動的なクエリー。filt と phys が指定されていない場合は必須
filt	[R/O]	AppTypeCriteria	検索を特定のホストタイプに制限するフィルタ。q と phys が指定されていない場合は必須
phys	[R/O]	PhysicalCriteria	物理ホストまたは仮想ホストに制限するフィルタ。q と filt が指定されていない場合は必須
hide	[O]	ブール型	検索を非表示にするかどうか。デフォルトは false
result		HostSearch	新しいホスト検索

hdb.hr.del

このコマンドは、ホスト検索を削除します。

表 7–18 hdb.hr.del コマンドの引数と結果


引数		構文	説明
ID	[R]	HostSearchID	ホスト検索の ID

hdb.hr.la

このコマンドは、リポジトリ内に定義されているすべてのホスト検索を一覧表示します。

表 7–19 hdb.hr.la コマンドの引数と結果


引数/結果		構文	説明
sh	[O]	ブール型	非表示の検索を表示するかどうか。デフォルトは false
result		HostSearchArray	ホスト検索

hdb.hr.le

このコマンドは、指定されたホスト検索の条件に一致するすべてのホストを一覧表示します。一覧表示されるのは、hdb.hr.le の実行時にこれらの条件に一致するホストです。

表 7–20 hdb.hr.le コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostSearchID	ホスト検索の ID
sh	[O]	ブール型	非表示の検索を表示するかどうか。デフォルトは false
result		HostArray	ホスト

hdb.hr.lo

このコマンドは、指定されたホスト検索に関する情報を検出します。

表 7–21 hr.hr.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostSearchID	ホスト検索の ID
result		HostSearch	ホスト検索

hdb.hr.mod

このコマンドは、既存のホスト検索を変更します。省略された引数の値は変更されません。

表 7–22 hdb.hr.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostSearchID	ホスト検索の ID
name	[O]	文字列	ホスト検索の名前
desc	[O]	文字列	ホスト検索の説明
q	[O]	AttributeCriteriaList	動的クエリー
filt	[O]	VarValueCriteria	検索を特定のホストタイプに制限するオプションフィルタ
phys	[O]	PhysicalCriteria	物理ホストまたは仮想ホストに限定するフィルタ
hide	[O]	ブール型	検索を非表示にするかどうか
result		HostSearch	変更後のホスト検索

hdb.hs: ホストセットの管理

hdb.hs コマンドは、ホストセットを管理します。

表 7–23 hdb.hs コマンドの概要


コマンド	説明
hdb.hs.add	新しいホストセットを追加する
hdb.hs.del	ホストセットを削除する
hdb.hs.la	すべてのホストセットを一覧表示する
hdb.hs.le	ホストセットに含まれるすべてのホストを一覧表示する
hdb.hs.lo	ホストセットに関する情報を検出する
hdb.hs.mod	既存のホストセットを変更する

hdb.hs.add

このコマンドは、リポジトリに新しいホストセットを追加します。

表 7–24 hdb.hs.add コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	ホストセットの名前
desc	[O]	文字列	ホストセットの説明
hIDs	[O]	HostIDSet	静的メンバーホストの ID
sIDs	[O]	HostSetIDSet	ホストサブセットの ID
rIDs	[O]	HostSearchIDSet	ホスト検索の ID
hide	[O]	ブール型	ホストセットを非表示にするかどうか。デフォルトは false
result		HostSet	新しいホストセット

hdb.hs.del

このコマンドは、ホストセットを削除します。

表 7–25 hdb.hs.del コマンドの引数と結果


引数		構文	説明
ID	[R]	HostSetID	ホスト ID

hdb.hs.la

このコマンドは、Sun N1 Service Provisioning System ソフトウェアに定義されているすべてのホストセットを一覧表示します。

表 7–26 hdb.hs.la コマンドの引数と結果


引数/結果		構文	説明
hide	[O]	ブール型	非表示のホストセットを表示するかどうか。デフォルトは false
result		HostSetArray	ホストセット

hdb.hs.le

このコマンドは、指定されたホストセットに含まれるすべてのホストを一覧表示します。

表 7–27 hdb.hs.le コマンドの引数と結果


引数		構文	説明
ID	[R]	HostSetID	ホストセット ID
hide	[O]	ブール型	非表示のホストセットを表示するかどうか。デフォルトは false
result		HostArray	ホスト

hdb.hs.lo

このコマンドは、指定されたホストセットを検出します。

表 7–28 hdb.hs.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostSetID	ホストセット ID
result		HostSet	ホストセット

hdb.hs.mod

このコマンドは、既存のホストセットを変更します。省略した場合、現在の値が保持されます。

表 7–29 hdb.hs.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostSetID	ホストセット ID
name	[O]	文字列	ホストセットの名前
desc	[O]	文字列	ホストセットの説明
hIDs	[O]	HostIDSet	静的メンバーホストの ID
sIDs	[O]	HostSetIDSet	ホストサブセットの ID
rIDs	[O]	HostSearchIDSet	ホスト検索の ID
hide	[O]	ブール型	ホストセットを非表示にするかどうか
result		HostSet	変更後のホストセット

hdb.ht: ホストタイプの管理

概要

hdb.ht コマンドは、ホストタイプを管理します。

表 7–30 hdb.ht コマンドの概要


コマンド	説明
hdb.ht.add	新しいホストタイプを追加する
hdb.ht.del	ホストタイプを削除する
hdb.ht.la	すべてのホストタイプを一覧表示する
hdb.ht.lo	ホストタイプに関する情報を検出する
hdb.ht.mod	既存のホストタイプを変更する

hdb.ht.add

このコマンドは、新しいホストタイプを追加し、このホストタイプに名前を割り当て、このホストタイプの属性を定義します。

表 7–31 hdb.ht.add コマンドの引数と結果


引数/結果		構文	説明
name	[R]	文字列	ホストタイプの名前
desc	[O]	文字列	ホストタイプの説明
attr	[R]	HostTypeVarList	ホストタイプの属性
hide	[O]	ブール型	ホストタイプを非表示にするかどうか。デフォルトは false
result		HostType	新しいホストタイプ

hdb.ht.del

このコマンドは、ホストタイプを削除します。

表 7–32 hdb.ht.del コマンドの引数と結果


引数		構文	説明
ID	[R]	HostTypeID	ホストタイプ ID

hdb.ht.la

このコマンドは、定義済みのすべてのホストタイプ (デフォルトのホストタイプ crhost を含む) を一覧表示します。

表 7–33 hdb.ht.la コマンドの引数と結果


引数/結果		構文	説明
sh	[O]	ブール型	非表示のホストタイプを表示するかどうか。デフォルトは false
result		HostTypeArray	ホストタイプ

hdb.ht.lo

このコマンドは、ホストタイプを検出します。

表 7–34 hdb.ht.lo コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostTypeID	ホストタイプ ID
result		HostType	ホストタイプ

hdb.ht.mod

このコマンドは、既存のホストタイプを変更します。省略された引数の値は変更されません。

表 7–35 hdb.ht.mod コマンドの引数と結果


引数/結果		構文	説明
ID	[R]	HostTypeID	ホストタイプ ID
name	[O]	文字列	ホストタイプの名前
desc	[O]	文字列	ホストタイプの説明
attr	[O]	HostTypeVarList	ホストタイプの属性
hide	[O]	ブール型	ホストタイプを非表示にするかどうか
result		HostType	変更後のホストタイプ