GET /api/hosts
List all hosts.

Params

Param Name Description
search
Optional

Filter results


Value: Must be String
order
Optional

Sort results


Value: Must be String
page
Optional

編頁結果


Value: Must be String
per_page
Optional

每個請求的項目數量


Value: Must be String

GET /api/hosts/:id
Show a host.

Params

Param Name Description
id
Required

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

POST /api/hosts
Create a host.

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional

required if host is managed and value is not inherited from host group


Value: Must be String
host[ip]
Optional

若是使用一個含有 DHCP 協定的子網路則不需要


Value: Must be String
host[mac]
Optional

required for managed host that is bare metal, not required if it's a virtual machine


Value: Must be String
host[architecture_id]
Optional

required if host is managed and value is not inherited from host group


Value: Must be a number.
host[domain_id]
Optional

required if host is managed and value is not inherited from host group


Value: Must be a number.
host[realm_id]
Optional

Value: Must be a number.
host[puppet_proxy_id]
Optional

Value: Must be a number.
host[puppet_class_ids]
Optional

Value: Must be an array of any type
host[operatingsystem_id]
Optional

required if host is managed and value is not inherited from host group


Value: Must be String
host[medium_id]
Optional

required if not imaged based provisioning and host is managed and value is not inherited from host group


Value: Must be String
host[ptable_id]
Optional

required if host is managed and custom partition has not been defined


Value: Must be a number.
host[subnet_id]
Optional

required if host is managed and value is not inherited from host group


Value: Must be a number.
host[compute_resource_id]
Optional

nil means host is bare metal


Value: Must be a number.
host[root_pass]
Optional

required if host is managed and value is not inherited from host group or default password in settings


Value: Must be String
host[model_id]
Optional

Value: Must be a number.
host[hostgroup_id]
Optional

Value: Must be a number.
host[owner_id]
Optional

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional

Value: Must be a number.
host[image_id]
Optional

Value: Must be a number.
host[host_parameters_attributes]
Optional

Value: Must be an array of any type
host[build]
Optional

Value: Must be 'true' or 'false'
host[enabled]
Optional

Value: Must be 'true' or 'false'
host[provision_method]
Optional

Value: Must be String
host[managed]
Optional

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional

用來追蹤協調流程任務狀態的 UUID,GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
Optional

有關於這部主機的額外資訊


Value: Must be String
host[capabilities]
Optional

Value: Must be String
host[compute_profile_id]
Optional

Value: Must be a number.
host[compute_attributes]
Optional

Value: Must be a Hash

PUT /api/hosts/:id
Update a host.

Params

Param Name Description
id
Required

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

Value: Must be a Hash
host[name]
Optional

Value: Must be String
host[environment_id]
Optional

Value: Must be String
host[ip]
Optional

not required if using a subnet with dhcp proxy


Value: Must be String
host[mac]
Optional

not required if its a virtual machine


Value: Must be String
host[architecture_id]
Optional

Value: Must be a number.
host[domain_id]
Optional

Value: Must be a number.
host[puppet_proxy_id]
Optional

Value: Must be a number.
host[operatingsystem_id]
Optional

Value: Must be String
host[puppet_class_ids]
Optional

Value: Must be an array of any type
host[medium_id]
Optional

Value: Must be a number.
host[ptable_id]
Optional

Value: Must be a number.
host[subnet_id]
Optional

Value: Must be a number.
host[compute_resource_id]
Optional

Value: Must be a number.
host[sp_subnet_id]
Optional

Value: Must be a number.
host[model_id]
Optional

Value: Must be a number.
host[hostgroup_id]
Optional

Value: Must be a number.
host[owner_id]
Optional

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional

Value: Must be a number.
host[image_id]
Optional

Value: Must be a number.
host[host_parameters_attributes]
Optional

Value: Must be an array of any type
host[build]
Optional

Value: Must be 'true' or 'false'
host[enabled]
Optional

Value: Must be 'true' or 'false'
host[provision_method]
Optional

Value: Must be String
host[managed]
Optional

Value: Must be 'true' or 'false'
host[progress_report_id]
Optional

用來追蹤協調流程任務狀態的 UUID,GET /api/orchestration/:UUID/tasks


Value: Must be String
host[capabilities]
Optional

Value: Must be String
host[compute_attributes]
Optional

Value: Must be a Hash

DELETE /api/hosts/:id
Delete an host.

Params

Param Name Description
id
Required

Value: 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/status
Get status of host

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Params

Param Name Description
id
Required

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