schema.md

Schema Types

Table of Contents

• Query
• Objects
  • BooleanValueInfo
  • BooleanValues
  • CollectionMeta
  • Group
  • GroupInfo
  • Groups
  • Host
  • HostGroups
  • HostStats
  • HostSystemProfile
  • HostTags
  • Hosts
  • OperatingSystem
  • StringValueInfo
  • StringValues
  • StructuredTag
  • TagInfo
  • Tags
  • operatingSystemValueInfo
  • operatingSystemValues
• Inputs
  • FilterAnsible
  • FilterBoolean
  • FilterDiskDevices
  • FilterDnfModules
  • FilterGroup
  • FilterInstalledProducts
  • FilterInt
  • FilterMssql
  • FilterNetworkInterfaces
  • FilterOperatingSystem
  • FilterPerReporterStaleness
  • FilterRhsm
  • FilterRpmOstreeDeployments
  • FilterSap
  • FilterString
  • FilterStringWithRegex
  • FilterStringWithWildcard
  • FilterStringWithWildcardWithLowercase
  • FilterSystemPurpose
  • FilterSystemd
  • FilterTag
  • FilterTimestamp
  • HostFilter
  • SapSidFilter
  • TagAggregationFilter
• Enums
  • HOSTS_ORDER_BY
  • HOST_GROUPS_ORDER_BY
  • HOST_TAGS_ORDER_BY
  • ORDER_DIR
  • VALUES_ORDER_BY
• Scalars
  • BigInt
  • Boolean
  • ID
  • Int
  • JSON
  • JSONObject
  • String

Query

Field	Argument	Type	Description
hosts		Hosts!	Fetches a list of hosts based on the given filtering, ordering and pagination criteria.
filter		HostFilter
limit		Int
offset		Int
order_by		HOSTS_ORDER_BY
order_how		ORDER_DIR
hostTags		HostTags	Fetches a list of unique tags and the number of their occurences in the given set of systems. By default the query operates on all known systems that are registered with the given org_id. This can be altered using the hostFilter parameter. The tags themselves can be filtered further using the filter parameter.
hostFilter		HostFilter
filter		TagAggregationFilter
limit		Int
offset		Int
order_by		HOST_TAGS_ORDER_BY
order_how		ORDER_DIR
hostSystemProfile		HostSystemProfile	Fetches a list of unique values for a given system profile field. By default the query operates on all known systems that are registered with the given org_id. This can be altered using hostFilter parameter.
hostFilter		HostFilter
hostGroups		HostGroups
hostFilter		HostFilter
limit		Int
offset		Int
order_by		HOST_GROUPS_ORDER_BY
order_how		ORDER_DIR
hostStats		HostStats!	Fetches the counts of current, stale and stale-warning hosts, optionally filtering by the hostFilter parameter. I haven't yet found a way of making the host filter optional.
hostFilter		HostFilter

Objects

BooleanValueInfo

Represents a single Boolean value. The count field indicates how many systems with the given value were returned by a query

Field	Argument	Type	Description
value		Boolean!
count		Int!

BooleanValues

A list of Boolean values together with count information

Field	Argument	Type	Description
data		[BooleanValueInfo]!
meta		CollectionMeta!

CollectionMeta

Metadata about a collection of entities

Field	Argument	Type	Description
count		Int!	number of returned results
total		Int!	total number of entities matching the query

Group

Field	Argument	Type	Description
id		String
name		String
account		String
org_id		String
created		String
updated		String

GroupInfo

Field	Argument	Type	Description
group		Group!
count		Int!

Groups

Field	Argument	Type	Description
data		[Group]!
meta		CollectionMeta!

Host

Inventory host

Field	Argument	Type	Description
id		ID!
account		String
org_id		String!
display_name		String
created_on		String
modified_on		String
stale_timestamp		String
reporter		String
ansible_host		String
canonical_facts		JSONObject	Canonical facts of a host. The subset of keys can be requested using filter.
filter		[String!]
system_profile_facts		JSONObject	System profile of a host. The subset of keys can be requested using filter.
filter		[String!]
tags		Tags
facts		JSONObject	Facts of a host. The subset of keys can be requested using filter.
filter		[String!]
per_reporter_staleness		JSONObject	The host's per-reporter staleness data in object format.
filter		[String!]
per_reporter_staleness_flat		[JSONObject]	The host's per-reporter staleness, flattened into an array.
filter		[String!]
groups		Groups

