參數名字 | 描述 |
---|---|
thin 選填 |
Only list ID and name of hosts Validations:
|
hostgroup_id 選填 |
主機群組的 ID Validations:
|
location_id 選填 |
位置 ID Validations:
|
organization_id 選填 |
組織 ID Validations:
|
environment_id 選填 |
環境的 ID Validations:
|
include 選填 |
Array of extra information types to include Validations:
|
search 選填 |
篩選結果 Validations:
|
order 選填 |
Sort field and order, eg. ‘id DESC’ Validations:
|
page 選填 |
頁數,從 1 開始 Validations:
|
per_page 選填 |
每頁要傳回的結果數量 Validations:
|
Field name | 類型 | Possible values |
---|---|---|
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 選填 |
Display hidden parameter values 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] 選填 , 允許空值 |
IDs of associated config groups Validations:
|
host[operatingsystem_id] 選填 , 允許空值 |
若主機是個受管理的主機,並且值不是由主機群組所繼承的話便需要 Validations:
|
host[medium_id] 選填 , 允許空值 |
若不是基於映像檔的佈建,而主機受管理並且值並非由主機群組所繼承的話便需要 Validations:
|
host[pxe_loader] 選填 , 允許空值 |
DHCP filename option (Grub2/PXELinux by default) 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] 選填 , 允許空值 |
The method used to provision the host. 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 address of interface Validations:
|
host[interfaces_attributes][ip6] 選填 , 允許空值 |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] 選填 , 允許空值 |
介面卡類型,例如 bmc。預設值為 interface Validations:
|
host[interfaces_attributes][name] 選填 , 允許空值 |
介面的 DNS 名稱 Validations:
|
host[interfaces_attributes][subnet_id] 選填 , 允許空值 |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] 選填 , 允許空值 |
Foreman subnet ID of IPv6 interface 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, this attribute has precedence over the subnet 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。僅適用於 bond 介面卡。 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] 選填 , 允許空值 |
IDs of associated config groups Validations:
|
host[operatingsystem_id] 選填 , 允許空值 |
若主機是個受管理的主機,並且值不是由主機群組所繼承的話便需要 Validations:
|
host[medium_id] 選填 , 允許空值 |
若不是基於映像檔的佈建,而主機受管理並且值並非由主機群組所繼承的話便需要 Validations:
|
host[pxe_loader] 選填 , 允許空值 |
DHCP filename option (Grub2/PXELinux by default) 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] 選填 , 允許空值 |
The method used to provision the host. 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 address of interface Validations:
|
host[interfaces_attributes][ip6] 選填 , 允許空值 |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] 選填 , 允許空值 |
介面卡類型,例如 bmc。預設值為 interface Validations:
|
host[interfaces_attributes][name] 選填 , 允許空值 |
介面的 DNS 名稱 Validations:
|
host[interfaces_attributes][subnet_id] 選填 , 允許空值 |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] 選填 , 允許空值 |
Foreman subnet ID of IPv6 interface 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, this attribute has precedence over the subnet 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。僅適用於 bond 介面卡。 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 必填 |
開機裝置,有效裝置為磁碟、cdrom、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 選填 |
Limit rebuild steps, valid steps are 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:
|