GET /api/hosts
すべてのホストを一覧表示

GET /api/hostgroups/:hostgroup_id/hosts
ホストグループのすべてのホストを一覧表示

GET /api/locations/:location_id/hosts
ロケーションごとにホストを一覧表示

GET /api/organizations/:organization_id/hosts
組織ごとにホストを一覧表示

GET /api/environments/:environment_id/hosts
環境ごとにホストを一覧表示

GET /api/hosts
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ip": null,
      "ip6": null,
      "environment_id": null,
      "environment_name": null,
      "last_report": null,
      "mac": null,
      "realm_id": null,
      "realm_name": null,
      "sp_mac": null,
      "sp_ip": null,
      "sp_name": null,
      "domain_id": null,
      "domain_name": null,
      "architecture_id": null,
      "architecture_name": null,
      "operatingsystem_id": null,
      "operatingsystem_name": null,
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "sp_subnet_id": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": null,
      "medium_name": null,
      "pxe_loader": null,
      "build": false,
      "comment": null,
      "disk": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": 135138680,
      "owner_name": "Admin User",
      "owner_type": "User",
      "enabled": true,
      "managed": false,
      "use_image": null,
      "image_file": "",
      "uuid": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "compute_profile_id": null,
      "compute_profile_name": null,
      "capabilities": [
        "build"
      ],
      "provision_method": "build",
      "certname": "host18",
      "image_id": null,
      "image_name": null,
      "created_at": "2019-09-11 14:31:59 UTC",
      "updated_at": "2019-09-11 14:31:59 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "uptime_seconds": null,
      "organization_id": 447626438,
      "organization_name": "Organization 1",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "name": "host18",
      "id": 102,
      "puppet_proxy_id": null,
      "puppet_proxy_name": null,
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": null,
      "puppet_ca_proxy": null,
      "hostgroup_name": null,
      "hostgroup_title": null,
      "parameters": [
        {
          "priority": 70,
          "created_at": "2019-09-11 14:31:59 UTC",
          "updated_at": "2019-09-11 14:31:59 UTC",
          "id": 767575239,
          "name": "foo",
          "parameter_type": null,
          "value": "bar"
        }
      ]
    }
  ]
}

パラメーター

パラメーター名 記述
thin
任意

ホストの一覧 ID および名前のみ

Validations:

  • Must be one of: true, false, 1, 0.

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

environment_id
任意

環境の ID

Validations:

  • Must be a String

include
任意

含める追加の情報タイプの配列

Validations:

  • Must be one of: parameters, all_parameters.

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
architecture string
boot_time datetime
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
domain string
domain_id integer
environment string
facts string
global_status ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
image string
installed_at datetime
ip string
last_report datetime
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
realm string
realm_id integer
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

GET /api/hosts/:id
ホストの表示

GET /api/hosts/host27
200
{
  "ip": null,
  "ip6": null,
  "environment_id": null,
  "environment_name": null,
  "last_report": null,
  "mac": null,
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": null,
  "domain_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build"
  ],
  "provision_method": "build",
  "certname": "host27",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:32:00 UTC",
  "updated_at": "2019-09-11 14:32:00 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "name": "host27",
  "id": 112,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-09-11 14:32:00 UTC",
      "updated_at": "2019-09-11 14:32:00 UTC",
      "managed": true,
      "identifier": null,
      "id": 121,
      "name": "host27",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host27",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/hosts
ホストの作成

POST /api/hosts
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981711,
    "medium_id": 980190962,
    "architecture_id": 501905019,
    "operatingsystem_id": 1073012828,
    "puppet_proxy_id": 182953976,
    "compute_resource_id": 980190962,
    "root_pass": "xybxa6JUkz63w",
    "location_id": 255093256,
    "organization_id": 447626438,
    "interfaces_attributes": {
      "1": {
        "primary": true,
        "ip": "10.0.0.20",
        "mac": "00:11:22:33:44:00"
      },
      "2": {
        "type": "bmc",
        "provider": "IPMI",
        "mac": "00:11:22:33:44:01"
      },
      "3": {
        "mac": "00:11:22:33:44:02",
        "_destroy": 1
      }
    }
  }
}
201
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "00:11:22:33:44:00",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": "00:11:22:33:44:01",
  "sp_ip": null,
  "sp_name": null,
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1",
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": 1007981711,
  "ptable_name": "ptable8",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": "Grub UEFI",
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": true,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build",
    "image",
    "new_volume"
  ],
  "provision_method": "build",
  "certname": "testhost11.mydomain.net",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:57 UTC",
  "updated_at": "2019-09-11 14:31:57 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "Warning",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "configuration_status": 0,
  "configuration_status_label": "No reports",
  "build_status": 0,
  "build_status_label": "Installed",
  "name": "testhost11.mydomain.net",
  "id": 95,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": null,
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "created_at": "2019-09-11 14:31:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 101,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "00:11:22:33:44:00",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-09-11 14:31:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 102,
      "name": null,
      "ip": null,
      "ip6": null,
      "mac": "00:11:22:33:44:01",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bmc",
      "username": null,
      "password": null,
      "provider": "IPMI",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