HostGroups

Field	Argument	Type	Description
data		[GroupInfo]!
meta		CollectionMeta!

HostStats

Field	Argument	Type	Description
total_hosts		Int!
fresh_hosts		Int!
stale_hosts		Int!
warn_hosts		Int!

HostSystemProfile

Lists unique system profile values.

Field	Argument	Type	Description
sap_system		BooleanValues!	Lists unique values of the sap_system field
limit		Int
offset		Int
order_by		VALUES_ORDER_BY
order_how		ORDER_DIR
sap_sids		StringValues!	Lists unique values of the sap_sids field
limit		Int
offset		Int
filter		SapSidFilter
order_by		VALUES_ORDER_BY
order_how		ORDER_DIR
operating_system		operatingSystemValues!
limit		Int
offset		Int
order_by		VALUES_ORDER_BY
order_how		ORDER_DIR

HostTags

Field	Argument	Type	Description
data		[TagInfo]!
meta		CollectionMeta!

Hosts

Field	Argument	Type	Description
data		[Host]!
meta		CollectionMeta!

OperatingSystem

Field	Argument	Type	Description
name		String!
major		Int
minor		Int

StringValueInfo

Represents a single String value. The count field indicates how many systems with the given value were returned by a query.

Field	Argument	Type	Description
value		String!
count		Int!

StringValues

A list of String values together with count information

Field	Argument	Type	Description
data		[StringValueInfo]!
meta		CollectionMeta!

StructuredTag

Structured representation of a tag

Field	Argument	Type	Description
namespace		String
key		String!
value		String

TagInfo

Field	Argument	Type	Description
tag		StructuredTag!
count		Int!

Tags

Field	Argument	Type	Description
data		[StructuredTag]!
meta		CollectionMeta!

operatingSystemValueInfo

Field	Argument	Type	Description
value		OperatingSystem
count		Int!

operatingSystemValues

Field	Argument	Type	Description
data		[operatingSystemValueInfo]!
meta		CollectionMeta!

Inputs

FilterAnsible

Filter by 'ansible' field of system profile

Field		Type	Description
controller_version		FilterStringWithWildcard	Filter by 'controller_version' field of ansible
hub_version		FilterStringWithWildcard	Filter by 'hub_version' field of ansible
catalog_worker_version		FilterStringWithWildcard	Filter by 'catalog_worker_version' field of ansible
sso_version		FilterStringWithWildcard	Filter by 'sso_version' field of ansible

FilterBoolean

Basic filter for boolean fields.

Field		Type	Description
is		Boolean	Compares the document field with the provided value. If null is provided then documents where the given field does not exist are returned.

FilterDiskDevices

Filter by 'disk_devices' field of system profile

Field		Type	Description
device		FilterString	Filter by 'device' field of disk_devices
label		FilterString	Filter by 'label' field of disk_devices
mount_point		FilterString	Filter by 'mount_point' field of disk_devices
type		FilterString	Filter by 'type' field of disk_devices

FilterDnfModules

Filter by 'dnf_modules' field of system profile

Field		Type	Description
name		FilterString	Filter by 'name' field of dnf_modules
stream		FilterString	Filter by 'stream' field of dnf_modules

FilterGroup

Groups filter on a host

Field		Type	Description
id		FilterString
name		FilterStringWithWildcardWithLowercase
hasSome		FilterBoolean

FilterInstalledProducts

Filter by 'installed_products' field of system profile

Field		Type	Description
name		FilterString	Filter by 'name' field of installed_products
id		FilterString	Filter by 'id' field of installed_products
status		FilterString	Filter by 'status' field of installed_products

FilterInt

Timestamp field filter with support for common operations.

Field		Type	Description
eq		BigInt	Equal to
lt		BigInt	Less than
lte		BigInt	Less than or equal to
gt		BigInt	Greater than
gte		BigInt	Greater than or equal to

FilterMssql

Filter by 'mssql' field of system profile

Field		Type	Description
version		FilterStringWithWildcard	Filter by 'version' field of mssql

