Red Hat Satellite · Schema

Host

A host registered with Red Hat Satellite representing a physical, virtual, or cloud system.

Configuration ManagementLifecycle ManagementPatch ManagementSubscription ManagementSystems Management

Properties

Name Type Description
id integer Unique identifier for the host.
name string Fully qualified domain name (FQDN) of the host.
ip ['string', 'null'] Primary IPv4 address of the host.
ip6 ['string', 'null'] Primary IPv6 address of the host.
mac ['string', 'null'] Primary MAC address of the host.
environment_id ['integer', 'null'] Puppet environment identifier.
hostgroup_id ['integer', 'null'] Host group identifier.
hostgroup_name ['string', 'null'] Host group name.
hostgroup_title ['string', 'null'] Full host group title including parent groups.
operatingsystem_id ['integer', 'null'] Operating system identifier.
operatingsystem_name ['string', 'null'] Operating system name and version.
architecture_id ['integer', 'null'] Architecture identifier.
architecture_name ['string', 'null'] Architecture name (e.g., x86_64).
domain_id ['integer', 'null'] DNS domain identifier.
domain_name ['string', 'null'] DNS domain name.
subnet_id ['integer', 'null'] IPv4 subnet identifier.
subnet_name ['string', 'null'] IPv4 subnet name.
subnet6_id ['integer', 'null'] IPv6 subnet identifier.
compute_resource_id ['integer', 'null'] Compute resource identifier. Null for bare metal hosts.
compute_resource_name ['string', 'null'] Compute resource name.
compute_profile_id ['integer', 'null'] Compute profile identifier.
medium_id ['integer', 'null'] Installation medium identifier.
ptable_id ['integer', 'null'] Partition table identifier.
model_id ['integer', 'null'] Hardware model identifier.
model_name ['string', 'null'] Hardware model name.
location_id integer Location identifier.
location_name string Location name.
organization_id integer Organization identifier.
organization_name string Organization name.
owner_id ['integer', 'null'] Owner identifier.
owner_type ['string', 'null'] Owner type (User or Usergroup).
managed boolean Whether the host is managed by Satellite for provisioning and configuration.
build boolean Whether the host is in build mode.
enabled boolean Whether configuration management reports are evaluated for this host.
comment ['string', 'null'] Additional information about the host.
uuid ['string', 'null'] Unique identifier from compute resource.
global_status integer Global status of the host (0=OK, 1=Warning, 2=Error).
global_status_label string Human-readable global status label.
content_facet_attributes object Content-related attributes from the Katello content facet.
subscription_facet_attributes object Subscription-related attributes from the Katello subscription facet.
interfaces array Network interfaces associated with the host.
puppetclasses array
all_puppetclasses array
created_at string Timestamp when the host was created.
updated_at string Timestamp when the host was last updated.
installed_at ['string', 'null'] Timestamp when the host OS was installed.
last_report ['string', 'null'] Timestamp of the last configuration management report.
View JSON Schema on GitHub

JSON Schema

