Param name | Description |
---|---|
name required |
Validations:
|
location_id required |
Validations:
|
organization_id required |
Validations:
|
ip optional |
IPv4 address, not required if using a subnet with DHCP proxy Validations:
|
ip6 optional |
IPv6 address, not required if using a subnet with DHCP proxy Validations:
|
mac optional |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
domain_id optional |
required if host is managed and value is not inherited from host group Validations:
|
operatingsystem_id optional |
required if host is managed and value is not inherited from host group Validations:
|
subnet_id optional |
required if host is managed and value is not inherited from host group Validations:
|
model_id optional |
Validations:
|
hostgroup_id optional |
Validations:
|
host_parameters_attributes optional |
Host's parameters (array or indexed hash) Validations:
|
host_parameters_attributes[name] required |
Name of the parameter Validations:
|
host_parameters_attributes[value] required |
Parameter value Validations:
|
host_parameters_attributes[parameter_type] optional |
Type of value Validations:
|
host_parameters_attributes[hidden_value] optional |
Validations:
|
build optional |
Validations:
|
enabled optional |
Include this host within Foreman reporting Validations:
|
managed optional |
True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not Validations:
|
comment optional |
Additional information about this host Validations:
|
interfaces_attributes optional |
Host's network interfaces. Validations:
|
interfaces_attributes[mac] optional |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
interfaces_attributes[ip] optional |
IPv4 address of interface Validations:
|
interfaces_attributes[ip6] optional |
IPv6 address of interface Validations:
|
interfaces_attributes[type] optional |
Interface type, e.g. bmc. Default is interface Validations:
|
interfaces_attributes[name] optional |
Interface's DNS name Validations:
|
interfaces_attributes[subnet_id] optional |
Foreman subnet ID of IPv4 interface Validations:
|
interfaces_attributes[subnet6_id] optional |
Foreman subnet ID of IPv6 interface Validations:
|
interfaces_attributes[domain_id] optional |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
interfaces_attributes[identifier] optional |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
interfaces_attributes[managed] optional |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
interfaces_attributes[primary] optional |
Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface. Validations:
|
interfaces_attributes[provision] optional |
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:
|
interfaces_attributes[username] optional |
Only for BMC interfaces. Validations:
|
interfaces_attributes[password] optional |
Only for BMC interfaces. Validations:
|
interfaces_attributes[provider] optional |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
interfaces_attributes[virtual] optional |
Alias or VLAN device Validations:
|
interfaces_attributes[tag] optional |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
interfaces_attributes[mtu] optional |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
interfaces_attributes[attached_to] optional |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
interfaces_attributes[mode] optional |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
interfaces_attributes[attached_devices] optional |
Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces. Validations:
|
interfaces_attributes[bond_options] optional |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
interfaces_attributes[compute_attributes] optional |
Additional compute resource specific attributes for the interface. Validations:
|
content_facet_attributes optional |
Parameters for host's content_facet facet Validations:
|
content_facet_attributes[content_view_id] optional |
Validations:
|
content_facet_attributes[lifecycle_environment_id] optional |
Validations:
|
content_facet_attributes[content_source_id] optional |
Validations:
|
content_facet_attributes[kickstart_repository_id] optional |
Repository Id associated with the kickstart repo used for provisioning Validations:
|
subscription_facet_attributes optional |
Parameters for host's subscription_facet facet Validations:
|
subscription_facet_attributes[release_version] optional |
Release version for this Host to use (7Server, 7.1, etc) Validations:
|
subscription_facet_attributes[autoheal] optional |
Sets whether the Host will autoheal subscriptions upon checkin Validations:
|
subscription_facet_attributes[purpose_usage] optional |
Sets the system purpose usage Validations:
|
subscription_facet_attributes[purpose_role] optional |
Sets the system purpose usage Validations:
|
subscription_facet_attributes[purpose_addons] optional |
Sets the system add-ons Validations:
|
subscription_facet_attributes[service_level] optional |
Service level to be used for autoheal Validations:
|
subscription_facet_attributes[hypervisor_guest_uuids] optional |
List of hypervisor guest uuids Validations:
|
subscription_facet_attributes[installed_products_attributes] optional |
List of products installed on the host Validations:
|
subscription_facet_attributes[installed_products_attributes][product_id] optional |
Product id as listed from a host's installed products, this is not the same product id as the products api returns Validations:
|
subscription_facet_attributes[installed_products_attributes][product_name] optional |
Product name as listed from a host's installed products Validations:
|
subscription_facet_attributes[installed_products_attributes][arch] optional |
Product architecture Validations:
|
subscription_facet_attributes[installed_products_attributes][version] optional |
Product version Validations:
|