Table of Contents
Host prototypeオブジェクト
次のオブジェクトは、hostprototypeAPIに直接関連しています。
ホストプロトタイプ
ホストプロトタイプオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| hostid | ID | ホストプロトタイプのID。 プロパティの動作: - 読み取り専用 - 更新操作時は必須 |
| host | string | ホストプロトタイプの技術名。 プロパティの動作: - 作成操作時は必須 - 継承されたオブジェクトでは読み取り専用 |
| name | string | ホストプロトタイプの表示名。 デフォルト: hostプロパティの値。プロパティの動作: - 継承されたオブジェクトでは読み取り専用 |
| status | integer | ホストプロトタイプのステータス。 可能な値: 0 - (デフォルト) 監視対象ホスト; 1 - 監視対象外ホスト。 |
| flags | integer | ホストプロトタイプの由来。 可能な値: 2 - ホストプロトタイプ; 6 - 検出されたホストプロトタイプ プロパティの動作: - 読み取り専用 |
| inventory_mode | integer | ホストインベントリの設定モード。 可能な値: -1 - (デフォルト) 無効; 0 - 手動; 1 - 自動。 |
| templateid | ID | 親テンプレートホストプロトタイプのID。 プロパティの動作: - 読み取り専用 |
| discover | integer | ホストプロトタイプの検出ステータス。 可能な値: 0 - (デフォルト) 新しいホストが検出される; 1 - 新しいホストは検出されず、既存のホストはロストとしてマークされる。 |
| custom_interfaces | integer | ホストプロトタイプによって作成されたホストのカスタムインターフェースのソース。 可能な値: 0 - (デフォルト) 親ホストからインターフェースを継承; 1 - ホストプロトタイプのカスタムインターフェースを使用。 プロパティの動作: - 継承されたオブジェクトでは読み取り専用 |
| uuid | string | インポートされたホストプロトタイプを既存のものにリンクするために使用されるユニバーサルユニーク識別子。指定されていない場合は自動生成されます。 プロパティの動作: - ホストプロトタイプがテンプレートに属している場合にサポート |
グループリンク
グループリンクオブジェクトは、ホストプロトタイプとホストグループをリンクします。 以下のプロパティを持ちます。
グループプロトタイプ
グループプロトタイプオブジェクトは、検出されたホストに対して作成されるグループを定義します。 以下のプロパティを持ちます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| group_prototypeid | ID | グループプロトタイプのID。 プロパティの動作: - 読み取り専用 |
| name | string | グループプロトタイプの名前。 プロパティの動作: - 作成操作時に必須 |
ホストプロトタイプタグ
ホストプロトタイプタグオブジェクトには、以下のプロパティがあります。
カスタムインターフェース
custom_interfacesがホストプロトタイプオブジェクトで「ホストプロトタイプのカスタムインターフェースを使用する」に設定されている場合、カスタムインターフェースがサポートされます。 カスタムインターフェースオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 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」に設定されている場合は必須 |
カスタムインターフェースの詳細
詳細オブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| version | integer | SNMPインターフェースのバージョン。 可能な値: 1 - SNMPv1; 2 - SNMPv2c; 3 - SNMPv3。 プロパティの動作: - 必須 |
| bulk | integer | バルクSNMPリクエストを使用するかどうか。 可能な値: 0 - バルクリクエストを使用しない; 1 - (デフォルト) - バルクリクエストを使用する。 |
| community | string | SNMPコミュニティ。 プロパティの動作: - versionが"SNMPv1"または"SNMPv2c"に設定されている場合は必須 |
| max_repetitions | integer | ネイティブSNMPバルクリクエスト (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"に設定されている場合はサポート |