Param name | Description |
---|---|
thin optional |
Only list ID and name of hosts Validations:
|
hostgroup_id optional |
ID de grup d'amfitrions Validations:
|
location_id optional |
ID d'ubicació Validations:
|
organization_id optional |
ID d'organització Validations:
|
environment_id optional |
ID d'entorn Validations:
|
include optional |
Seqüència de tipus extres d'informació a incloure Validations:
|
search optional |
filtra els resultats Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
pagina els resultats Validations:
|
per_page optional |
Nombre d'entrades per petició Validations:
|
Field name | Tipus | Possible values |
---|---|---|
activation_key | string | |
activation_key_id | string | |
applicable_errata | string | |
applicable_rpms | string | |
architecture | string | |
autoheal | boolean | |
build | true, false | |
class | string | |
comment | text | |
compute_resource | string | |
compute_resource_id | integer | |
config_group | string | |
content_source | string | |
content_view | string | |
content_view_id | integer | |
domain | string | |
domain_id | integer | |
environment | string | |
errata_status | security_needed, errata_needed, updated, unknown | |
facts | string | |
global_status | ok, warning, error | |
has_ip | string | |
has_mac | string | |
host_collection | string | |
host_collection_id | integer | |
hostgroup | string | |
hostgroup_fullname | string | |
hostgroup_id | integer | |
hostgroup_name | string | |
hostgroup_title | string | |
hypervisor | boolean | |
hypervisor_host | string | |
image | string | |
installable_errata | string | |
installed_at | datetime | |
installed_package | string | |
installed_package_name | string | |
ip | string | |
last_checkin | datetime | |
last_report | datetime | |
lifecycle_environment | string | |
lifecycle_environment_id | integer | |
location | string | |
location_id | integer | |
mac | string | |
managed | true, false | |
model | string | |
name | string | |
organization | string | |
organization_id | integer | |
origin | string | |
os | string | |
os_description | string | |
os_id | integer | |
os_major | string | |
os_minor | string | |
os_title | string | |
owner | string | |
owner_id | integer | |
owner_type | string | |
params | string | |
parent_hostgroup | string | |
puppet_ca | string | |
puppet_proxy_id | integer | |
puppetmaster | string | |
realm | string | |
realm_id | integer | |
registered_at | datetime | |
registered_through | string | |
release_version | string | |
service_level | string | |
smart_proxy | string | |
status.applied | integer | |
status.enabled | true, false | |
status.failed | integer | |
status.failed_restarts | integer | |
status.interesting | true, false | |
status.pending | integer | |
status.restarted | integer | |
status.skipped | integer | |
subnet | string | |
subnet.name | text | |
subnet6 | string | |
subnet6.name | text | |
subscription_id | string | |
subscription_name | string | |
subscription_status | valid, partial, invalid, unknown, unsubscribed_hypervisor | |
subscription_uuid | string | |
trace_app | string | |
trace_app_type | string | |
trace_helper | string | |
trace_status | reboot_needed, process_restart_needed, updated | |
upgradable_rpms | string | |
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | string | |
usergroup.name | string | |
uuid | string |
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
show_hidden_parameters optional |
Mostra els valors dels paràmetres ocults Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
host required |
Validations:
|
host[name] required |
Validations:
|
host[location_id] required |
es requereix si les ubicacions estan habilitades Validations:
|
host[organization_id] required |
es requereix si les organitzacions estan habilitades 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 |
no es requereix si s'està utilitzant una subxarxa amb servidor intermediari DHCP 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 |
ID de servidor intermediari de Puppet Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
ID de servidor intermediari de l'AC de Puppet Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
Els ID dels grups de configuracions 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 |
es requereix si l'amfitrió està gestionat i no s'ha definit la partició personalitzada 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 |
Tipus de propietari de l'amfitrió 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 |
Nom del paràmetre Validations:
|
host[host_parameters_attributes][value] required |
Valor del paràmetre Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Inclou aquest amfitrió dins de l'enviament d'informes de Foreman Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. 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 |
Informació addicional quant a aquest amfitrió Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Les interfícies de xarxa dels amfitrions. 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 |
Adreça IPv4 de la interfície Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
Adreça IPv6 de la interfície Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Tipus d'interfície, p. ex. bmc. Per defecte és interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Nom DNS de la interfície Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
ID de la subxarxa de Foreman de la interfície IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
ID de la subxarxa de Foreman de la interfície IPv6 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 |
L'identificador de dispositiu, p. ex. eth0 o 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 |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Proveïdor de la interfície, p. ex. IPMI. Únicament per a les interfícies BMC. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Àlies o dispositiu VLAN 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][mtu] optional , nil allowed |
MTU, this attribute has precedence over the subnet MTU. 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:
|
host[subscription_facet_attributes][installed_products_attributes] optional , nil allowed |
List of products installed on the host Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_id] optional , nil allowed |
Product id as listed from a host's installed products, this is not the same product id as the products api returns Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_name] optional , nil allowed |
Product name as listed from a host's installed products Validations:
|
host[subscription_facet_attributes][installed_products_attributes][arch] optional , nil allowed |
Product architecture Validations:
|
host[subscription_facet_attributes][installed_products_attributes][version] optional , nil allowed |
Product version Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
host required |
Validations:
|
host[name] optional |
Validations:
|
host[location_id] optional |
es requereix si les ubicacions estan habilitades Validations:
|
host[organization_id] optional |
es requereix si les organitzacions estan habilitades 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 |
no es requereix si s'està utilitzant una subxarxa amb servidor intermediari DHCP 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 |
ID de servidor intermediari de Puppet Validations:
|
host[puppet_ca_proxy_id] optional , nil allowed |
ID de servidor intermediari de l'AC de Puppet Validations:
|
host[puppetclass_ids] optional , nil allowed |
Validations:
|
host[config_group_ids] optional , nil allowed |
Els ID dels grups de configuracions 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 |
es requereix si l'amfitrió està gestionat i no s'ha definit la partició personalitzada 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 |
Tipus de propietari de l'amfitrió 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 |
Nom del paràmetre Validations:
|
host[host_parameters_attributes][value] optional |
Valor del paràmetre Validations:
|
host[build] optional , nil allowed |
Validations:
|
host[enabled] optional , nil allowed |
Inclou aquest amfitrió dins de l'enviament d'informes de Foreman Validations:
|
host[provision_method] optional , nil allowed |
The method used to provision the host. 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 |
Informació addicional quant a aquest amfitrió Validations:
|
host[capabilities] optional , nil allowed |
Validations:
|
host[compute_profile_id] optional , nil allowed |
Validations:
|
host[interfaces_attributes] optional , nil allowed |
Les interfícies de xarxa dels amfitrions. 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 |
Adreça IPv4 de la interfície Validations:
|
host[interfaces_attributes][ip6] optional , nil allowed |
Adreça IPv6 de la interfície Validations:
|
host[interfaces_attributes][type] optional , nil allowed |
Tipus d'interfície, p. ex. bmc. Per defecte és interface Validations:
|
host[interfaces_attributes][name] optional , nil allowed |
Nom DNS de la interfície Validations:
|
host[interfaces_attributes][subnet_id] optional , nil allowed |
ID de la subxarxa de Foreman de la interfície IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil allowed |
ID de la subxarxa de Foreman de la interfície IPv6 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 |
L'identificador de dispositiu, p. ex. eth0 o 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 |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][password] optional , nil allowed |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][provider] optional , nil allowed |
Proveïdor de la interfície, p. ex. IPMI. Únicament per a les interfícies BMC. Validations:
|
host[interfaces_attributes][virtual] optional , nil allowed |
Àlies o dispositiu VLAN 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][mtu] optional , nil allowed |
MTU, this attribute has precedence over the subnet MTU. 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:
|
host[subscription_facet_attributes][installed_products_attributes] optional , nil allowed |
List of products installed on the host Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_id] optional , nil allowed |
Product id as listed from a host's installed products, this is not the same product id as the products api returns Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_name] optional , nil allowed |
Product name as listed from a host's installed products Validations:
|
host[subscription_facet_attributes][installed_products_attributes][arch] optional , nil allowed |
Product architecture Validations:
|
host[subscription_facet_attributes][installed_products_attributes][version] optional , nil allowed |
Product version Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
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 |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
Returns string representing a host status of a given type
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
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 |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
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 |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
device required |
boot device, valid devices are disk, cdrom, pxe, bios Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
name required |
nom d'amfitrió de l'amfitrió Validations:
|
facts required |
el hash que conté els objectes d'interès per a l'amfitrió Validations:
|
certname optional |
optional: certname of the host Validations:
|
type optional |
optional: the STI type of host to create Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
only optional |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
id required |
Validations:
|
kind required |
Template kinds, available values: Validations:
|
Param name | Description |
---|---|
location_id optional |
Abast per ubicacions Validations:
|
organization_id optional |
Abast per organitzacions Validations:
|
host_id required |
The id of the host to alter Validations:
|
host_collection_ids required |
List of host collection ids to update Validations:
|