host
必須

Validations:

  • Must be a Hash

host[name]
必須

Validations:

  • Must be a String

host[location_id]
必須

Validations:

  • Must be a number.

host[organization_id]
必須

Validations:

  • Must be a number.

host[environment_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • Must be a String

host[mac]
任意 , nil可

管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。

Validations:

  • Must be a String

host[architecture_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[medium_id]
任意 , nil可

イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
任意 , nil可

ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

Nil はホストがベアメタルであることを意味します

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。

Validations:

  • Must be a String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

ホストのパラメーター (配列またはインデックス化されたハッシュ)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
必須

パラメーター名

Validations:

  • Must be a String

host[host_parameters_attributes][value]
必須

パラメーター値

Validations:

  • Must be a String

host[build]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

host[enabled]
任意 , nil可

このホストを Foreman レポート内に組み込む

Validations:

  • Must be one of: true, false, 1, 0.

host[provision_method]
任意 , nil可

このメソッドは、ホストのプロビジョニングに使用されます。

Validations:

  • Must be one of: build, image.

host[managed]
任意 , nil可

ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。

Validations:

  • Must be one of: true, false, 1, 0.

host[progress_report_id]
任意 , nil可

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
任意 , nil可

このホストについての追加情報

Validations:

  • Must be a String

host[capabilities]
任意 , nil可

Validations:

  • Must be a String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

ホストのネットワークインターフェース

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
任意 , nil可

インターフェースの IPv4 アドレス

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
任意 , nil可

インターフェースの IPv6 アドレス

Validations:

  • Must be a String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
任意 , nil可

IPv4 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

IPv6 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
任意 , nil可

MTU。この属性はサブネット MTU より優先されます。

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID ['eth1', 'eth2']。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
任意 , nil可

インターフェースの追加のコンピュートリソース固有の属性。

Validations:

  • Must be a Hash

host[compute_attributes]
任意 , nil可

追加のコンピュートリソース固有の属性。

Validations:

  • Must be a Hash


PUT /api/hosts/:id
ホストの更新

PUT /api/hosts/host20
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981717,
    "medium_id": 980190962,
    "architecture_id": 501905019,
    "operatingsystem_id": 1073012828,
    "puppet_proxy_id": 182953976,
    "compute_resource_id": 980190962,
    "root_pass": "xybxa6JUkz63w",
    "location_id": 255093256,
    "organization_id": 447626438,
    "ip": "10.0.0.20",
    "mac": "52:53:00:1e:85:93",
    "compute_attributes": {
      "cpus": 4,
      "memory": 1024
    }
  }
}
200
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "52:53:00:1e:85:93",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1",
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": 1007981717,
  "ptable_name": "ptable14",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build",
    "image",
    "new_volume"
  ],
  "provision_method": "build",
  "certname": "testhost11.mydomain.net",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:59 UTC",
  "updated_at": "2019-09-11 14:31:59 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "Warning",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "configuration_status": 0,
  "configuration_status_label": "No reports",
  "name": "testhost11.mydomain.net",
  "id": 104,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": null,
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "created_at": "2019-09-11 14:31:59 UTC",
      "updated_at": "2019-09-11 14:31:59 UTC",
      "managed": true,
      "identifier": null,
      "id": 113,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "52:53:00:1e:85:93",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host
必須

Validations:

  • Must be a Hash

host[name]
任意

Validations:

  • Must be a String

host[location_id]
任意

Validations:

  • Must be a number.

host[organization_id]
任意

Validations:

  • Must be a number.

