Host prototypeオブジェクト

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

ホストプロトタイプ

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

Property Type Description
hostid ID ホストプロトタイプのID。

Property behavior:
- 読み取り専用
- 更新操作では 必須
host string ホストプロトタイプの技術名。

Property behavior:
- 作成操作では 必須
- 継承されたオブジェクトでは 読み取り専用
name string ホストプロトタイプの表示名。

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

Property behavior:
- 継承されたオブジェクトでは 読み取り専用
status integer ホストプロトタイプのステータス。

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

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

Property behavior:
- 読み取り専用
inventory_mode integer ホストインベントリの入力モード。

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

Property behavior:
- 読み取り専用
discover integer ホストプロトタイプのディスカバリステータス。

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

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

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

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

グループリンク

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

Property Type Description
groupid ID ホストグループのID。

Property behavior:
- required

グループプロトタイプ

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

プロパティ Type 説明
group_prototypeid ID グループプロトタイプのID。

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

Property behavior:
- create操作で required

ホストプロトタイプタグ

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

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

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

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

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

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

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

プロパティの動作:
- 必須
useip integer IP 経由で接続するかどうか。

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

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

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

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

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

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

プロパティの動作:
- 必須
details object カスタムインターフェースの詳細 用の追加オブジェクト。

プロパティの動作:
- type が「SNMP」に設定されている場合は 必須

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

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

Property Type Description
version integer SNMPインターフェースのバージョン。

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

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

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

プロパティの動作:
- version が "SNMPv1" または "SNMPv2c" に設定されている場合は 必須
max_repetitions integer ネイティブSNMP bulkリクエスト (GetBulkRequest-PDUs) の最大繰り返し値。
SNMPv2 および v3 の discovery[] と walk[] アイテムでのみ使用されます。

デフォルト: 10。
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" に設定されている場合に サポート