Params

Param name Description
host
required

Validations:

  • Hash

host[name]
required

Validations:

  • String

host[location_id]
required

required if locations are enabled

Validations:

  • number.

host[organization_id]
required

required if organizations are enabled

Validations:

  • number.

host[environment_id]
optional , nil allowed

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

Validations:

  • String

host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy

Validations:

  • String

host[mac]
optional , nil allowed

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

Validations:

  • String

host[architecture_id]
optional , nil allowed

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

Validations:

  • number.

host[domain_id]
optional , nil allowed

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

Validations:

  • number.

host[realm_id]
optional , nil allowed

Validations:

  • number.

host[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • number.

host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • number.

host[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • 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

Validations:

  • 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

Validations:

  • String

host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub UEFI SecureBoot, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
optional , nil allowed

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

Validations:

  • number.

host[subnet_id]
optional , nil allowed

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

Validations:

  • number.

host[compute_resource_id]
optional , nil allowed

nil means host is bare metal

Validations:

  • 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

Validations:

  • String

host[model_id]
optional , nil allowed

Validations:

  • number.

host[hostgroup_id]
optional , nil allowed

Validations:

  • number.

host[owner_id]
optional , nil allowed

Validations:

  • number.

host[owner_type]
optional , nil allowed

Host’s owner type

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil allowed

Validations:

  • number.

host[host_parameters_attributes]
optional , nil allowed

Host’s parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
required

Name of the parameter

Validations:

  • String

host[host_parameters_attributes][value]
required

Parameter value

Validations:

  • String

host[build]
optional , nil allowed

Validations:

  • boolean

host[enabled]
optional , nil allowed

Validations:

  • boolean

host[provision_method]
optional , nil allowed

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

Validations:

  • 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

Validations:

  • boolean

host[progress_report_id]
optional , nil allowed

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

Validations:

  • String

host[comment]
optional , nil allowed

Additional information about this host

Validations:

  • String

host[capabilities]
optional , nil allowed

Validations:

  • String

host[compute_profile_id]
optional , nil allowed

Validations:

  • number.

host[interfaces_attributes]
optional , nil allowed

Host’s network interfaces.

Validations:

  • 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.

Validations:

  • String

host[interfaces_attributes][ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • String

host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • String

host[interfaces_attributes][type]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][name]
optional , nil allowed

Interface’s DNS name

Validations:

  • String

host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • number.

host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • number.

host[interfaces_attributes][domain_id]
optional , nil allowed

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

Validations:

  • number.

host[interfaces_attributes][identifier]
optional , nil allowed

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

Validations:

  • 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?

Validations:

  • boolean

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.

Validations:

  • boolean

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.

Validations:

  • boolean

host[interfaces_attributes][username]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String

host[interfaces_attributes][password]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String

host[interfaces_attributes][provider]
optional , nil allowed

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil allowed

Alias or VLAN device

Validations:

  • boolean

host[interfaces_attributes][tag]
optional , nil allowed

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

Validations:

  • 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.

Validations:

  • String

host[interfaces_attributes][mode]
optional , nil allowed

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

Validations:

  • 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.

Validations:

  • 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.

Validations:

  • String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Hash

host[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes.

Validations:

  • Hash

host[content_facet_attributes]
optional , nil allowed

Parameters for host’s content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
optional , nil allowed

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
optional , nil allowed

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
optional , nil allowed

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
optional , nil allowed

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
optional , nil allowed

Parameters for host’s subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
optional , nil allowed

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
optional , nil allowed

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • boolean

host[subscription_facet_attributes][service_level]
optional , nil allowed

Service level to be used for autoheal.

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil allowed

List of hypervisor guest uuids

Validations:

  • Must be an array of any type