Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ip]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

not required if using a subnet with DHCP proxy


Value: Must be String
host[mac]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

nil means host is bare metal


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Host's owner type


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[build]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[managed]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

本机附加信息


Value: Must be String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Host's network interfaces.


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

MAC address of interface


Value: Must be String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

IP address of interface


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Interface type, e.g: bmc


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Interface's DNS name


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of interface


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Foreman domain ID of interface


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Device identifier, e.g. eth0 or eth1.1


Value: Must be String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?


Value: Must be 'true' or 'false'
host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.


Value: Must be 'true' or 'false'
host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.


Value: Must be 'true' or 'false'
host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Interface provider, e.g. IPMI. Only for BMC interfaces.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Alias or VLAN device


Value: Must be 'true' or 'false'
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


Value: Must be an array of any type
host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Space separated options, e.g. miimon=100. Only for bond interfaces.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: zh-CN.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes.


Value: Must be Hash