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

not required if using a subnet with DHCP proxy


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

Host's parameters (array or indexed hash)


Value:

Must be an Array of nested elements

host[host_parameters_attributes][name]
required

Name of the parameter


Value:

Must be String

host[host_parameters_attributes][value]
required

Parameter value


Value:

Must be String

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 to track orchestration tasks status, GET /api/orchestration/:UUID/tasks


Value:

Must be String

host[comment]
optional

Additional information about this host


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