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": 10,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "host650.example361.com",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ip": "0.0.0.98",
      "ip6": null,
      "environment_id": null,
      "environment_name": null,
      "last_report": null,
      "mac": "00:53:67:ab:00:7d",
      "realm_id": null,
      "realm_name": null,
      "sp_mac": "00:43:56:cd:00:0b",
      "sp_ip": "1.0.0.7",
      "sp_name": null,
      "domain_id": 759776793,
      "domain_name": "example361.com",
      "architecture_id": 578327787,
      "architecture_name": "x86_64-361",
      "operatingsystem_id": 1073012858,
      "operatingsystem_name": "operatingsystem180 192",
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "sp_subnet_id": null,
      "ptable_id": 1007981802,
      "ptable_name": "ptable284",
      "medium_id": 1011586648,
      "medium_name": "medium183",
      "pxe_loader": "Grub2 UEFI",
      "build": false,
      "comment": null,
      "disk": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": 886836129,
      "owner_name": "apiadmin User",
      "owner_type": "User",
      "enabled": true,
      "managed": true,
      "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": "host650.example361.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2019-11-07 08:39:29 UTC",
      "updated_at": "2019-11-07 08:39:29 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,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "host650.example361.com",
      "id": 51,
      "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
    }
  ]
}

参数

参数名字 描述
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
created_at datetime
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
params_name 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/host716
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": 980190963,
  "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": "host716",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-11-07 08:39:58 UTC",
  "updated_at": "2019-11-07 08:39: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": "hal900253",
  "name": "host716",
  "id": 16,
  "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-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:39:58 UTC",
      "updated_at": "2019-11-07 08:39:58 UTC",
      "managed": true,
      "identifier": null,
      "id": 18,
      "name": "host716",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host716",
      "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
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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": 1007981703,
    "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
    }
  }
}
201
{
  "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": 1007981703,
  "ptable_name": "ptable213",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": "Grub2 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-11-07 08:37:28 UTC",
  "updated_at": "2019-11-07 08:37:28 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": 3,
  "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-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": "string",
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": "string",
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "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-11-07 08:37:28 UTC",
      "updated_at": "2019-11-07 08:37:28 UTC",
      "managed": true,
      "identifier": null,
      "id": 3,
      "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
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a String

host[ip]
选填 , 允许空值

如果使用附带 DHCP 代理服务器的子网则不需要

Validations:

  • Must be a String

host[mac]
选填 , 允许空值

如果管理的主机为裸机则需要填写,如果为虚拟机,则不需要。

Validations:

  • Must be a String

host[architecture_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[domain_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[realm_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[puppet_proxy_id]
选填 , 允许空值

Puppet 代理服务器 ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
选填 , 允许空值

Puppet CA 代理服务器 ID

Validations:

  • Must be a number.

host[puppetclass_ids]
选填 , 允许空值

Validations:

  • Must be an array of any type

host[config_group_ids]
选填 , 允许空值

关联配置组的 ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a String

host[medium_id]
选填 , 允许空值

如果不是基于置备的映像,且用于管理主机,同时数值不是来自主机组,则需要填写。

Validations:

  • Must be a String

host[pxe_loader]
选填 , 允许空值

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]
选填 , 允许空值

如果已管理主机,且未定义自定义分区,则需填写。

Validations:

  • Must be a number.

host[subnet_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[compute_resource_id]
选填 , 允许空值

nil 说明主机是裸机

Validations:

  • Must be a number.

host[root_pass]
选填 , 允许空值

如果已管理主机,且数值不是从主机组或设置中的默认密码继承,则需填写。

Validations:

  • Must be a String

host[model_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[hostgroup_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[owner_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[owner_type]
选填 , 允许空值

主机拥有者类型

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[host_parameters_attributes]
选填 , 允许空值

主机参数(阵列或索引哈希)

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[host_parameters_attributes][parameter_type]
选填 , 允许空值

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
选填 , 允许空值

Validations:

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

host[build]
选填 , 允许空值

Validations:

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

host[enabled]
选填 , 允许空值

将这个主机包含在 Foreman 报告中

Validations:

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

host[provision_method]
选填 , 允许空值

此方法用于置备主机。

Validations:

  • Must be one of: build, image.

host[managed]
选填 , 允许空值

用来表示主机被管理或没有被管理的 True/False 标签。注:这个值还决定是否需要一些参数。

Validations:

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

host[progress_report_id]
选填 , 允许空值

用来跟踪业务流程任务状态的 UUID,GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
选填 , 允许空值

有关主机的附加信息

Validations:

  • Must be a String

host[capabilities]
选填 , 允许空值

Validations:

  • Must be a String

host[compute_profile_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[interfaces_attributes]
选填 , 允许空值

主机的网络接口。

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
选填 , 允许空值

接口的 MAC 地址。在裸机中管理的接口需要这个地址。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
选填 , 允许空值

接口的 IPv4 地址

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
选填 , 允许空值

接口的 IPv6 地址

Validations:

  • Must be a String

host[interfaces_attributes][type]
选填 , 允许空值

接口类型,例如:bmc。默认为 interface

Validations:

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

host[interfaces_attributes][name]
选填 , 允许空值

接口 DNS 名称

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
选填 , 允许空值

IPv4 接口的 Foreman 子网 ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
选填 , 允许空值

IPv6 接口的 Foreman 子网 ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
选填 , 允许空值

接口的 Foreman 域 ID。所管理主机中的主接口需要这个选项。

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
选填 , 允许空值

设备标识符,例如:eth0 或者 eth1.1。

Validations:

  • Must be a String

host[interfaces_attributes][managed]
选填 , 允许空值

这个接口应由 DHCP 管理还是由 DNS 智能代理服务器管理?是否应在预配过程中对其进行配置?

Validations:

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

host[interfaces_attributes][primary]
选填 , 允许空值

是否应该使用这个接口构建该主机的 FQDN?每台管理的主机都需要有一个主接口。

Validations:

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

host[interfaces_attributes][provision]
选填 , 允许空值

这个接口是否应该用于 PXELinux 的 TFTP(或基于映象主机的 SSH)?每台管理的主机需要有一个预配接口。

Validations:

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

host[interfaces_attributes][username]
选填 , 允许空值

仅用于 BMC 接口

Validations:

  • Must be a String

host[interfaces_attributes][password]
选填 , 允许空值

仅用于 BMC 接口

Validations:

  • Must be a String

host[interfaces_attributes][provider]
选填 , 允许空值

接口提供者,例如 IPMI。仅用于 BMC 接口。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
选填 , 允许空值

别名或 VLAN 失败

Validations:

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

host[interfaces_attributes][tag]
选填 , 允许空值

VLAN 标签,这个属性优先于子网 VLAN ID。仅用于虚拟接口。

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
选填 , 允许空值

MTU,这个属性优先于子网 MTU。

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
选填 , 允许空值

这个接口所属接口识别符,例如:eth1。仅用于虚拟接口。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
选填 , 允许空值

接口的捆绑模式,例如: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]
选填 , 允许空值

附加接口的识别符,例如:['eth1', 'eth2']。对于捆绑的接口,那些是从属接口。仅用于捆绑和桥接接口。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
选填 , 允许空值

使用空格分隔的选项,例如:miimon=100。仅用于捆绑接口。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
选填 , 允许空值

该接口的附加计算资源具体属性。

Validations:

  • Must be a Hash

host[compute_attributes]
选填 , 允许空值

附加计算资源的具体属性。

Validations:

  • Must be a Hash


PUT /api/hosts/:id
更新主机

示例

PUT /api/hosts/host719
{
  "host": {
    "interfaces_attributes": [
      {
        "id": 22,
        "name": "newname",
        "type": "bmc"
      }
    ]
  }
}
422
{
  "error": {
    "id": 20,
    "errors": {
      "interfaces.type": [
        "can't be changed once the interface is saved"
      ]
    },
    "full_messages": [
      "Type can't be changed once the interface is saved"
    ]
  }
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a String

host[ip]
选填 , 允许空值

如果使用附带 DHCP 代理服务器的子网则不需要

Validations:

  • Must be a String

host[mac]
选填 , 允许空值

如果管理的主机为裸机则需要填写,如果为虚拟机,则不需要。

Validations:

  • Must be a String

host[architecture_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[domain_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[realm_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[puppet_proxy_id]
选填 , 允许空值

Puppet 代理服务器 ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
选填 , 允许空值

Puppet CA 代理服务器 ID

Validations:

  • Must be a number.

host[puppetclass_ids]
选填 , 允许空值

Validations:

  • Must be an array of any type

host[config_group_ids]
选填 , 允许空值

关联配置组的 ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a String

host[medium_id]
选填 , 允许空值

如果不是基于置备的映像,且用于管理主机,同时数值不是来自主机组,则需要填写。

Validations:

  • Must be a String

host[pxe_loader]
选填 , 允许空值

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]
选填 , 允许空值

如果已管理主机,且未定义自定义分区,则需填写。

Validations:

  • Must be a number.

host[subnet_id]
选填 , 允许空值

如果已管理主机,且数值不是从主机组中继承,则需填写。

Validations:

  • Must be a number.

host[compute_resource_id]
选填 , 允许空值

nil 说明主机是裸机

Validations:

  • Must be a number.

host[root_pass]
选填 , 允许空值

如果已管理主机,且数值不是从主机组或设置中的默认密码继承,则需填写。

Validations:

  • Must be a String

host[model_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[hostgroup_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[owner_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[owner_type]
选填 , 允许空值

主机拥有者类型

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[host_parameters_attributes]
选填 , 允许空值

主机参数(阵列或索引哈希)

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[host_parameters_attributes][parameter_type]
选填 , 允许空值

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
选填 , 允许空值

Validations:

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

host[build]
选填 , 允许空值

Validations:

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

host[enabled]
选填 , 允许空值

将这个主机包含在 Foreman 报告中

Validations:

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

host[provision_method]
选填 , 允许空值

此方法用于置备主机。

Validations:

  • Must be one of: build, image.

host[managed]
选填 , 允许空值

用来表示主机被管理或没有被管理的 True/False 标签。注:这个值还决定是否需要一些参数。

Validations:

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

host[progress_report_id]
选填 , 允许空值

用来跟踪业务流程任务状态的 UUID,GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
选填 , 允许空值

有关主机的附加信息

Validations:

  • Must be a String

host[capabilities]
选填 , 允许空值

Validations:

  • Must be a String

host[compute_profile_id]
选填 , 允许空值

Validations:

  • Must be a number.

host[interfaces_attributes]
选填 , 允许空值

主机的网络接口。

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
选填 , 允许空值

接口的 MAC 地址。在裸机中管理的接口需要这个地址。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
选填 , 允许空值

接口的 IPv4 地址

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
选填 , 允许空值

接口的 IPv6 地址

Validations:

  • Must be a String

host[interfaces_attributes][type]
选填 , 允许空值

接口类型,例如:bmc。默认为 interface

Validations:

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

host[interfaces_attributes][name]
选填 , 允许空值

接口 DNS 名称

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
选填 , 允许空值

IPv4 接口的 Foreman 子网 ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
选填 , 允许空值

IPv6 接口的 Foreman 子网 ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
选填 , 允许空值

接口的 Foreman 域 ID。所管理主机中的主接口需要这个选项。

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
选填 , 允许空值

设备标识符,例如:eth0 或者 eth1.1。

Validations:

  • Must be a String

host[interfaces_attributes][managed]
选填 , 允许空值

这个接口应由 DHCP 管理还是由 DNS 智能代理服务器管理?是否应在预配过程中对其进行配置?

Validations:

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

host[interfaces_attributes][primary]
选填 , 允许空值

是否应该使用这个接口构建该主机的 FQDN?每台管理的主机都需要有一个主接口。

Validations:

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

host[interfaces_attributes][provision]
选填 , 允许空值

这个接口是否应该用于 PXELinux 的 TFTP(或基于映象主机的 SSH)?每台管理的主机需要有一个预配接口。

Validations:

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

host[interfaces_attributes][username]
选填 , 允许空值

仅用于 BMC 接口

Validations:

  • Must be a String

host[interfaces_attributes][password]
选填 , 允许空值

仅用于 BMC 接口

Validations:

  • Must be a String

host[interfaces_attributes][provider]
选填 , 允许空值

接口提供者,例如 IPMI。仅用于 BMC 接口。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
选填 , 允许空值

别名或 VLAN 失败

Validations:

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

host[interfaces_attributes][tag]
选填 , 允许空值

VLAN 标签,这个属性优先于子网 VLAN ID。仅用于虚拟接口。

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
选填 , 允许空值

MTU,这个属性优先于子网 MTU。

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
选填 , 允许空值

这个接口所属接口识别符,例如:eth1。仅用于虚拟接口。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
选填 , 允许空值

接口的捆绑模式,例如: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]
选填 , 允许空值

附加接口的识别符,例如:['eth1', 'eth2']。对于捆绑的接口,那些是从属接口。仅用于捆绑和桥接接口。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
选填 , 允许空值

使用空格分隔的选项,例如:miimon=100。仅用于捆绑接口。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
选填 , 允许空值

该接口的附加计算资源具体属性。

Validations:

  • Must be a Hash

host[compute_attributes]
选填 , 允许空值

附加计算资源的具体属性。

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
删除主机

示例

DELETE /api/hosts/host728
{
  "host": {}
}
404
{
  "error": {
    "message": "Resource host not found by id 'host728'"
  }
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host782/enc
200
{
  "data": {
    "parameters": {
      "foreman_subnets": [],
      "foreman_interfaces": [
        {
          "ip": null,
          "ip6": null,
          "mac": null,
          "name": "host782",
          "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$uLoZGHzYcd1lEBPr$Ow4e9oRmN4/9E3y4rQFN8w1CsoATETimT3HLKRsMgP2",
      "foreman_config_groups": [],
      "puppetmaster": "",
      "foreman_env": "environment152",
      "test": "myvalue",
      "org_param": "xyz",
      "loc_param": "abc"
    },
    "classes": [
      "class30"
    ],
    "environment": "environment152"
  }
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host761/status
404
{
  "error": {
    "message": "Resource host not found by id 'host761'"
  }
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host823/status/global
200
{
  "status_label": "OK",
  "status": 0
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host825/vm_compute_attributes
200
{
  "cpus": 4,
  "memory": null
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host804/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": "host804",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-11-07 08:40:15 UTC",
  "updated_at": "2019-11-07 08:40:15 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": "host804",
  "id": 120,
  "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-11-07 08:40:15 UTC",
      "updated_at": "2019-11-07 08:40:15 UTC",
      "managed": true,
      "identifier": null,
      "id": 128,
      "name": "host804",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host804",
      "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
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host644.example358.com/power
{
  "power_action": "status",
  "host": {}
}
200
{
  "power": "on"
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/43/power
200
{
  "id": 43,
  "state": "on",
  "title": "On"
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host646.example359.com/boot
{
  "device": "bios",
  "host": {}
}
200
{
  "boot": "{\"action\":\"bios\",\"result\":true}"
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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
必填

引导设备,有效设备为磁盘、光盘、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"
  }
}
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: upload_facts",
    "missing_permissions": [
      "upload_facts"
    ]
  }
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host381/rebuild_config
{
  "host": {}
}
422
{
  "message": "Configuration rebuild failed for: TFTP, DNS, and DHCP."
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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/host784.example380.com/template/provitamin
404
{
  "message": "No template with kind provitamin for host784.example380.com"
}

参数

参数名字 描述
location_id
选填

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
选填

Set the current organization context for the request

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
必填

模板类型,可用值:PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init

Validations:

  • Must be a String