FilterNetworkInterfaces

Filter by 'network_interfaces' field of system profile

Field		Type	Description
ipv4_addresses		FilterString	Filter by 'ipv4_addresses' field of network_interfaces
ipv6_addresses		FilterString	Filter by 'ipv6_addresses' field of network_interfaces
mtu		FilterInt	Filter by 'mtu' field of network_interfaces
mac_address		FilterString	Filter by 'mac_address' field of network_interfaces
name		FilterString	Filter by 'name' field of network_interfaces
state		FilterString	Filter by 'state' field of network_interfaces
type		FilterString	Filter by 'type' field of network_interfaces

FilterOperatingSystem

Filter by 'operating_system' field of system profile

Field		Type	Description
major		FilterInt	Filter by 'major' field of operating_system
minor		FilterInt	Filter by 'minor' field of operating_system
name		FilterString	Filter by 'name' field of operating_system

FilterPerReporterStaleness

Per-reporter staleness filter.

Field		Type	Description
AND		[FilterPerReporterStaleness!]	Apply logical conjunction on the given filtering criteria
OR		[FilterPerReporterStaleness!]	Apply logical disjunction on the given filtering criteria
NOT		FilterPerReporterStaleness	Negate the given filtering criteria
reporter		FilterString
stale_timestamp		FilterTimestamp
last_check_in		FilterTimestamp
check_in_succeeded		FilterBoolean
hostFilter		HostFilter

FilterRhsm

Filter by 'rhsm' field of system profile

Field		Type	Description
version		FilterString	Filter by 'version' field of rhsm

FilterRpmOstreeDeployments

Filter by 'rpm_ostree_deployments' field of system profile

Field		Type	Description
id		FilterString	Filter by 'id' field of rpm_ostree_deployments
checksum		FilterString	Filter by 'checksum' field of rpm_ostree_deployments
origin		FilterString	Filter by 'origin' field of rpm_ostree_deployments
osname		FilterString	Filter by 'osname' field of rpm_ostree_deployments
version		FilterString	Filter by 'version' field of rpm_ostree_deployments
booted		FilterBoolean	Filter by 'booted' field of rpm_ostree_deployments
pinned		FilterBoolean	Filter by 'pinned' field of rpm_ostree_deployments

FilterSap

Filter by 'sap' field of system profile

Field		Type	Description
sap_system		FilterBoolean	Filter by 'sap_system' field of sap
sids		FilterString	Filter by 'sids' field of sap
instance_number		FilterString	Filter by 'instance_number' field of sap
version		FilterString	Filter by 'version' field of sap

FilterString

Basic filter for string fields that allows filtering based on exact match.

Field		Type	Description
eq		String	Compares the document field with the provided value. If null is provided then documents where the given field does not exist are returned.

FilterStringWithRegex

String field filter that allows filtering based on exact match or using regular expression.

Field		Type	Description
eq		String	Compares the document field with the provided value. If null is provided then documents where the given field does not exist are returned.
regex		String	Matches the document field against the provided regular expression.

FilterStringWithWildcard

String field filter that allows filtering based on exact match or using wildcards.

Field		Type	Description
eq		String	Compares the document field with the provided value. If null is provided then documents where the given field does not exist are returned.
matches		String	Compares the document field with the provided value. Wildcards may be used in the query (e.g. ki*y). Two types of wildcard operators are supported: ?, which matches any single character *, which can match zero or more characters, including an empty one See Elasticsearch documentation for more details.

FilterStringWithWildcardWithLowercase

String field filter that allows filtering based on exact match or using wildcards. In both cases the case of a letter can be ignored (case-insensitive matching) using the _lc suffixed operators.

Field		Type	Description
eq		String	Compares the document field with the provided value. If null is provided then documents where the given field does not exist are returned.
eq_lc		String	This operator is like FilterStringWithWildcard.eq except that it performs case-insensitive matching. Furthermore, unlike for eq, null is not an allowed value.
matches		String	Compares the document field with the provided value. Wildcards may be used in the query (e.g. ki*y). Two types of wildcard operators are supported: ?, which matches any single character *, which can match zero or more characters, including an empty one See Elasticsearch documentation for more details.
matches_lc		String	This operator is like FilterStringWithWildcard.matches except that it performs case-insensitive matching.

