Host interfaceオブジェクト

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

ホストインターフェース

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

プロパティ 型 説明
interfaceid ID インターフェースのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
available integer ホストインターフェースの可用性。

指定可能な値:
0 - (デフォルト) 不明;
1 - 使用可能;
2 - 使用不可。

プロパティの動作:
- 読み取り専用
hostid ID インターフェースが属するホストのID。

プロパティの動作:
- 固定
- 作成操作では必須
type integer インターフェースのタイプ。

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

プロパティの動作:
- 作成操作では必須
ip string インターフェースで使用するIPアドレス。

DNS経由で接続する場合は空にできます。

プロパティの動作:
- 作成操作では必須
dns string インターフェースで使用するDNS名。

IP経由で接続する場合は空にできます。

プロパティの動作:
- 作成操作では必須
port string インターフェースで使用するポート番号。
ユーザーマクロを含めることができます。

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

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

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

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

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

プロパティの動作:
- typeが「SNMP」に設定されている場合は必須
disable_until timestamp 使用できないホストインターフェースの次回のポーリング時刻。

プロパティの動作:
- 読み取り専用
error string ホストインターフェースが使用できない場合のエラーテキスト。

プロパティの動作:
- 読み取り専用
errors_from timestamp ホストインターフェースが使用できなくなった時刻。

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

詳細

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

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

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

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

指定可能な値:
0 - バルクリクエストを使用しない;
1 - (デフォルト) - バルクリクエストを使用する。
community string SNMPコミュニティ。SNMPv1およびSNMPv2インターフェースでのみ使用されます。

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

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

指定可能な値: 0～100（0 - 再試行を無効にする）。
デフォルト: 5。
securityname string SNMPv3セキュリティ名。SNMPv3インターフェースでのみ使用されます。
securitylevel integer SNMPv3セキュリティレベル。SNMPv3インターフェースでのみ使用されます。

指定可能な値:
0 - (デフォルト) - noAuthNoPriv;
1 - authNoPriv;
2 - authPriv。
authpassphrase string SNMPv3認証パスフレーズ。SNMPv3インターフェースでのみ使用されます。
privpassphrase string SNMPv3プライバシーパスフレーズ。SNMPv3インターフェースでのみ使用されます。
authprotocol integer SNMPv3認証プロトコル。SNMPv3インターフェースでのみ使用されます。

指定可能な値:
0 - (デフォルト) - MD5;
1 - SHA1;
2 - SHA224;
3 - SHA256;
4 - SHA384;
5 - SHA512。
privprotocol integer SNMPv3プライバシープロトコル。SNMPv3インターフェースでのみ使用されます。

指定可能な値:
0 - (デフォルト) - DES;
1 - AES128;
2 - AES192;
3 - AES256;
4 - AES192C;
5 - AES256C。
contextname string SNMPv3コンテキスト名。SNMPv3インターフェースでのみ使用されます。