red-hat-satellite-host-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Host",
  "type": "object",
  "description": "A host registered with Red Hat Satellite representing a physical, virtual, or cloud system.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the host."
    },
    "name": {
      "type": "string",
      "description": "Fully qualified domain name (FQDN) of the host."
    },
    "ip": {
      "type": "['string', 'null']",
      "description": "Primary IPv4 address of the host."
    },
    "ip6": {
      "type": "['string', 'null']",
      "description": "Primary IPv6 address of the host."
    },
    "mac": {
      "type": "['string', 'null']",
      "description": "Primary MAC address of the host."
    },
    "environment_id": {
      "type": "['integer', 'null']",
      "description": "Puppet environment identifier."
    },
    "hostgroup_id": {
      "type": "['integer', 'null']",
      "description": "Host group identifier."
    },
    "hostgroup_name": {
      "type": "['string', 'null']",
      "description": "Host group name."
    },
    "hostgroup_title": {
      "type": "['string', 'null']",
      "description": "Full host group title including parent groups."
    },
    "operatingsystem_id": {
      "type": "['integer', 'null']",
      "description": "Operating system identifier."
    },
    "operatingsystem_name": {
      "type": "['string', 'null']",
      "description": "Operating system name and version."
    },
    "architecture_id": {
      "type": "['integer', 'null']",
      "description": "Architecture identifier."
    },
    "architecture_name": {
      "type": "['string', 'null']",
      "description": "Architecture name (e.g., x86_64)."
    },
    "domain_id": {
      "type": "['integer', 'null']",
      "description": "DNS domain identifier."
    },
    "domain_name": {
      "type": "['string', 'null']",
      "description": "DNS domain name."
    },
    "subnet_id": {
      "type": "['integer', 'null']",
      "description": "IPv4 subnet identifier."
    },
    "subnet_name": {
      "type": "['string', 'null']",
      "description": "IPv4 subnet name."
    },
    "subnet6_id": {
      "type": "['integer', 'null']",
      "description": "IPv6 subnet identifier."
    },
    "compute_resource_id": {
      "type": "['integer', 'null']",
      "description": "Compute resource identifier. Null for bare metal hosts."
    },
    "compute_resource_name": {
      "type": "['string', 'null']",
      "description": "Compute resource name."
    },
    "compute_profile_id": {
      "type": "['integer', 'null']",
      "description": "Compute profile identifier."
    },
    "medium_id": {
      "type": "['integer', 'null']",
      "description": "Installation medium identifier."
    },
    "ptable_id": {
      "type": "['integer', 'null']",
      "description": "Partition table identifier."
    },
    "model_id": {
      "type": "['integer', 'null']",
      "description": "Hardware model identifier."
    },
    "model_name": {
      "type": "['string', 'null']",
      "description": "Hardware model name."
    },
    "location_id": {
      "type": "integer",
      "description": "Location identifier."
    },
    "location_name": {
      "type": "string",
      "description": "Location name."
    },
    "organization_id": {
      "type": "integer",
      "description": "Organization identifier."
    },
    "organization_name": {
      "type": "string",
      "description": "Organization name."
    },
    "owner_id": {
      "type": "['integer', 'null']",
      "description": "Owner identifier."
    },
    "owner_type": {
      "type": "['string', 'null']",
      "description": "Owner type (User or Usergroup)."
    },
    "managed": {
      "type": "boolean",
      "description": "Whether the host is managed by Satellite for provisioning and configuration."
    },
    "build": {
      "type": "boolean",
      "description": "Whether the host is in build mode."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether configuration management reports are evaluated for this host."
    },
    "comment": {
      "type": "['string', 'null']",
      "description": "Additional information about the host."
    },
    "uuid": {
      "type": "['string', 'null']",
      "description": "Unique identifier from compute resource."
    },
    "global_status": {
      "type": "integer",
      "description": "Global status of the host (0=OK, 1=Warning, 2=Error)."
    },
    "global_status_label": {
      "type": "string",
      "description": "Human-readable global status label."
    },
    "content_facet_attributes": {
      "type": "object",
      "description": "Content-related attributes from the Katello content facet."
    },
    "subscription_facet_attributes": {
      "type": "object",
      "description": "Subscription-related attributes from the Katello subscription facet."
    },
    "interfaces": {
      "type": "array",
      "description": "Network interfaces associated with the host."
    },
    "puppetclasses": {
      "type": "array"
    },
    "all_puppetclasses": {
      "type": "array"
    },
    "created_at": {
      "type": "string",
      "description": "Timestamp when the host was created."
    },
    "updated_at": {
      "type": "string",
      "description": "Timestamp when the host was last updated."
    },
    "installed_at": {
      "type": "['string', 'null']",
      "description": "Timestamp when the host OS was installed."
    },
    "last_report": {
      "type": "['string', 'null']",
      "description": "Timestamp of the last configuration management report."
    }
  }
}