Params

Param name Description
thin
optional

Only list ID and name of hosts

Validations:

  • Must be one of: true, false, 1, 0.

hostgroup_id
optional

ID of host group

Validations:

  • String

location_id
optional

ID of location

Validations:

  • String

organization_id
optional

ID of organization

Validations:

  • String

include
optional

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.

search
optional

filter results

Validations:

  • String

order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> DESC'

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
activation_key string
activation_key_id string
addon string
addons_status mismatched, matched, not_specified
applicable_debs string
applicable_errata string
applicable_errata_issued date
applicable_rpms string
architecture string
autoheal boolean
available_module_stream_name string
available_module_stream_stream string
boot_time
build true, false
build_status built, pending, token_expired, build_failed
comment text
compute_resource string
compute_resource_id integer
content_source string
content_view string
content_view_id integer
created_at datetime
domain string
domain_id integer
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
id integer
image string
infrastructure_facet.foreman
infrastructure_facet.smart_proxy_id
installable_errata string
installed_at datetime
installed_deb string
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
params_name string
parent_hostgroup string
pools_expiring_in_days string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
reported.boot_time
reported.cores
reported.disks_total
reported.ram
reported.sockets
reported.virtual true, false
role text
role_status mismatched, matched, not_specified
service_level string
sla_status mismatched, matched, not_specified
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, disabled, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_debs string
upgradable_rpms string
usage text
usage_status mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string