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 , nil allowed

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


Value:

Must be String

host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy


Value:

Must be String

host[mac]
optional , nil allowed

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


Value:

Must be String

host[architecture_id]
optional , nil allowed

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


Value:

Must be a number.

host[domain_id]
optional , nil allowed

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


Value:

Must be a number.

host[realm_id]
optional , nil allowed

Value:

Must be a number.

host[puppet_proxy_id]
optional , nil allowed

Value:

Must be a number.

host[puppet_class_ids]
optional , nil allowed

Value:

Must be an array of any type

host[operatingsystem_id]
optional , nil allowed

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


Value:

Must be String

host[medium_id]
optional , nil allowed

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 , nil allowed

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


Value:

Must be a number.

host[subnet_id]
optional , nil allowed

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


Value:

Must be a number.

host[compute_resource_id]
optional , nil allowed

nil means host is bare metal


Value:

Must be a number.

host[root_pass]
optional , nil allowed

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 , nil allowed

Value:

Must be a number.

host[hostgroup_id]
optional , nil allowed

Value:

Must be a number.

host[owner_id]
optional , nil allowed

Value:

Must be a number.

host[owner_type]
optional , nil allowed

Host's owner type


Value:

Must be one of: User, Usergroup.

host[puppet_ca_proxy_id]
optional , nil allowed

Value:

Must be a number.

host[image_id]
optional , nil allowed

Value:

Must be a number.

host[host_parameters_attributes]
optional , nil allowed

Value:

Must be an array of any type

host[build]
optional , nil allowed

Value:

Must be 'true' or 'false'

host[enabled]
optional , nil allowed

Value:

Must be 'true' or 'false'

host[provision_method]
optional , nil allowed

The method used to provision the host. Possible provision_methods may be build (Network Based), image (Image Based)


Value:

Must be String

host[managed]
optional , nil allowed

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 , nil allowed

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


Value:

Must be String

host[comment]
optional , nil allowed

Additional information about this host


Value:

Must be String

host[capabilities]
optional , nil allowed

Value:

Must be String

host[compute_profile_id]
optional , nil allowed

Value:

Must be a number.

host[interfaces_attributes]
optional , nil allowed

Host's network interfaces.


Value:

Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.


Value:

Must be String

host[interfaces_attributes][ip]
optional , nil allowed

IP address of interface


Value:

Must be String

host[interfaces_attributes][type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface


Value:

Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil allowed

Interface's DNS name


Value:

Must be String

host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of interface


Value:

Must be Fixnum

host[interfaces_attributes][domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.


Value:

Must be Fixnum

host[interfaces_attributes][identifier]
optional , nil allowed

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


Value:

Must be String

host[interfaces_attributes][managed]
optional , nil allowed

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 , nil allowed

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 , nil allowed

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 , nil allowed

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][password]
optional , nil allowed

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][provider]
optional , nil allowed

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


Value:

Must be one of: IPMI.

host[interfaces_attributes][virtual]
optional , nil allowed

Alias or VLAN device


Value:

Must be 'true' or 'false'

host[interfaces_attributes][tag]
optional , nil allowed

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 , nil allowed

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 , nil allowed

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 , nil allowed

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil allowed

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


Value:

Must be String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.


Value:

Must be Hash

host[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes.


Value:

Must be Hash