FilterSystemPurpose

Filter by 'system_purpose' field of system profile

Field		Type	Description
usage		FilterString	Filter by 'usage' field of system_purpose
role		FilterString	Filter by 'role' field of system_purpose
sla		FilterString	Filter by 'sla' field of system_purpose

FilterSystemd

Filter by 'systemd' field of system profile

Field		Type	Description
state		FilterString	Filter by 'state' field of systemd
jobs_queued		FilterInt	Filter by 'jobs_queued' field of systemd
failed		FilterInt	Filter by 'failed' field of systemd
failed_services		FilterString	Filter by 'failed_services' field of systemd

FilterTag

Filters hosts by the presence of a host tag

Field		Type	Description
namespace		FilterString	Tag namespace
key		FilterString!	Tag key
value		FilterString	Tag value

FilterTimestamp

Timestamp field filter with support for common operations.

Field		Type	Description
lt		String	Less than
lte		String	Less than or equal to
gt		String	Greater than
gte		String	Greater than or equal to
eq		String	Equal

HostFilter

Defines criteria by which the hosts are filtered.

Field		Type	Description
AND		[HostFilter!]	Apply logical conjunction on the given filtering criteria
OR		[HostFilter!]	Apply logical disjunction on the given filtering criteria
NOT		HostFilter	Negate the given filtering criteria
id		FilterStringWithWildcard	Filter by host id
insights_id		FilterStringWithWildcard	Filter by insights id
display_name		FilterStringWithWildcardWithLowercase	Filter by display_name
fqdn		FilterStringWithWildcardWithLowercase	Filter by fqdn
provider_type		FilterString	Filter by provider_type
provider_id		FilterString	Filter by provider_id
modified_on		FilterTimestamp	Filter by modified_on
spf_virtual_host_uuid		FilterString	Filter by 'virtual_host_uuid' field of system profile
spf_system_update_method		FilterString	Filter by 'system_update_method' field of system profile
spf_mssql		FilterMssql	Filter by 'mssql' field of system profile
spf_ansible		FilterAnsible	Filter by 'ansible' field of system profile
spf_system_purpose		FilterSystemPurpose	Filter by 'system_purpose' field of system profile
spf_rhsm		FilterRhsm	Filter by 'rhsm' field of system profile
spf_rpm_ostree_deployments		FilterRpmOstreeDeployments	Filter by 'rpm_ostree_deployments' field of system profile
spf_greenboot_fallback_detected		FilterBoolean	Filter by 'greenboot_fallback_detected' field of system profile
spf_greenboot_status		FilterString	Filter by 'greenboot_status' field of system profile
spf_host_type		FilterString	Filter by 'host_type' field of system profile
spf_is_marketplace		FilterBoolean	Filter by 'is_marketplace' field of system profile
spf_selinux_config_file		FilterString	Filter by 'selinux_config_file' field of system profile
spf_selinux_current_mode		FilterString	Filter by 'selinux_current_mode' field of system profile
spf_tuned_profile		FilterString	Filter by 'tuned_profile' field of system profile
spf_sap_version		FilterString	Filter by 'sap_version' field of system profile
spf_sap_instance_number		FilterString	Filter by 'sap_instance_number' field of system profile
spf_sap_sids		FilterString	Filter by 'sap_sids' field of system profile
spf_sap_system		FilterBoolean	Filter by 'sap_system' field of system profile
spf_sap		FilterSap	Filter by 'sap' field of system profile
spf_enabled_services		FilterString	Filter by 'enabled_services' field of system profile
spf_installed_services		FilterString	Filter by 'installed_services' field of system profile
spf_gpg_pubkeys		FilterString	Filter by 'gpg_pubkeys' field of system profile
spf_installed_packages		FilterString	Filter by 'installed_packages' field of system profile
spf_captured_date		FilterString	Filter by 'captured_date' field of system profile
spf_insights_egg_version		FilterString	Filter by 'insights_egg_version' field of system profile
spf_insights_client_version		FilterStringWithWildcard	Filter by 'insights_client_version' field of system profile
spf_installed_products		FilterInstalledProducts	Filter by 'installed_products' field of system profile
spf_dnf_modules		FilterDnfModules	Filter by 'dnf_modules' field of system profile
spf_cloud_provider		FilterString	Filter by 'cloud_provider' field of system profile
spf_satellite_managed		FilterBoolean	Filter by 'satellite_managed' field of system profile
spf_katello_agent_running		FilterBoolean	Filter by 'katello_agent_running' field of system profile
spf_subscription_auto_attach		FilterString	Filter by 'subscription_auto_attach' field of system profile
spf_subscription_status		FilterString	Filter by 'subscription_status' field of system profile
spf_last_boot_time		FilterTimestamp	Filter by 'last_boot_time' field of system profile
spf_kernel_modules		FilterString	Filter by 'kernel_modules' field of system profile
spf_basearch		FilterString	Filter by 'basearch' field of system profile
spf_arch		FilterString	Filter by 'arch' field of system profile
spf_releasever		FilterString	Filter by 'releasever' field of system profile
spf_os_kernel_version		FilterStringWithWildcard	Filter by 'os_kernel_version' field of system profile
spf_os_release		FilterStringWithWildcard	Filter by 'os_release' field of system profile
spf_operating_system		FilterOperatingSystem	Filter by 'operating_system' field of system profile
spf_systemd		FilterSystemd	Filter by 'systemd' field of system profile
spf_cpu_flags		FilterString	Filter by 'cpu_flags' field of system profile
spf_bios_version		FilterString	Filter by 'bios_version' field of system profile
spf_bios_vendor		FilterString	Filter by 'bios_vendor' field of system profile
spf_disk_devices		FilterDiskDevices	Filter by 'disk_devices' field of system profile
spf_network_interfaces		FilterNetworkInterfaces	Filter by 'network_interfaces' field of system profile
spf_infrastructure_vendor		FilterString	Filter by 'infrastructure_vendor' field of system profile
spf_infrastructure_type		FilterString	Filter by 'infrastructure_type' field of system profile
spf_system_memory_bytes		FilterInt	Filter by 'system_memory_bytes' field of system profile
spf_threads_per_core		FilterInt	Filter by 'threads_per_core' field of system profile
spf_cores_per_socket		FilterInt	Filter by 'cores_per_socket' field of system profile
spf_number_of_sockets		FilterInt	Filter by 'number_of_sockets' field of system profile
spf_number_of_cpus		FilterInt	Filter by 'number_of_cpus' field of system profile
spf_cpu_model		FilterString	Filter by 'cpu_model' field of system profile
spf_rhc_config_state		FilterString	Filter by 'rhc_config_state' field of system profile
spf_rhc_client_id		FilterString	Filter by 'rhc_client_id' field of system profile
spf_owner_id		FilterString	Filter by 'owner_id' field of system profile
stale_timestamp		FilterTimestamp	Filter by the stale_timestamp value
tag		FilterTag	Filter by host tag. The tag namespace/key/value must match exactly what the host is tagged with
per_reporter_staleness		FilterPerReporterStaleness	Filter by per_reporter_staleness sub-fields
group		FilterGroup

SapSidFilter

Defines the criteria by which sap_sids are filtered in the hostSystemProfile query.

Field		Type	Description
search		FilterStringWithRegex	Limits the aggregation to sap_sids that match the given search term. The search term is a regular exression that operates on a string representation of a sap_sid.

TagAggregationFilter

Defines the criteria by which tags are filtered in the hostTags query.

Field		Type	Description
search		FilterStringWithRegex	Limits the aggregation to tags that match the given search term. The search term is a regular exression that operates on a string representation of a tag. The string representation has a form of "namespace/key=value" i.e. the segments are concatenated together using "=" and "/", respectively. There is no expecing of the control characters in the segments. As a result, "=" and "/" appear in every tag.

Enums

HOSTS_ORDER_BY

Value	Description
display_name
group_name
modified_on
operating_system

HOST_GROUPS_ORDER_BY

Value	Description
group
count

HOST_TAGS_ORDER_BY

Value	Description
tag
count

ORDER_DIR

Value	Description
ASC
DESC

VALUES_ORDER_BY

Value	Description
value
count

Scalars

BigInt

Boolean

The Boolean scalar type represents true or false.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

JSONObject

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.