host[environment_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • Must be a String

host[mac]
任意 , nil可

管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。

Validations:

  • Must be a String

host[architecture_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[medium_id]
任意 , nil可

イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
任意 , nil可

ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

Nil はホストがベアメタルであることを意味します

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。

Validations:

  • Must be a String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

ホストのパラメーター (配列またはインデックス化されたハッシュ)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
任意

パラメーター名

Validations:

  • Must be a String

host[host_parameters_attributes][value]
任意

パラメーター値

Validations:

  • Must be a String

host[build]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

host[enabled]
任意 , nil可

このホストを Foreman レポート内に組み込む

Validations:

  • Must be one of: true, false, 1, 0.

host[provision_method]
任意 , nil可

このメソッドは、ホストのプロビジョニングに使用されます。

Validations:

  • Must be one of: build, image.

host[managed]
任意 , nil可

ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。

Validations:

  • Must be one of: true, false, 1, 0.

host[progress_report_id]
任意 , nil可

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
任意 , nil可

このホストについての追加情報

Validations:

  • Must be a String

host[capabilities]
任意 , nil可

Validations:

  • Must be a String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

ホストのネットワークインターフェース

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
任意 , nil可

インターフェースの IPv4 アドレス

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
任意 , nil可

インターフェースの IPv6 アドレス

Validations:

  • Must be a String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
任意 , nil可

IPv4 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

IPv6 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
任意 , nil可

MTU。この属性はサブネット MTU より優先されます。

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID ['eth1', 'eth2']。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
任意 , nil可

インターフェースの追加のコンピュートリソース固有の属性。

Validations:

  • Must be a Hash

host[compute_attributes]
任意 , nil可

追加のコンピュートリソース固有の属性。

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
ホストの削除

DELETE /api/hosts/host63
{
  "host": {}
}
200
{
  "id": 151,
  "name": "host63",
  "last_compile": null,
  "last_report": null,
  "updated_at": "2019-09-11T14:32:05.672Z",
  "created_at": "2019-09-11T14:32:05.672Z",
  "root_pass": "$5$1UEV7oLOB3txm0ip$T/Nk/weLcsTQ2L037RGo3FU7r9q8F8JOWJ/tex5FSoC",
  "architecture_id": null,
  "operatingsystem_id": null,
  "environment_id": null,
  "ptable_id": null,
  "medium_id": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 117925625,
  "owner_type": "User",
  "enabled": true,
  "puppet_ca_proxy_id": null,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": null,
  "puppet_proxy_id": null,
  "certname": "host63",
  "image_id": null,
  "organization_id": 447626438,
  "location_id": 255093256,
  "otp": null,
  "realm_id": null,
  "compute_profile_id": null,
  "provision_method": "build",
  "grub_pass": "$6$fHs7oc0AiZkJrndT$Vk0Hqc2jjSAFiS8sBcE0FZ4g/I/y281ekboCAJ.RDC34ydh7j3d5GRr88AKzKHFgCyPpsGv8Wq64K0aFuok5H0",
  "global_status": 0,
  "lookup_value_matcher": "fqdn=host63",
  "pxe_loader": null,
  "initiated_at": null,
  "build_errors": null
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/enc
ホストの ENC 値の取得

GET /api/hosts/host37/enc
200
{
  "data": {
    "parameters": {
      "foreman_subnets": [],
      "foreman_interfaces": [
        {
          "ip": null,
          "ip6": null,
          "mac": null,
          "name": "host37",
          "attrs": {},
          "virtual": false,
          "link": true,
          "identifier": null,
          "managed": true,
          "primary": true,
          "provision": true,
          "subnet": null,
          "subnet6": null,
          "tag": null,
          "attached_to": null,
          "type": "Interface"
        }
      ],
      "location": "Location 1",
      "location_title": "Location 1",
      "organization": "Organization 1",
      "organization_title": "Organization 1",
      "owner_name": "Admin User",
      "owner_email": "admin@someware.com",
      "ssh_authorized_keys": [],
      "foreman_users": {
        "secret_admin": {
          "firstname": "Admin",
          "lastname": "User",
          "mail": "admin@someware.com",
          "description": null,
          "fullname": "Admin User",
          "name": "secret_admin",
          "ssh_authorized_keys": []
        }
      },
      "root_pw": "$5$LNghnpYoI94vN2OZ$39iivXS1MnBFhWGgHFeMxY5KS8mp5iF0gvoldfq0Ok4",
      "foreman_config_groups": [],
      "puppetmaster": "",
      "foreman_env": "environment2",
      "test": "myvalue",
      "org_param": "xyz",
      "loc_param": "abc"
    },
    "classes": [
      "class1"
    ],
    "environment": "environment2"
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status
ホストの設定ステータスの取得

Return value may either be one of the following:

  • Alerts disabled
  • No reports
  • Error
  • Out of sync
  • Active
  • Pending
  • No changes

GET /api/hosts/host26/status
200
{
  "status": "No reports"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status/:type
ホストのステータスの取得

Returns string representing a host status of a given type

GET /api/hosts/host83/status/global
200
{
  "status_label": "OK",
  "status": 0
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

type
必須

ステータスタイプ。以下のいずれか * global * configuration * build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
ホストの vm 属性の取得

Return the host’s compute attributes that can be used to create a clone of this VM

GET /api/hosts/host122/vm_compute_attributes
200
{
  "cpus": 4,
  "memory": null
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/disassociate
ホストの VM との関連付けを解除

PUT /api/hosts/host16/disassociate
{
  "host": {}
}
200
{
  "ip": null,
  "ip6": null,
  "environment_id": null,
  "environment_name": null,
  "last_report": null,
  "mac": null,
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": null,
  "domain_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build"
  ],
  "provision_method": "build",
  "certname": "host16",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:58 UTC",
  "updated_at": "2019-09-11 14:31:58 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "name": "host16",
  "id": 99,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-09-11 14:31:58 UTC",
      "updated_at": "2019-09-11 14:31:58 UTC",
      "managed": true,
      "identifier": null,
      "id": 107,
      "name": "host16",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host16",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/power
ホストでパワー操作を実行します

PUT /api/hosts/host106.example190.com/power
{
  "power_action": "status",
  "host": {}
}
200
{
  "power": "on"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

power_action
必須

パワーアクション。有効なアクションは (on/start)、(off/stop)、(soft/reboot)、(cycle/reset)、(state/status) です。

Validations:

  • Must be a String


GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

GET /api/hosts/6/power
200
{
  "id": 6,
  "state": "on",
  "title": "On"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/boot
指定されたデバイスからホストを起動

PUT /api/hosts/host479/boot
{
  "device": "bios",
  "host": {}
}
422
{
  "message": "ERF42-3180 [Foreman::Exception]: No BMC NIC available for host host479"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

device
必須

ブートデバイス。有効なデバイスはディスク、CDROM、PXE、BIOS です。

Validations:

  • Must be a String


POST /api/hosts/facts
ホストのファクトをアップロードし、必要な場合はホストを作成します

POST /api/hosts/facts
{
  "name": "brslc022.brs.infineon.com",
  "facts": {
    "is_virtual": "true",
    "processorcount": "2",
    "serialnumber": "VMware-56 4d 15 06 72 86 a9 d3-8a 09 fc 27 5a cf 00 45",
    "kernel": "Linux",
    "virtual": "vmware",
    "_timestamp": "2010-02-16 12:52:38.163833 +01:00",
    "network_eth0": "172.29.205.0",
    "operatingsystemrelease": "4",
    "uniqueid": "1dac16cd",
    "hardwaremodel": "i686",
    "rubysitedir": "/usr/lib/site_ruby/1.8",
    "platform": "Linux_2.6_i386_all",
    "uptime_seconds": "3756",
    "lsbrelease": ":core-3.0-ia32:core-3.0-noarch:graphics-3.0-ia32:graphics-3.0-noarch",
    "memorysize": "1.45 GB",
    "gi": "4",
    "netmask_eth0": "255.255.255.128",
    "ipaddress": "172.29.205.22",
    "physicalprocessorcount": "0",
    "swapfree": "1.95 GB",
    "vmware": "virtual",
    "netmask": "255.255.255.128",
    "clientversion": "0.24.8",
    "fqdn": "brslc022.brs.infineon.com",
    "timezone": "GMT",
    "ps": "ps -ef",
    "kernelrelease": "2.6.9-89.0.16.ELsmp",
    "hardwareisa": "i686",
    "domain": "brs.infineon.com",
    "type": "Other",
    "kernelversion": "2.6.9",
    "id": "root",
    "lsbdistdescription": "Red Hat Enterprise Linux AS release 4 (Nahant Update 8)",
    "uptime_hours": "1",
    "lsbdistrelease": "4",
    "macaddress_eth0": "00:0C:29:CF:00:45",
    "manufacturer": "VMware, Inc.",
    "memoryfree": "1.39 GB",
    "selinux": "false",
    "gateway_if": "eth0",
    "lsbdistcodename": "NahantUpdate8",
    "sshrsakey": "AAAAB3NzaC1yc2EAAAABIwAAAIEAyj0XAKzx4WlNE8Vzj0ABBEHxqHr2H4AZZnabnQkYTOfz5kObXL+BvYqPONg2EqeUYCTNaFtQQPpJ4H+TM+GCJDNvFEKJTRd+cFoOuramf9LunWN/+ETreQ5V8KhKvdYTNw5blPBKiQz/XxSxcm7beo5QiBVr/lOM0u8YhGTLawk=",
    "uptime_days": "0",
    "interfaces": "eth0",
    "hostname": "brslc022",
    "graphcard": "VMware",
    "uptime": "1:02 hours",
    "processor0": "Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz",
    "puppetversion": "0.24.8",
    "productname": "VMware Virtual Platform",
    "architecture": "i386",
    "gateway": "172.29.205.1",
    "rubyversion": "1.8.1",
    "environment": "brs_test",
    "path": "/usr/bin:/sbin:/bin:/usr/sbin:/opt/csw/bin",
    "swapsize": "1.95 GB",
    "ipaddress_eth0": "172.29.205.22",
    "facterversion": "1.5.7",
    "kernelmajversion": "2.6",
    "operatingsystem": "RedHat",
    "macaddress": "00:0C:29:CF:00:45",
    "processor1": "Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz",
    "lsbmajdistrelease": "4",
    "sshdsakey": "AAAAB3NzaC1kc3MAAACBAIUasO2eEvlRHfcO8wMPfbo98YfgVsJj0qhUDSSoSa6xmYI8QWBDMoxf1h8INiDfrNQ5e4VreLQjt4/2Ex7OXoeB7C9Cg18/TlfZU+RTNMdsL85W5hQrrKoBm+ksMnxidkDC66ROq+pmxBTGDwwxg3ugF8eZnVSzCZ1FE605AsStAAAAFQCrr3s1cLQFRc6oZJAx3EZDxDraCQAAAIBqIqIvY7KtRsI+8y8E5MSZXpRRZxf0zqbraDxASwzImUr6ysEmpJsHbHyi6UePnF55tG/iZNM4bSNg/3qExK8So040byV71qN4HNT48nIh3cCS0z8oKLqvlCRJ+dOY1QMkE8ZLfOyF4A6ZOTuE8TTsGpvUIR0HyXkpoiIR9XcgzgAAAIA4nkedBQi+VA01NvWx27GGz5P3TTQ36yDODZdLmXoepQM1rPfKWvPFFd5MxgJumSU5BKhYUiQTOImcRlQcY5DA3dGbog1dOAKlWyeJn4WRHbYr+VNgR/HwBzHLMW4TXLt38ThmPv9TiLS1RvTdHuDm2oRTadNZOrmQz619kZejmw==",
    "lsbdistid": "RedHatEnterpriseAS"
  },
  "host": {
    "name": "brslc022.brs.infineon.com"
  }
}
201
{
  "id": 15,
  "name": "brslc022.brs.infineon.com",
  "last_compile": "2010-02-16T11:52:38.163Z",
  "last_report": null,
  "updated_at": "2019-09-11T14:39:25.635Z",
  "created_at": "2019-09-11T14:39:25.251Z",
  "root_pass": null,
  "architecture_id": 578327779,
  "operatingsystem_id": 1073012865,
  "environment_id": 687036940,
  "ptable_id": null,
  "medium_id": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": 980190964,
  "hostgroup_id": null,
  "owner_id": null,
  "owner_type": null,
  "enabled": true,
  "puppet_ca_proxy_id": null,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": null,
  "puppet_proxy_id": null,
  "certname": "brslc022.brs.infineon.com",
  "image_id": null,
  "organization_id": 447626456,
  "location_id": 447626455,
  "otp": null,
  "realm_id": null,
  "compute_profile_id": null,
  "provision_method": "build",
  "grub_pass": "",
  "global_status": 0,
  "lookup_value_matcher": "fqdn=brslc022.brs.infineon.com",
  "pxe_loader": null,
  "initiated_at": null,
  "build_errors": null,
  "reported_data_attributes": {
    "id": 1,
    "host_id": 15,
    "boot_time": "2019-09-11T13:36:49.000Z",
    "created_at": "2019-09-11T14:39:25.583Z",
    "updated_at": "2019-09-11T14:39:25.583Z"
  }
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

name
必須

ホストのホスト名

Validations:

  • Must be a String

facts
必須

ホストのファクトを含むハッシュ

Validations:

  • Must be a Hash

certname
任意

オプション: ホストの証明書名

Validations:

  • Must be a String

type
任意

オプション: 作成するホストの STI タイプ

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
オーケストレーション設定の再ビルド

POST /api/hosts/host41/rebuild_config
{
  "only": [
    "TFTP"
  ],
  "host": {}
}
200
{
  "message": "Configuration successfully rebuilt."
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

only
任意

再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
テンプレートコンテンツのプロビジョニング中にプレビューがレンダリングされました

GET /api/hosts/host39.example187.com/template/provision
200
{
  "template": "template content 1"
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

kind
必須

テンプレート種類、利用可能な値:

Validations:

  • Must be a String