Host interfaceオブジェクト

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

ホストインターフェース

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

作成操作では、ip と dns の両方のプロパティが必須であることに注意してください。 DNS を使用しない場合は、空文字列に設定してください。

Property Type Description
interfaceid ID インターフェースのID。

Property behavior:
- read-only
- 更新操作で required
available integer ホストインターフェースの可用性。

指定可能な値:
0 - (default) 不明;
1 - 利用可能;
2 - 利用不可。

Property behavior:
- read-only
hostid ID このインターフェースが属するホストのID。

Property behavior:
- constant
- 作成操作で required
type integer インターフェースのタイプ。

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

Property behavior:
- 作成操作で required
ip string インターフェースで使用されるIPアドレス。

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

Property behavior:
- 作成操作で required
dns string インターフェースで使用されるDNS名。

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

Property behavior:
- 作成操作で required
port string インターフェースで使用されるポート番号。
ユーザーマクロを含めることができます。

Property behavior:
- 作成操作で required
useip integer IP 経由で接続するかどうか。

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

Property behavior:
- 作成操作で required
main integer このインターフェースをホスト上のデフォルトとして使用するかどうか。ホスト上では、特定のタイプごとに1つのインターフェースのみをデフォルトとして設定できます。

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

Property behavior:
- 作成操作で required
details object インターフェース用の追加のdetailsオブジェクト。

Property behavior:
- type が "SNMP" に設定されている場合は required
disable_until timestamp 利用不可のホストインターフェースに対する次回のポーリング時刻。

Property behavior:
- read-only
error string ホストインターフェースが利用不可の場合のエラーテキスト。

Property behavior:
- read-only
errors_from timestamp ホストインターフェースが利用不可になった時刻。

Property behavior:
- read-only

詳細

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

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

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

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

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

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

デフォルト: 10。
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インターフェースでのみ使用されます。