この章では、ホストの管理に必要なコマンドについて説明します。
CLI には、ホストを管理する以下のコマンドセットが含まれています。
表 9–1 ホスト管理のためのコマンドセット
CLI 接頭辞 |
コマンドセットの説明 |
---|---|
hdb.a |
アプリケーションインスタンスを管理するコマンド (Remote Agents や Local Distributors などのアプリケーション) |
hdb.h |
対象ホストを管理するコマンド |
hdb.hr |
ホスト検索を管理するコマンド |
hdb.hs |
ホストセットを管理するコマンド |
hdb.ht |
ホスト型を管理するコマンド |
この章では、これらの各セット内のすべてのコマンドについて説明します。
hdb.aコマンドファミリは、Remote Agents や Local Distributors などの プロビジョニングソフトウェア のアプリケーションのインスタンスを制御します。
表 9–2 hdb.a コマンドの概要
コマンド名 |
説明 |
---|---|
hdb.a.add |
新しいアプリケーションインスタンスを追加する |
hdb.a.del |
アプリケーションインスタンスを削除する |
hdb.a.la |
すべてのアプリケーションインスタンスを一覧表示する |
hdb.a.lo |
特定のアプリケーションインスタンスについての情報を検出する |
hdb.a.mod |
既存のアプリケーションインスタンスを変更する |
hdb.a.clear |
アプリケーションインスタンスのリソースキャッシュを消去する |
このコマンドは、新しいアプリケーションインスタンスを追加し、特定の N1 Service Provisioning System software アプリケーションの特定の構成を Master Server で登録します。
表 9–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 ポートが使用されます。
このコマンドは、Master Server の内部ファイルからアプリケーションインスタンスを削除します。 アプリケーションインスタンスは削除されると、Master Server によって認識されなくなります。
アプリケーションインスタンスを削除しても、アプリケーションインスタンスがインストールされたマシン上の N1 Service Provisioning System software ファイルは削除されません。
引数 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
AppInstanceID |
アプリケーションインスタンスの ID |
このコマンドは、Master Server に認識されているすべてのアプリケーションインスタンスを一覧表示します。
このコマンドでは、引数は使用できません。
表 9–5 hdba.la コマンドの戻り値
結果 |
結果の構文 |
説明 |
---|---|---|
result |
AppInstanceArray |
アプリケーションインスタンス |
このコマンドは、特定のアプリケーションインスタンスについての情報を検出します。
表 9–6 hdb.a.lo コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
AppInstanceID |
アプリケーションインスタンスの ID |
result |
AppInstance |
アプリケーションインスタンス |
このコマンドは、既存のアプリケーションインスタンスの指定された属性を変更します。 省略された引数は、現在の値を保持します。
表 9–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 ポートが使用されます。
このコマンドは、アプリケーションインスタンスのリソースキャッシュを消去します。
表 9–8 hdb.a.clear コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
AppInstanceID |
アプリケーションインスタンスの ID |
hdb.h コマンドは、対象ホストを管理します。 対象ホストとは、N1 Service Provisioning System software でアプリケーションを管理している物理ホストおよび仮想ホストのことです。
表 9–9 hdb.h コマンドの概要
コマンド |
説明 |
---|---|
hdb.h.add |
新しいホストを追加する |
hdb.h.del |
ホストを削除する |
hdb.h.la |
すべてのホストを一覧表示する |
hdb.h.lo |
ホストについての情報を検出する |
hdb.h.lq |
一致するホストを照会する |
hdb.h.mod |
既存のホストを変更する |
このコマンドは、新しいホストをホストリポジトリに追加します。
表 9–10 hdb.h.add コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
name |
[R] |
文字列 |
ホストの名前 |
desc |
[O] |
文字列 |
ホストの説明 |
tID |
[R] |
HostTypeID |
ホスト型の ID |
attr |
[O] |
ハッシュテーブル |
ホストの属性 |
hide |
[O] |
ブール型 |
ホストを非表示にするかどうか。デフォルトは false |
pID |
[O] |
HostID |
仮想ホストの場合は親ホストの ID。物理ホストの場合は空白 |
result |
Host |
新しいホスト |
-attr 引数は優先指定を設定するだけです。 明示的に記述されていない属性は、デフォルト値を保持します。
このコマンドは、ホストを削除します。
表 9–11 hdb.h.del コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostID |
ホスト ID |
このコマンドは、リポジトリ内のすべてのホストを一覧表示します。
表 9–12 hdb.h.la コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
sh |
[O] |
ブール型 |
非表示ホストを表示するかどうか。デフォルトは false |
result |
HostArray |
ホスト |
このコマンドは、リポジトリからホストについての情報を検出します。
表 9–13 hdb.h.lo コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostID |
ホスト ID |
result |
Host |
ホスト |
このコマンドは、指定された条件または指定されたフィルタに一致するホストを照会します。
このコマンドを呼び出すときは、照会 (-query) またはフィルタ (-filt または -phys) を指定してください。
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
query |
[O] |
AttributeCriteriaList |
照会条件 |
filt |
[O] |
AppTypeCriteria |
アプリケーション型のフィルタ |
phys |
[O] |
PhysicalCriteria |
物理または仮想ホストに限定するフィルタ |
sh |
[O] |
ブール型 |
非表示ホストを表示するかどうか。デフォルトは false |
result |
HostArray |
ホスト |
このコマンドは、既存のホストの指定された属性を変更します。 省略された引数は、現在の値を保持します。
表 9–15 hdb.h.mod コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostID |
ホスト ID |
name |
[O] |
文字列 |
ホストの名前 |
desc |
[O] |
文字列 |
ホストの説明 |
tID |
[O] |
HostTypeID |
ホスト型の ID |
attr |
[O] |
ハッシュテーブル |
ホストの属性 |
hide |
[O] |
ブール型 |
ホストを非表示にするかどうか |
pID |
[O] |
HostID |
仮想ホストの場合は親ホストのID。物理ホストの場合は "<null>” |
result |
Host |
変更されたホスト |
値を変更する属性は、-attr 引数で指定してください。 明示的に指定されていない属性は、デフォルト値を保持します (またはデフォルト値にリセットされます)。
hdb.hr コマンドは、ホスト検索を管理します。
表 9–16 hdb.hr コマンドの概要
コマンド |
説明 |
---|---|
hdb.hr.add |
新しいホスト検索を追加する |
hdb.hr.del |
ホスト検索を削除する |
hdb.hr.la |
すべてのホスト検索を一覧表示する |
hdb.hr.le |
ホスト検索によって返されたすべてのホストを一覧表示する |
hdb.hr.lo |
ホスト検索についての情報を検出する |
hdb.hr.mod |
既存のホスト検索を変更する |
このコマンドは、新しいホスト検索を追加します。 ホスト検索の名前と検索条件をリポジトリに入力します。
表 9–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 |
新しいホスト検索 |
このコマンドは、ホスト検索を削除します。
表 9–18 hdb.hr.del コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSearchID |
ホスト検索の ID |
このコマンドは、リポジトリ内に定義されたすべてのホスト検索を一覧表示します。
表 9–19 hdb.hr.la コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
sh |
[O] |
ブール型 |
非表示検索を表示するかどうか。デフォルトは false |
result |
HostSearchArray |
ホスト検索 |
このコマンドは、指定されたホスト検索の条件に一致するすべてのホストを一覧表示します。 hdb.hr.le の実行時にこれらの条件に一致するホストをが一覧表示されます。
表 9–20 hdb.hr.le コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSearchID |
ホスト検索の ID |
sh |
[O] |
ブール型 |
非表示検索を表示するかどうか。デフォルトは false |
result |
HostArray |
ホスト |
このコマンドは、指定されたホスト検索についての情報を検出します。
表 9–21 hr.hr.lo の引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSearchID |
ホスト検索の ID |
result |
HostSearch |
ホスト検索 |
このコマンドは、既存のホスト検索を変更します。 省略された引数は、現在の値を保持します。
表 9–22 hdb.hr.mod コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSearchID |
ホスト検索の ID |
name |
[O] |
文字列 |
ホスト検索の名前 |
desc |
[O] |
文字列 |
ホスト検索の説明 |
q |
[O] |
AttributeCriteriaList |
動的照会 |
filt |
[O] |
VarValueCriteria |
検索を特定の型のホストに限定するオプションのフィルタ |
phys |
[O] |
PhysicalCriteria |
物理または仮想ホストに限定するフィルタ |
sh |
[O] |
ブール型 |
検索を非表示にするかどうか |
result |
HostSearch |
変更されたホスト検索 |
hdb.hs コマンドは、ホストセットを管理します。
表 9–23 hdb.hs コマンドの概要
コマンド |
説明 |
---|---|
hdb.hs.add |
新しいホストセットを追加する |
hdb.hs.del |
ホストセットを削除する |
hdb.hs.la |
すべてのホストセットを一覧表示する |
hdb.hs.le |
ホストセット内に含まれるすべてのホストを一覧表示する |
hdb.hs.lo |
ホストセットの情報を検出する |
hdb.hs.mod |
既存のホストセットを変更する |
このコマンドは、新しいホストセットをリポジトリに追加します。
表 9–24 hdb.hs.add コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
name |
[R] |
文字列 |
ホストセットの名前 |
desc |
[O] |
文字列 |
ホストセットの説明 |
hIDs |
[O] |
HostIDSet |
静的メンバーホストの ID |
sIDs |
[O] |
HostSetIDSet |
ホストサブセットの ID |
rIDs |
[O] |
HostSearchIDSet |
ホスト検索の ID |
sh |
[O] |
ブール型 |
ホストセットを非表示にするかどうか。デフォルトは false |
result |
HostSet |
新しいホストセット |
このコマンドは、ホストセットを削除します。
表 9–25 hdb.hs.del コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSetID |
ホスト ID |
このコマンドは、N1 Service Provisioning System software で定義されたすべてのホストセットを一覧表示します。
表 9–26 hdb.hs.la コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
sh |
[O] |
ブール型 |
非表示ホストセットを表示するかどうか。デフォルトは false |
result |
HostSetArray |
ホストセット |
このコマンドは、指定されたホストセット内に含まれるすべてのホストを一覧表示します。
表 9–27 hdb.hs.le コマンドの引数と結果
引数 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSetID |
ホストセットの ID |
sh |
[O] |
ブール型 |
非表示ホストセットを表示するかどうか。デフォルトは false |
result |
HostArray |
ホスト |
このコマンドは、指定されたホストセットを検出します。
表 9–28 hdb.hs.lo コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostSetID |
ホストセットの ID |
result |
HostSet |
ホストセット |
このコマンドは、既存のホストセットを変更します。省略された引数は、現在の値を保持します。
表 9–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 コマンドは、ホスト型を管理します。
表 9–30 hdb.ht コマンドの概要
コマンド |
説明 |
---|---|
hdb.ht.add |
新しいホスト型を追加する |
hdb.ht.del |
ホスト型を削除する |
hdb.ht.la |
すべてのホスト型を一覧表示する |
hdb.ht.lo |
ホスト型についての情報を検出する |
hdb.ht.mod |
既存のホスト型を変更する |
このコマンドは、新しいホスト型を追加します。 ホスト型に名前を割り当て、ホスト型の属性を定義します。
表 9–31 hdb.ht.add コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
name |
[R] |
文字列 |
ホスト型の名前 |
desc |
[O] |
文字列 |
ホスト型の説明 |
attr |
[R] |
HostTypeVarList |
ホスト型の属性 |
hide |
[O] |
ブール型 |
ホスト型を非表示にするかどうか。デフォルトは false |
result |
HostType |
新しいホスト型 |
このコマンドは、ホスト型を削除します。
表 9–32 hdb.ht.del コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostTypeID |
ホスト型の ID |
このコマンドは、デフォルトのホスト型の crhost を含むすべての定義済みホスト型を一覧表示します。
表 9–33 hdb.ht.la コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
sh |
[O] |
ブール型 |
非表示ホスト型を表示するかどうか。デフォルトは false |
result |
HostTypeArray |
ホスト型 |
このコマンドは、ホスト型を検出します。
表 9–34 hdb.ht.lo コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostTypeID |
ホスト型の ID |
result |
HostType |
ホスト型 |
このコマンドは、既存のホスト型を変更します。 省略された引数は、現在の値を保持します。
表 9–35 hdb.ht.mod コマンドの引数と結果
引数/結果 |
構文 |
説明 |
|
---|---|---|---|
ID |
[R] |
HostTypeID |
ホスト型の ID |
name |
[O] |
文字列 |
ホスト型の名前 |
desc |
[O] |
文字列 |
ホスト型の説明 |
attr |
[O] |
HostTypeVarList |
ホスト型の属性 |
hide |
[O] |
ブール型 |
ホスト型を非表示にするかどうか |
result |
HostType |
変更されたホスト型 |