参数名字 | 描述 |
---|---|
thin 选填 |
只列出主机的 ID 和名称 Validations:
|
hostgroup_id 选填 |
主机组 ID Validations:
|
location_id 选填 |
位置 ID Validations:
|
organization_id 选填 |
机构 ID Validations:
|
environment_id 选填 |
环境 ID Validations:
|
include 选填 |
要包含的额外信息类型阵列 Validations:
|
search 选填 |
过滤结果 Validations:
|
order 选填 |
排序项和顺序,例如 ‘id DESC’ Validations:
|
page 选填 |
页号,从 1 开始 Validations:
|
per_page 选填 |
每页中显示的返回结果数 Validations:
|
字段名 | 类型 | 可能的值 |
---|---|---|
architecture | ||
boot_time | ||
build | true, false | |
class | string | |
comment | ||
compute_resource | ||
compute_resource_id | ||
config_group | string | |
created_at | ||
domain | ||
domain_id | ||
environment | ||
facts | string | |
global_status | ok, warning, error | |
has_ip | ||
has_mac | ||
hostgroup | ||
hostgroup_fullname | ||
hostgroup_id | ||
hostgroup_name | ||
hostgroup_title | ||
image | ||
installed_at | ||
ip | ||
last_report | ||
location | ||
location_id | ||
mac | ||
managed | true, false | |
model | ||
name | ||
organization | ||
organization_id | ||
origin | ||
os | ||
os_description | ||
os_id | ||
os_major | string | |
os_minor | string | |
os_title | ||
owner | string | |
owner_id | ||
owner_type | ||
params | string | |
params_name | ||
parent_hostgroup | string | |
puppet_ca | ||
puppet_proxy_id | ||
puppetmaster | ||
realm | ||
realm_id | ||
smart_proxy | string | |
status.applied | ||
status.enabled | true, false | |
status.failed | ||
status.failed_restarts | ||
status.interesting | true, false | |
status.pending | ||
status.restarted | ||
status.skipped | ||
subnet | ||
subnet.name | ||
subnet6 | ||
subnet6.name | ||
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | ||
usergroup.name | ||
uuid |
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
show_hidden_parameters 选填 |
显示隐藏的参数值 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
host 必填 |
Validations:
|
host[name] 必填 |
Validations:
|
host[location_id] 必填 |
Validations:
|
host[organization_id] 必填 |
Validations:
|
host[environment_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[ip] 选填 , 允许空值 |
如果使用附带 DHCP 代理服务器的子网则不需要 Validations:
|
host[mac] 选填 , 允许空值 |
如果管理的主机为裸机则需要填写,如果为虚拟机,则不需要。 Validations:
|
host[architecture_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[domain_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[realm_id] 选填 , 允许空值 |
Validations:
|
host[puppet_proxy_id] 选填 , 允许空值 |
Puppet 代理服务器 ID Validations:
|
host[puppet_ca_proxy_id] 选填 , 允许空值 |
Puppet CA 代理服务器 ID Validations:
|
host[puppetclass_ids] 选填 , 允许空值 |
Validations:
|
host[config_group_ids] 选填 , 允许空值 |
关联配置组的 ID Validations:
|
host[operatingsystem_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[medium_id] 选填 , 允许空值 |
如果不是基于置备的映像,且用于管理主机,同时数值不是来自主机组,则需要填写。 Validations:
|
host[pxe_loader] 选填 , 允许空值 |
DHCP 文件名选项(默认为 Grub2/PXELinux) Validations:
|
host[ptable_id] 选填 , 允许空值 |
如果已管理主机,且未定义自定义分区,则需填写。 Validations:
|
host[subnet_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[compute_resource_id] 选填 , 允许空值 |
nil 说明主机是裸机 Validations:
|
host[root_pass] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组或设置中的默认密码继承,则需填写。 Validations:
|
host[model_id] 选填 , 允许空值 |
Validations:
|
host[hostgroup_id] 选填 , 允许空值 |
Validations:
|
host[owner_id] 选填 , 允许空值 |
Validations:
|
host[owner_type] 选填 , 允许空值 |
主机拥有者类型 Validations:
|
host[image_id] 选填 , 允许空值 |
Validations:
|
host[host_parameters_attributes] 选填 , 允许空值 |
主机参数(阵列或索引哈希) Validations:
|
host[host_parameters_attributes][name] 必填 |
参数名称 Validations:
|
host[host_parameters_attributes][value] 必填 |
参数值 Validations:
|
host[host_parameters_attributes][parameter_type] 选填 , 允许空值 |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] 选填 , 允许空值 |
Validations:
|
host[build] 选填 , 允许空值 |
Validations:
|
host[enabled] 选填 , 允许空值 |
将这个主机包含在 Foreman 报告中 Validations:
|
host[provision_method] 选填 , 允许空值 |
此方法用于置备主机。 Validations:
|
host[managed] 选填 , 允许空值 |
用来表示主机被管理或没有被管理的 True/False 标签。注:这个值还决定是否需要一些参数。 Validations:
|
host[progress_report_id] 选填 , 允许空值 |
用来跟踪业务流程任务状态的 UUID,GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] 选填 , 允许空值 |
有关主机的附加信息 Validations:
|
host[capabilities] 选填 , 允许空值 |
Validations:
|
host[compute_profile_id] 选填 , 允许空值 |
Validations:
|
host[interfaces_attributes] 选填 , 允许空值 |
主机的网络接口。 Validations:
|
host[interfaces_attributes][mac] 选填 , 允许空值 |
接口的 MAC 地址。在裸机中管理的接口需要这个地址。 Validations:
|
host[interfaces_attributes][ip] 选填 , 允许空值 |
接口的 IPv4 地址 Validations:
|
host[interfaces_attributes][ip6] 选填 , 允许空值 |
接口的 IPv6 地址 Validations:
|
host[interfaces_attributes][type] 选填 , 允许空值 |
接口类型,例如:bmc。默认为 interface Validations:
|
host[interfaces_attributes][name] 选填 , 允许空值 |
接口 DNS 名称 Validations:
|
host[interfaces_attributes][subnet_id] 选填 , 允许空值 |
IPv4 接口的 Foreman 子网 ID Validations:
|
host[interfaces_attributes][subnet6_id] 选填 , 允许空值 |
IPv6 接口的 Foreman 子网 ID Validations:
|
host[interfaces_attributes][domain_id] 选填 , 允许空值 |
接口的 Foreman 域 ID。所管理主机中的主接口需要这个选项。 Validations:
|
host[interfaces_attributes][identifier] 选填 , 允许空值 |
设备标识符,例如:eth0 或者 eth1.1。 Validations:
|
host[interfaces_attributes][managed] 选填 , 允许空值 |
这个接口应由 DHCP 管理还是由 DNS 智能代理服务器管理?是否应在预配过程中对其进行配置? Validations:
|
host[interfaces_attributes][primary] 选填 , 允许空值 |
是否应该使用这个接口构建该主机的 FQDN?每台管理的主机都需要有一个主接口。 Validations:
|
host[interfaces_attributes][provision] 选填 , 允许空值 |
这个接口是否应该用于 PXELinux 的 TFTP(或基于映象主机的 SSH)?每台管理的主机需要有一个预配接口。 Validations:
|
host[interfaces_attributes][username] 选填 , 允许空值 |
仅用于 BMC 接口 Validations:
|
host[interfaces_attributes][password] 选填 , 允许空值 |
仅用于 BMC 接口 Validations:
|
host[interfaces_attributes][provider] 选填 , 允许空值 |
接口提供者,例如 IPMI。仅用于 BMC 接口。 Validations:
|
host[interfaces_attributes][virtual] 选填 , 允许空值 |
别名或 VLAN 失败 Validations:
|
host[interfaces_attributes][tag] 选填 , 允许空值 |
VLAN 标签,这个属性优先于子网 VLAN ID。仅用于虚拟接口。 Validations:
|
host[interfaces_attributes][mtu] 选填 , 允许空值 |
MTU,这个属性优先于子网 MTU。 Validations:
|
host[interfaces_attributes][attached_to] 选填 , 允许空值 |
这个接口所属接口识别符,例如:eth1。仅用于虚拟接口。 Validations:
|
host[interfaces_attributes][mode] 选填 , 允许空值 |
接口的捆绑模式,例如:balance-rr。仅用于捆绑接口。 Validations:
|
host[interfaces_attributes][attached_devices] 选填 , 允许空值 |
附加接口的识别符,例如:`['eth1', 'eth2']`。对于捆绑的接口,那些是从属接口。仅用于捆绑和桥接接口。 Validations:
|
host[interfaces_attributes][bond_options] 选填 , 允许空值 |
使用空格分隔的选项,例如:miimon=100。仅用于捆绑接口。 Validations:
|
host[interfaces_attributes][compute_attributes] 选填 , 允许空值 |
该接口的附加计算资源具体属性。 Validations:
|
host[compute_attributes] 选填 , 允许空值 |
附加计算资源的具体属性。 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
host 必填 |
Validations:
|
host[name] 选填 |
Validations:
|
host[location_id] 选填 |
Validations:
|
host[organization_id] 选填 |
Validations:
|
host[environment_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[ip] 选填 , 允许空值 |
如果使用附带 DHCP 代理服务器的子网则不需要 Validations:
|
host[mac] 选填 , 允许空值 |
如果管理的主机为裸机则需要填写,如果为虚拟机,则不需要。 Validations:
|
host[architecture_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[domain_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[realm_id] 选填 , 允许空值 |
Validations:
|
host[puppet_proxy_id] 选填 , 允许空值 |
Puppet 代理服务器 ID Validations:
|
host[puppet_ca_proxy_id] 选填 , 允许空值 |
Puppet CA 代理服务器 ID Validations:
|
host[puppetclass_ids] 选填 , 允许空值 |
Validations:
|
host[config_group_ids] 选填 , 允许空值 |
关联配置组的 ID Validations:
|
host[operatingsystem_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[medium_id] 选填 , 允许空值 |
如果不是基于置备的映像,且用于管理主机,同时数值不是来自主机组,则需要填写。 Validations:
|
host[pxe_loader] 选填 , 允许空值 |
DHCP 文件名选项(默认为 Grub2/PXELinux) Validations:
|
host[ptable_id] 选填 , 允许空值 |
如果已管理主机,且未定义自定义分区,则需填写。 Validations:
|
host[subnet_id] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组中继承,则需填写。 Validations:
|
host[compute_resource_id] 选填 , 允许空值 |
nil 说明主机是裸机 Validations:
|
host[root_pass] 选填 , 允许空值 |
如果已管理主机,且数值不是从主机组或设置中的默认密码继承,则需填写。 Validations:
|
host[model_id] 选填 , 允许空值 |
Validations:
|
host[hostgroup_id] 选填 , 允许空值 |
Validations:
|
host[owner_id] 选填 , 允许空值 |
Validations:
|
host[owner_type] 选填 , 允许空值 |
主机拥有者类型 Validations:
|
host[image_id] 选填 , 允许空值 |
Validations:
|
host[host_parameters_attributes] 选填 , 允许空值 |
主机参数(阵列或索引哈希) Validations:
|
host[host_parameters_attributes][name] 选填 |
参数名称 Validations:
|
host[host_parameters_attributes][value] 选填 |
参数值 Validations:
|
host[host_parameters_attributes][parameter_type] 选填 , 允许空值 |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] 选填 , 允许空值 |
Validations:
|
host[build] 选填 , 允许空值 |
Validations:
|
host[enabled] 选填 , 允许空值 |
将这个主机包含在 Foreman 报告中 Validations:
|
host[provision_method] 选填 , 允许空值 |
此方法用于置备主机。 Validations:
|
host[managed] 选填 , 允许空值 |
用来表示主机被管理或没有被管理的 True/False 标签。注:这个值还决定是否需要一些参数。 Validations:
|
host[progress_report_id] 选填 , 允许空值 |
用来跟踪业务流程任务状态的 UUID,GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] 选填 , 允许空值 |
有关主机的附加信息 Validations:
|
host[capabilities] 选填 , 允许空值 |
Validations:
|
host[compute_profile_id] 选填 , 允许空值 |
Validations:
|
host[interfaces_attributes] 选填 , 允许空值 |
主机的网络接口。 Validations:
|
host[interfaces_attributes][mac] 选填 , 允许空值 |
接口的 MAC 地址。在裸机中管理的接口需要这个地址。 Validations:
|
host[interfaces_attributes][ip] 选填 , 允许空值 |
接口的 IPv4 地址 Validations:
|
host[interfaces_attributes][ip6] 选填 , 允许空值 |
接口的 IPv6 地址 Validations:
|
host[interfaces_attributes][type] 选填 , 允许空值 |
接口类型,例如:bmc。默认为 interface Validations:
|
host[interfaces_attributes][name] 选填 , 允许空值 |
接口 DNS 名称 Validations:
|
host[interfaces_attributes][subnet_id] 选填 , 允许空值 |
IPv4 接口的 Foreman 子网 ID Validations:
|
host[interfaces_attributes][subnet6_id] 选填 , 允许空值 |
IPv6 接口的 Foreman 子网 ID Validations:
|
host[interfaces_attributes][domain_id] 选填 , 允许空值 |
接口的 Foreman 域 ID。所管理主机中的主接口需要这个选项。 Validations:
|
host[interfaces_attributes][identifier] 选填 , 允许空值 |
设备标识符,例如:eth0 或者 eth1.1。 Validations:
|
host[interfaces_attributes][managed] 选填 , 允许空值 |
这个接口应由 DHCP 管理还是由 DNS 智能代理服务器管理?是否应在预配过程中对其进行配置? Validations:
|
host[interfaces_attributes][primary] 选填 , 允许空值 |
是否应该使用这个接口构建该主机的 FQDN?每台管理的主机都需要有一个主接口。 Validations:
|
host[interfaces_attributes][provision] 选填 , 允许空值 |
这个接口是否应该用于 PXELinux 的 TFTP(或基于映象主机的 SSH)?每台管理的主机需要有一个预配接口。 Validations:
|
host[interfaces_attributes][username] 选填 , 允许空值 |
仅用于 BMC 接口 Validations:
|
host[interfaces_attributes][password] 选填 , 允许空值 |
仅用于 BMC 接口 Validations:
|
host[interfaces_attributes][provider] 选填 , 允许空值 |
接口提供者,例如 IPMI。仅用于 BMC 接口。 Validations:
|
host[interfaces_attributes][virtual] 选填 , 允许空值 |
别名或 VLAN 失败 Validations:
|
host[interfaces_attributes][tag] 选填 , 允许空值 |
VLAN 标签,这个属性优先于子网 VLAN ID。仅用于虚拟接口。 Validations:
|
host[interfaces_attributes][mtu] 选填 , 允许空值 |
MTU,这个属性优先于子网 MTU。 Validations:
|
host[interfaces_attributes][attached_to] 选填 , 允许空值 |
这个接口所属接口识别符,例如:eth1。仅用于虚拟接口。 Validations:
|
host[interfaces_attributes][mode] 选填 , 允许空值 |
接口的捆绑模式,例如:balance-rr。仅用于捆绑接口。 Validations:
|
host[interfaces_attributes][attached_devices] 选填 , 允许空值 |
附加接口的识别符,例如:`['eth1', 'eth2']`。对于捆绑的接口,那些是从属接口。仅用于捆绑和桥接接口。 Validations:
|
host[interfaces_attributes][bond_options] 选填 , 允许空值 |
使用空格分隔的选项,例如:miimon=100。仅用于捆绑接口。 Validations:
|
host[interfaces_attributes][compute_attributes] 选填 , 允许空值 |
该接口的附加计算资源具体属性。 Validations:
|
host[compute_attributes] 选填 , 允许空值 |
附加计算资源的具体属性。 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
Returns string representing a host status of a given type
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
type 必填 |
状态类型,可为以下之一
Validations:
|
Clears a host sub-status of a given type
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
type 必填 |
status type Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
power_action 必填 |
电源操作,有效操作为 (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)。 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
device 必填 |
引导设备,有效设备为磁盘、光盘、pxe、bios。 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
name 必填 |
主机的主机名 Validations:
|
facts 必填 |
包含主机详情的哈希 Validations:
|
certname 选填 |
自选:主机的证书名 Validations:
|
type 选填 |
自选:要创建主机的 STI 类型 Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
only 选填 |
限制重建步骤,有效步骤是 DHCP, DNS, TFTP Validations:
|
参数名字 | 描述 |
---|---|
location_id 选填 |
Set the current location context for the request Validations:
|
organization_id 选填 |
Set the current organization context for the request Validations:
|
id 必填 |
Validations:
|
kind 必填 |
模板类型,可用值: Validations:
|