Host prototypeオブジェクト

次のオブジェクトは、hostprototypeAPIに直接関連しています。

ホストプロトタイプ

ホストプロトタイプオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
hostid ID ホストプロトタイプのID。

Property behavior:
- read-only
- 更新操作では required
host string ホストプロトタイプの技術名。

Property behavior:
- 作成操作では required
- 継承オブジェクトでは read-only
name string ホストプロトタイプの表示名。

デフォルト: host プロパティの値。

Property behavior:
- 継承オブジェクトでは read-only
status integer ホストプロトタイプのステータス。

使用可能な値:
0 - (default) 監視対象ホスト;
1 - 非監視ホスト。
flags integer ホストプロトタイプの生成元。

使用可能な値:
2 - ホストプロトタイプ;
6 - ディスカバリされたホストプロトタイプ

Property behavior:
- read-only
inventory_mode integer ホストインベントリの設定モード。

使用可能な値:
-1 - (default) 無効;
0 - 手動;
1 - 自動。
templateid ID 親テンプレートのホストプロトタイプのID。

Property behavior:
- read-only
discover integer ホストプロトタイプのディスカバリステータス。

使用可能な値:
0 - (default) 新しいホストがディスカバリされる;
1 - 新しいホストはディスカバリされず、既存のホストは失われたものとしてマークされる。
custom_interfaces integer ホストプロトタイプによって作成されるホストのカスタムインターフェースのソース。

使用可能な値:
0 - (default) 親ホストからインターフェースを継承する;
1 - ホストプロトタイプのカスタムインターフェースを使用する。

Property behavior:
- 継承オブジェクトでは read-only
uuid string インポートされたホストプロトタイプを既存のものにリンクするために使用される汎用一意識別子。指定されていない場合は自動生成されます。

Property behavior:
- ホストプロトタイプがテンプレートに属している場合に supported

グループリンク

グループリンクオブジェクトは、ホストプロトタイプをホストグループに関連付けます。 以下のプロパティがあります。

プロパティ 型 説明
groupid ID ホストグループのID。

プロパティの動作:
- 必須

グループプロトタイプ

グループプロトタイプオブジェクトは、ディスカバリされたホスト用に作成されるグループを定義します。
このオブジェクトには、以下のプロパティがあります。

Property Type Description
group_prototypeid ID グループプロトタイプのID。

Property behavior:
- read-only
name string グループプロトタイプの名前。

Property behavior:
- 作成操作では required

ホストプロトタイプタグ

ホストプロトタイプタグオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
tag string ホストプロトタイプタグ名。

プロパティの動作:
- 必須
value string ホストプロトタイプタグの値。

プロパティの動作:
- 読み取り専用。
object integer タグの継承元オブジェクトのタイプ。

指定可能な値:
0 - テンプレート。

プロパティの動作:
- 読み取り専用。
objectid ID タグの継承元オブジェクトのID。

プロパティの動作:
- 読み取り専用。

カスタムインターフェース

Host prototype object の custom_interfaces が「ホストプロトタイプのカスタムインターフェースを使用」に設定されている場合、カスタムインターフェースがサポートされます。 カスタムインターフェースオブジェクトには、以下のプロパティがあります。

Property Type Description
type integer インターフェースタイプ。

指定可能な値:
1 - エージェント;
2 - SNMP;
3 - IPMI;
4 - JMX.

Property behavior:
- 必須
useip integer IP 経由で接続するかどうか。

指定可能な値:
0 - ホストの DNS 名を使用して接続;
1 - ホストの IP アドレスを使用して接続。

Property behavior:
- 必須
ip string インターフェースで使用される IP アドレス。
マクロを含めることができます。

Property behavior:
- useip が「ホストの IP アドレスを使用して接続」に設定されている場合は 必須
dns string インターフェースで使用される DNS 名。
マクロを含めることができます。

Property behavior:
- useip が「ホストの DNS 名を使用して接続」に設定されている場合は 必須
port string インターフェースで使用されるポート番号。
ユーザーマクロおよび LLD マクロを含めることができます。

Property behavior:
- 必須
main integer このインターフェースをホスト上のデフォルトとして使用するかどうか。
ホスト上では、あるタイプのインターフェースのうち 1 つだけをデフォルトとして設定できます。

指定可能な値:
0 - デフォルトではない;
1 - デフォルト。

Property behavior:
- 必須
details object カスタムインターフェースの詳細 のための追加オブジェクト。

Property behavior:
- type が「SNMP」に設定されている場合は 必須

カスタムインターフェースの詳細

details オブジェクトには、次のプロパティがあります。

プロパティ タイプ 説明
version integer SNMPインターフェースのバージョン。

指定可能な値:
1 - SNMPv1;
2 - SNMPv2c;
3 - SNMPv3。

プロパティの動作:
- 必須
bulk integer バルクSNMPリクエストを使用するかどうか。

指定可能な値:
0 - バルクリクエストを使用しない;
1 - (デフォルト) - バルクリクエストを使用する。
community string SNMPコミュニティ。

プロパティの動作:
- version が「SNMPv1」または「SNMPv2c」に設定されている場合は必須
max_repetitions string ネイティブSNMPバルクリクエスト（GetBulkRequest-PDU）の最大繰り返し値。
SNMPv2およびSNMPv3の walk[] アイテムでのみ使用されます。
LLDマクロおよびユーザーマクロがサポートされています。

指定可能な値: 1～2147483647（INT32_MAX）。
デフォルト: 10。
retries string リクエストがタイムアウトした場合の最大再試行回数。
walk[] および get[] アイテムで使用されます。walk[] の場合、再試行回数はウォーク全体で共有されます。
LLDマクロおよびユーザーマクロがサポートされています。

指定可能な値: 0～100（0 - 再試行を無効にする）。
デフォルト: 5。
securityname string SNMPv3セキュリティ名。

プロパティの動作:
- version が「SNMPv3」に設定されている場合にサポート
securitylevel integer SNMPv3セキュリティレベル。

指定可能な値:
0 - (デフォルト) - noAuthNoPriv;
1 - authNoPriv;
2 - authPriv。

プロパティの動作:
- version が「SNMPv3」に設定されている場合にサポート
authpassphrase string SNMPv3認証パスフレーズ。

プロパティの動作:
- version が「SNMPv3」に設定され、securitylevel が「authNoPriv」または「authPriv」に設定されている場合にサポート
privpassphrase string SNMPv3プライバシーパスフレーズ。

プロパティの動作:
- version が「SNMPv3」に設定され、securitylevel が「authPriv」に設定されている場合にサポート
authprotocol integer SNMPv3認証プロトコル。

指定可能な値:
0 - (デフォルト) - MD5;
1 - SHA1;
2 - SHA224;
3 - SHA256;
4 - SHA384;
5 - SHA512。

プロパティの動作:
- version が「SNMPv3」に設定され、securitylevel が「authNoPriv」または「authPriv」に設定されている場合にサポート
privprotocol integer SNMPv3プライバシープロトコル。SNMPv3インターフェースでのみ使用されます。

指定可能な値:
0 - (デフォルト) - DES;
1 - AES128;
2 - AES192;
3 - AES256;
4 - AES192C;
5 - AES256C。

プロパティの動作:
- version が「SNMPv3」に設定され、securitylevel が「authPriv」に設定されている場合にサポート
contextname string SNMPv3コンテキスト名。

プロパティの動作:
- version が「SNMPv3」に設定されている場合にサポート