Param name | Description |
---|---|
thin optional |
Only list ID and name of hosts Validations:
|
hostgroup_id optional |
ID of host group Validations:
|
location_id optional |
ID of location Validations:
|
organization_id optional |
ID of organization Validations:
|
environment_id optional |
ID of environment Validations:
|
include optional |
Array of extra information types to include Validations:
|
search optional |
filter results Validations:
|
order optional |
sort results Validations:
|
page optional |
paginate results Validations:
|
per_page optional |
number of entries per request Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
show_hidden_parameters optional |
Display hidden parameter values Validations:
|
Param name | Description |
---|---|
host required |
Validations:
|
host[name] required |
Validations:
|
host[location_id] required |
required if locations are enabled Validations:
|
host[organization_id] required |
required if organizations are enabled Validations:
|
host[environment_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] optional , nil allowed |
not required if using a subnet with DHCP proxy Validations:
|
host[mac] optional , nil allowed |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
host[architecture_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] optional , nil allowed |
Validations:
|
host[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
IDs of associated config groups Validations:
|
host[operatingsystem_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
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:
|
host[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] optional , nil allowed |
required if host is managed and custom partition has not been defined Validations:
|
host[subnet_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] optional , nil allowed |
nil means host is bare metal Validations:
|
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:
|
host[model_id] optional , nil allowed |
Validations:
|
host[hostgroup_id] optional , nil allowed |
Validations:
|
host[owner_id] optional , nil allowed |
Validations:
|
host[owner_type] optional , nil allowed |
Host's owner type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] required |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] required |
Parameter value Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Include this host within Foreman reporting Validations:
|
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:
|
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:
|
host[progress_report_id] optional , nil allowed |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Additional information about this host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Host's network interfaces. Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface's DNS name Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] optional , nil allowed |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias or VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
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:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
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:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Additional compute resource specific attributes. Validations:
|
host[content_facet_attributes] optional , nil allowed |
Parameters for host's content_facet facet Validations:
|
host[content_facet_attributes][content_view_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][lifecycle_environment_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][content_source_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][kickstart_repository_id] optional , nil allowed |
Repository Id associated with the kickstart repo used for provisioning Validations:
|
host[subscription_facet_attributes] optional , nil allowed |
Parameters for host's subscription_facet facet Validations:
|
host[subscription_facet_attributes][release_version] optional , nil allowed |
Release version for this Host to use (7Server, 7.1, etc) Validations:
|
host[subscription_facet_attributes][autoheal] optional , nil allowed |
Sets whether the Host will autoheal subscriptions upon checkin Validations:
|
host[subscription_facet_attributes][service_level] optional , nil allowed |
Service level to be used for autoheal. Validations:
|
host[subscription_facet_attributes][hypervisor_guest_uuids] optional , nil allowed |
List of hypervisor guest uuids Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
host required |
Validations:
|
host[name] optional |
Validations:
|
host[location_id] optional |
required if locations are enabled Validations:
|
host[organization_id] optional |
required if organizations are enabled Validations:
|
host[environment_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] optional , nil allowed |
not required if using a subnet with DHCP proxy Validations:
|
host[mac] optional , nil allowed |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
host[architecture_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] optional , nil allowed |
Validations:
|
host[puppet_proxy_id] optional , nil allowed |
Puppet proxy ID Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
Puppet CA proxy ID Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
IDs of associated config groups Validations:
|
host[operatingsystem_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
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:
|
host[pxe_loader] optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] optional , nil allowed |
required if host is managed and custom partition has not been defined Validations:
|
host[subnet_id] optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] optional , nil allowed |
nil means host is bare metal Validations:
|
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:
|
host[model_id] optional , nil allowed |
Validations:
|
host[hostgroup_id] optional , nil allowed |
Validations:
|
host[owner_id] optional , nil allowed |
Validations:
|
host[owner_type] optional , nil allowed |
Host's owner type Validations:
|
host[image_id] optional , nil allowed |
Validations:
|
host[host_parameters_attributes] optional , nil allowed |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] optional |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] optional |
Parameter value Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Include this host within Foreman reporting Validations:
|
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:
|
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:
|
host[progress_report_id] optional , nil allowed |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil allowed |
Additional information about this host Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Host's network interfaces. Validations:
|
host[interfaces_attributes][mac] optional , nil allowed |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] optional , nil allowed |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Interface's DNS name Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] optional , nil allowed |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil allowed |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Alias or VLAN device Validations:
|
host[interfaces_attributes][tag] optional , nil allowed |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
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:
|
host[interfaces_attributes][mode] optional , nil allowed |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
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:
|
host[interfaces_attributes][bond_options] optional , nil allowed |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil allowed |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] optional , nil allowed |
Additional compute resource specific attributes. Validations:
|
host[content_facet_attributes] optional , nil allowed |
Parameters for host's content_facet facet Validations:
|
host[content_facet_attributes][content_view_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][lifecycle_environment_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][content_source_id] optional , nil allowed |
Validations:
|
host[content_facet_attributes][kickstart_repository_id] optional , nil allowed |
Repository Id associated with the kickstart repo used for provisioning Validations:
|
host[subscription_facet_attributes] optional , nil allowed |
Parameters for host's subscription_facet facet Validations:
|
host[subscription_facet_attributes][release_version] optional , nil allowed |
Release version for this Host to use (7Server, 7.1, etc) Validations:
|
host[subscription_facet_attributes][autoheal] optional , nil allowed |
Sets whether the Host will autoheal subscriptions upon checkin Validations:
|
host[subscription_facet_attributes][service_level] optional , nil allowed |
Service level to be used for autoheal. Validations:
|
host[subscription_facet_attributes][hypervisor_guest_uuids] optional , nil allowed |
List of hypervisor guest uuids Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
Return value may either be one of the following:
Alerts disabled
No reports
Error
Out of sync
Active
Pending
No changes
Param name | Description |
---|---|
id required |
Validations:
|
Returns string representing a host status of a given type
Param name | Description |
---|---|
id required |
Validations:
|
type required |
status type, can be one of
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Param name | Description |
---|---|
id required |
Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
power_action required |
power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
device required |
boot device, valid devices are disk, cdrom, pxe, bios Validations:
|
Param name | Description |
---|---|
name required |
hostname of the host Validations:
|
facts required |
hash containing the facts for the host Validations:
|
certname optional |
optional: certname of the host Validations:
|
type optional |
optional: the STI type of host to create Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
only optional |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP Validations:
|
Param name | Description |
---|---|
id required |
Validations:
|
kind required |
Template kinds, available values: Validations:
|
Param name | Description |
---|---|
host_id required |
The id of the host to alter Validations:
|
host_collection_ids required |
List of host collection ids to update Validations:
|