Table of Contents
host.create
説明
object host.create(object/array hosts)
このメソッドは新しいホストを作成します。
このメソッドは管理者およびスーパ管理者ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメータ
(object/array) 作成するホスト。
標準のホストプロパティに加えて、このメソッドは以下のパラメータを受け付けます。
| パラメータ | 型 | 説明 |
|---|---|---|
| groups | object/array | ホストを追加するホストグループ。 ホストグループには groupidプロパティのみが定義されている必要があります。パラメータの動作: - 必須 |
| interfaces | object/array | ホストに作成するインターフェース。 |
| tags | object/array | ホストタグ。 |
| templates | object/array | ホストにリンクするテンプレート。 テンプレートには templateidプロパティのみが定義されている必要があります。 |
| macros | object/array | ホストに作成するユーザーマクロ。 |
| inventory | object | ホストインベントリのプロパティ。 |
戻り値
(object) hostidsプロパティの下に生成されたホストのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたホストの順序と一致します。
例
ホストの作成
IPインターフェースとタグを持つ「Linux server」というホストを作成し、グループに追加し、テンプレートをリンクし、ホストインベントリにMACアドレスを設定します。
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Linux server",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "50"
}
],
"tags": [
{
"tag": "host-name",
"value": "linux-server"
}
],
"templates": [
{
"templateid": "20045"
}
],
"macros": [
{
"macro": "{$USER_ID}",
"value": "123321"
},
{
"macro": "{$USER_LOCATION}",
"value": "0:0:0",
"description": "latitude, longitude and altitude coordinates"
}
],
"inventory_mode": 0,
"inventory": {
"macaddress_a": "01234",
"macaddress_b": "56768"
}
},
"id": 1
}レスポンス:
SNMPインターフェースを持つホストの作成
詳細付きのSNMPv3インターフェースを持つ"SNMP host"というホストを作成します。
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "SNMP host",
"interfaces": [
{
"type": 2,
"main": 1,
"useip": 1,
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": 3,
"bulk": 0,
"securityname": "mysecurityname",
"contextname": "",
"securitylevel": 1
}
}
],
"groups": [
{
"groupid": "4"
}
]
},
"id": 1
}レスポンス:
PSK暗号化でホストを作成する
PSK暗号化を設定した「PSK host」というホストを作成します。 ホストはPSKを使用するように事前に設定されている必要があることに注意してください。
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "PSK host",
"interfaces": [
{
"type": 1,
"ip": "192.168.3.1",
"dns": "",
"port": "10050",
"useip": 1,
"main": 1
}
],
"groups": [
{
"groupid": "2"
}
],
"tls_accept": 2,
"tls_connect": 2,
"tls_psk_identity": "PSK 001",
"tls_psk": "1f87b595725ac58dd977beef14b97461a7c1045b9a1c963065002c5473194952"
},
"id": 1
}レスポンス:
プロキシで監視するホスト情報の作成
ID "1" のプロキシで監視するホスト情報を作成します。
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Host monitored by proxy",
"groups": [
{
"groupid": "2"
}
],
"monitored_by": 1,
"proxyid": 1
},
"id": 1
}Response:
プロキシグループで監視するホストの作成
ID "1" のプロキシグループで監視するホストを作成します。
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "Host monitored by proxy group",
"groups": [
{
"groupid": "2"
}
],
"monitored_by": 2,
"proxy_groupid": 1
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "プロキシグループで監視するホスト",
"groups": [
{
"groupid": "2"
}
],
"monitored_by": 2,
"proxy_groupid": 1
},
"id": 1
}レスポンス:
参照
ソース
CHost::create() in ui/include/classes/api/services/CHost.php.